## On this page

  

 

 # SensorCommonBuilder Class Reference

 Last update: 17.07.2025 

A base class for all Sensor Builders. [More...](#details)

Inheritance diagram for SensorCommonBuilder:

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



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [IsTemplateFileValid](#a9a725904d2ac3064228522e114d1c878) (self) Checks whether the template file is valid.   
 ![-](/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="properties" name="properties"></a>Properties

 [AxisSystem](#a4c4b8fa4fecce1d2737f605f77e7320a) = property(fget = \_\_GetAxisSystem) Gets the Axis System of the Sensor.   
  [DimensionFromFile](#a200f2a3daa2b2e8c9dba7873c8113575) = property(fget = \_\_GetDimensionFromFile, fset = \_\_SetDimensionFromFile) Gets or sets the property to enable the use of dimensions that come from File.   
  [DisplayPropertiesFromFile](#a25c27255cdce9925fc0388178c130b7e) = property(fget = \_\_GetDisplayPropertiesFromFile, fset = \_\_SetDisplayPropertiesFromFile) Gets or sets the property to enable the use of display properties that come from File.   
  [GridOriginX](#a5c64608c9fc8d2352e5deb9c2b74b3a4) = property(fget = \_\_GetGridOriginX, fset = \_\_SetGridOriginX) Gets or sets the grid X origin.   
  [GridOriginY](#aea68e71b420f605044061b8570cb2ca5) = property(fget = \_\_GetGridOriginY, fset = \_\_SetGridOriginY) Gets or sets the grid Y origin.   
  [GridStepX](#ada9eb3eb967aa429dc2e928c8b2db09a) = property(fget = \_\_GetGridStepX, fset = \_\_SetGridStepX) Gets or sets the grid X step.   
  [GridStepY](#a1ad5c904b94df862b400a77756ffc7b0) = property(fget = \_\_GetGridStepY, fset = \_\_SetGridStepY) Gets or sets the grid Y step.   
  [SensorFilter](#acbb4440b4c2ca6ed44ed6a3bab96d968) = property(fget = \_\_GetSensorFilter) Gets the sensor filter.   
  [ShowGrid](#a5878def1d46a8ca655fbe382ad940c68) = property(fget = \_\_GetShowGrid, fset = \_\_SetShowGrid) Gets or sets the property to enable grid preview.   
  [TemplateFilePath](#a829318693665dfa6aa63290394cea703) = property(fget = \_\_GetTemplateFilePath, fset = \_\_SetTemplateFilePath) Gets or sets the template file's path.   
  [TemplateType](#ae080d6e5f74a3b1767c6a7b89b47530d) = property(fget = \_\_GetTemplateType) Gets or sets the template type.   
  [Type](#a1d1cfd8ffb84e947f82999c682b666a7) = property(fget = \_\_GetType, fset = \_\_SetType) Gets or sets the type of the sensor.   
  [UseTemplateFile](#aed80ae56dc61e75287ff3691ecd3460d) = property(fget = \_\_GetUseTemplateFile, fset = \_\_SetUseTemplateFile) Gets or sets the property to enable the use of template file.   
  [WavelengthEnd](#a46bde9dee090ea55c3b34fdfeedd8c4c) = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd) Gets or sets the wavelength ending border.   
  [WavelengthResolution](#ae7d4742766f2a2e3468a5a9422e7920c) = property(fget = \_\_GetWavelengthResolution, fset = \_\_SetWavelengthResolution) Gets or sets the Wavelength resolution.   
  [WavelengthSampling](#ac0504254907d817707b6771948e9affe) = property(fget = \_\_GetWavelengthSampling, fset = \_\_SetWavelengthSampling) Gets or sets the wavelength sampling.   
  [WavelengthStart](#a437eeee4ad26212fa85c30cfbf5b09c8) = property(fget = \_\_GetWavelengthStart, fset = \_\_SetWavelengthStart) Gets or sets the wavelength starting border.   
  [XEnd](#a799203cf9eff20a5ef568bbc1b9d1a47) = property(fget = \_\_GetXEnd, fset = \_\_SetXEnd) Gets or sets the Sensor X end dimension value.   
  [XMirroredExtent](#a78fc5a48a0a4a6282855a28240b3f94a) = property(fget = \_\_GetXMirroredExtent, fset = \_\_SetXMirroredExtent) Gets the Sensor X dimension mirrored extent value.   
  [XResolution](#a96287c228b691e8c81135fbb396e7478) = property(fget = \_\_GetXResolution, fset = \_\_SetXResolution) Gets or sets the Sensor X dimension resolution value.   
  [XSampling](#a540f4cef446490f932858988d28b9b8b) = property(fget = \_\_GetXSampling, fset = \_\_SetXSampling) Gets or sets the Sensor X dimension sampling value.   
  [XStart](#a7963a0ff7bd1a05f42907b2e4a8912fb) = property(fget = \_\_GetXStart, fset = \_\_SetXStart) Gets or sets the Sensor X start dimension value.   
  [YEnd](#a9695e3ae4ea46b87955435354389d31e) = property(fget = \_\_GetYEnd, fset = \_\_SetYEnd) Gets or sets the Sensor Y end dimension value.   
  [YMirroredExtent](#aa912900c157c45f922fdb9ebdf4ae54d) = property(fget = \_\_GetYMirroredExtent, fset = \_\_SetYMirroredExtent) Gets the Sensor Y dimension mirrored extent value.   
  [YResolution](#a3a4e7b1dd022a48e387495568b68fb6c) = property(fget = \_\_GetYResolution, fset = \_\_SetYResolution) Gets or sets the Sensor Y dimension resolution value.   
  [YSampling](#a27b575c86195f02c2d904e8563e498b3) = property(fget = \_\_GetYSampling, fset = \_\_SetYSampling) Gets or sets the Sensor Y dimension sampling 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="details" name="details"></a>## 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

<a id="a9a725904d2ac3064228522e114d1c878" name="a9a725904d2ac3064228522e114d1c878"></a>## [◆ ](#a9a725904d2ac3064228522e114d1c878)IsTemplateFileValid()

 IsTemplateFileValid  (  *self*) 

Checks whether the template file is valid.

ReturnsTrue: The template file is valid.  
 False: The template file is not valid. 



## 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 of the Sensor.

**Value type**: AxisSystem object.





<a id="a200f2a3daa2b2e8c9dba7873c8113575" name="a200f2a3daa2b2e8c9dba7873c8113575"></a>## [◆ ](#a200f2a3daa2b2e8c9dba7873c8113575)DimensionFromFile

 DimensionFromFile = property(fget = \_\_GetDimensionFromFile, fset = \_\_SetDimensionFromFile)  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.





<a id="a25c27255cdce9925fc0388178c130b7e" name="a25c27255cdce9925fc0388178c130b7e"></a>## [◆ ](#a25c27255cdce9925fc0388178c130b7e)DisplayPropertiesFromFile

 DisplayPropertiesFromFile = property(fget = \_\_GetDisplayPropertiesFromFile, fset = \_\_SetDisplayPropertiesFromFile)  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.





<a id="a5c64608c9fc8d2352e5deb9c2b74b3a4" name="a5c64608c9fc8d2352e5deb9c2b74b3a4"></a>## [◆ ](#a5c64608c9fc8d2352e5deb9c2b74b3a4)GridOriginX

 GridOriginX = property(fget = \_\_GetGridOriginX, fset = \_\_SetGridOriginX)  static 

Gets or sets the grid X origin.

**Value type**: Double.

The default value is 0.0.





<a id="aea68e71b420f605044061b8570cb2ca5" name="aea68e71b420f605044061b8570cb2ca5"></a>## [◆ ](#aea68e71b420f605044061b8570cb2ca5)GridOriginY

 GridOriginY = property(fget = \_\_GetGridOriginY, fset = \_\_SetGridOriginY)  static 

Gets or sets the grid Y origin.

**Value type**: Double.

The default value is 0.0.





<a id="ada9eb3eb967aa429dc2e928c8b2db09a" name="ada9eb3eb967aa429dc2e928c8b2db09a"></a>## [◆ ](#ada9eb3eb967aa429dc2e928c8b2db09a)GridStepX

 GridStepX = property(fget = \_\_GetGridStepX, fset = \_\_SetGridStepX)  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.





<a id="a1ad5c904b94df862b400a77756ffc7b0" name="a1ad5c904b94df862b400a77756ffc7b0"></a>## [◆ ](#a1ad5c904b94df862b400a77756ffc7b0)GridStepY

 GridStepY = property(fget = \_\_GetGridStepY, fset = \_\_SetGridStepY)  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.





<a id="acbb4440b4c2ca6ed44ed6a3bab96d968" name="acbb4440b4c2ca6ed44ed6a3bab96d968"></a>## [◆ ](#acbb4440b4c2ca6ed44ed6a3bab96d968)SensorFilter

 [SensorFilter](class_speos_n_x_1_1_sensor_filter.xhtml) = property(fget = \_\_GetSensorFilter)  static 

Gets the sensor filter.

**Value type**: SensorFilter object.





<a id="a5878def1d46a8ca655fbe382ad940c68" name="a5878def1d46a8ca655fbe382ad940c68"></a>## [◆ ](#a5878def1d46a8ca655fbe382ad940c68)ShowGrid

 ShowGrid = property(fget = \_\_GetShowGrid, fset = \_\_SetShowGrid)  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.





<a id="a829318693665dfa6aa63290394cea703" name="a829318693665dfa6aa63290394cea703"></a>## [◆ ](#a829318693665dfa6aa63290394cea703)TemplateFilePath

 TemplateFilePath = property(fget = \_\_GetTemplateFilePath, fset = \_\_SetTemplateFilePath)  static 

Gets or sets the template file's path.

**Value type**: String.

The default value is an empty string.





<a id="ae080d6e5f74a3b1767c6a7b89b47530d" name="ae080d6e5f74a3b1767c6a7b89b47530d"></a>## [◆ ](#ae080d6e5f74a3b1767c6a7b89b47530d)TemplateType

 TemplateType = property(fget = \_\_GetTemplateType)  static 

Gets or sets the template type.

The values are:  
 0 - None  
 1 - Measure  
 2 - Template

**Value type**: Integer.

The default value is 0.





<a id="a1d1cfd8ffb84e947f82999c682b666a7" name="a1d1cfd8ffb84e947f82999c682b666a7"></a>## [◆ ](#a1d1cfd8ffb84e947f82999c682b666a7)Type

 Type = property(fget = \_\_GetType, fset = \_\_SetType)  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.





<a id="aed80ae56dc61e75287ff3691ecd3460d" name="aed80ae56dc61e75287ff3691ecd3460d"></a>## [◆ ](#aed80ae56dc61e75287ff3691ecd3460d)UseTemplateFile

 UseTemplateFile = property(fget = \_\_GetUseTemplateFile, fset = \_\_SetUseTemplateFile)  static 

Gets or sets the property to enable the use of template file.

True: Enables Template File.   
 False: Disables Template File.

**Value type**: Boolean.





<a id="a46bde9dee090ea55c3b34fdfeedd8c4c" name="a46bde9dee090ea55c3b34fdfeedd8c4c"></a>## [◆ ](#a46bde9dee090ea55c3b34fdfeedd8c4c)WavelengthEnd

 WavelengthEnd = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd)  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.





<a id="ae7d4742766f2a2e3468a5a9422e7920c" name="ae7d4742766f2a2e3468a5a9422e7920c"></a>## [◆ ](#ae7d4742766f2a2e3468a5a9422e7920c)WavelengthResolution

 WavelengthResolution = property(fget = \_\_GetWavelengthResolution, fset = \_\_SetWavelengthResolution)  static 

Gets or sets the Wavelength resolution.

**Prerequisite**: The Type property must be 1 or 3.

**Value type**: Double.





<a id="ac0504254907d817707b6771948e9affe" name="ac0504254907d817707b6771948e9affe"></a>## [◆ ](#ac0504254907d817707b6771948e9affe)WavelengthSampling

 WavelengthSampling = property(fget = \_\_GetWavelengthSampling, fset = \_\_SetWavelengthSampling)  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.





<a id="a437eeee4ad26212fa85c30cfbf5b09c8" name="a437eeee4ad26212fa85c30cfbf5b09c8"></a>## [◆ ](#a437eeee4ad26212fa85c30cfbf5b09c8)WavelengthStart

 WavelengthStart = property(fget = \_\_GetWavelengthStart, fset = \_\_SetWavelengthStart)  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.





<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 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.





<a id="a96287c228b691e8c81135fbb396e7478" name="a96287c228b691e8c81135fbb396e7478"></a>## [◆ ](#a96287c228b691e8c81135fbb396e7478)XResolution

 XResolution = property(fget = \_\_GetXResolution, fset = \_\_SetXResolution)  static 

Gets or sets the Sensor X dimension resolution value.

**Value type**: Double.





<a id="a540f4cef446490f932858988d28b9b8b" name="a540f4cef446490f932858988d28b9b8b"></a>## [◆ ](#a540f4cef446490f932858988d28b9b8b)XSampling

 XSampling = property(fget = \_\_GetXSampling, fset = \_\_SetXSampling)  static 

Gets or sets the Sensor X dimension sampling value.

**Value type**: Integer.

The default value is 100.





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

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

Gets or sets the Sensor Y end 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 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.





<a id="a3a4e7b1dd022a48e387495568b68fb6c" name="a3a4e7b1dd022a48e387495568b68fb6c"></a>## [◆ ](#a3a4e7b1dd022a48e387495568b68fb6c)YResolution

 YResolution = property(fget = \_\_GetYResolution, fset = \_\_SetYResolution)  static 

Gets or sets the Sensor Y dimension resolution value.

**Value type**: Double.





<a id="a27b575c86195f02c2d904e8563e498b3" name="a27b575c86195f02c2d904e8563e498b3"></a>## [◆ ](#a27b575c86195f02c2d904e8563e498b3)YSampling

 YSampling = property(fget = \_\_GetYSampling, fset = \_\_SetYSampling)  static 

Gets or sets the Sensor Y dimension sampling value.

**Value type**: Integer.

The default value is 100.





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