## On this page # SensorIrradianceBuilder Class Reference Last update: 17.07.2025 Represents an Irradiance Sensor Builder. [More...](#details) Inheritance diagram for SensorIrradianceBuilder: ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_sensor_irradiance_builder.png) ## Properties [IntegrationDirection](#a32f84a55f51f63e299c102606eeef29a) = property(fget = \_\_GetIntegrationDirection, fset = \_\_SetIntegrationDirection) Gets or sets the integration direction. [IntegrationDirectionReversed](#a797698b1814ca64be12b8e45a9a3e8e8) = property(fget = \_\_GetIntegrationDirectionReversed, fset = \_\_SetIntegrationDirectionReversed) Gets or set the reverse direction of integration. [IntegrationType](#acfa28acdaa41352ffd89be690a20933d) = property(fget = \_\_GetIntegrationType, fset = \_\_SetIntegrationType) Gets or set the integration type. [OutputFaces](#adafd66969c7b1fc5378ba1973965f8d3) = property(fget = \_\_GetOutputFaces, fset = \_\_SetOutputFaces) Gets or sets the output faces. [RayFileFormat](#a35e6f0c1b96490c0a04782ee3726a39a) = property(fget = \_\_GetRayFileFormat, fset = \_\_SetRayFileFormat) Gets or sets the ray file format. [UseRayFile](#a48acd8152ec600fb5843d9ff718d9040) = property(fget = \_\_GetUseRayFile, fset = \_\_SetUseRayFile) Gets or sets the property to enable ray file. ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [SensorCommonBuilder](class_speos_n_x_1_1_sensor_common_builder.xhtml) [AxisSystem](class_speos_n_x_1_1_sensor_common_builder.xhtml#a4c4b8fa4fecce1d2737f605f77e7320a) = property(fget = \_\_GetAxisSystem) Gets the Axis System of the Sensor. [DimensionFromFile](class_speos_n_x_1_1_sensor_common_builder.xhtml#a200f2a3daa2b2e8c9dba7873c8113575) = property(fget = \_\_GetDimensionFromFile, fset = \_\_SetDimensionFromFile) Gets or sets the property to enable the use of dimensions that come from File. [DisplayPropertiesFromFile](class_speos_n_x_1_1_sensor_common_builder.xhtml#a25c27255cdce9925fc0388178c130b7e) = property(fget = \_\_GetDisplayPropertiesFromFile, fset = \_\_SetDisplayPropertiesFromFile) Gets or sets the property to enable the use of display properties that come from File. [GridOriginX](class_speos_n_x_1_1_sensor_common_builder.xhtml#a5c64608c9fc8d2352e5deb9c2b74b3a4) = property(fget = \_\_GetGridOriginX, fset = \_\_SetGridOriginX) Gets or sets the grid X origin. [GridOriginY](class_speos_n_x_1_1_sensor_common_builder.xhtml#aea68e71b420f605044061b8570cb2ca5) = property(fget = \_\_GetGridOriginY, fset = \_\_SetGridOriginY) Gets or sets the grid Y origin. [GridStepX](class_speos_n_x_1_1_sensor_common_builder.xhtml#ada9eb3eb967aa429dc2e928c8b2db09a) = property(fget = \_\_GetGridStepX, fset = \_\_SetGridStepX) Gets or sets the grid X step. [GridStepY](class_speos_n_x_1_1_sensor_common_builder.xhtml#a1ad5c904b94df862b400a77756ffc7b0) = property(fget = \_\_GetGridStepY, fset = \_\_SetGridStepY) Gets or sets the grid Y step. [SensorFilter](class_speos_n_x_1_1_sensor_common_builder.xhtml#acbb4440b4c2ca6ed44ed6a3bab96d968) = property(fget = \_\_GetSensorFilter) Gets the sensor filter. [ShowGrid](class_speos_n_x_1_1_sensor_common_builder.xhtml#a5878def1d46a8ca655fbe382ad940c68) = property(fget = \_\_GetShowGrid, fset = \_\_SetShowGrid) Gets or sets the property to enable grid preview. [TemplateFilePath](class_speos_n_x_1_1_sensor_common_builder.xhtml#a829318693665dfa6aa63290394cea703) = property(fget = \_\_GetTemplateFilePath, fset = \_\_SetTemplateFilePath) Gets or sets the template file's path. [TemplateType](class_speos_n_x_1_1_sensor_common_builder.xhtml#ae080d6e5f74a3b1767c6a7b89b47530d) = property(fget = \_\_GetTemplateType) Gets or sets the template type. [Type](class_speos_n_x_1_1_sensor_common_builder.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) = property(fget = \_\_GetType, fset = \_\_SetType) Gets or sets the type of the sensor. [UseTemplateFile](class_speos_n_x_1_1_sensor_common_builder.xhtml#aed80ae56dc61e75287ff3691ecd3460d) = property(fget = \_\_GetUseTemplateFile, fset = \_\_SetUseTemplateFile) Gets or sets the property to enable the use of template file. [WavelengthEnd](class_speos_n_x_1_1_sensor_common_builder.xhtml#a46bde9dee090ea55c3b34fdfeedd8c4c) = property(fget = \_\_GetWavelengthEnd, fset = \_\_SetWavelengthEnd) Gets or sets the wavelength ending border. [WavelengthResolution](class_speos_n_x_1_1_sensor_common_builder.xhtml#ae7d4742766f2a2e3468a5a9422e7920c) = property(fget = \_\_GetWavelengthResolution, fset = \_\_SetWavelengthResolution) Gets or sets the Wavelength resolution. [WavelengthSampling](class_speos_n_x_1_1_sensor_common_builder.xhtml#ac0504254907d817707b6771948e9affe) = property(fget = \_\_GetWavelengthSampling, fset = \_\_SetWavelengthSampling) Gets or sets the wavelength sampling. [WavelengthStart](class_speos_n_x_1_1_sensor_common_builder.xhtml#a437eeee4ad26212fa85c30cfbf5b09c8) = property(fget = \_\_GetWavelengthStart, fset = \_\_SetWavelengthStart) Gets or sets the wavelength starting border. [XEnd](class_speos_n_x_1_1_sensor_common_builder.xhtml#a799203cf9eff20a5ef568bbc1b9d1a47) = property(fget = \_\_GetXEnd, fset = \_\_SetXEnd) Gets or sets the Sensor X end dimension value. [XMirroredExtent](class_speos_n_x_1_1_sensor_common_builder.xhtml#a78fc5a48a0a4a6282855a28240b3f94a) = property(fget = \_\_GetXMirroredExtent, fset = \_\_SetXMirroredExtent) Gets the Sensor X dimension mirrored extent value. [XResolution](class_speos_n_x_1_1_sensor_common_builder.xhtml#a96287c228b691e8c81135fbb396e7478) = property(fget = \_\_GetXResolution, fset = \_\_SetXResolution) Gets or sets the Sensor X dimension resolution value. [XSampling](class_speos_n_x_1_1_sensor_common_builder.xhtml#a540f4cef446490f932858988d28b9b8b) = property(fget = \_\_GetXSampling, fset = \_\_SetXSampling) Gets or sets the Sensor X dimension sampling value. [XStart](class_speos_n_x_1_1_sensor_common_builder.xhtml#a7963a0ff7bd1a05f42907b2e4a8912fb) = property(fget = \_\_GetXStart, fset = \_\_SetXStart) Gets or sets the Sensor X start dimension value. [YEnd](class_speos_n_x_1_1_sensor_common_builder.xhtml#a9695e3ae4ea46b87955435354389d31e) = property(fget = \_\_GetYEnd, fset = \_\_SetYEnd) Gets or sets the Sensor Y end dimension value. [YMirroredExtent](class_speos_n_x_1_1_sensor_common_builder.xhtml#aa912900c157c45f922fdb9ebdf4ae54d) = property(fget = \_\_GetYMirroredExtent, fset = \_\_SetYMirroredExtent) Gets the Sensor Y dimension mirrored extent value. [YResolution](class_speos_n_x_1_1_sensor_common_builder.xhtml#a3a4e7b1dd022a48e387495568b68fb6c) = property(fget = \_\_GetYResolution, fset = \_\_SetYResolution) Gets or sets the Sensor Y dimension resolution value. [YSampling](class_speos_n_x_1_1_sensor_common_builder.xhtml#a27b575c86195f02c2d904e8563e498b3) = property(fget = \_\_GetYSampling, fset = \_\_SetYSampling) Gets or sets the Sensor Y dimension sampling value. [YStart](class_speos_n_x_1_1_sensor_common_builder.xhtml#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. ## Additional Inherited Members ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [SensorCommonBuilder](class_speos_n_x_1_1_sensor_common_builder.xhtml) [IsTemplateFileValid](class_speos_n_x_1_1_sensor_common_builder.xhtml#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. ## Detailed Description Represents an Irradiance Sensor Builder. The Irradiance Sensor Builder is used to create and edit Irradiance Sensor features. To create a new instance of this class, use FeatureCollection::CreateSensorIrradianceBuilder ## Property Documentation ## [◆ ](#a32f84a55f51f63e299c102606eeef29a)IntegrationDirection IntegrationDirection = property(fget = \_\_GetIntegrationDirection, fset = \_\_SetIntegrationDirection) static Gets or sets the integration direction. **Prerequisite**: The IntegrationType property must be 0, 2 or 4. The integration direction property takes a feature tag and returns a feature tag. **Value type**: Integer. The default value is 0. ## [◆ ](#a797698b1814ca64be12b8e45a9a3e8e8)IntegrationDirectionReversed IntegrationDirectionReversed = property(fget = \_\_GetIntegrationDirectionReversed, fset = \_\_SetIntegrationDirectionReversed) static Gets or set the reverse direction of integration. **Prerequisite**: The IntegrationType property must be 0, 2 or 4. True: Reverses the IntegrationDirection property False: Does not reverse the IntegrationDirection property **Value type**: Boolean. The default value is False. ## [◆ ](#acfa28acdaa41352ffd89be690a20933d)IntegrationType IntegrationType = property(fget = \_\_GetIntegrationType, fset = \_\_SetIntegrationType) static Gets or set the integration type. The values are: 0 - Planar. 1 - Radial. 2 - Hemishperical. 3 - Cylindrical. 4 - Semi-cylindrical. **Value type**: Integer. The default value is 0. ## [◆ ](#adafd66969c7b1fc5378ba1973965f8d3)OutputFaces OutputFaces = property(fget = \_\_GetOutputFaces, fset = \_\_SetOutputFaces) static Gets or sets the output faces. The output faces property takes a list of feature tag and returns a list of feature tag. **Value type**: List of integer. The default value is an empty list. ## [◆ ](#a35e6f0c1b96490c0a04782ee3726a39a)RayFileFormat RayFileFormat = property(fget = \_\_GetRayFileFormat, fset = \_\_SetRayFileFormat) static Gets or sets the ray file format. **Prerequisite**: The EnableRayFile property must be True. Defines the type of 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. ## [◆ ](#a48acd8152ec600fb5843d9ff718d9040)UseRayFile UseRayFile = property(fget = \_\_GetUseRayFile, fset = \_\_SetUseRayFile) static Gets or sets the property to enable ray file. True: Enables Ray file. False: Disables Ray file. **Value type**: Boolean. The default value is False. --- The documentation for this class was generated from the following file:- **SpeosNX.py**