## On this page

  

 

 # SensorIntensityBuilder Class Reference

 Last update: 16.07.2025 

Represents an Intensity Sensor Builder. [More...](#details)

Inheritance diagram for SensorIntensityBuilder:

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



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

str [AdaptiveSampling](#a24a76e05d74278f759e4c0a310f3e97b) = property(fget=\_\_GetAdaptiveSampling, fset=\_\_SetAdaptiveSampling) Gets or sets the property to enable adaptive sampling.   
 str [CellDiameter](#a54568300b967caf42f3ff41ceda48c6e) = property(fget=\_\_GetCellDiameter, fset=\_\_SetCellDiameter) Gets or sets the cell diameter.   
 str [CellDistance](#a89261bcae91ef4d99878985e6fecd12b) = property(fget=\_\_GetCellDistance, fset=\_\_SetCellDistance) Gets or sets the cell distance.   
 str [ConoscopicResolution](#abedf381f29e2c1484a54512e0b4a9ce6) = property(fget=\_\_GetConoscopicResolution, fset=\_\_SetConoscopicResolution) Gets or sets the Conoscopic resolution.   
 str [ConoscopicSampling](#aa0179072787bd47dc53512ac9c22120f) = property(fget=\_\_GetConoscopicSampling, fset=\_\_SetConoscopicSampling) Gets or sets the Conoscopic sampling.   
 str [ConoscopicThetaMax](#af4244f96e7755ee9944d6c39bb61d083) = property(fget=\_\_GetConoscopicThetaMax, fset=\_\_SetConoscopicThetaMax) Gets or sets the Conoscopic theta maximum value.   
 str [Format](#a507e4732e8ad3e01f3cc155a9367e9bc) = property(fget=\_\_GetFormat, fset=\_\_SetFormat) Gets or sets the format type.   
 str [IntegrationAngle](#aafed16fbbcc425503a9e4068b1eb0b20) = property(fget=\_\_GetIntegrationAngle, fset=\_\_SetIntegrationAngle) Gets or sets the integration angle.   
 str [IntensityResultViewingDirection](#a373a1795f293e08e56ea2f8903e68d0b) = property(fget=\_\_GetIntensityResultViewingDirection, fset=\_\_SetIntensityResultViewingDirection) Gets or sets the intensity result viewing direction.   
 str [NearField](#a2f0dd448a30c680618472417c64ad302) = property(fget=\_\_GetNearField, fset=\_\_SetNearField) Gets or sets the property to enable near-field.   
 str [Orientation](#a6eb41f84a29e82c187c30a960d2956fa) = property(fget=\_\_GetOrientation, fset=\_\_SetOrientation) Gets or sets the orientation type.   
 str [PolarFilePath](#aa95d88f5d3dfade46c40d91fef6ed794) = property(fget=\_\_GetPolarFilePath, fset=\_\_SetPolarFilePath) Gets or sets the polar file path.   
 str [PolarXEnd](#a5e789d47e7dd759f8ef9884ce919df44) = property(fget=\_\_GetPolarXEnd) Gets the polar X end.   
 str [PolarXResolution](#a8b42212c83980de16ea61226c3b624e2) = property(fget=\_\_GetPolarXResolution, fset=\_\_SetPolarXResolution) Gets or sets the polar X resolution.   
 str [PolarXSampling](#a39b1f083cafda5560739433ae7eaa34b) = property(fget=\_\_GetPolarXSampling, fset=\_\_SetPolarXSampling) Gets or sets the polar X sampling.   
 str [PolarXStart](#a5444fde831d7d3d50037288c6f47236b) = property(fget=\_\_GetPolarXStart) Gets the polar X start.   
 str [PolarYEnd](#a2da949b67beebfcad4c6d72c935a8d22) = property(fget=\_\_GetPolarYEnd) Gets the polar Y end.   
 str [PolarYResolution](#a90bad860ef0914b50323677e88265b55) = property(fget=\_\_GetPolarYResolution, fset=\_\_SetPolarYResolution) Gets or sets the polar Y resolution.   
 str [PolarYSampling](#a47ea5d4b1591acea1cbe3509601fc8a1) = property(fget=\_\_GetPolarYSampling, fset=\_\_SetPolarYSampling) Gets or sets the polar Y sampling.   
 str [PolarYStart](#a322477a20fa9227fee2e182ff26f095c) = property(fget=\_\_GetPolarYStart) Gets the polar Y start.   
 str [Radius](#a448737e54715a305e8086a0a7d3aac7c) = property(fget=\_\_GetRadius, fset=\_\_SetRadius) Gets or sets the radius.   
 ![-](/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.   
 ## <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 [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') ## <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 [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.   
 <a id="details" name="details"></a>## Detailed Description

Represents an Intensity Sensor Builder.

The Intensity Sensor Builder is used to create and edit Intensity Sensor features.

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



## Member Data Documentation

<a id="a24a76e05d74278f759e4c0a310f3e97b" name="a24a76e05d74278f759e4c0a310f3e97b"></a>## [◆ ](#a24a76e05d74278f759e4c0a310f3e97b)AdaptiveSampling

 str AdaptiveSampling = property(fget=\_\_GetAdaptiveSampling, fset=\_\_SetAdaptiveSampling)  static 

Gets or sets the property to enable adaptive sampling.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

True: Activates adaptive Sampling.  
 False: Deactivates adaptive Sampling.

**Value type**: Boolean.

The default value is False.





<a id="a54568300b967caf42f3ff41ceda48c6e" name="a54568300b967caf42f3ff41ceda48c6e"></a>## [◆ ](#a54568300b967caf42f3ff41ceda48c6e)CellDiameter

 str CellDiameter = property(fget=\_\_GetCellDiameter, fset=\_\_SetCellDiameter)  static 

Gets or sets the cell diameter.

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

**Value type**: Double.  
**Range**The value must be superior to 0.0.

The default value is 174.9773 mm.





<a id="a89261bcae91ef4d99878985e6fecd12b" name="a89261bcae91ef4d99878985e6fecd12b"></a>## [◆ ](#a89261bcae91ef4d99878985e6fecd12b)CellDistance

 str CellDistance = property(fget=\_\_GetCellDistance, fset=\_\_SetCellDistance)  static 

Gets or sets the cell distance.

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

**Value type**: Double.

The default value is 1000.0 mm.





<a id="abedf381f29e2c1484a54512e0b4a9ce6" name="abedf381f29e2c1484a54512e0b4a9ce6"></a>## [◆ ](#abedf381f29e2c1484a54512e0b4a9ce6)ConoscopicResolution

 str ConoscopicResolution = property(fget=\_\_GetConoscopicResolution, fset=\_\_SetConoscopicResolution)  static 

Gets or sets the Conoscopic resolution.

**Prerequisite**: The OrientationType property must be 2.

**Value type**: Double.





<a id="aa0179072787bd47dc53512ac9c22120f" name="aa0179072787bd47dc53512ac9c22120f"></a>## [◆ ](#aa0179072787bd47dc53512ac9c22120f)ConoscopicSampling

 str ConoscopicSampling = property(fget=\_\_GetConoscopicSampling, fset=\_\_SetConoscopicSampling)  static 

Gets or sets the Conoscopic sampling.

**Prerequisite**: The OrientationType property must be 2.

**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value is 90.





<a id="af4244f96e7755ee9944d6c39bb61d083" name="af4244f96e7755ee9944d6c39bb61d083"></a>## [◆ ](#af4244f96e7755ee9944d6c39bb61d083)ConoscopicThetaMax

 str ConoscopicThetaMax = property(fget=\_\_GetConoscopicThetaMax, fset=\_\_SetConoscopicThetaMax)  static 

Gets or sets the Conoscopic theta maximum value.

**Prerequisite**: The OrientationType property must be 2.

**Value type**: Double.

The default value is 90.0.





<a id="a507e4732e8ad3e01f3cc155a9367e9bc" name="a507e4732e8ad3e01f3cc155a9367e9bc"></a>## [◆ ](#a507e4732e8ad3e01f3cc155a9367e9bc)Format

 str Format = property(fget=\_\_GetFormat, fset=\_\_SetFormat)  static 

Gets or sets the format type.

These formats correspond to light distribution standards and will generate different file formats as an output.

The values are:  
 0 - XMP  
 1 - IESNA Type A.  
 2 - IESNA Type B.  
 3 - IESNA Type C.  
 4 - Eulumdat.

**Value type**: Integer.

The default value is 0.





<a id="aafed16fbbcc425503a9e4068b1eb0b20" name="aafed16fbbcc425503a9e4068b1eb0b20"></a>## [◆ ](#aafed16fbbcc425503a9e4068b1eb0b20)IntegrationAngle

 str IntegrationAngle = property(fget=\_\_GetIntegrationAngle, fset=\_\_SetIntegrationAngle)  static 

Gets or sets the integration angle.

**Prerequisite**: The OrientationType property must be 1, 2, 3 or 4.

This parameter appears only for IESNA and Eulumdat formats.

**Value type**: Double (in degrees).  
**Range**: (0.0, 90.0)

The default value is 5.0 degrees.





<a id="a373a1795f293e08e56ea2f8903e68d0b" name="a373a1795f293e08e56ea2f8903e68d0b"></a>## [◆ ](#a373a1795f293e08e56ea2f8903e68d0b)IntensityResultViewingDirection

 str IntensityResultViewingDirection = property(fget=\_\_GetIntensityResultViewingDirection, fset=\_\_SetIntensityResultViewingDirection)  static 

Gets or sets the intensity result viewing direction.

**Prerequisite**: The OrientationType property must be 0 or 1.

The values are:  
 0 - From source looking at sensor, The viewing direction of the observer is the same as the light direction emitted.  
 1 - From sensor looking at source, The viewing direction of the observer is in the opposite of the light direction.

**Value type**: Integer.

The default value is 0.





<a id="a2f0dd448a30c680618472417c64ad302" name="a2f0dd448a30c680618472417c64ad302"></a>## [◆ ](#a2f0dd448a30c680618472417c64ad302)NearField

 str NearField = property(fget=\_\_GetNearField, fset=\_\_SetNearField)  static 

Gets or sets the property to enable near-field.

True: Enables Near Field.  
 False: Disables Near Field.

**Value type**: Boolean.





<a id="a6eb41f84a29e82c187c30a960d2956fa" name="a6eb41f84a29e82c187c30a960d2956fa"></a>## [◆ ](#a6eb41f84a29e82c187c30a960d2956fa)Orientation

 str Orientation = property(fget=\_\_GetOrientation, fset=\_\_SetOrientation)  static 

Gets or sets the orientation type.

**Prerequisite**: The FormatType property must be 0.

The values are:  
 0 - X as Parallel, Y as Meridian, for a polar parameterization with the poles along the X axis.  
 1 - X as Meridian, Y as Parallel, for a polar parameterization with the poles along the Y axis.  
 2 - Conoscopic, for a polar parameterization with the poles along the Z axis.

**Value type**: Integer.

The default value is 0.





<a id="aa95d88f5d3dfade46c40d91fef6ed794" name="aa95d88f5d3dfade46c40d91fef6ed794"></a>## [◆ ](#aa95d88f5d3dfade46c40d91fef6ed794)PolarFilePath

 str PolarFilePath = property(fget=\_\_GetPolarFilePath, fset=\_\_SetPolarFilePath)  static 

Gets or sets the polar file path.

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

**Value type**: String.

The default value is an empty string.





<a id="a5e789d47e7dd759f8ef9884ce919df44" name="a5e789d47e7dd759f8ef9884ce919df44"></a>## [◆ ](#a5e789d47e7dd759f8ef9884ce919df44)PolarXEnd

 str PolarXEnd = property(fget=\_\_GetPolarXEnd)  static 

Gets the polar X end.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a8b42212c83980de16ea61226c3b624e2" name="a8b42212c83980de16ea61226c3b624e2"></a>## [◆ ](#a8b42212c83980de16ea61226c3b624e2)PolarXResolution

 str PolarXResolution = property(fget=\_\_GetPolarXResolution, fset=\_\_SetPolarXResolution)  static 

Gets or sets the polar X resolution.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a39b1f083cafda5560739433ae7eaa34b" name="a39b1f083cafda5560739433ae7eaa34b"></a>## [◆ ](#a39b1f083cafda5560739433ae7eaa34b)PolarXSampling

 str PolarXSampling = property(fget=\_\_GetPolarXSampling, fset=\_\_SetPolarXSampling)  static 

Gets or sets the polar X sampling.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value are:   
 37 for IESNA Type A and IESNA Type B.  
 36 for IESNA Type C and Eulumdat.





<a id="a5444fde831d7d3d50037288c6f47236b" name="a5444fde831d7d3d50037288c6f47236b"></a>## [◆ ](#a5444fde831d7d3d50037288c6f47236b)PolarXStart

 str PolarXStart = property(fget=\_\_GetPolarXStart)  static 

Gets the polar X start.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a2da949b67beebfcad4c6d72c935a8d22" name="a2da949b67beebfcad4c6d72c935a8d22"></a>## [◆ ](#a2da949b67beebfcad4c6d72c935a8d22)PolarYEnd

 str PolarYEnd = property(fget=\_\_GetPolarYEnd)  static 

Gets the polar Y end.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a90bad860ef0914b50323677e88265b55" name="a90bad860ef0914b50323677e88265b55"></a>## [◆ ](#a90bad860ef0914b50323677e88265b55)PolarYResolution

 str PolarYResolution = property(fget=\_\_GetPolarYResolution, fset=\_\_SetPolarYResolution)  static 

Gets or sets the polar Y resolution.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a47ea5d4b1591acea1cbe3509601fc8a1" name="a47ea5d4b1591acea1cbe3509601fc8a1"></a>## [◆ ](#a47ea5d4b1591acea1cbe3509601fc8a1)PolarYSampling

 str PolarYSampling = property(fget=\_\_GetPolarYSampling, fset=\_\_SetPolarYSampling)  static 

Gets or sets the polar Y sampling.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value are:   
 37 for IESNA Type A and IESNA Type B.  
 19 for IESNA Type C and Eulumdat.





<a id="a322477a20fa9227fee2e182ff26f095c" name="a322477a20fa9227fee2e182ff26f095c"></a>## [◆ ](#a322477a20fa9227fee2e182ff26f095c)PolarYStart

 str PolarYStart = property(fget=\_\_GetPolarYStart)  static 

Gets the polar Y start.

**Prerequisite**: The FormatType property must be 1, 2, 3 or 4.

**Value type**: Double.





<a id="a448737e54715a305e8086a0a7d3aac7c" name="a448737e54715a305e8086a0a7d3aac7c"></a>## [◆ ](#a448737e54715a305e8086a0a7d3aac7c)Radius

 str Radius = property(fget=\_\_GetRadius, fset=\_\_SetRadius)  static 

Gets or sets the radius.

**Value type**: Double (in mm).  
**Range**: The parameter must be superior to 0.0.

The default value is 1000.0 mm.





---

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