SensorObserverBuilder Class Reference
Last update: 17.07.2025Represents the builder for an observer sensor. More...
Properties | |
| AutoFramingHorizontal = property(fget = __GetAutoFramingHorizontal, fset = __SetAutoFramingHorizontal) | |
| Gets or sets the automatic framing horizontal position. | |
| AutoFramingVertical = property(fget = __GetAutoFramingVertical, fset = __SetAutoFramingVertical) | |
| Gets or sets the automatic framing horizontal position. | |
| AxisSystem = property(fget = __GetAxisSystem) | |
| Gets the axis system. | |
| DimensionHorizontalEnd = property(fget = __GetDimensionHorizontalEnd, fset = __SetDimensionHorizontalEnd) | |
| Gets or sets the horizontal end for dimension. | |
| DimensionHorizontalMirroredExtent = property(fget = __GetDimensionHorizontalMirroredExtent, fset = __SetDimensionHorizontalMirroredExtent) | |
| Gets or sets the mirrored extent property for horizontal dimension. | |
| DimensionHorizontalResolution = property(fget = __GetDimensionHorizontalResolution, fset = __SetDimensionHorizontalResolution) | |
| Gets or sets the horizontal resolution for dimension. | |
| DimensionHorizontalSampling = property(fget = __GetDimensionHorizontalSampling, fset = __SetDimensionHorizontalSampling) | |
| Gets or sets the horizontal sampling for dimension. | |
| DimensionHorizontalStart = property(fget = __GetDimensionHorizontalStart, fset = __SetDimensionHorizontalStart) | |
| Gets or sets the horizontal start for dimension. | |
| DimensionVerticalEnd = property(fget = __GetDimensionVerticalEnd, fset = __SetDimensionVerticalEnd) | |
| Gets or sets the vertical end for dimension. | |
| DimensionVerticalMirroredExtent = property(fget = __GetDimensionVerticalMirroredExtent, fset = __SetDimensionVerticalMirroredExtent) | |
| Gets or sets the mirrored extent property for vertical dimension. | |
| DimensionVerticalResolution = property(fget = __GetDimensionVerticalResolution, fset = __SetDimensionVerticalResolution) | |
| Gets or sets the vertical resolution for dimension. | |
| DimensionVerticalSampling = property(fget = __GetDimensionVerticalSampling, fset = __SetDimensionVerticalSampling) | |
| Gets or sets the vertical sampling for dimension. | |
| DimensionVerticalStart = property(fget = __GetDimensionVerticalStart, fset = __SetDimensionVerticalStart) | |
| Gets or sets the vertical start for dimension. | |
| Distance = property(fget = __GetDistance, fset = __SetDistance) | |
| Gets or sets the distance. | |
| Focal = property(fget = __GetFocal, fset = __SetFocal) | |
| Gets or sets the focal. | |
| IntegrationAngle = property(fget = __GetIntegrationAngle, fset = __SetIntegrationAngle) | |
| Gets or sets the integration angle. | |
| InterocularDistance = property(fget = __GetInterocularDistance, fset = __SetInterocularDistance) | |
| Gets or set the interocular distance. | |
| Layer = property(fget = __GetLayer, fset = __SetLayer) | |
| Gets or sets the layer mode. | |
| Stereo = property(fget = __GetStereo, fset = __SetStereo) | |
| gets or sets the stereo property. | |
| VisionFieldHorizontalEnd = property(fget = __GetVisionFieldHorizontalEnd, fset = __SetVisionFieldHorizontalEnd) | |
| Gets or sets the horizontal end for vision field. | |
| VisionFieldHorizontalMirroredExtent = property(fget = __GetVisionFieldHorizontalMirroredExtent, fset = __SetVisionFieldHorizontalMirroredExtent) | |
| Gets or sets the mirrored extent property for horizontal vision field. | |
| VisionFieldHorizontalResolution = property(fget = __GetVisionFieldHorizontalResolution, fset = __SetVisionFieldHorizontalResolution) | |
| Gets or sets the horizontal resolution for vision field. | |
| VisionFieldHorizontalSampling = property(fget = __GetVisionFieldHorizontalSampling, fset = __SetVisionFieldHorizontalSampling) | |
| Gets or sets the horizontal sampling for vision field. | |
| VisionFieldHorizontalStart = property(fget = __GetVisionFieldHorizontalStart, fset = __SetVisionFieldHorizontalStart) | |
| Gets or sets the horizontal start for vision field. | |
| VisionFieldVerticalEnd = property(fget = __GetVisionFieldVerticalEnd, fset = __SetVisionFieldVerticalEnd) | |
| Gets or sets the vertical end for vision field. | |
| VisionFieldVerticalMirroredExtent = property(fget = __GetVisionFieldVerticalMirroredExtent, fset = __SetVisionFieldVerticalMirroredExtent) | |
| Gets or sets the mirrored extent property for vertical vision field. | |
| VisionFieldVerticalResolution = property(fget = __GetVisionFieldVerticalResolution, fset = __SetVisionFieldVerticalResolution) | |
| Gets or sets the vertical resolution for vision field. | |
| VisionFieldVerticalSampling = property(fget = __GetVisionFieldVerticalSampling, fset = __SetVisionFieldVerticalSampling) | |
| Gets or sets the vertical sampling for vision field. | |
| VisionFieldVerticalStart = property(fget = __GetVisionFieldVerticalStart, fset = __SetVisionFieldVerticalStart) | |
| Gets or sets the vertical start for vision field. | |
| WavelengthEnd = property(fget = __GetWavelengthEnd, fset = __SetWavelengthEnd) | |
| Gets or sets the higher value of the wavelength range to be considered by the sensor. | |
| 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 lower value of the wavelength range to be considered by the sensor. | |
 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 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 the builder for an observer sensor.
The observer sensor builder is used to create and edit observer sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensorObserverBuilder
Property Documentation
◆ AutoFramingHorizontal
|
static |
Gets or sets the automatic framing horizontal position.
Value type: Integer.
Range: The value must be superior or equal to 0 and inferior or equal to the number of columns.
The default value is 0.
◆ AutoFramingVertical
|
static |
Gets or sets the automatic framing horizontal position.
Value type: Integer.
Range: The value must be superior or equal to 0 and inferior or equal to the number of lines.
The default value is 0.
◆ AxisSystem
|
static |
Gets the axis system.
Value type: AxisSystem object.
◆ DimensionHorizontalEnd
|
static |
Gets or sets the horizontal end for dimension.
Value type: Double (in mm).
The default value is 50.0 mm.
◆ DimensionHorizontalMirroredExtent
|
static |
Gets or sets the mirrored extent property for horizontal dimension.
True: DimensionHorizontalStart == -DimensionHorizontalEnd, you can only change the DimensionHorizontalEnd value.
False: DimensionHorizontalStart and DimensionHorizontalEnd can have different value.
Value type: Boolean.
The default value is False.
◆ DimensionHorizontalResolution
|
static |
Gets or sets the horizontal resolution for dimension.
Value type: Double.
◆ DimensionHorizontalSampling
|
static |
Gets or sets the horizontal sampling for dimension.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100.
◆ DimensionHorizontalStart
|
static |
Gets or sets the horizontal start for dimension.
Value type: Double (in mm).
The default value is -50.0 mm.
◆ DimensionVerticalEnd
|
static |
Gets or sets the vertical end for dimension.
Value type: Double (in mm).
The default value is 50.0 mm.
◆ DimensionVerticalMirroredExtent
|
static |
Gets or sets the mirrored extent property for vertical dimension.
True: DimensionVerticalStart == -DimensionVerticalEnd, you can only change the DimensionVerticalEnd value.
False: DimensionVerticalStart and DimensionVerticalEnd can have different value.
Value type: Boolean.
The default value is False.
◆ DimensionVerticalResolution
|
static |
Gets or sets the vertical resolution for dimension.
Value type: Double.
◆ DimensionVerticalSampling
|
static |
Gets or sets the vertical sampling for dimension.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 100.
◆ DimensionVerticalStart
|
static |
Gets or sets the vertical start for dimension.
Value type: Double (in mm).
The default value is -50.0 mm.
◆ Distance
|
static |
Gets or sets the distance.
Adjusts the radius of the sphere to narrow or widen the global field of vision.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 1000.0 mm.
◆ Focal
|
static |
Gets or sets the focal.
Adjusts the distance between the sensor radiance plan and the origin point of the observed object. The larger the focal, the closer to the object.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 50.0 mm.
◆ IntegrationAngle
|
static |
Gets or sets the integration angle.
Value type: Double (in degrees).
The default value is 5.0 degrees.
◆ InterocularDistance
|
static |
Gets or set the interocular distance.
Prerequisite: The Stereo property must be True.
Value type: Double (in mm).
Range: The value must be superior to 0.0.
The default value is 65.0 mm.
◆ Layer
|
static |
Gets or sets the layer mode.
The values are:
0 - None, the simulation generates a Speos360 file with one layer for all sources.
1 - Source, the result includes one layer per active source.
Value type: Integer.
The default value is 0.
◆ Stereo
|
static |
gets or sets the stereo property.
When you define a stereo sensor, make sure that the Front direction is horizontal, the Top direction is vertical, and the Central resolution matches the intended 3D display.
True: Enables stereo.
False: Disables stereo.
Value type: Boolean.
The default value is False.
◆ VisionFieldHorizontalEnd
|
static |
Gets or sets the horizontal end for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double (in degrees).
Range: [-180.0, 180.0]
The default value is 180.0 degrees.
◆ VisionFieldHorizontalMirroredExtent
|
static |
Gets or sets the mirrored extent property for horizontal vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
True: VisionFieldHorizontalStart == -VisionFieldHorizontalEnd, you can only change the VisionFieldHorizontalEnd value.
False: VisionFieldHorizontalStart and VisionFieldHorizontalEnd can have different value.
Value type: Boolean.
The default value is False.
◆ VisionFieldHorizontalResolution
|
static |
Gets or sets the horizontal resolution for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double.
◆ VisionFieldHorizontalSampling
|
static |
Gets or sets the horizontal sampling for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 9.
◆ VisionFieldHorizontalStart
|
static |
Gets or sets the horizontal start for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double (in degrees).
Range: [-180.0, 180.0]
The default value is -180.0 degrees.
◆ VisionFieldVerticalEnd
|
static |
Gets or sets the vertical end for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double (in degrees).
Range: [-90.0, 90.0]
The default value is 90.0 degrees.
◆ VisionFieldVerticalMirroredExtent
|
static |
Gets or sets the mirrored extent property for vertical vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
True: VisionFieldVerticalStart == -VisionFieldVerticalEnd, you can only change the VisionFieldVerticalEnd value.
False: VisionFieldVerticalStart and VisionFieldVerticalEnd can have different value.
Value type: Boolean.
The default value is False.
◆ VisionFieldVerticalResolution
|
static |
Gets or sets the vertical resolution for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double.
◆ VisionFieldVerticalSampling
|
static |
Gets or sets the vertical sampling for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 5.
◆ VisionFieldVerticalStart
|
static |
Gets or sets the vertical start for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Double (in degrees).
Range: [-90.0, 90.0]
The default value is -90.0 degrees.
◆ WavelengthEnd
|
static |
Gets or sets the higher value of the wavelength range to be considered by the sensor.
The sensor does not take into account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 700.0 nm.
◆ WavelengthResolution
|
static |
Gets or sets the Wavelength resolution.
Value type: Double.
◆ WavelengthSampling
|
static |
Gets or sets the wavelength sampling.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 13.
◆ WavelengthStart
|
static |
Gets or sets the lower value of the wavelength range to be considered by the sensor.
The sensor does not take into account wavelengths beyond the borders that you define.
Value type: Double (in nm).
The default value is 400.0 nm.
The documentation for this class was generated from the following file:
- SpeosNX.py
