## On this page

  

 

 # Sensor3DIrradianceBuilder Class Reference

 Last update: 16.07.2025 

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

Inheritance diagram for Sensor3DIrradianceBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_sensor3_d_irradiance_builder.png)



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

str [Absorption](#af0e4e0694d2a0c411735486a7f2d685a) = property(fget=\_\_GetAbsorption, fset=\_\_SetAbsorption) Gets or sets the absorption property.   
 str [IntegrationType](#a020a182b42752cf5fa53178e74c9e8ea) = property(fget=\_\_GetIntegrationType, fset=\_\_SetIntegrationType) Gets or sets the integration type.   
 str [Layer](#a80837300dfb3751c003ebb2bce3946ef) = property(fget=\_\_GetLayer, fset=\_\_SetLayer) Gets or sets the layer mode.   
 str [MeasureType](#a4385576fed0eba497baab4727ed800b7) = property(fget=\_\_GetMeasureType, fset=\_\_SetMeasureType) Gets or sets the measure type.   
 str [RayFileFormat](#aa5f160e1b955029d035ea10586086d73) = property(fget=\_\_GetRayFileFormat, fset=\_\_SetRayFileFormat) Gets or sets the ray file format.   
 str [Reflection](#aa6f3fb980b7361d963dcf967edc440d9) = property(fget=\_\_GetReflection, fset=\_\_SetReflection) Gets or sets the reflection property.   
 str [Selections](#aa9fcfdd328b91fcb1786b76a13109a22) = property(fget=\_\_GetSelections, fset=\_\_SetSelections) Gets or sets the selected faces or bodies.   
 str [TemplateFilePath](#a2fead9d4fee3c7c05710d79edf5d4bf5) = property(fget=\_\_GetTemplateFilePath, fset=\_\_SetTemplateFilePath) Gets or sets the XM3 template file.   
 str [Transmission](#a41c9311d72d50c9d0550862958a4e7ff) = property(fget=\_\_GetTransmission, fset=\_\_SetTransmission) Gets or sets the transmission property.   
 str [UseRayFile](#a0991311e71d02a2fc520db098afd2e4d) = property(fget=\_\_GetUseRayFile, fset=\_\_SetUseRayFile) Gets or sets the property to enable or disable use of ray file.   
 str [UseTemplateFile](#a529d5c46dc317113823a9225751d711a) = property(fget=\_\_GetUseTemplateFile, fset=\_\_SetUseTemplateFile) Gets or sets the property to enable or disable use of XM3 template file.   
 str [WavelengthEnd](#a1d3af865fff16f6eb31305404623a867) = property(fget=\_\_GetWavelengthEnd, fset=\_\_SetWavelengthEnd) Gets or sets the higher value of the wavelength range to be considered by the sensor.   
 str [WavelengthStart](#a93c3bc11064cbd8e5885016a97877d3e) = 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_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_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__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_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__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 <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>



## Member Data Documentation

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

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

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

Gets or sets 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="a80837300dfb3751c003ebb2bce3946ef" name="a80837300dfb3751c003ebb2bce3946ef"></a>## [◆ ](#a80837300dfb3751c003ebb2bce3946ef)Layer

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

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

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

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

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

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

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

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

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

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

 str 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\_2412.py**