SensorRadianceBuilder Class Reference
Last update: 17.07.2025Represents a Radiance Sensor Builder. More...
Static Public Attributes | |
| str | AutomaticFraming = property(fget=__GetAutomaticFraming, fset=__SetAutomaticFraming) |
| Gets or sets the property to enable automatic framing. | |
| str | CameraName = property(fget=__GetCameraName, fset=__SetCameraName) |
| Gets or set the camera by its name. | |
| str | Definition = property(fget=__GetDefinition, fset=__SetDefinition) |
| Gets or sets the definition type. | |
| str | Focal = property(fget=__GetFocal, fset=__SetFocal) |
| Gets or sets the focal. | |
| str | FrameObserverPoint = property(fget=__GetFrameObserverPoint, fset=__SetFrameObserverPoint) |
| Gets or sets the frame observer point. | |
| str | HVRatio = property(fget=__GetHVRatio, fset=__SetHVRatio) |
| Gets or sets the H/V ratio. | |
| str | IntegrationAngle = property(fget=__GetIntegrationAngle, fset=__SetIntegrationAngle) |
| Gets or sets the integration angle. | |
| str | Observer = property(fget=__GetObserver, fset=__SetObserver) |
| Gets or sets the observer type. | |
| str | ObserverFrontDirection = property(fget=__GetObserverFrontDirection, fset=__SetObserverFrontDirection) |
| Gets or sets the observer front direction. | |
| str | ObserverFrontDirectionReversed = property(fget=__GetObserverFrontDirectionReversed, fset=__SetObserverFrontDirectionReversed) |
| Gets or sets the reverse direction of observer front direction. | |
| str | ObserverHorizontalFOV = property(fget=__GetObserverHorizontalFOV, fset=__SetObserverHorizontalFOV) |
| Gets or sets the observer horizontal field of view. | |
| str | ObserverHorizontalResolution = property(fget=__GetObserverHorizontalResolution) |
| Gets or sets the observer horizontal resolution. | |
| str | ObserverHorizontalSampling = property(fget=__GetObserverHorizontalSampling, fset=__SetObserverHorizontalSampling) |
| Gets or sets the observer horizontal sampling. | |
| str | ObserverPoint = property(fget=__GetObserverPoint, fset=__SetObserverPoint) |
| Gets or sets the observer point. | |
| str | ObserverTopDirection = property(fget=__GetObserverTopDirection, fset=__SetObserverTopDirection) |
| Gets or sets the observer top direction. | |
| str | ObserverTopDirectionReversed = property(fget=__GetObserverTopDirectionReversed, fset=__SetObserverTopDirectionReversed) |
| Gets or sets the reverse direction of observer top direction. | |
| str | ObserverVerticalFOV = property(fget=__GetObserverVerticalFOV, fset=__SetObserverVerticalFOV) |
| Gets or sets the observer vertical field of view. | |
| str | ObserverVerticalResolution = property(fget=__GetObserverVerticalResolution) |
| Gets or sets the observer vertical resolution. | |
 Static Public Attributes inherited from SensorCommonBuilder | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the Sensor. | |
| str | DimensionFromFile = property(fget=__GetDimensionFromFile, fset=__SetDimensionFromFile) |
| Gets or sets the property to enable the use of dimensions that come from File. | |
| str | DisplayPropertiesFromFile = property(fget=__GetDisplayPropertiesFromFile, fset=__SetDisplayPropertiesFromFile) |
| Gets or sets the property to enable the use of display properties that come from File. | |
| str | GridOriginX = property(fget=__GetGridOriginX, fset=__SetGridOriginX) |
| Gets or sets the grid X origin. | |
| str | GridOriginY = property(fget=__GetGridOriginY, fset=__SetGridOriginY) |
| Gets or sets the grid Y origin. | |
| str | GridStepX = property(fget=__GetGridStepX, fset=__SetGridStepX) |
| Gets or sets the grid X step. | |
| str | GridStepY = property(fget=__GetGridStepY, fset=__SetGridStepY) |
| Gets or sets the grid Y step. | |
| str | SensorFilter = property(fget=__GetSensorFilter) |
| Gets the sensor filter. | |
| str | ShowGrid = property(fget=__GetShowGrid, fset=__SetShowGrid) |
| Gets or sets the property to enable grid preview. | |
| str | TemplateFilePath = property(fget=__GetTemplateFilePath, fset=__SetTemplateFilePath) |
| Gets or sets the template file's path. | |
| str | TemplateType = property(fget=__GetTemplateType) |
| Gets or sets the template type. | |
| str | Type = property(fget=__GetType, fset=__SetType) |
| Gets or sets the type of the sensor. | |
| str | UseTemplateFile = property(fget=__GetUseTemplateFile, fset=__SetUseTemplateFile) |
| Gets or sets the property to enable the use of template file. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd, fset=__SetWavelengthEnd) |
| Gets or sets the wavelength ending border. | |
| str | WavelengthResolution = property(fget=__GetWavelengthResolution, fset=__SetWavelengthResolution) |
| Gets or sets the Wavelength resolution. | |
| str | WavelengthSampling = property(fget=__GetWavelengthSampling, fset=__SetWavelengthSampling) |
| Gets or sets the wavelength sampling. | |
| str | WavelengthStart = property(fget=__GetWavelengthStart, fset=__SetWavelengthStart) |
| Gets or sets the wavelength starting border. | |
| str | XEnd = property(fget=__GetXEnd, fset=__SetXEnd) |
| Gets or sets the Sensor X end dimension value. | |
| str | XMirroredExtent = property(fget=__GetXMirroredExtent, fset=__SetXMirroredExtent) |
| Gets the Sensor X dimension mirrored extent value. | |
| str | XResolution = property(fget=__GetXResolution, fset=__SetXResolution) |
| Gets or sets the Sensor X dimension resolution value. | |
| str | XSampling = property(fget=__GetXSampling, fset=__SetXSampling) |
| Gets or sets the Sensor X dimension sampling value. | |
| str | XStart = property(fget=__GetXStart, fset=__SetXStart) |
| Gets or sets the Sensor X start dimension value. | |
| str | YEnd = property(fget=__GetYEnd, fset=__SetYEnd) |
| Gets or sets the Sensor Y end dimension value. | |
| str | YMirroredExtent = property(fget=__GetYMirroredExtent, fset=__SetYMirroredExtent) |
| Gets the Sensor Y dimension mirrored extent value. | |
| str | YResolution = property(fget=__GetYResolution, fset=__SetYResolution) |
| Gets or sets the Sensor Y dimension resolution value. | |
| str | YSampling = property(fget=__GetYSampling, fset=__SetYSampling) |
| Gets or sets the Sensor Y dimension sampling value. | |
| Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
Additional Inherited Members | |
| Public Member Functions inherited from SensorCommonBuilder | |
| 'bool' | IsTemplateFileValid (self) |
| Checks whether the template file is valid. | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
| 'None' | 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 a Radiance Sensor Builder.
The Radiance Sensor Builder is used to create and edit Radiance Sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensorRadianceBuilder
Member Data Documentation
◆ AutomaticFraming
|
static |
Gets or sets the property to enable automatic framing.
Prerequisite: The DefinitionType must be 2 or the ObserverType must be 0.
Automatic Framing reframes the camera on the radiance sensor.
True : Enable Automatic Framing.
False : Disable Automatic Framing.
Value type: Boolean.
The default value is False.
◆ CameraName
|
static |
Gets or set the camera by its name.
Prerequisite: The DefinitionType property must be 1.
Value type: String.
The default value is an empty string.
◆ Definition
|
static |
Gets or sets the definition type.
The values are:
0 - Frame.
1 - Camera.
2 - Observer.
Value type: Integer.
The default value is 0.
◆ Focal
|
static |
Gets or sets the focal.
Prerequisite: The DefinitionType property must be 2 or the ObserverType must be 0.
Focal defines the distance between the sensor plane and the Observer point.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 250.0 mm.
◆ FrameObserverPoint
|
static |
Gets or sets the frame observer point.
Prerequisite: The ObserverType must be 1.
The property frame observer point takes a feature tag and returns a feature tag.
Defines the location of the frame.
Value type: Integer.
The default value is 0.
◆ HVRatio
|
static |
Gets or sets the H/V ratio.
Prerequisite: The DefinitionType property must be 1.
H/V Ratio modifies the X Start and X End values according to the Y Start and Y End values.
Value type: Double.
The default value is 1.33.
◆ IntegrationAngle
|
static |
Gets or sets the integration angle.
Value type: Double (in degrees).
Range: (0.0, 90.0)
The default value is 5.0 degrees.
◆ Observer
|
static |
Gets or sets the observer type.
Prerequisite: The DefinitionType property must be 0.
The values are:
0 : Focal.
1 : Observer.
Value type: Integer.
The default value is 0.
◆ ObserverFrontDirection
|
static |
Gets or sets the observer front direction.
Prerequisite: The DefinitionType must be 2.
The property observer front direction takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ ObserverFrontDirectionReversed
|
static |
Gets or sets the reverse direction of observer front direction.
Prerequisite: The DefinitionType must be 2.
True: Reverses the observer front direction.
False: Does not reverse the Observer Front Direction.
Value type: Boolean.
The default value is False.
◆ ObserverHorizontalFOV
|
static |
Gets or sets the observer horizontal field of view.
Prerequisite: The DefinitionType must be 2.
Value type: Double (in degrees).
Range: (0, 180)
The default value is 2.0 degrees.
◆ ObserverHorizontalResolution
|
static |
Gets or sets the observer horizontal resolution.
Prerequisite: The DefinitionType must be 2.
Value type: Integer.
◆ ObserverHorizontalSampling
|
static |
Gets or sets the observer horizontal sampling.
Prerequisite: The DefinitionType must be 2.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100.
◆ ObserverPoint
|
static |
Gets or sets the observer point.
Prerequisite: The DefinitionType must be 2.
The property observer point takes a feature tag and returns a feature tag.
Defines the location of the observer.
Value type: Integer.
The default value is 0.
◆ ObserverTopDirection
|
static |
Gets or sets the observer top direction.
Prerequisite: The DefinitionType must be 2.
The property observer top direction takes a feature tag and returns a feature tag.
Value type: Integer.
The default value is 0.
◆ ObserverTopDirectionReversed
|
static |
Gets or sets the reverse direction of observer top direction.
Prerequisite: The DefinitionType must be 2.
True: Reverses the Observer top Direction.
False: Does not reverse the observer top direction.
Value type: Boolean.
The default value is False.
◆ ObserverVerticalFOV
|
static |
Gets or sets the observer vertical field of view.
Prerequisite: The DefinitionType must be 2.
Value type: Double.
Range: (0, 180)
The default value is 2.0 degrees.
◆ ObserverVerticalResolution
|
static |
Gets or sets the observer vertical resolution.
Prerequisite: The DefinitionType must be 2.
Value type: Integer.
The documentation for this class was generated from the following file:
- SpeosNX.py
