SensorHumanEyeBuilder Class Reference
Last update: 17.07.2025Represents a Human Eye Sensor Builder. More...
Public Member Functions | |
| 'None' | UdpateWavelengthSamplingFromResolution (self, value) |
 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. | |
Static Public Attributes | |
| str | DisplayPropertiesFromFile = property(fget=__GetDisplayPropertiesFromFile, fset=__SetDisplayPropertiesFromFile) |
| Gets or sets the property to enable the use of display properties that come from File. | |
| str | EyePoint = property(fget=__GetEyePoint, fset=__SetEyePoint) |
| Gets or sets the eye point. | |
| 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 | LayerType = property(fget=__GetLayerType, fset=__SetLayerType) |
| Gets or sets the layer mode. | |
| str | PupilDiameter = property(fget=__GetPupilDiameter, fset=__SetPupilDiameter) |
| Gets or sets the pupil diameter. | |
| str | ShowGrid = property(fget=__GetShowGrid, fset=__SetShowGrid) |
| Gets or sets the property to enable grid preview. | |
| str | TargetPoint = property(fget=__GetTargetPoint, fset=__SetTargetPoint) |
| Gets or sets the target point. | |
| str | TemplateFilePath = property(fget=__GetTemplateFilePath, fset=__SetTemplateFilePath) |
| Gets or sets the XM3 template file. | |
| str | Type = property(fget=__GetType, fset=__SetType) |
| Gets or sets the sensor type. | |
| str | UseTemplateFile = property(fget=__GetUseTemplateFile, fset=__SetUseTemplateFile) |
| Gets or sets the property to enable or disable use of XM3 template file. | |
| str | VerticalDirection = property(fget=__GetVerticalDirection, fset=__SetVerticalDirection) |
| Gets or sets the vertical direction. | |
| str | VerticalDirectionReversed = property(fget=__GetVerticalDirectionReversed, fset=__SetVerticalDirectionReversed) |
| Gets or sets the reverse vertical direction. | |
| str | VisionFieldHorizontalEnd = property(fget=__GetVisionFieldHorizontalEnd, fset=__SetVisionFieldHorizontalEnd) |
| Gets or sets the horizontal end for vision field. | |
| str | VisionFieldHorizontalMirroredExtent = property(fget=__GetVisionFieldHorizontalMirroredExtent, fset=__SetVisionFieldHorizontalMirroredExtent) |
| Gets or sets the mirrored extent property for horizontal vision field. | |
| str | VisionFieldHorizontalResolution = property(fget=__GetVisionFieldHorizontalResolution, fset=__SetVisionFieldHorizontalResolution) |
| Gets or sets the horizontal resolution for vision field. | |
| str | VisionFieldHorizontalSampling = property(fget=__GetVisionFieldHorizontalSampling, fset=__SetVisionFieldHorizontalSampling) |
| Gets the horizontal sampling for vision field. | |
| str | VisionFieldHorizontalStart = property(fget=__GetVisionFieldHorizontalStart, fset=__SetVisionFieldHorizontalStart) |
| Gets or sets the horizontal start for vision field. | |
| str | VisionFieldVerticalEnd = property(fget=__GetVisionFieldVerticalEnd, fset=__SetVisionFieldVerticalEnd) |
| Gets or sets the vertical end for vision field. | |
| str | VisionFieldVerticalMirroredExtent = property(fget=__GetVisionFieldVerticalMirroredExtent, fset=__SetVisionFieldVerticalMirroredExtent) |
| Gets or sets the mirrored extent property for vertical vision field. | |
| str | VisionFieldVerticalResolution = property(fget=__GetVisionFieldVerticalResolution, fset=__SetVisionFieldVerticalResolution) |
| Gets or sets the vertical resolution for vision field. | |
| str | VisionFieldVerticalSampling = property(fget=__GetVisionFieldVerticalSampling, fset=__SetVisionFieldVerticalSampling) |
| Gets the vertical sampling for vision field. | |
| str | VisionFieldVerticalStart = property(fget=__GetVisionFieldVerticalStart, fset=__SetVisionFieldVerticalStart) |
| Gets or sets the vertical start for vision field. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd) |
| Gets the higher value of the wavelength range to be considered by the sensor. | |
| str | WavelengthResolution = property(fget=__GetWavelengthResolution) |
| Gets or sets the Wavelength resolution. | |
| str | WavelengthSampling = property(fget=__GetWavelengthSampling, fset=__SetWavelengthSampling) |
| Gets or sets the wavelength sampling. | |
| str | WavelengthStart = property(fget=__GetWavelengthStart) |
| Gets the lower value of the wavelength range to be considered by the sensor. | |
| 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. | |
Detailed Description
Represents a Human Eye Sensor Builder.
The Human Eye Sensor Builder is used to create and edit Human Eye Sensor features.
To create a new instance of this class, use FeatureCollection::CreateSensorHumanEyeBuilder
Member Data Documentation
◆ DisplayPropertiesFromFile
|
static |
Gets or sets the property to enable the use of display properties that come from File.
Prerequisite: The property UseTemplateFile must be True.
True: Uses all the grid related values from the .xml file.
False: Does not use the Display properties from file.
Value type: Boolean.
The default value is False.
◆ EyePoint
|
static |
Gets or sets the eye point.
The EyePoint property takes and returns a Tag from an NX object.
Value type: Integer.
The default value is 0.
◆ GridOriginX
|
static |
Gets or sets the grid X origin.
Value type: Double.
The default value is 0.0.
◆ GridOriginY
|
static |
Gets or sets the grid Y origin.
Value type: Double.
The default value is 0.0.
◆ GridStepX
|
static |
Gets or sets the grid X step.
Value type: Double.
Range: The value must be superior to 0.
The default value is 10.0.
◆ GridStepY
|
static |
Gets or sets the grid Y step.
Value type: Double.
Range: The value must be superior to 0.
The default value is 10.0.
◆ LayerType
|
static |
Gets or sets the layer mode.
The values are:
0 - None.
1 - Data Separated by Source.
Value type: Integer.
The default value is 0.
◆ PupilDiameter
|
static |
Gets or sets the pupil diameter.
Value type: Double.
Range: The value must be superior to 0.0.
The default value is 4.0.
◆ ShowGrid
|
static |
Gets or sets the property to enable grid preview.
True: Displays a grid on the sensor.
False: Does not display a grid on the sensor.
Value type: Boolean.
The default value is True.
◆ TargetPoint
|
static |
Gets or sets the target point.
The TargetPoint property takes and returns a Tag from an NX object.
Value type: Integer.
The default value is 0.
◆ TemplateFilePath
|
static |
Gets or sets the XM3 template file.
Prerequisite: The property TemplateFile must be True.
Value type: String.
The default value is an empty string.
◆ Type
|
static |
Gets or sets the sensor type.
The values are:
0 - Colorimetric to get the color results without any spectral layer separation.
1 - Spectral to get the color results and spectral data separated by wavelength.
Value type: Integer.
The default value is 0.
◆ UseTemplateFile
|
static |
Gets or sets the property to enable or disable use of XM3 template file.
True: Uses XM3 template file.
False: Does not use XM3 template file.
Value type: Boolean.
The default value is False.
◆ VerticalDirection
|
static |
Gets or sets the vertical direction.
The VerticalDirection property takes and returns a Tag from an NX object.
Value type: Integer.
The default value is 0.
◆ VerticalDirectionReversed
|
static |
Gets or sets the reverse vertical direction.
Returns the flag to indicate the vertical direction is reversed.
True: Reverses the vertical direction.
False: Does not reverse the vertical direction.
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: [-90.0, 90.0]
The default value is 20.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.
Range: The value must be superior to 0.
◆ VisionFieldHorizontalSampling
|
static |
Gets the horizontal sampling for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
◆ 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: [-90.0, 90.0]
The default value is -20.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 10.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 the vertical sampling for vision field.
Vision Field corresponds to the surface on which are located observer positions around target point.
Value type: Integer.
◆ 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 -10.0 degrees.
◆ WavelengthEnd
|
static |
Gets the higher value of the wavelength range to be considered by the sensor.
Value type: Double (in nm).
The default value is 830.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 the lower value of the wavelength range to be considered by the sensor.
Value type: Double (in nm).
The default value is 360.0 nm.
The documentation for this class was generated from the following file:
- SpeosNX.py
