SourceDisplayBuilder Class Reference
Last update: 17.07.2025Represents the builder for a display source. More...
Properties | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the axis system. | |
| BlueSpectrumFilePath = property(fget = __GetBlueSpectrumFilePath, fset = __SetBlueSpectrumFilePath) | |
| Gets or sets the blue spectrum file. | |
| ColorSpace = property(fget = __GetColorSpace, fset = __SetColorSpace) | |
| Gets or sets the color space model type. | |
| Contrast = property(fget = __GetContrast, fset = __SetContrast) | |
| Gets or sets the contrast ratio. | |
| CosN = property(fget = __GetCosN, fset = __SetCosN) | |
| Gets or sets the N value for Cos distribution. | |
| GaussianFWHMAngle = property(fget = __GetGaussianFWHMAngle, fset = __SetGaussianFWHMAngle) | |
| Gets or sets the FWHM angle value for Symmetric Gaussian distribution. | |
| GaussianFWHMAngleX = property(fget = __GetGaussianFWHMAngleX, fset = __SetGaussianFWHMAngleX) | |
| Gets or sets the FWHM X angle value for Asymmetric Gaussian distribution. | |
| GaussianFWHMAngleY = property(fget = __GetGaussianFWHMAngleY, fset = __SetGaussianFWHMAngleY) | |
| Gets or sets the FWHM Y angle value for Asymmetric Gaussian distribution. | |
| GreenSpectrumFilePath = property(fget = __GetGreenSpectrumFilePath, fset = __SetGreenSpectrumFilePath) | |
| Gets or sets the green spectrum file. | |
| ImageFilePath = property(fget = __GetImageFilePath, fset = __SetImageFilePath) | |
| Gets or sets the image file. | |
| InfiniteContrast = property(fget = __GetInfiniteContrast, fset = __SetInfiniteContrast) | |
| Gets or sets the property to enable infinite contrast ratio. | |
| IntensityFilePath = property(fget = __GetIntensityFilePath, fset = __SetIntensityFilePath) | |
| Gets or sets the intensity file for Library distribution. | |
| IntensityType = property(fget = __GetIntensityType, fset = __SetIntensityType) | |
| Gets or sets the intensity diagram. | |
| LambertianMaximumAngle = property(fget = __GetLambertianMaximumAngle, fset = __SetLambertianMaximumAngle) | |
| Gets or sets the theta value for Lambertian distribution. | |
| Luminance = property(fget = __GetLuminance, fset = __SetLuminance) | |
| Gets or sets the luminance. | |
| NumberOfRays = property(fget = __GetNumberOfRays, fset = __SetNumberOfRays) | |
| Gets or sets the number of rays. | |
| RayLength = property(fget = __GetRayLength, fset = __SetRayLength) | |
| Gets or sets the ray length. | |
| RedSpectrumFilePath = property(fget = __GetRedSpectrumFilePath, fset = __SetRedSpectrumFilePath) | |
| Gets or sets the red spectrum file. | |
| ShowImage = property(fget = __GetShowImage, fset = __SetShowImage) | |
| Gets or sets the property to show the image. | |
| ShowIntensityDistribution = property(fget = __GetShowIntensityDistribution, fset = __SetShowIntensityDistribution) | |
| Gets or sets the property to show the intensity distribution in the 3D view. | |
| WhitePointType = property(fget = __GetWhitePointType, fset = __SetWhitePointType) | |
| Gets or sets the white point type of the standard illuminant. | |
| WhitePointX = property(fget = __GetWhitePointX, fset = __SetWhitePointX) | |
| Gets or sets the X coordinate of the white point. | |
| WhitePointY = property(fget = __GetWhitePointY, fset = __SetWhitePointY) | |
| Gets or sets the Y coordinate of the white point. | |
| XDirection = property(fget = __GetXDirection, fset = __SetXDirection) | |
| Gets or sets the X direction. | |
| XDirectionReversed = property(fget = __GetXDirectionReversed, fset = __SetXDirectionReversed) | |
| Gets or sets the property to reverse the X direction. | |
| XEnd = property(fget = __GetXEnd, fset = __SetXEnd) | |
| Gets or sets the sensor X end dimension value. | |
| XMirroredExtent = property(fget = __GetXMirroredExtent, fset = __SetXMirroredExtent) | |
| Gets or sets the sensor X dimension mirrored value. | |
| XStart = property(fget = __GetXStart, fset = __SetXStart) | |
| Gets or sets the sensor X start dimension value. | |
| YDirection = property(fget = __GetYDirection, fset = __SetYDirection) | |
| Gets or sets the Y direction. | |
| YDirectionReversed = property(fget = __GetYDirectionReversed, fset = __SetYDirectionReversed) | |
| Gets or sets the property to reverse the Y direction. | |
| YEnd = property(fget = __GetYEnd, fset = __SetYEnd) | |
| Gets or sets the sensor Y start dimension value. | |
| YMirroredExtent = property(fget = __GetYMirroredExtent, fset = __SetYMirroredExtent) | |
| Gets or sets the sensor Y dimension mirrored value. | |
| YStart = property(fget = __GetYStart, fset = __SetYStart) | |
| Gets or sets the sensor Y start dimension value. | |
 Properties inherited from FeatureBuilder | |
| Feature = property(fget = __GetFeature) | |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| FullName = property(fget = __GetFullName) | |
| Gets the full name of the feature being edited. | |
| Name = property(fget = __GetName, fset = __SetName) | |
| Gets or sets the name of the feature being edited. | |
| NameWithContext = property(fget = __GetNameWithContext) | |
| Gets the name with context of the feature being edited. | |
| Status = property(fget = __GetStatus) | |
| Returns the status of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| Commit (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. | |
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 FeatureCollection::CreateSourceDisplayBuilder
Property Documentation
◆ AxisSystem
|
static |
Gets the axis system.
Value type: AxisSystem object.
◆ BlueSpectrumFilePath
|
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.
◆ ColorSpace
|
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.
◆ Contrast
|
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.
◆ CosN
|
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.
◆ GaussianFWHMAngle
|
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.
◆ GaussianFWHMAngleX
|
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.
◆ GaussianFWHMAngleY
|
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.
◆ GreenSpectrumFilePath
|
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.
◆ ImageFilePath
|
static |
Gets or sets the image file.
Selects a .jpg or a .png file.
Value type: String.
The default value is an empty string.
◆ InfiniteContrast
|
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.
◆ IntensityFilePath
|
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.
◆ IntensityType
|
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.
◆ LambertianMaximumAngle
|
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.
◆ Luminance
|
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.
◆ NumberOfRays
|
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.
◆ RayLength
|
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.
◆ RedSpectrumFilePath
|
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.
◆ ShowImage
|
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.
◆ ShowIntensityDistribution
|
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.
◆ WhitePointType
|
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.
◆ WhitePointX
|
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.
◆ WhitePointY
|
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.
◆ XDirection
|
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.
◆ XDirectionReversed
|
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.
◆ XEnd
|
static |
Gets or sets the sensor X end dimension value.
Value type: Double (in mm).
The default value is 50.0 mm.
◆ XMirroredExtent
|
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.
◆ XStart
|
static |
Gets or sets the sensor X start dimension value.
Value type: Double (in mm).
The default value is -50.0 mm.
◆ YDirection
|
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.
◆ YDirectionReversed
|
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.
◆ YEnd
|
static |
Gets or sets the sensor Y start dimension value.
Value type: Double (in mm).
The default value is 50.0 mm.
◆ YMirroredExtent
|
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.
◆ YStart
|
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
