SensorIntensityBuilder Class Reference
Last update: 17.07.2025Represents an Intensity Sensor Builder. More...
Properties | |
| AdaptiveSampling = property(fget = __GetAdaptiveSampling, fset = __SetAdaptiveSampling) | |
| Gets or sets the property to enable adaptive sampling. | |
| CellDiameter = property(fget = __GetCellDiameter, fset = __SetCellDiameter) | |
| Gets or sets the cell diameter. | |
| CellDistance = property(fget = __GetCellDistance, fset = __SetCellDistance) | |
| Gets or sets the cell distance. | |
| ConoscopicResolution = property(fget = __GetConoscopicResolution, fset = __SetConoscopicResolution) | |
| Gets or sets the Conoscopic resolution. | |
| ConoscopicSampling = property(fget = __GetConoscopicSampling, fset = __SetConoscopicSampling) | |
| Gets or sets the Conoscopic sampling. | |
| ConoscopicThetaMax = property(fget = __GetConoscopicThetaMax, fset = __SetConoscopicThetaMax) | |
| Gets or sets the Conoscopic theta maximum value. | |
| Format = property(fget = __GetFormat, fset = __SetFormat) | |
| Gets or sets the format type. | |
| IntegrationAngle = property(fget = __GetIntegrationAngle, fset = __SetIntegrationAngle) | |
| Gets or sets the integration angle. | |
| IntensityResultViewingDirection = property(fget = __GetIntensityResultViewingDirection, fset = __SetIntensityResultViewingDirection) | |
| Gets or sets the intensity result viewing direction. | |
| NearField = property(fget = __GetNearField, fset = __SetNearField) | |
| Gets or sets the property to enable near-field. | |
| Orientation = property(fget = __GetOrientation, fset = __SetOrientation) | |
| Gets or sets the orientation type. | |
| PolarFilePath = property(fget = __GetPolarFilePath, fset = __SetPolarFilePath) | |
| Gets or sets the polar file path. | |
| PolarXEnd = property(fget = __GetPolarXEnd) | |
| Gets the polar X end. | |
| PolarXResolution = property(fget = __GetPolarXResolution, fset = __SetPolarXResolution) | |
| Gets or sets the polar X resolution. | |
| PolarXSampling = property(fget = __GetPolarXSampling, fset = __SetPolarXSampling) | |
| Gets or sets the polar X sampling. | |
| PolarXStart = property(fget = __GetPolarXStart) | |
| Gets the polar X start. | |
| PolarYEnd = property(fget = __GetPolarYEnd) | |
| Gets the polar Y end. | |
| PolarYResolution = property(fget = __GetPolarYResolution, fset = __SetPolarYResolution) | |
| Gets or sets the polar Y resolution. | |
| PolarYSampling = property(fget = __GetPolarYSampling, fset = __SetPolarYSampling) | |
| Gets or sets the polar Y sampling. | |
| PolarYStart = property(fget = __GetPolarYStart) | |
| Gets the polar Y start. | |
| Radius = property(fget = __GetRadius, fset = __SetRadius) | |
| Gets or sets the radius. | |
 Properties inherited from SensorCommonBuilder | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the Axis System of the Sensor. | |
| DimensionFromFile = property(fget = __GetDimensionFromFile, fset = __SetDimensionFromFile) | |
| Gets or sets the property to enable the use of dimensions that come from File. | |
| DisplayPropertiesFromFile = property(fget = __GetDisplayPropertiesFromFile, fset = __SetDisplayPropertiesFromFile) | |
| Gets or sets the property to enable the use of display properties that come from File. | |
| GridOriginX = property(fget = __GetGridOriginX, fset = __SetGridOriginX) | |
| Gets or sets the grid X origin. | |
| GridOriginY = property(fget = __GetGridOriginY, fset = __SetGridOriginY) | |
| Gets or sets the grid Y origin. | |
| GridStepX = property(fget = __GetGridStepX, fset = __SetGridStepX) | |
| Gets or sets the grid X step. | |
| GridStepY = property(fget = __GetGridStepY, fset = __SetGridStepY) | |
| Gets or sets the grid Y step. | |
| SensorFilter = property(fget = __GetSensorFilter) | |
| Gets the sensor filter. | |
| ShowGrid = property(fget = __GetShowGrid, fset = __SetShowGrid) | |
| Gets or sets the property to enable grid preview. | |
| TemplateFilePath = property(fget = __GetTemplateFilePath, fset = __SetTemplateFilePath) | |
| Gets or sets the template file's path. | |
| TemplateType = property(fget = __GetTemplateType) | |
| Gets or sets the template type. | |
| Type = property(fget = __GetType, fset = __SetType) | |
| Gets or sets the type of the sensor. | |
| UseTemplateFile = property(fget = __GetUseTemplateFile, fset = __SetUseTemplateFile) | |
| Gets or sets the property to enable the use of template file. | |
| WavelengthEnd = property(fget = __GetWavelengthEnd, fset = __SetWavelengthEnd) | |
| Gets or sets the wavelength ending border. | |
| WavelengthResolution = property(fget = __GetWavelengthResolution, fset = __SetWavelengthResolution) | |
| Gets or sets the Wavelength resolution. | |
| WavelengthSampling = property(fget = __GetWavelengthSampling, fset = __SetWavelengthSampling) | |
| Gets or sets the wavelength sampling. | |
| WavelengthStart = property(fget = __GetWavelengthStart, fset = __SetWavelengthStart) | |
| Gets or sets the wavelength starting border. | |
| XEnd = property(fget = __GetXEnd, fset = __SetXEnd) | |
| Gets or sets the Sensor X end dimension value. | |
| XMirroredExtent = property(fget = __GetXMirroredExtent, fset = __SetXMirroredExtent) | |
| Gets the Sensor X dimension mirrored extent value. | |
| XResolution = property(fget = __GetXResolution, fset = __SetXResolution) | |
| Gets or sets the Sensor X dimension resolution value. | |
| XSampling = property(fget = __GetXSampling, fset = __SetXSampling) | |
| Gets or sets the Sensor X dimension sampling value. | |
| XStart = property(fget = __GetXStart, fset = __SetXStart) | |
| Gets or sets the Sensor X start dimension value. | |
| YEnd = property(fget = __GetYEnd, fset = __SetYEnd) | |
| Gets or sets the Sensor Y end dimension value. | |
| YMirroredExtent = property(fget = __GetYMirroredExtent, fset = __SetYMirroredExtent) | |
| Gets the Sensor Y dimension mirrored extent value. | |
| YResolution = property(fget = __GetYResolution, fset = __SetYResolution) | |
| Gets or sets the Sensor Y dimension resolution value. | |
| YSampling = property(fget = __GetYSampling, fset = __SetYSampling) | |
| Gets or sets the Sensor Y dimension sampling value. | |
| YStart = property(fget = __GetYStart, fset = __SetYStart) | |
| Gets or sets the Sensor Y start dimension value. | |
| Properties inherited from FeatureBuilder | |
| Feature = property(fget = __GetFeature) | |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| FullName = property(fget = __GetFullName) | |
| Gets the full name of the feature being edited. | |
| Name = property(fget = __GetName, fset = __SetName) | |
| Gets or sets the name of the feature being edited. | |
| NameWithContext = property(fget = __GetNameWithContext) | |
| Gets the name with context of the feature being edited. | |
| Status = property(fget = __GetStatus) | |
| Returns the status of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from SensorCommonBuilder | |
| IsTemplateFileValid (self) | |
| Checks whether the template file is valid. | |
| Public Member Functions inherited from FeatureBuilder | |
| Commit (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 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 FeatureCollection::CreateSensorIntensityBuilder
Property Documentation
◆ AdaptiveSampling
|
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.
◆ CellDiameter
|
static |
Gets or sets the cell diameter.
Prerequisite: The EnableNearField property must be True.
Value type: Double.
RangeThe value must be superior to 0.0.
The default value is 174.9773 mm.
◆ CellDistance
|
static |
Gets or sets the cell distance.
Prerequisite: The EnableNearField property must be True.
Value type: Double.
The default value is 1000.0 mm.
◆ ConoscopicResolution
|
static |
Gets or sets the Conoscopic resolution.
Prerequisite: The OrientationType property must be 2.
Value type: Double.
◆ ConoscopicSampling
|
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.
◆ ConoscopicThetaMax
|
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.
◆ Format
|
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.
◆ IntegrationAngle
|
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.
◆ IntensityResultViewingDirection
|
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.
◆ NearField
|
static |
Gets or sets the property to enable near-field.
True: Enables Near Field.
False: Disables Near Field.
Value type: Boolean.
◆ Orientation
|
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.
◆ PolarFilePath
|
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.
◆ PolarXEnd
|
static |
Gets the polar X end.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ PolarXResolution
|
static |
Gets or sets the polar X resolution.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ PolarXSampling
|
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.
◆ PolarXStart
|
static |
Gets the polar X start.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ PolarYEnd
|
static |
Gets the polar Y end.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ PolarYResolution
|
static |
Gets or sets the polar Y resolution.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ PolarYSampling
|
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.
◆ PolarYStart
|
static |
Gets the polar Y start.
Prerequisite: The FormatType property must be 1, 2, 3 or 4.
Value type: Double.
◆ Radius
|
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.py
