SensorCommonBuilder Class Reference
Last update: 17.07.2025A base class for all Sensor Builders. More...
Public Member Functions | |
| IsTemplateFileValid (self) | |
| Checks whether the template file is valid. | |
 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. | |
Properties | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the Axis System of the Sensor. | |
| DimensionFromFile = property(fget = __GetDimensionFromFile, fset = __SetDimensionFromFile) | |
| Gets or sets the property to enable the use of dimensions that come from File. | |
| DisplayPropertiesFromFile = property(fget = __GetDisplayPropertiesFromFile, fset = __SetDisplayPropertiesFromFile) | |
| Gets or sets the property to enable the use of display properties that come from File. | |
| GridOriginX = property(fget = __GetGridOriginX, fset = __SetGridOriginX) | |
| Gets or sets the grid X origin. | |
| GridOriginY = property(fget = __GetGridOriginY, fset = __SetGridOriginY) | |
| Gets or sets the grid Y origin. | |
| GridStepX = property(fget = __GetGridStepX, fset = __SetGridStepX) | |
| Gets or sets the grid X step. | |
| GridStepY = property(fget = __GetGridStepY, fset = __SetGridStepY) | |
| Gets or sets the grid Y step. | |
| SensorFilter = property(fget = __GetSensorFilter) | |
| Gets the sensor filter. | |
| ShowGrid = property(fget = __GetShowGrid, fset = __SetShowGrid) | |
| Gets or sets the property to enable grid preview. | |
| TemplateFilePath = property(fget = __GetTemplateFilePath, fset = __SetTemplateFilePath) | |
| Gets or sets the template file's path. | |
| TemplateType = property(fget = __GetTemplateType) | |
| Gets or sets the template type. | |
| Type = property(fget = __GetType, fset = __SetType) | |
| Gets or sets the type of the sensor. | |
| UseTemplateFile = property(fget = __GetUseTemplateFile, fset = __SetUseTemplateFile) | |
| Gets or sets the property to enable the use of template file. | |
| WavelengthEnd = property(fget = __GetWavelengthEnd, fset = __SetWavelengthEnd) | |
| Gets or sets the wavelength ending border. | |
| WavelengthResolution = property(fget = __GetWavelengthResolution, fset = __SetWavelengthResolution) | |
| Gets or sets the Wavelength resolution. | |
| WavelengthSampling = property(fget = __GetWavelengthSampling, fset = __SetWavelengthSampling) | |
| Gets or sets the wavelength sampling. | |
| WavelengthStart = property(fget = __GetWavelengthStart, fset = __SetWavelengthStart) | |
| Gets or sets the wavelength starting border. | |
| XEnd = property(fget = __GetXEnd, fset = __SetXEnd) | |
| Gets or sets the Sensor X end dimension value. | |
| XMirroredExtent = property(fget = __GetXMirroredExtent, fset = __SetXMirroredExtent) | |
| Gets the Sensor X dimension mirrored extent value. | |
| XResolution = property(fget = __GetXResolution, fset = __SetXResolution) | |
| Gets or sets the Sensor X dimension resolution value. | |
| XSampling = property(fget = __GetXSampling, fset = __SetXSampling) | |
| Gets or sets the Sensor X dimension sampling value. | |
| XStart = property(fget = __GetXStart, fset = __SetXStart) | |
| Gets or sets the Sensor X start dimension value. | |
| YEnd = property(fget = __GetYEnd, fset = __SetYEnd) | |
| Gets or sets the Sensor Y end dimension value. | |
| YMirroredExtent = property(fget = __GetYMirroredExtent, fset = __SetYMirroredExtent) | |
| Gets the Sensor Y dimension mirrored extent value. | |
| YResolution = property(fget = __GetYResolution, fset = __SetYResolution) | |
| Gets or sets the Sensor Y dimension resolution value. | |
| YSampling = property(fget = __GetYSampling, fset = __SetYSampling) | |
| Gets or sets the Sensor Y dimension sampling 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. | |
Detailed Description
A base class for all Sensor Builders.
A Builder is an object that is used to create and edit Features.
This is an abstract class that provides the basic functionality common to all builders. See the Builder subclasses for details of application-specific builders.
This is an abstract class, and cannot be instantiated.
Member Function Documentation
◆ IsTemplateFileValid()
| IsTemplateFileValid | ( | self | ) |
Checks whether the template file is valid.
- Returns
- True: The template file is valid.
False: The template file is not valid.
Property Documentation
◆ AxisSystem
|
static |
Gets the Axis System of the Sensor.
Value type: AxisSystem object.
◆ DimensionFromFile
|
static |
Gets or sets the property to enable the use of dimensions that come from File.
True: Uses the following values from the XMP template: type, X and Y size, Wavelength values.
False: Does not use the dimension from file.
Value type: Boolean.
The default value is False.
◆ DisplayPropertiesFromFile
|
static |
Gets or sets the property to enable the use of display properties that come from File.
True: Uses all the grid related values from the .xml file.
False: Does not use the Display properties from file.
Value type: Boolean.
The default value is False.
◆ GridOriginX
|
static |
Gets or sets the grid X origin.
Value type: Double.
The default value is 0.0.
◆ GridOriginY
|
static |
Gets or sets the grid Y origin.
Value type: Double.
The default value is 0.0.
◆ GridStepX
|
static |
Gets or sets the grid X step.
Value type: Double.
Range: The value must be superior to 0.
The default value is 10.0.
◆ GridStepY
|
static |
Gets or sets the grid Y step.
Value type: Double.
Range: The value must be superior to 0.
The default value is 10.0.
◆ SensorFilter
|
static |
Gets the sensor filter.
Value type: SensorFilter object.
◆ ShowGrid
|
static |
Gets or sets the property to enable grid preview.
True: Displays a grid on the sensor.
False: Does not display a grid on the sensor.
Value type: Boolean.
The default value is True.
◆ TemplateFilePath
|
static |
Gets or sets the template file's path.
Value type: String.
The default value is an empty string.
◆ TemplateType
|
static |
Gets or sets the template type.
The values are:
0 - None
1 - Measure
2 - Template
Value type: Integer.
The default value is 0.
◆ Type
|
static |
Gets or sets the type of the sensor.
The values are:
0 - Photometric, results in cd.
1 - Colorimetric, color results in cd or W/sr.
2 - Radiometric, results in W/sr.
3 - Spectral, results in cd or W/sr.
Value type: Integer.
The default value is 0.
◆ UseTemplateFile
|
static |
Gets or sets the property to enable the use of template file.
True: Enables Template File.
False: Disables Template File.
Value type: Boolean.
◆ WavelengthEnd
|
static |
Gets or sets the wavelength ending border.
Prerequisite: The Type property must be 1 or 3.
The sensor does not take account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 700.0 nm.
◆ WavelengthResolution
|
static |
Gets or sets the Wavelength resolution.
Prerequisite: The Type property must be 1 or 3.
Value type: Double.
◆ WavelengthSampling
|
static |
Gets or sets the wavelength sampling.
Prerequisite: The Type property must be 1 or 3.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 13.
◆ WavelengthStart
|
static |
Gets or sets the wavelength starting border.
Prerequisite: The Type property must be 1 or 3.
The sensor does not take account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 400.0 nm.
◆ 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 the Sensor X dimension mirrored extent 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.
◆ XResolution
|
static |
Gets or sets the Sensor X dimension resolution value.
Value type: Double.
◆ XSampling
|
static |
Gets or sets the Sensor X dimension sampling value.
Value type: Integer.
The default value is 100.
◆ XStart
|
static |
Gets or sets the Sensor X start dimension value.
Value type: Double (in mm).
The default value is -50.0 mm.
◆ YEnd
|
static |
Gets or sets the Sensor Y end dimension value.
Value type: Double (in mm).
The default value is 50.0 mm.
◆ YMirroredExtent
|
static |
Gets the Sensor Y dimension mirrored extent 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.
◆ YResolution
|
static |
Gets or sets the Sensor Y dimension resolution value.
Value type: Double.
◆ YSampling
|
static |
Gets or sets the Sensor Y dimension sampling value.
Value type: Integer.
The default value is 100.
◆ 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
