SensorCameraBuilder Class Reference
Last update: 17.07.2025Represents a Camera Sensor Builder. More...
Public Member Functions | |
| 'None' | UpdateWavelengthSamplingFromResolution (self, resolution) |
| Updates the wavelength sampling from a resolution. | |
 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 | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the Sensor. | |
| str | BlueGain = property(fget=__GetBlueGain, fset=__SetBlueGain) |
| Gets or sets the blue gain. | |
| str | CameraMode = property(fget=__GetCameraMode, fset=__SetCameraMode) |
| Gets or sets the camera mode. | |
| str | ColorMode = property(fget=__GetColorMode, fset=__SetColorMode) |
| Gets or sets the color mode. | |
| str | DisplayAperture = property(fget=__GetDisplayAperture, fset=__SetDisplayAperture) |
| Gets or sets the property to enable the preview of the Aperture. | |
| str | DisplayCameraField = property(fget=__GetDisplayCameraField, fset=__SetDisplayCameraField) |
| Gets or sets the property to enable the preview of the Camera Field. | |
| str | DisplayObjectField = property(fget=__GetDisplayObjectField, fset=__SetDisplayObjectField) |
| Gets or sets the property to enable the preview of the Object Field. | |
| str | DistortionFilePath = property(fget=__GetDistortionFilePath, fset=__SetDistortionFilePath) |
| Gets or sets the distortion file path. | |
| str | FNumber = property(fget=__GetFNumber, fset=__SetFNumber) |
| Gets or sets the F number. | |
| str | FocalLength = property(fget=__GetFocalLength, fset=__SetFocalLength) |
| Gets or sets the focal length. | |
| str | GammaCorrection = property(fget=__GetGammaCorrection, fset=__SetGammaCorrection) |
| Gets or sets the gamma correction. | |
| str | GreenGain = property(fget=__GetGreenGain, fset=__SetGreenGain) |
| Gets or sets the green gain. | |
| str | Height = property(fget=__GetHeight, fset=__SetHeight) |
| Gets or sets the height . | |
| str | HorizontalFOV = property(fget=__GetHorizontalFOV) |
| Gets the Horizontal Field of View. | |
| str | HorizontalPixels = property(fget=__GetHorizontalPixels, fset=__SetHorizontalPixels) |
| Gets or sets the horizontal pixels . | |
| str | ImagerDistance = property(fget=__GetImagerDistance, fset=__SetImagerDistance) |
| Gets or sets the Image Distance. | |
| str | Layer = property(fget=__GetLayer, fset=__SetLayer) |
| Gets or sets the layer mode. | |
| str | PNGBits = property(fget=__GetPNGBits, fset=__SetPNGBits) |
| Gets or sets the PNG Bits. | |
| str | RedGain = property(fget=__GetRedGain, fset=__SetRedGain) |
| Gets or sets the red gain. | |
| str | SensitivityBlueSpectrumFilePath = property(fget=__GetSensitivityBlueSpectrumFilePath, fset=__SetSensitivityBlueSpectrumFilePath) |
| Gets or sets the sensitivity blue spectrum file path. | |
| str | SensitivityGreenSpectrumFilePath = property(fget=__GetSensitivityGreenSpectrumFilePath, fset=__SetSensitivityGreenSpectrumFilePath) |
| Gets or sets the sensitivity green spectrum file path. | |
| str | SensitivityMonochromaticSpectrumFilePath = property(fget=__GetSensitivityMonochromaticSpectrumFilePath, fset=__SetSensitivityMonochromaticSpectrumFilePath) |
| Gets or sets the sensitivity monochromatic spectrum file path. | |
| str | SensitivityRedSpectrumFilePath = property(fget=__GetSensitivityRedSpectrumFilePath, fset=__SetSensitivityRedSpectrumFilePath) |
| Gets or sets the sensitivity red spectrum file path. | |
| str | TransmittanceFilePath = property(fget=__GetTransmittanceFilePath, fset=__SetTransmittanceFilePath) |
| Gets or sets the transmittance file path. | |
| str | VerticalFOV = property(fget=__GetVerticalFOV) |
| Gets the Vertical Field of View. | |
| str | VerticalPixels = property(fget=__GetVerticalPixels, fset=__SetVerticalPixels) |
| Gets or sets the vertical pixels . | |
| str | VisualizationRadius = property(fget=__GetVisualizationRadius, fset=__SetVisualizationRadius) |
| Gets or sets the Visualization radius. | |
| str | WavelengthEnd = property(fget=__GetWavelengthEnd, fset=__SetWavelengthEnd) |
| Gets or sets the higher value of the wavelength range to be considered by the sensor. | |
| str | WavelengthResolution = property(fget=__GetWavelengthResolution) |
| Gets 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 lower value of the wavelength range to be considered by the sensor. | |
| str | WhiteBalanceBlueSpectrumFilePath = property(fget=__GetWhiteBalanceBlueSpectrumFilePath, fset=__SetWhiteBalanceBlueSpectrumFilePath) |
| Gets or sets the white balance blue spectrum file path. | |
| str | WhiteBalanceGreenSpectrumFilePath = property(fget=__GetWhiteBalanceGreenSpectrumFilePath, fset=__SetWhiteBalanceGreenSpectrumFilePath) |
| Gets or sets the white balance green spectrum file path. | |
| str | WhiteBalanceMode = property(fget=__GetWhiteBalanceMode, fset=__SetWhiteBalanceMode) |
| Gets or sets the white balance mode. | |
| str | WhiteBalanceRedSpectrumFilePath = property(fget=__GetWhiteBalanceRedSpectrumFilePath, fset=__SetWhiteBalanceRedSpectrumFilePath) |
| Gets or sets the white balance red spectrum file path. | |
| str | Width = property(fget=__GetWidth, fset=__SetWidth) |
| Gets or sets the width . | |
| 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 Camera Sensor Builder.
The Camera Sensor Builder creates or edits Camera Sensor features.
To create a new instance of this class, use FeatureCollection.CreateSensorCameraBuilder.
With a surface source, you can simulate rays integration as in a real camera according to the camera parameters set.
Member Function Documentation
◆ UpdateWavelengthSamplingFromResolution()
| 'None' UpdateWavelengthSamplingFromResolution | ( | self, | |
| resolution ) |
Updates the wavelength sampling from a resolution.
- Parameters
-
[in] Resolution Double.
Member Data Documentation
◆ AxisSystem
|
static |
Gets the Axis System of the Sensor.
Value type: AxisSystem object.
◆ BlueGain
|
static |
Gets or sets the blue gain.
Prerequisite: The WhiteBalanceMode property must be 2.
Value type: Double.
The default value is 1.0.
◆ CameraMode
|
static |
Gets or sets the camera mode.
The values are:
0 - Geometric, it is a simplified version of the Camera Sensor definition parameters.
1 - Photometric / Colorimetric, it allows you to set every Camera Sensor parameters, including the photometric definition parameters.
Value type: Integer.
The default value is 0.
◆ ColorMode
|
static |
Gets or sets the color mode.
Prerequisite: The CameraMode property must be 1.
The values are:
0 - Monochrome, the simulation results are available in grey scale.
1 - Color, the simulation results are available in color according to the White Balance mode.
Value type: Integer.
The default value is 1.
◆ DisplayAperture
|
static |
Gets or sets the property to enable the preview of the Aperture.
True: Displays the Aperture.
False: Does not display the Aperture
Value type: Boolean.
The default value is True.
◆ DisplayCameraField
|
static |
Gets or sets the property to enable the preview of the Camera Field.
True: Displays the Camera Field.
False: Does not display the Camera Field
Value type: Boolean.
The default value is True.
◆ DisplayObjectField
|
static |
Gets or sets the property to enable the preview of the Object Field.
True: Displays the Object Field.
False: Does not display the Object Field
Value type: Boolean.
The default value is True.
◆ DistortionFilePath
|
static |
Gets or sets the distortion file path.
Value type: String.
The default value is an empty file path (string).
◆ FNumber
|
static |
Gets or sets the F number.
Represents the aperture of the front lens.
Value type: Double.
Range: The value must be superior to 0.
The default value is 15.0.
◆ FocalLength
|
static |
Gets or sets the focal length.
Distance between the center of the optical system and the focus.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 15.0 mm.
◆ GammaCorrection
|
static |
Gets or sets the gamma correction.
Prerequisite: The CameraMode property must be 1.
Compensates the curve before the display on the screen.
Value type: Double.
The default value is 2.2.
◆ GreenGain
|
static |
Gets or sets the green gain.
Prerequisite: The WhiteBalanceMode property must be 2.
Value type: Double.
The default value is 1.0.
◆ Height
|
static |
Gets or sets the height .
Defines the sensor's height.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 5.0 mm.
◆ HorizontalFOV
|
static |
Gets the Horizontal Field of View.
Value type: Double.
◆ HorizontalPixels
|
static |
Gets or sets the horizontal pixels .
Defines the horizontal pixels number corresponding to the camera resolution.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 640.
◆ ImagerDistance
|
static |
Gets or sets the Image Distance.
Value type: Double (in mm).
The default value is 15.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 - Data separated by Source, the result includes one layer per active source.
Value type: Integer.
The default value is 0.
◆ PNGBits
|
static |
Gets or sets the PNG Bits.
Prerequisite: The CameraMode property must be 1.
The values are:
0 - 8 Bits.
1 - 10 Bits.
2 - 12 Bits.
3 - 16 Bits.
Value type: Integer.
The default value is 3.
◆ RedGain
|
static |
Gets or sets the red gain.
Prerequisite: The WhiteBalanceMode property must be 2.
Value type: Double.
The default value is 1.0.
◆ SensitivityBlueSpectrumFilePath
|
static |
Gets or sets the sensitivity blue spectrum file path.
Prerequisite: The ColorMode property must be 1.
Value type: String.
The default value is an empty file path (string).
◆ SensitivityGreenSpectrumFilePath
|
static |
Gets or sets the sensitivity green spectrum file path.
Prerequisite: The ColorMode property must be 1.
Value type: String.
The default value is an empty file path (string).
◆ SensitivityMonochromaticSpectrumFilePath
|
static |
Gets or sets the sensitivity monochromatic spectrum file path.
Prerequisite: The ColorMode property must be 0.
Value type: String.
The default value is an empty file path (string).
◆ SensitivityRedSpectrumFilePath
|
static |
Gets or sets the sensitivity red spectrum file path.
Prerequisite: The ColorMode property must be 1.
Value type: String.
The default value is an empty file path (string).
◆ TransmittanceFilePath
|
static |
Gets or sets the transmittance file path.
Value type: String.
The default value is an empty file path (string).
◆ VerticalFOV
|
static |
Gets the Vertical Field of View.
Value type: Double.
◆ VerticalPixels
|
static |
Gets or sets the vertical pixels .
Defines the vertical pixels number corresponding to the camera resolution.
Value type: Integer.
Range: The value must be superior to 0.
The default value is 480.
◆ VisualizationRadius
|
static |
Gets or sets the Visualization radius.
Changes the radius of the Object field of the camera.
Value type: Double (in mm).
Range: The parameter must be superior to 0.0.
The default value is 1000.0 mm.
◆ WavelengthEnd
|
static |
Gets or sets the higher value of the wavelength range to be considered by the sensor.
Prerequisite: The CameraMode property must be 1.
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 the Wavelength resolution.
Prerequisite: The CameraMode property must be 1.
Value type: Double.
◆ WavelengthSampling
|
static |
Gets or sets the wavelength sampling.
Prerequisite: The CameraMode property must be 1.
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.
Prerequisite: The CameraMode property must be 1.
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.
◆ WhiteBalanceBlueSpectrumFilePath
|
static |
Gets or sets the white balance blue spectrum file path.
Prerequisite: The WhiteBalanceMode property must be 3.
Value type: String.
The default value is an empty file path (string).
◆ WhiteBalanceGreenSpectrumFilePath
|
static |
Gets or sets the white balance green spectrum file path.
Prerequisite: The WhiteBalanceMode property must be 3.
Value type: String.
The default value is an empty file path (string).
◆ WhiteBalanceMode
|
static |
Gets or sets the white balance mode.
Prerequisite: The ColorMode property must be 1.
The values are:
0 - None.
1 - Grey World.
2 - Use White Balance.
3 - Display Primaries.
Value type: Integer.
The default value is 0.
◆ WhiteBalanceRedSpectrumFilePath
|
static |
Gets or sets the white balance red spectrum file path.
Prerequisite: The WhiteBalanceMode property must be 3.
Value type: String.
The default value is an empty file path (string).
◆ Width
|
static |
Gets or sets the width .
Defines the sensor's width.
Value type: Double (in mm).
Range: The value must be superior to 0.
The default value is 5.0 mm.
The documentation for this class was generated from the following file:
- SpeosNX.py
