## On this page # SensorIrradianceBuilder Class Reference Last update: 16.07.2025 Represents an Irradiance Sensor Builder. [More...](#details) Inheritance diagram for SensorIrradianceBuilder: ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_sensor_irradiance_builder.png) ## Static Public Attributes str [IntegrationDirection](#a2baf67702c8a0a845d9688f16cc0e051) = property(fget=\_\_GetIntegrationDirection, fset=\_\_SetIntegrationDirection) Gets or sets the integration direction. str [IntegrationDirectionReversed](#a198ba000d02876c14a7570fb089b7b7a) = property(fget=\_\_GetIntegrationDirectionReversed, fset=\_\_SetIntegrationDirectionReversed) Gets or sets the reverse direction of integration. str [IntegrationType](#a020a182b42752cf5fa53178e74c9e8ea) = property(fget=\_\_GetIntegrationType, fset=\_\_SetIntegrationType) Gets or sets the integration type. str [OutputFaces](#adffb85f85692aad8cd8d3871c7c2cdf7) = property(fget=\_\_GetOutputFaces, fset=\_\_SetOutputFaces) Gets or sets the output faces. str [RayFileFormat](#aa5f160e1b955029d035ea10586086d73) = property(fget=\_\_GetRayFileFormat, fset=\_\_SetRayFileFormat) Gets or sets the ray file format. str [UseRayFile](#a0991311e71d02a2fc520db098afd2e4d) = property(fget=\_\_GetUseRayFile, fset=\_\_SetUseRayFile) Gets or sets the property to enable ray file. ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [SensorCommonBuilder](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml)str [AxisSystem](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the Axis System of the Sensor. str [DimensionFromFile](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a0133c03caa27c4a2c2eec6f56ac87d45) = property(fget=\_\_GetDimensionFromFile, fset=\_\_SetDimensionFromFile) Gets or sets the property to enable the use of dimensions that come from File. str [DisplayPropertiesFromFile](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#aa9f06ab58588bea04699f00b412161c6) = property(fget=\_\_GetDisplayPropertiesFromFile, fset=\_\_SetDisplayPropertiesFromFile) Gets or sets the property to enable the use of display properties that come from File. str [GridOriginX](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a3e462caa50357a9788b8735930dc8af0) = property(fget=\_\_GetGridOriginX, fset=\_\_SetGridOriginX) Gets or sets the grid X origin. str [GridOriginY](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a7c3aa08faef640884a10d6766ce36efe) = property(fget=\_\_GetGridOriginY, fset=\_\_SetGridOriginY) Gets or sets the grid Y origin. str [GridStepX](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a03d8d2fd56c4163a396dc0fd8a90f963) = property(fget=\_\_GetGridStepX, fset=\_\_SetGridStepX) Gets or sets the grid X step. str [GridStepY](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a2528f56fb7db94f6d20bbed9d51bde14) = property(fget=\_\_GetGridStepY, fset=\_\_SetGridStepY) Gets or sets the grid Y step. str [SensorFilter](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a187957a21db7d300e5dec39e3762d6fa) = property(fget=\_\_GetSensorFilter) Gets the sensor filter. str [ShowGrid](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a7472c93e10d87ea740d116838e5f5f50) = property(fget=\_\_GetShowGrid, fset=\_\_SetShowGrid) Gets or sets the property to enable grid preview. str [TemplateFilePath](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a2fead9d4fee3c7c05710d79edf5d4bf5) = property(fget=\_\_GetTemplateFilePath, fset=\_\_SetTemplateFilePath) Gets or sets the template file's path. str [TemplateType](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a7d7e05d22f3cf6511873f0e5d5150dbc) = property(fget=\_\_GetTemplateType) Gets or sets the template type. str [Type](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a71656f4f93df1e4a4f6dfe758863b287) = property(fget=\_\_GetType, fset=\_\_SetType) Gets or sets the type of the sensor. str [UseTemplateFile](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a529d5c46dc317113823a9225751d711a) = property(fget=\_\_GetUseTemplateFile, fset=\_\_SetUseTemplateFile) Gets or sets the property to enable the use of template file. str [WavelengthEnd](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a1d3af865fff16f6eb31305404623a867) = property(fget=\_\_GetWavelengthEnd, fset=\_\_SetWavelengthEnd) Gets or sets the wavelength ending border. str [WavelengthResolution](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a4d829d8a46f0614c7c32b78ae1602fd9) = property(fget=\_\_GetWavelengthResolution, fset=\_\_SetWavelengthResolution) Gets or sets the Wavelength resolution. str [WavelengthSampling](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a1a2c2043920b4b7bb6308cb22e73ec13) = property(fget=\_\_GetWavelengthSampling, fset=\_\_SetWavelengthSampling) Gets or sets the wavelength sampling. str [WavelengthStart](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a93c3bc11064cbd8e5885016a97877d3e) = property(fget=\_\_GetWavelengthStart, fset=\_\_SetWavelengthStart) Gets or sets the wavelength starting border. str [XEnd](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a26309a89380b2756527ec19cffef2b6c) = property(fget=\_\_GetXEnd, fset=\_\_SetXEnd) Gets or sets the Sensor X end dimension value. str [XMirroredExtent](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#ae7c2faf5c62ec2baf03149375fadd672) = property(fget=\_\_GetXMirroredExtent, fset=\_\_SetXMirroredExtent) Gets the Sensor X dimension mirrored extent value. str [XResolution](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#af339e4c5181343e4c3e38d92c9c05c47) = property(fget=\_\_GetXResolution, fset=\_\_SetXResolution) Gets or sets the Sensor X dimension resolution value. str [XSampling](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a9694a3d43cce188431740d9b8c364ac2) = property(fget=\_\_GetXSampling, fset=\_\_SetXSampling) Gets or sets the Sensor X dimension sampling value. str [XStart](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#abcbac58872bdd9d694ee7177d1ef7973) = property(fget=\_\_GetXStart, fset=\_\_SetXStart) Gets or sets the Sensor X start dimension value. str [YEnd](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a3106ba653a070cd30ef2357bddd2cf60) = property(fget=\_\_GetYEnd, fset=\_\_SetYEnd) Gets or sets the Sensor Y end dimension value. str [YMirroredExtent](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a1a4644fb780cae70d397e455eac08e13) = property(fget=\_\_GetYMirroredExtent, fset=\_\_SetYMirroredExtent) Gets the Sensor Y dimension mirrored extent value. str [YResolution](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a213abc811c0466065f36593a1520259b) = property(fget=\_\_GetYResolution, fset=\_\_SetYResolution) Gets or sets the Sensor Y dimension resolution value. str [YSampling](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a223ff92346c9c64903238723f549419b) = property(fget=\_\_GetYSampling, fset=\_\_SetYSampling) Gets or sets the Sensor Y dimension sampling value. str [YStart](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#accbaddec059ec07b1ca7f3a94b4574d2) = property(fget=\_\_GetYStart, fset=\_\_SetYStart) Gets or sets the Sensor Y start dimension value. ![-](/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. ## Properties **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 [SensorCommonBuilder](class_speos_n_x__2412_1_1_sensor_common_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 [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') ## Additional Inherited Members ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [SensorCommonBuilder](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml) 'bool' [IsTemplateFileValid](class_speos_n_x__2412_1_1_sensor_common_builder.xhtml#a9903334ee3f31502bf70eb52e9f9dadb) (self) Checks whether the template file is valid. ![-](/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. ## 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 ## Member Data Documentation ## [◆ ](#a2baf67702c8a0a845d9688f16cc0e051)IntegrationDirection str 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. ## [◆ ](#a198ba000d02876c14a7570fb089b7b7a)IntegrationDirectionReversed str IntegrationDirectionReversed = property(fget=\_\_GetIntegrationDirectionReversed, fset=\_\_SetIntegrationDirectionReversed) static Gets or sets 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. ## [◆ ](#a020a182b42752cf5fa53178e74c9e8ea)IntegrationType str IntegrationType = property(fget=\_\_GetIntegrationType, fset=\_\_SetIntegrationType) static Gets or sets 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. ## [◆ ](#adffb85f85692aad8cd8d3871c7c2cdf7)OutputFaces str 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. ## [◆ ](#aa5f160e1b955029d035ea10586086d73)RayFileFormat str 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. ## [◆ ](#a0991311e71d02a2fc520db098afd2e4d)UseRayFile str 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\_2412.py**