## On this page

  

 

 # SourceDisplayBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for a display source. [More...](#details)

Inheritance diagram for SourceDisplayBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_source_display_builder.png)



## <a id="properties" name="properties"></a>Properties

 [AxisSystem](#a4c4b8fa4fecce1d2737f605f77e7320a) = property(fget = \_\_GetAxisSystem) Gets the axis system.   
  [BlueSpectrumFilePath](#af1cbfd0c5aaa18adee891776ff30ca9d) = property(fget = \_\_GetBlueSpectrumFilePath, fset = \_\_SetBlueSpectrumFilePath) Gets or sets the blue spectrum file.   
  [ColorSpace](#a20f8d042a293f7b8c87f2992d183ceb9) = property(fget = \_\_GetColorSpace, fset = \_\_SetColorSpace) Gets or sets the color space model type.   
  [Contrast](#a690b0e5bb0e1902989e2a077a8508e62) = property(fget = \_\_GetContrast, fset = \_\_SetContrast) Gets or sets the contrast ratio.   
  [CosN](#a548cd7bd81805336aaf7631086bc9360) = property(fget = \_\_GetCosN, fset = \_\_SetCosN) Gets or sets the N value for Cos distribution.   
  [GaussianFWHMAngle](#aef43808a7f9844489cdeaf7a6c7db0d2) = property(fget = \_\_GetGaussianFWHMAngle, fset = \_\_SetGaussianFWHMAngle) Gets or sets the FWHM angle value for Symmetric Gaussian distribution.   
  [GaussianFWHMAngleX](#a4855863207ac5302b593e6b769ec82a9) = property(fget = \_\_GetGaussianFWHMAngleX, fset = \_\_SetGaussianFWHMAngleX) Gets or sets the FWHM X angle value for Asymmetric Gaussian distribution.   
  [GaussianFWHMAngleY](#ab60d4d5c051a1779188872181db64fd7) = property(fget = \_\_GetGaussianFWHMAngleY, fset = \_\_SetGaussianFWHMAngleY) Gets or sets the FWHM Y angle value for Asymmetric Gaussian distribution.   
  [GreenSpectrumFilePath](#ae08250ad2f5b04fa360eb22c7769c080) = property(fget = \_\_GetGreenSpectrumFilePath, fset = \_\_SetGreenSpectrumFilePath) Gets or sets the green spectrum file.   
  [ImageFilePath](#a41734f9d1ab445ca3f74efb480f7b1c2) = property(fget = \_\_GetImageFilePath, fset = \_\_SetImageFilePath) Gets or sets the image file.   
  [InfiniteContrast](#a8c66123a9f9c92efe37579d38aec6730) = property(fget = \_\_GetInfiniteContrast, fset = \_\_SetInfiniteContrast) Gets or sets the property to enable infinite contrast ratio.   
  [IntensityFilePath](#ae441c07f8c1c874ed6918b174f8fb1d3) = property(fget = \_\_GetIntensityFilePath, fset = \_\_SetIntensityFilePath) Gets or sets the intensity file for Library distribution.   
  [IntensityType](#aa14d1fc77993a0b6b6816a4d0441561a) = property(fget = \_\_GetIntensityType, fset = \_\_SetIntensityType) Gets or sets the intensity diagram.   
  [LambertianMaximumAngle](#acbeb0774371b3835f5970e8f0a3eec83) = property(fget = \_\_GetLambertianMaximumAngle, fset = \_\_SetLambertianMaximumAngle) Gets or sets the theta value for Lambertian distribution.   
  [Luminance](#a83cdcfa372358021030f5a7095bf2456) = property(fget = \_\_GetLuminance, fset = \_\_SetLuminance) Gets or sets the luminance.   
  [NumberOfRays](#a622dc1d3ba1038d63b443881726aac17) = property(fget = \_\_GetNumberOfRays, fset = \_\_SetNumberOfRays) Gets or sets the number of rays.   
  [RayLength](#ac34ed0a90a26560cbc5671f5f0243421) = property(fget = \_\_GetRayLength, fset = \_\_SetRayLength) Gets or sets the ray length.   
  [RedSpectrumFilePath](#afc42d0cd925127b856144656d9f9d114) = property(fget = \_\_GetRedSpectrumFilePath, fset = \_\_SetRedSpectrumFilePath) Gets or sets the red spectrum file.   
  [ShowImage](#a8f71cc3c28f87a4a31f909a9d4b18924) = property(fget = \_\_GetShowImage, fset = \_\_SetShowImage) Gets or sets the property to show the image.   
  [ShowIntensityDistribution](#a988eaa701eb99af6e535e4d8ce8d22c4) = property(fget = \_\_GetShowIntensityDistribution, fset = \_\_SetShowIntensityDistribution) Gets or sets the property to show the intensity distribution in the 3D view.   
  [WhitePointType](#aee30c02105b7e65855ee5976c11c2db6) = property(fget = \_\_GetWhitePointType, fset = \_\_SetWhitePointType) Gets or sets the white point type of the standard illuminant.   
  [WhitePointX](#a36c61aa2378a1d999086241732672114) = property(fget = \_\_GetWhitePointX, fset = \_\_SetWhitePointX) Gets or sets the X coordinate of the white point.   
  [WhitePointY](#ae9e202f90077d5edf159cd7aedf2423f) = property(fget = \_\_GetWhitePointY, fset = \_\_SetWhitePointY) Gets or sets the Y coordinate of the white point.   
  [XDirection](#ac32c0a2dded19b16f8b3c6f95a350212) = property(fget = \_\_GetXDirection, fset = \_\_SetXDirection) Gets or sets the X direction.   
  [XDirectionReversed](#aeec30b2aaa4a69736255d2f2a67848c7) = property(fget = \_\_GetXDirectionReversed, fset = \_\_SetXDirectionReversed) Gets or sets the property to reverse the X direction.   
  [XEnd](#a799203cf9eff20a5ef568bbc1b9d1a47) = property(fget = \_\_GetXEnd, fset = \_\_SetXEnd) Gets or sets the sensor X end dimension value.   
  [XMirroredExtent](#a78fc5a48a0a4a6282855a28240b3f94a) = property(fget = \_\_GetXMirroredExtent, fset = \_\_SetXMirroredExtent) Gets or sets the sensor X dimension mirrored value.   
  [XStart](#a7963a0ff7bd1a05f42907b2e4a8912fb) = property(fget = \_\_GetXStart, fset = \_\_SetXStart) Gets or sets the sensor X start dimension value.   
  [YDirection](#a1c37124b0cb81a86cb2553a26ca6488a) = property(fget = \_\_GetYDirection, fset = \_\_SetYDirection) Gets or sets the Y direction.   
  [YDirectionReversed](#a63f504d122e56ea17b42eae4c7ecbb56) = property(fget = \_\_GetYDirectionReversed, fset = \_\_SetYDirectionReversed) Gets or sets the property to reverse the Y direction.   
  [YEnd](#a9695e3ae4ea46b87955435354389d31e) = property(fget = \_\_GetYEnd, fset = \_\_SetYEnd) Gets or sets the sensor Y start dimension value.   
  [YMirroredExtent](#aa912900c157c45f922fdb9ebdf4ae54d) = property(fget = \_\_GetYMirroredExtent, fset = \_\_SetYMirroredExtent) Gets or sets the sensor Y dimension mirrored value.   
  [YStart](#a11a4148336b7022a46cbcf4c1706b179) = property(fget = \_\_GetYStart, fset = \_\_SetYStart) Gets or sets the sensor Y start dimension value.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Feature](class_speos_n_x_1_1_feature_builder.xhtml#a94ea57aab7fe0356cbfbd048b1ad971e) = property(fget = \_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
  [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a0b7259da2de11c688aa435d1f0509134) = property(fget = \_\_GetFullName) Gets the full name of the feature being edited.   
  [Name](class_speos_n_x_1_1_feature_builder.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName, fset = \_\_SetName) Gets or sets the name of the feature being edited.   
  [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a99e8764720550e4ed0eba629a625b2e3) = property(fget = \_\_GetNameWithContext) Gets the name with context of the feature being edited.   
  [Status](class_speos_n_x_1_1_feature_builder.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b) = property(fget = \_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a2b74e1b440341a82332053432b52b42c) (self) Commits any edits that have been applied to the builder.   
  **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 <a id="details" name="details"></a>## Detailed Description

Represents the builder for a display source.

The display source builder is used to create and edit display source features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateSourceDisplayBuilder</a>



## Property Documentation

<a id="a4c4b8fa4fecce1d2737f605f77e7320a" name="a4c4b8fa4fecce1d2737f605f77e7320a"></a>## [◆ ](#a4c4b8fa4fecce1d2737f605f77e7320a)AxisSystem

 [AxisSystem](class_speos_n_x_1_1_axis_system.xhtml) = property(fget = \_\_GetAxisSystem)  static 

Gets the axis system.

**Value type**: AxisSystem object.





<a id="af1cbfd0c5aaa18adee891776ff30ca9d" name="af1cbfd0c5aaa18adee891776ff30ca9d"></a>## [◆ ](#af1cbfd0c5aaa18adee891776ff30ca9d)BlueSpectrumFilePath

 BlueSpectrumFilePath = property(fget = \_\_GetBlueSpectrumFilePath, fset = \_\_SetBlueSpectrumFilePath)  static 

Gets or sets the blue spectrum file.

Prerequisite: The ColorSpace property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a20f8d042a293f7b8c87f2992d183ceb9" name="a20f8d042a293f7b8c87f2992d183ceb9"></a>## [◆ ](#a20f8d042a293f7b8c87f2992d183ceb9)ColorSpace

 ColorSpace = property(fget = \_\_GetColorSpace, fset = \_\_SetColorSpace)  static 

Gets or sets the color space model type.

The values are:  
 0 - sRGB. Uses the standard and most commonly used RGB based model.  
 1 - Adobe RGB. Uses a larger gamut.  
 2 - User Defined RGB. Defines manually the white point of the standard illuminant.

**Value type**: Integer.

The default value is 0.





<a id="a690b0e5bb0e1902989e2a077a8508e62" name="a690b0e5bb0e1902989e2a077a8508e62"></a>## [◆ ](#a690b0e5bb0e1902989e2a077a8508e62)Contrast

 Contrast = property(fget = \_\_GetContrast, fset = \_\_SetContrast)  static 

Gets or sets the contrast ratio.

Prerequisite: The IsInfiniteContrast property must be False.

Contrast Ratio = (Luminance of the brightest color-Luminance of the darkest color)/(Luminance of the darkest color).

**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value is 500.





<a id="a548cd7bd81805336aaf7631086bc9360" name="a548cd7bd81805336aaf7631086bc9360"></a>## [◆ ](#a548cd7bd81805336aaf7631086bc9360)CosN

 CosN = property(fget = \_\_GetCosN, fset = \_\_SetCosN)  static 

Gets or sets the N value for Cos distribution.

Prerequisite: The IntensityType property must be 1.

**Value type**: Double.

The default value is 3.0.





<a id="aef43808a7f9844489cdeaf7a6c7db0d2" name="aef43808a7f9844489cdeaf7a6c7db0d2"></a>## [◆ ](#aef43808a7f9844489cdeaf7a6c7db0d2)GaussianFWHMAngle

 GaussianFWHMAngle = property(fget = \_\_GetGaussianFWHMAngle, fset = \_\_SetGaussianFWHMAngle)  static 

Gets or sets the FWHM angle value for Symmetric Gaussian distribution.

Prerequisite: The IntensityType property must be 2.

**Value type**: Double (in degrees).  
**Range**: \[0.0, 180.0\].

The default value is 30.0 degrees.





<a id="a4855863207ac5302b593e6b769ec82a9" name="a4855863207ac5302b593e6b769ec82a9"></a>## [◆ ](#a4855863207ac5302b593e6b769ec82a9)GaussianFWHMAngleX

 GaussianFWHMAngleX = property(fget = \_\_GetGaussianFWHMAngleX, fset = \_\_SetGaussianFWHMAngleX)  static 

Gets or sets the FWHM X angle value for Asymmetric Gaussian distribution.

Prerequisite: The IntensityType property must be 3.

**Value type**: Double (in degrees).  
**Range**: \[0.0, 180.0\].

The default value is 30.0 degrees.





<a id="ab60d4d5c051a1779188872181db64fd7" name="ab60d4d5c051a1779188872181db64fd7"></a>## [◆ ](#ab60d4d5c051a1779188872181db64fd7)GaussianFWHMAngleY

 GaussianFWHMAngleY = property(fget = \_\_GetGaussianFWHMAngleY, fset = \_\_SetGaussianFWHMAngleY)  static 

Gets or sets the FWHM Y angle value for Asymmetric Gaussian distribution.

Prerequisite: The IntensityType property must be 3.

**Value type**: Double (in degrees).  
**Range**: \[0.0, 180.0\].

The default value is 30.0 degrees.





<a id="ae08250ad2f5b04fa360eb22c7769c080" name="ae08250ad2f5b04fa360eb22c7769c080"></a>## [◆ ](#ae08250ad2f5b04fa360eb22c7769c080)GreenSpectrumFilePath

 GreenSpectrumFilePath = property(fget = \_\_GetGreenSpectrumFilePath, fset = \_\_SetGreenSpectrumFilePath)  static 

Gets or sets the green spectrum file.

Prerequisite: The ColorSpace property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a41734f9d1ab445ca3f74efb480f7b1c2" name="a41734f9d1ab445ca3f74efb480f7b1c2"></a>## [◆ ](#a41734f9d1ab445ca3f74efb480f7b1c2)ImageFilePath

 ImageFilePath = property(fget = \_\_GetImageFilePath, fset = \_\_SetImageFilePath)  static 

Gets or sets the image file.

Selects a .jpg or a .png file.

**Value type**: String.

The default value is an empty string.





<a id="a8c66123a9f9c92efe37579d38aec6730" name="a8c66123a9f9c92efe37579d38aec6730"></a>## [◆ ](#a8c66123a9f9c92efe37579d38aec6730)InfiniteContrast

 InfiniteContrast = property(fget = \_\_GetInfiniteContrast, fset = \_\_SetInfiniteContrast)  static 

Gets or sets the property to enable infinite contrast ratio.

True: Enable contrast ratio.  
 False: Disable contrast ratio.

**Value type**: Boolean.

The default value is True.





<a id="ae441c07f8c1c874ed6918b174f8fb1d3" name="ae441c07f8c1c874ed6918b174f8fb1d3"></a>## [◆ ](#ae441c07f8c1c874ed6918b174f8fb1d3)IntensityFilePath

 IntensityFilePath = property(fget = \_\_GetIntensityFilePath, fset = \_\_SetIntensityFilePath)  static 

Gets or sets the intensity file for Library distribution.

Prerequisite: The IntensityType property must be 4.

**Value type**: String.

The default value is an empty string.





<a id="aa14d1fc77993a0b6b6816a4d0441561a" name="aa14d1fc77993a0b6b6816a4d0441561a"></a>## [◆ ](#aa14d1fc77993a0b6b6816a4d0441561a)IntensityType

 IntensityType = property(fget = \_\_GetIntensityType, fset = \_\_SetIntensityType)  static 

Gets or sets the intensity diagram.

The intensity diagram of a source describes in which directions is made the emission.

The values are:  
 0 - Lambertian.  
 1 - Cos.  
 2 - Symmetric Gaussian.  
 3 - Asymmetric Gaussian.  
 4 - Library.

**Value type**: Integer.

The default value is 0.





<a id="acbeb0774371b3835f5970e8f0a3eec83" name="acbeb0774371b3835f5970e8f0a3eec83"></a>## [◆ ](#acbeb0774371b3835f5970e8f0a3eec83)LambertianMaximumAngle

 LambertianMaximumAngle = property(fget = \_\_GetLambertianMaximumAngle, fset = \_\_SetLambertianMaximumAngle)  static 

Gets or sets the theta value for Lambertian distribution.

Prerequisite: The IntensityType property must be 0.

**Value type**: Double (in degrees).  
**Range**: \[0.0, 180.0\].

The default value is 180.0 degrees.





<a id="a83cdcfa372358021030f5a7095bf2456" name="a83cdcfa372358021030f5a7095bf2456"></a>## [◆ ](#a83cdcfa372358021030f5a7095bf2456)Luminance

 Luminance = property(fget = \_\_GetLuminance, fset = \_\_SetLuminance)  static 

Gets or sets the luminance.

The luminance parameter is the source luminance for the white point in front direction of the source.

**Value type**: Double (in cd/m2).  
**Range**: The value must be superior to 0.0.

The default value is 50.0 cd/m2.





<a id="a622dc1d3ba1038d63b443881726aac17" name="a622dc1d3ba1038d63b443881726aac17"></a>## [◆ ](#a622dc1d3ba1038d63b443881726aac17)NumberOfRays

 NumberOfRays = property(fget = \_\_GetNumberOfRays, fset = \_\_SetNumberOfRays)  static 

Gets or sets the number of rays.

**Value type**: Integer.  
**Range**: The value must be superior or equal to 0.

The default value is 100.





<a id="ac34ed0a90a26560cbc5671f5f0243421" name="ac34ed0a90a26560cbc5671f5f0243421"></a>## [◆ ](#ac34ed0a90a26560cbc5671f5f0243421)RayLength

 RayLength = property(fget = \_\_GetRayLength, fset = \_\_SetRayLength)  static 

Gets or sets the ray length.

**Value type**: Double (in mm).  
**Range**: The value must be superior to 0.0.

The default value is 75.0 mm.





<a id="afc42d0cd925127b856144656d9f9d114" name="afc42d0cd925127b856144656d9f9d114"></a>## [◆ ](#afc42d0cd925127b856144656d9f9d114)RedSpectrumFilePath

 RedSpectrumFilePath = property(fget = \_\_GetRedSpectrumFilePath, fset = \_\_SetRedSpectrumFilePath)  static 

Gets or sets the red spectrum file.

Prerequisite: The ColorSpace property must be 2.

**Value type**: String.

The default value is an empty string.





<a id="a8f71cc3c28f87a4a31f909a9d4b18924" name="a8f71cc3c28f87a4a31f909a9d4b18924"></a>## [◆ ](#a8f71cc3c28f87a4a31f909a9d4b18924)ShowImage

 ShowImage = property(fget = \_\_GetShowImage, fset = \_\_SetShowImage)  static 

Gets or sets the property to show the image.

True: Shows the image.  
 False: Does not show the image.

The default value is True.





<a id="a988eaa701eb99af6e535e4d8ce8d22c4" name="a988eaa701eb99af6e535e4d8ce8d22c4"></a>## [◆ ](#a988eaa701eb99af6e535e4d8ce8d22c4)ShowIntensityDistribution

 ShowIntensityDistribution = property(fget = \_\_GetShowIntensityDistribution, fset = \_\_SetShowIntensityDistribution)  static 

Gets or sets the property to show the intensity distribution in the 3D view.

Prerequisite: The IntensityType property must be 4.

True: Shows the intensity distribution in the 3D view.  
 False: Does not show the intensity distribution in the 3D view.

The default value is False.





<a id="aee30c02105b7e65855ee5976c11c2db6" name="aee30c02105b7e65855ee5976c11c2db6"></a>## [◆ ](#aee30c02105b7e65855ee5976c11c2db6)WhitePointType

 WhitePointType = property(fget = \_\_GetWhitePointType, fset = \_\_SetWhitePointType)  static 

Gets or sets the white point type of the standard illuminant.

Prerequisite: The ColorSpace property must be 2.

The values are:  
 0 - D65. Uses a standard daylight illuminant that provides accurate color perception and evaluation.  
 1 - D50. Uses a natural, horizon light.  
 2 - C. Uses an average daylight illuminant.  
 3 - E. Uses an illuminant that gives equal weight to all wavelengths.  
 4 - User defined. Edits the Color Coordinates of the white point.

**Value type**: Integer.

The default value is 0.





<a id="a36c61aa2378a1d999086241732672114" name="a36c61aa2378a1d999086241732672114"></a>## [◆ ](#a36c61aa2378a1d999086241732672114)WhitePointX

 WhitePointX = property(fget = \_\_GetWhitePointX, fset = \_\_SetWhitePointX)  static 

Gets or sets the X coordinate of the white point.

Prerequisite: The WhitePoint property must be 4.

**Value type**: Double.

The default value is 0.31271.





<a id="ae9e202f90077d5edf159cd7aedf2423f" name="ae9e202f90077d5edf159cd7aedf2423f"></a>## [◆ ](#ae9e202f90077d5edf159cd7aedf2423f)WhitePointY

 WhitePointY = property(fget = \_\_GetWhitePointY, fset = \_\_SetWhitePointY)  static 

Gets or sets the Y coordinate of the white point.

Prerequisite: The WhitePoint property must be 4.

**Value type**: Double.

The default value is 0.32902.





<a id="ac32c0a2dded19b16f8b3c6f95a350212" name="ac32c0a2dded19b16f8b3c6f95a350212"></a>## [◆ ](#ac32c0a2dded19b16f8b3c6f95a350212)XDirection

 XDirection = property(fget = \_\_GetXDirection, fset = \_\_SetXDirection)  static 

Gets or sets the X direction.

Prerequisite: The IntensityType property must be 3 or 4.

The XDirection property takes a feature tag and returns a feature tag.  
 You can modify the property if the distribution is Asymmetric Gaussian or Library

**Value type**: Integer.

The default value is 0.





<a id="aeec30b2aaa4a69736255d2f2a67848c7" name="aeec30b2aaa4a69736255d2f2a67848c7"></a>## [◆ ](#aeec30b2aaa4a69736255d2f2a67848c7)XDirectionReversed

 XDirectionReversed = property(fget = \_\_GetXDirectionReversed, fset = \_\_SetXDirectionReversed)  static 

Gets or sets the property to reverse the X direction.

Prerequisite: The IntensityType property must be 3 or 4.

True: Reverses the X direction.  
 False: Does not reverse the X direction.

**Value type**: Boolean.

The default value is False.





<a id="a799203cf9eff20a5ef568bbc1b9d1a47" name="a799203cf9eff20a5ef568bbc1b9d1a47"></a>## [◆ ](#a799203cf9eff20a5ef568bbc1b9d1a47)XEnd

 XEnd = property(fget = \_\_GetXEnd, fset = \_\_SetXEnd)  static 

Gets or sets the sensor X end dimension value.

**Value type**: Double (in mm).

The default value is 50.0 mm.





<a id="a78fc5a48a0a4a6282855a28240b3f94a" name="a78fc5a48a0a4a6282855a28240b3f94a"></a>## [◆ ](#a78fc5a48a0a4a6282855a28240b3f94a)XMirroredExtent

 XMirroredExtent = property(fget = \_\_GetXMirroredExtent, fset = \_\_SetXMirroredExtent)  static 

Gets or sets the sensor X dimension mirrored value.

True: XStart == -XEnd, you can only change the XEnd value.  
 False: XStart and XEnd can have different value.

**Value type**: Boolean.

The default value is False.





<a id="a7963a0ff7bd1a05f42907b2e4a8912fb" name="a7963a0ff7bd1a05f42907b2e4a8912fb"></a>## [◆ ](#a7963a0ff7bd1a05f42907b2e4a8912fb)XStart

 XStart = property(fget = \_\_GetXStart, fset = \_\_SetXStart)  static 

Gets or sets the sensor X start dimension value.

**Value type**: Double (in mm).

The default value is -50.0 mm.





<a id="a1c37124b0cb81a86cb2553a26ca6488a" name="a1c37124b0cb81a86cb2553a26ca6488a"></a>## [◆ ](#a1c37124b0cb81a86cb2553a26ca6488a)YDirection

 YDirection = property(fget = \_\_GetYDirection, fset = \_\_SetYDirection)  static 

Gets or sets the Y direction.

Prerequisite: The IntensityType property must be 3 or 4.

The YDirection property takes a feature tag and returns a feature tag.  
 You can modify the property if the distribution is Asymmetric Gaussian or Library

**Value type**: Integer.

The default value is 0.





<a id="a63f504d122e56ea17b42eae4c7ecbb56" name="a63f504d122e56ea17b42eae4c7ecbb56"></a>## [◆ ](#a63f504d122e56ea17b42eae4c7ecbb56)YDirectionReversed

 YDirectionReversed = property(fget = \_\_GetYDirectionReversed, fset = \_\_SetYDirectionReversed)  static 

Gets or sets the property to reverse the Y direction.

Prerequisite: The IntensityType property must be 3 or 4.

True: Reverses the Y direction.  
 False: Does not reverse the Y direction.

**Value type**: Boolean.

The default value is False.





<a id="a9695e3ae4ea46b87955435354389d31e" name="a9695e3ae4ea46b87955435354389d31e"></a>## [◆ ](#a9695e3ae4ea46b87955435354389d31e)YEnd

 YEnd = property(fget = \_\_GetYEnd, fset = \_\_SetYEnd)  static 

Gets or sets the sensor Y start dimension value.

**Value type**: Double (in mm).

The default value is 50.0 mm.





<a id="aa912900c157c45f922fdb9ebdf4ae54d" name="aa912900c157c45f922fdb9ebdf4ae54d"></a>## [◆ ](#aa912900c157c45f922fdb9ebdf4ae54d)YMirroredExtent

 YMirroredExtent = property(fget = \_\_GetYMirroredExtent, fset = \_\_SetYMirroredExtent)  static 

Gets or sets the sensor Y dimension mirrored value.

True: YStart == -YEnd, you can only change the YEnd value.  
 False: YStart and YEnd can have different value.

**Value type**: Boolean.

The default value is False.





<a id="a11a4148336b7022a46cbcf4c1706b179" name="a11a4148336b7022a46cbcf4c1706b179"></a>## [◆ ](#a11a4148336b7022a46cbcf4c1706b179)YStart

 YStart = property(fget = \_\_GetYStart, fset = \_\_SetYStart)  static 

Gets or sets the sensor Y start dimension value.

**Value type**: Double (in mm).

The default value is -50.0 mm.





---

The documentation for this class was generated from the following file:- **SpeosNX.py**