## 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_2025_r1_1/class_speos_n_x_1_1_source_display_builder.png)



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the axis system.   
 str [BlueSpectrumFilePath](#a7dfeb0681efba85ca5f071e66842f5be) = property(fget=\_\_GetBlueSpectrumFilePath, fset=\_\_SetBlueSpectrumFilePath) Gets or sets the blue spectrum file.   
 str [ColorSpace](#aeaf08fe09b5dba864e9567b46973cc03) = property(fget=\_\_GetColorSpace, fset=\_\_SetColorSpace) Gets or sets the color space model type.   
 str [Contrast](#ac35d783502acc19412173b338d6334f1) = property(fget=\_\_GetContrast, fset=\_\_SetContrast) Gets or sets the contrast ratio.   
 str [CosN](#ab6af473ac0abd6943d5eac98e2fb5140) = property(fget=\_\_GetCosN, fset=\_\_SetCosN) Gets or sets the N value for Cos distribution.   
 str [GaussianFWHMAngle](#ae942485ca7f6424861badd0a17717a88) = property(fget=\_\_GetGaussianFWHMAngle, fset=\_\_SetGaussianFWHMAngle) Gets or sets the FWHM angle value for Symmetric Gaussian distribution.   
 str [GaussianFWHMAngleX](#ad6ea73208d1290bbc84771f72c8498fa) = property(fget=\_\_GetGaussianFWHMAngleX, fset=\_\_SetGaussianFWHMAngleX) Gets or sets the FWHM X angle value for Asymmetric Gaussian distribution.   
 str [GaussianFWHMAngleY](#a26d44695dc3a431cd107819bfb868362) = property(fget=\_\_GetGaussianFWHMAngleY, fset=\_\_SetGaussianFWHMAngleY) Gets or sets the FWHM Y angle value for Asymmetric Gaussian distribution.   
 str [GreenSpectrumFilePath](#adbd5552b771bee21f7509ddc489a4e0b) = property(fget=\_\_GetGreenSpectrumFilePath, fset=\_\_SetGreenSpectrumFilePath) Gets or sets the green spectrum file.   
 str [ImageFilePath](#a123e0960e42f334da9b12d11d373ded4) = property(fget=\_\_GetImageFilePath, fset=\_\_SetImageFilePath) Gets or sets the image file.   
 str [InfiniteContrast](#a97fbd54feb5d7cc3a0114d309da25eb8) = property(fget=\_\_GetInfiniteContrast, fset=\_\_SetInfiniteContrast) Gets or sets the property to enable infinite contrast ratio.   
 str [IntensityFilePath](#a5fb8a391fc503ad7b654dd18251dd622) = property(fget=\_\_GetIntensityFilePath, fset=\_\_SetIntensityFilePath) Gets or sets the intensity file for Library distribution.   
 str [IntensityType](#afaead7b0002acb1a44c356673d626e33) = property(fget=\_\_GetIntensityType, fset=\_\_SetIntensityType) Gets or sets the intensity diagram.   
 str [LambertianMaximumAngle](#a5c9bee4a046db76be718cb37c7874f89) = property(fget=\_\_GetLambertianMaximumAngle, fset=\_\_SetLambertianMaximumAngle) Gets or sets the theta value for Lambertian distribution.   
 str [Luminance](#ae0eaed72c741a4ee1dcf2fe53257db93) = property(fget=\_\_GetLuminance, fset=\_\_SetLuminance) Gets or sets the luminance.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [RedSpectrumFilePath](#a2f7cfab93559124a4765aa804c289e27) = property(fget=\_\_GetRedSpectrumFilePath, fset=\_\_SetRedSpectrumFilePath) Gets or sets the red spectrum file.   
 str [ShowImage](#ae48d523804e948eb7ae37b49a913bb6f) = property(fget=\_\_GetShowImage, fset=\_\_SetShowImage) Gets or sets the property to show the image.   
 str [ShowIntensityDistribution](#a71ae77d862335a54710f601e220d1d77) = property(fget=\_\_GetShowIntensityDistribution, fset=\_\_SetShowIntensityDistribution) Gets or sets the property to show the intensity distribution in the 3D view.   
 str [WhitePointType](#a40dd8956fa2b807fc1ffc7805e7639c3) = property(fget=\_\_GetWhitePointType, fset=\_\_SetWhitePointType) Gets or sets the white point type of the standard illuminant.   
 str [WhitePointX](#aa3f27fb02d4752eb583a4b0773122e8f) = property(fget=\_\_GetWhitePointX, fset=\_\_SetWhitePointX) Gets or sets the X coordinate of the white point.   
 str [WhitePointY](#a27fa0aa58391796b4f86ffbe2e9a4a64) = property(fget=\_\_GetWhitePointY, fset=\_\_SetWhitePointY) Gets or sets the Y coordinate of the white point.   
 str [XDirection](#a6f2c95537ef8210d7f1a99643aeeff4f) = property(fget=\_\_GetXDirection, fset=\_\_SetXDirection) Gets or sets the X direction.   
 str [XDirectionReversed](#a42df9e8270fbe6b5a4944cb1e94b9885) = property(fget=\_\_GetXDirectionReversed, fset=\_\_SetXDirectionReversed) Gets or sets the property to reverse the X direction.   
 str [XEnd](#a26309a89380b2756527ec19cffef2b6c) = property(fget=\_\_GetXEnd, fset=\_\_SetXEnd) Gets or sets the sensor X end dimension value.   
 str [XMirroredExtent](#ae7c2faf5c62ec2baf03149375fadd672) = property(fget=\_\_GetXMirroredExtent, fset=\_\_SetXMirroredExtent) Gets or sets the sensor X dimension mirrored value.   
 str [XStart](#abcbac58872bdd9d694ee7177d1ef7973) = property(fget=\_\_GetXStart, fset=\_\_SetXStart) Gets or sets the sensor X start dimension value.   
 str [YDirection](#a2a551b3ded090b6d859f82d01db9c453) = property(fget=\_\_GetYDirection, fset=\_\_SetYDirection) Gets or sets the Y direction.   
 str [YDirectionReversed](#aa42b4aa0974c063ccf0211c50ecbb1fb) = property(fget=\_\_GetYDirectionReversed, fset=\_\_SetYDirectionReversed) Gets or sets the property to reverse the Y direction.   
 str [YEnd](#a3106ba653a070cd30ef2357bddd2cf60) = property(fget=\_\_GetYEnd, fset=\_\_SetYEnd) Gets or sets the sensor Y start dimension value.   
 str [YMirroredExtent](#a1a4644fb780cae70d397e455eac08e13) = property(fget=\_\_GetYMirroredExtent, fset=\_\_SetYMirroredExtent) Gets or sets the sensor Y dimension mirrored value.   
 str [YStart](#accbaddec059ec07b1ca7f3a94b4574d2) = property(fget=\_\_GetYStart, fset=\_\_SetYStart) Gets or sets the sensor Y start dimension value.   
 ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) 'None' [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
  'None' **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>



## Member Data Documentation

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

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

Gets the axis system.

**Value type**: AxisSystem object.





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

 str 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="aeaf08fe09b5dba864e9567b46973cc03" name="aeaf08fe09b5dba864e9567b46973cc03"></a>## [◆ ](#aeaf08fe09b5dba864e9567b46973cc03)ColorSpace

 str 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="ac35d783502acc19412173b338d6334f1" name="ac35d783502acc19412173b338d6334f1"></a>## [◆ ](#ac35d783502acc19412173b338d6334f1)Contrast

 str 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="ab6af473ac0abd6943d5eac98e2fb5140" name="ab6af473ac0abd6943d5eac98e2fb5140"></a>## [◆ ](#ab6af473ac0abd6943d5eac98e2fb5140)CosN

 str 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="ae942485ca7f6424861badd0a17717a88" name="ae942485ca7f6424861badd0a17717a88"></a>## [◆ ](#ae942485ca7f6424861badd0a17717a88)GaussianFWHMAngle

 str 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="ad6ea73208d1290bbc84771f72c8498fa" name="ad6ea73208d1290bbc84771f72c8498fa"></a>## [◆ ](#ad6ea73208d1290bbc84771f72c8498fa)GaussianFWHMAngleX

 str 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="a26d44695dc3a431cd107819bfb868362" name="a26d44695dc3a431cd107819bfb868362"></a>## [◆ ](#a26d44695dc3a431cd107819bfb868362)GaussianFWHMAngleY

 str 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="adbd5552b771bee21f7509ddc489a4e0b" name="adbd5552b771bee21f7509ddc489a4e0b"></a>## [◆ ](#adbd5552b771bee21f7509ddc489a4e0b)GreenSpectrumFilePath

 str 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="a123e0960e42f334da9b12d11d373ded4" name="a123e0960e42f334da9b12d11d373ded4"></a>## [◆ ](#a123e0960e42f334da9b12d11d373ded4)ImageFilePath

 str 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="a97fbd54feb5d7cc3a0114d309da25eb8" name="a97fbd54feb5d7cc3a0114d309da25eb8"></a>## [◆ ](#a97fbd54feb5d7cc3a0114d309da25eb8)InfiniteContrast

 str 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="a5fb8a391fc503ad7b654dd18251dd622" name="a5fb8a391fc503ad7b654dd18251dd622"></a>## [◆ ](#a5fb8a391fc503ad7b654dd18251dd622)IntensityFilePath

 str 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="afaead7b0002acb1a44c356673d626e33" name="afaead7b0002acb1a44c356673d626e33"></a>## [◆ ](#afaead7b0002acb1a44c356673d626e33)IntensityType

 str 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="a5c9bee4a046db76be718cb37c7874f89" name="a5c9bee4a046db76be718cb37c7874f89"></a>## [◆ ](#a5c9bee4a046db76be718cb37c7874f89)LambertianMaximumAngle

 str 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="ae0eaed72c741a4ee1dcf2fe53257db93" name="ae0eaed72c741a4ee1dcf2fe53257db93"></a>## [◆ ](#ae0eaed72c741a4ee1dcf2fe53257db93)Luminance

 str 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="aaa149f4084199f582574fb95a19750ec" name="aaa149f4084199f582574fb95a19750ec"></a>## [◆ ](#aaa149f4084199f582574fb95a19750ec)NumberOfRays

 str 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="a24786b401f788b91236f7c5238005822" name="a24786b401f788b91236f7c5238005822"></a>## [◆ ](#a24786b401f788b91236f7c5238005822)RayLength

 str 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="a2f7cfab93559124a4765aa804c289e27" name="a2f7cfab93559124a4765aa804c289e27"></a>## [◆ ](#a2f7cfab93559124a4765aa804c289e27)RedSpectrumFilePath

 str 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="ae48d523804e948eb7ae37b49a913bb6f" name="ae48d523804e948eb7ae37b49a913bb6f"></a>## [◆ ](#ae48d523804e948eb7ae37b49a913bb6f)ShowImage

 str 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="a71ae77d862335a54710f601e220d1d77" name="a71ae77d862335a54710f601e220d1d77"></a>## [◆ ](#a71ae77d862335a54710f601e220d1d77)ShowIntensityDistribution

 str 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="a40dd8956fa2b807fc1ffc7805e7639c3" name="a40dd8956fa2b807fc1ffc7805e7639c3"></a>## [◆ ](#a40dd8956fa2b807fc1ffc7805e7639c3)WhitePointType

 str 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 - C. Uses an average daylight illuminant.  
 1 - D50. Uses a natural, horizon light.  
 2 - D65. Uses a standard daylight illuminant that provides accurate color perception and evaluation.  
 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="aa3f27fb02d4752eb583a4b0773122e8f" name="aa3f27fb02d4752eb583a4b0773122e8f"></a>## [◆ ](#aa3f27fb02d4752eb583a4b0773122e8f)WhitePointX

 str 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="a27fa0aa58391796b4f86ffbe2e9a4a64" name="a27fa0aa58391796b4f86ffbe2e9a4a64"></a>## [◆ ](#a27fa0aa58391796b4f86ffbe2e9a4a64)WhitePointY

 str 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="a6f2c95537ef8210d7f1a99643aeeff4f" name="a6f2c95537ef8210d7f1a99643aeeff4f"></a>## [◆ ](#a6f2c95537ef8210d7f1a99643aeeff4f)XDirection

 str 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="a42df9e8270fbe6b5a4944cb1e94b9885" name="a42df9e8270fbe6b5a4944cb1e94b9885"></a>## [◆ ](#a42df9e8270fbe6b5a4944cb1e94b9885)XDirectionReversed

 str 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="a26309a89380b2756527ec19cffef2b6c" name="a26309a89380b2756527ec19cffef2b6c"></a>## [◆ ](#a26309a89380b2756527ec19cffef2b6c)XEnd

 str 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="ae7c2faf5c62ec2baf03149375fadd672" name="ae7c2faf5c62ec2baf03149375fadd672"></a>## [◆ ](#ae7c2faf5c62ec2baf03149375fadd672)XMirroredExtent

 str 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="abcbac58872bdd9d694ee7177d1ef7973" name="abcbac58872bdd9d694ee7177d1ef7973"></a>## [◆ ](#abcbac58872bdd9d694ee7177d1ef7973)XStart

 str 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="a2a551b3ded090b6d859f82d01db9c453" name="a2a551b3ded090b6d859f82d01db9c453"></a>## [◆ ](#a2a551b3ded090b6d859f82d01db9c453)YDirection

 str 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="aa42b4aa0974c063ccf0211c50ecbb1fb" name="aa42b4aa0974c063ccf0211c50ecbb1fb"></a>## [◆ ](#aa42b4aa0974c063ccf0211c50ecbb1fb)YDirectionReversed

 str 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="a3106ba653a070cd30ef2357bddd2cf60" name="a3106ba653a070cd30ef2357bddd2cf60"></a>## [◆ ](#a3106ba653a070cd30ef2357bddd2cf60)YEnd

 str 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="a1a4644fb780cae70d397e455eac08e13" name="a1a4644fb780cae70d397e455eac08e13"></a>## [◆ ](#a1a4644fb780cae70d397e455eac08e13)YMirroredExtent

 str 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="accbaddec059ec07b1ca7f3a94b4574d2" name="accbaddec059ec07b1ca7f3a94b4574d2"></a>## [◆ ](#accbaddec059ec07b1ca7f3a94b4574d2)YStart

 str 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**