## On this page

  

 

 # Sensor3DIrradianceBuilder Class Reference

 Last update: 17.07.2025 

Represents the builder for a 3D irradiance sensor. [More...](#details)

Inheritance diagram for Sensor3DIrradianceBuilder:

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



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

 [Absorption](#ad5a628f3737ef7b2581ca8092c138849) = property(fget = \_\_GetAbsorption, fset = \_\_SetAbsorption) Gets or sets the absorption property.   
  [IntegrationType](#acfa28acdaa41352ffd89be690a20933d) = property(fget = \_\_GetIntegrationType, fset = \_\_SetIntegrationType) Gets or set the integration type.   
  [Layer](#a9a8118be7780e95363d631cbca7e7800) = property(fget = \_\_GetLayer, fset = \_\_SetLayer) Gets or sets the layer mode.   
  [MeasureType](#ac90683a25bccda054181046382b3c6bf) = property(fget = \_\_GetMeasureType, fset = \_\_SetMeasureType) Gets or sets the measure type.   
  [RayFileFormat](#a35e6f0c1b96490c0a04782ee3726a39a) = property(fget = \_\_GetRayFileFormat, fset = \_\_SetRayFileFormat) Gets or sets the ray file format.   
  [Reflection](#a3703d6573392d7883981d3f831eadae4) = property(fget = \_\_GetReflection, fset = \_\_SetReflection) Gets or sets the reflection property.   
  [Selections](#ac61a72cbb212f32719cff7cde2bad50c) = property(fget = \_\_GetSelections, fset = \_\_SetSelections) Gets or sets the selected faces or bodies.   
  [TemplateFilePath](#a829318693665dfa6aa63290394cea703) = property(fget = \_\_GetTemplateFilePath, fset = \_\_SetTemplateFilePath) Gets or sets the XM3 template file.   
  [Transmission](#afdeb73437bc5c016079b2d9188f33977) = property(fget = \_\_GetTransmission, fset = \_\_SetTransmission) Gets or sets the transmission property.   
  [UseRayFile](#a48acd8152ec600fb5843d9ff718d9040) = property(fget = \_\_GetUseRayFile, fset = \_\_SetUseRayFile) Gets or sets the property to enable or disable use of ray file.   
  [UseTemplateFile](#aed80ae56dc61e75287ff3691ecd3460d) = property(fget = \_\_GetUseTemplateFile, fset = \_\_SetUseTemplateFile) Gets or sets the property to enable or disable use of XM3 template file.   
  [WavelengthEnd](#a46bde9dee090ea55c3b34fdfeedd8c4c) = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd) Gets or sets the higher value of the wavelength range to be considered by the sensor.   
  [WavelengthResolution](#ae7d4742766f2a2e3468a5a9422e7920c) = property(fget = \_\_GetWavelengthResolution) Gets 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 lower value of the wavelength range to be considered by the sensor.   
 ![-](/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 3D irradiance sensor.

The 3D irradiance sensor builder is used to create and edit 3D irradiance sensor features.

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



## Property Documentation

<a id="ad5a628f3737ef7b2581ca8092c138849" name="ad5a628f3737ef7b2581ca8092c138849"></a>## [◆ ](#ad5a628f3737ef7b2581ca8092c138849)Absorption

 Absorption = property(fget = \_\_GetAbsorption, fset = \_\_SetAbsorption)  static 

Gets or sets the absorption property.

**Prerequisite**: The property MeasureType must be 0 or 2, and IntegrationType must be 0.

**Value type**: Boolean.

The default value is True.





<a id="acfa28acdaa41352ffd89be690a20933d" name="acfa28acdaa41352ffd89be690a20933d"></a>## [◆ ](#acfa28acdaa41352ffd89be690a20933d)IntegrationType

 IntegrationType = property(fget = \_\_GetIntegrationType, fset = \_\_SetIntegrationType)  static 

Gets or set the integration type.

The values are:  
 0 - Planar. Integration that is made orthogonally with the sensor plan.  
 1 - Radial. Follows specific street lighting illumination regulations.

**Value type**: Integer.

The default value is 0.





<a id="a9a8118be7780e95363d631cbca7e7800" name="a9a8118be7780e95363d631cbca7e7800"></a>## [◆ ](#a9a8118be7780e95363d631cbca7e7800)Layer

 Layer = property(fget = \_\_GetLayer, fset = \_\_SetLayer)  static 

Gets or sets the layer mode.

The values are:  
 0 - None.  
 1 - Source.

**Value type**: Integer.

The default value is 0.





<a id="ac90683a25bccda054181046382b3c6bf" name="ac90683a25bccda054181046382b3c6bf"></a>## [◆ ](#ac90683a25bccda054181046382b3c6bf)MeasureType

 MeasureType = property(fget = \_\_GetMeasureType, fset = \_\_SetMeasureType)  static 

Gets or sets the measure type.

The values are:  
 0 - Photometric to compute the luminous intensity and generate an extended map for Virtual 3D Photometric Lab.  
 1 - Colorimetric to compute the radiant intensity and generate an extended map for Virtual 3D Photometric Lab.  
 2 - Radiometric to compute the color results without any spectral layer separation and generate a spectral map for Virtual 3D Photometric Lab.

**Value type**: Integer.

The default value is 0.





<a id="a35e6f0c1b96490c0a04782ee3726a39a" name="a35e6f0c1b96490c0a04782ee3726a39a"></a>## [◆ ](#a35e6f0c1b96490c0a04782ee3726a39a)RayFileFormat

 RayFileFormat = property(fget = \_\_GetRayFileFormat, fset = \_\_SetRayFileFormat)  static 

Gets or sets the ray file format.

**Prerequisite**: The UseRayFile property must be True.

Defines the type of ray file. The simulation creates the ray file.

The values are:  
 0 - Speos without Polarization.  
 1 - Speos with Polarization.  
 2 - IES TM-25 without Polarization.  
 3 - IES TM-25 with Polarization.

**Value type**: Integer.

The default value is 0.





<a id="a3703d6573392d7883981d3f831eadae4" name="a3703d6573392d7883981d3f831eadae4"></a>## [◆ ](#a3703d6573392d7883981d3f831eadae4)Reflection

 Reflection = property(fget = \_\_GetReflection, fset = \_\_SetReflection)  static 

Gets or sets the reflection property.

**Prerequisite**: The property MeasureType must be 0 or 2, and IntegrationType must be 0.

**Value type**: Boolean.

The default value is True.





<a id="ac61a72cbb212f32719cff7cde2bad50c" name="ac61a72cbb212f32719cff7cde2bad50c"></a>## [◆ ](#ac61a72cbb212f32719cff7cde2bad50c)Selections

 Selections = property(fget = \_\_GetSelections, fset = \_\_SetSelections)  static 

Gets or sets the selected faces or bodies.

The Selections property takes and returns a list of feature tags.

**Value type**: List of integer.

The default value is an empty list.





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

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

Gets or sets the XM3 template file.

**Prerequisite**: The property TemplateFile must be True.

**Value type**: String.

The default value is an empty string.





<a id="afdeb73437bc5c016079b2d9188f33977" name="afdeb73437bc5c016079b2d9188f33977"></a>## [◆ ](#afdeb73437bc5c016079b2d9188f33977)Transmission

 Transmission = property(fget = \_\_GetTransmission, fset = \_\_SetTransmission)  static 

Gets or sets the transmission property.

**Prerequisite**: The property MeasureType must be 0 or 2, and IntegrationType must be 0.

**Value type**: Boolean.

The default value is True.





<a id="a48acd8152ec600fb5843d9ff718d9040" name="a48acd8152ec600fb5843d9ff718d9040"></a>## [◆ ](#a48acd8152ec600fb5843d9ff718d9040)UseRayFile

 UseRayFile = property(fget = \_\_GetUseRayFile, fset = \_\_SetUseRayFile)  static 

Gets or sets the property to enable or disable use of ray file.

True: Uses ray file.  
 False: Does not use ray file.

**Value type**: Boolean.

The default value is False.





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

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

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

True: Uses XM3 template file.  
 False: Does not use XM3 template file.

**Value type**: Boolean.

The default value is False.





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

 WavelengthEnd = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd)  static 

Gets or sets the higher value of the wavelength range to be considered by the sensor.

**Prerequisite**: The property MeasureType must be 1.

The sensor does not take into 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)  static 

Gets the Wavelength resolution.

**Prerequisite**: The property MeasureType must be 1.

**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 property MeasureType must be 1.

**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 lower value of the wavelength range to be considered by the sensor.

**Prerequisite**: The property MeasureType must be 1.

The sensor does not take into account wavelengths beyond the borders that you define.

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

The default value is 400.0 nm.





---

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