## On this page

  

 

 # SensorCameraBuilder Class Reference

 Last update: 16.07.2025 

Represents a Camera Sensor Builder. [More...](#details)

Inheritance diagram for SensorCameraBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_sensor_camera_builder.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 'None' [UpdateWavelengthSamplingFromResolution](#aa84cc20a2aa99d1c8ff2ff353cb0923a) (self, resolution) Updates the wavelength sampling from a resolution.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the Axis System of the Sensor.   
 str [BlueGain](#a71412030c05833590a9a336cc1f08f49) = property(fget=\_\_GetBlueGain, fset=\_\_SetBlueGain) Gets or sets the blue gain.   
 str [CameraMode](#a932c5ab6f914702d97b2a6bbeaf6d434) = property(fget=\_\_GetCameraMode, fset=\_\_SetCameraMode) Gets or sets the camera mode.   
 str [ColorMode](#ae310087df32e1820a6892c84c983fe4a) = property(fget=\_\_GetColorMode, fset=\_\_SetColorMode) Gets or sets the color mode.   
 str [DisplayAperture](#a4d9c18ae8c1b3cb4ad9955acea263bf5) = property(fget=\_\_GetDisplayAperture, fset=\_\_SetDisplayAperture) Gets or sets the property to enable the preview of the Aperture.   
 str [DisplayCameraField](#aada3a30677e9030fceb3e874b74582d8) = property(fget=\_\_GetDisplayCameraField, fset=\_\_SetDisplayCameraField) Gets or sets the property to enable the preview of the Camera Field.   
 str [DisplayObjectField](#ae62d490c1685125c77ecc4b6482767a2) = property(fget=\_\_GetDisplayObjectField, fset=\_\_SetDisplayObjectField) Gets or sets the property to enable the preview of the Object Field.   
 str [DistortionFilePath](#ac2983e1196890b29cbeda75b824a9344) = property(fget=\_\_GetDistortionFilePath, fset=\_\_SetDistortionFilePath) Gets or sets the distortion file path.   
 str [FNumber](#a3a76a25b83be29a1eaf4f98dd4d39bd5) = property(fget=\_\_GetFNumber, fset=\_\_SetFNumber) Gets or sets the F number.   
 str [FocalLength](#ae8cfcee5f004bdc568f323c19de9f430) = property(fget=\_\_GetFocalLength, fset=\_\_SetFocalLength) Gets or sets the focal length.   
 str [GammaCorrection](#ac2c4a2fbb62c65cc6cbec857ca9919da) = property(fget=\_\_GetGammaCorrection, fset=\_\_SetGammaCorrection) Gets or sets the gamma correction.   
 str [GreenGain](#ab295b63fcc4308c1953aa8d0b01cb8e7) = property(fget=\_\_GetGreenGain, fset=\_\_SetGreenGain) Gets or sets the green gain.   
 str [Height](#a37eb7401ae5f6ba4e112d3909cae96f0) = property(fget=\_\_GetHeight, fset=\_\_SetHeight) Gets or sets the height .   
 str [HorizontalFOV](#a02946d0fe38b0f9101891760028ffc57) = property(fget=\_\_GetHorizontalFOV) Gets the Horizontal Field of View.   
 str [HorizontalPixels](#afcfe41111470f3b67568e5a8f450d8c2) = property(fget=\_\_GetHorizontalPixels, fset=\_\_SetHorizontalPixels) Gets or sets the horizontal pixels .   
 str [ImagerDistance](#a6141870e7231b921a2386d327823c395) = property(fget=\_\_GetImagerDistance, fset=\_\_SetImagerDistance) Gets or sets the Image Distance.   
 str [Layer](#a80837300dfb3751c003ebb2bce3946ef) = property(fget=\_\_GetLayer, fset=\_\_SetLayer) Gets or sets the layer mode.   
 str [PNGBits](#adddf71612af0ed60c665af22d2713147) = property(fget=\_\_GetPNGBits, fset=\_\_SetPNGBits) Gets or sets the PNG Bits.   
 str [RedGain](#af0399142a4ec64706903368ba8de0c53) = property(fget=\_\_GetRedGain, fset=\_\_SetRedGain) Gets or sets the red gain.   
 str [SensitivityBlueSpectrumFilePath](#a4925a1b3c302e7273aa7bf211d9a356a) = property(fget=\_\_GetSensitivityBlueSpectrumFilePath, fset=\_\_SetSensitivityBlueSpectrumFilePath) Gets or sets the sensitivity blue spectrum file path.   
 str [SensitivityGreenSpectrumFilePath](#af68d2d4690da9703d4747c7dc6c3fdc7) = property(fget=\_\_GetSensitivityGreenSpectrumFilePath, fset=\_\_SetSensitivityGreenSpectrumFilePath) Gets or sets the sensitivity green spectrum file path.   
 str [SensitivityMonochromaticSpectrumFilePath](#a129349ebf40f40194471213480321380) = property(fget=\_\_GetSensitivityMonochromaticSpectrumFilePath, fset=\_\_SetSensitivityMonochromaticSpectrumFilePath) Gets or sets the sensitivity monochromatic spectrum file path.   
 str [SensitivityRedSpectrumFilePath](#acb311777bc46345b76b598eab8c451b6) = property(fget=\_\_GetSensitivityRedSpectrumFilePath, fset=\_\_SetSensitivityRedSpectrumFilePath) Gets or sets the sensitivity red spectrum file path.   
 str [TransmittanceFilePath](#a54bf4cfb85bbf3048ae57ed6bc80b6c3) = property(fget=\_\_GetTransmittanceFilePath, fset=\_\_SetTransmittanceFilePath) Gets or sets the transmittance file path.   
 str [VerticalFOV](#a90171c807ee2c2cb739641ea43588724) = property(fget=\_\_GetVerticalFOV) Gets the Vertical Field of View.   
 str [VerticalPixels](#a8cf6ebb154d8cc9926c500c352fd53a4) = property(fget=\_\_GetVerticalPixels, fset=\_\_SetVerticalPixels) Gets or sets the vertical pixels .   
 str [VisualizationRadius](#a043232eb7c476f89c1ed105dfb49b30d) = property(fget=\_\_GetVisualizationRadius, fset=\_\_SetVisualizationRadius) Gets or sets the Visualization radius.   
 str [WavelengthEnd](#a1d3af865fff16f6eb31305404623a867) = property(fget=\_\_GetWavelengthEnd, fset=\_\_SetWavelengthEnd) Gets or sets the higher value of the wavelength range to be considered by the sensor.   
 str [WavelengthResolution](#a4d829d8a46f0614c7c32b78ae1602fd9) = property(fget=\_\_GetWavelengthResolution) Gets the Wavelength resolution.   
 str [WavelengthSampling](#a1a2c2043920b4b7bb6308cb22e73ec13) = property(fget=\_\_GetWavelengthSampling, fset=\_\_SetWavelengthSampling) Gets or sets the wavelength sampling.   
 str [WavelengthStart](#a93c3bc11064cbd8e5885016a97877d3e) = property(fget=\_\_GetWavelengthStart, fset=\_\_SetWavelengthStart) Gets or sets the lower value of the wavelength range to be considered by the sensor.   
 str [WhiteBalanceBlueSpectrumFilePath](#ac58c98d60a2003a39c7b14f1cfb72589) = property(fget=\_\_GetWhiteBalanceBlueSpectrumFilePath, fset=\_\_SetWhiteBalanceBlueSpectrumFilePath) Gets or sets the white balance blue spectrum file path.   
 str [WhiteBalanceGreenSpectrumFilePath](#abeda2924267b2e290da58a7375b9e53f) = property(fget=\_\_GetWhiteBalanceGreenSpectrumFilePath, fset=\_\_SetWhiteBalanceGreenSpectrumFilePath) Gets or sets the white balance green spectrum file path.   
 str [WhiteBalanceMode](#a956903ef214a82a051a7da04daf016e7) = property(fget=\_\_GetWhiteBalanceMode, fset=\_\_SetWhiteBalanceMode) Gets or sets the white balance mode.   
 str [WhiteBalanceRedSpectrumFilePath](#aa9dd2b1b7befe069a71b4c454521f21d) = property(fget=\_\_GetWhiteBalanceRedSpectrumFilePath, fset=\_\_SetWhiteBalanceRedSpectrumFilePath) Gets or sets the white balance red spectrum file path.   
 str [Width](#a096a0624e4fd3f618dc24f10ca3d695c) = property(fget=\_\_GetWidth, fset=\_\_SetWidth) Gets or sets the width .   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') <a id="details" name="details"></a>## 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

<a id="aa84cc20a2aa99d1c8ff2ff353cb0923a" name="aa84cc20a2aa99d1c8ff2ff353cb0923a"></a>## [◆ ](#aa84cc20a2aa99d1c8ff2ff353cb0923a)UpdateWavelengthSamplingFromResolution()

  'None' UpdateWavelengthSamplingFromResolution  (  *self*,     *resolution* )

Updates the wavelength sampling from a resolution.

Parameters \[in\]ResolutionDouble.  




## Member Data Documentation

<a id="af0a012d49a5b59a4f43bb342b8c725c2" name="af0a012d49a5b59a4f43bb342b8c725c2"></a>## [◆ ](#af0a012d49a5b59a4f43bb342b8c725c2)AxisSystem

 str [AxisSystem](class_speos_n_x__2412_1_1_axis_system.xhtml) = property(fget=\_\_GetAxisSystem)  static 

Gets the Axis System of the Sensor.

**Value type**: AxisSystem object.





<a id="a71412030c05833590a9a336cc1f08f49" name="a71412030c05833590a9a336cc1f08f49"></a>## [◆ ](#a71412030c05833590a9a336cc1f08f49)BlueGain

 str BlueGain = property(fget=\_\_GetBlueGain, fset=\_\_SetBlueGain)  static 

Gets or sets the blue gain.

**Prerequisite**: The WhiteBalanceMode property must be 2.

**Value type**: Double.

The default value is 1.0.





<a id="a932c5ab6f914702d97b2a6bbeaf6d434" name="a932c5ab6f914702d97b2a6bbeaf6d434"></a>## [◆ ](#a932c5ab6f914702d97b2a6bbeaf6d434)CameraMode

 str CameraMode = property(fget=\_\_GetCameraMode, fset=\_\_SetCameraMode)  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.





<a id="ae310087df32e1820a6892c84c983fe4a" name="ae310087df32e1820a6892c84c983fe4a"></a>## [◆ ](#ae310087df32e1820a6892c84c983fe4a)ColorMode

 str ColorMode = property(fget=\_\_GetColorMode, fset=\_\_SetColorMode)  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.





<a id="a4d9c18ae8c1b3cb4ad9955acea263bf5" name="a4d9c18ae8c1b3cb4ad9955acea263bf5"></a>## [◆ ](#a4d9c18ae8c1b3cb4ad9955acea263bf5)DisplayAperture

 str DisplayAperture = property(fget=\_\_GetDisplayAperture, fset=\_\_SetDisplayAperture)  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.





<a id="aada3a30677e9030fceb3e874b74582d8" name="aada3a30677e9030fceb3e874b74582d8"></a>## [◆ ](#aada3a30677e9030fceb3e874b74582d8)DisplayCameraField

 str DisplayCameraField = property(fget=\_\_GetDisplayCameraField, fset=\_\_SetDisplayCameraField)  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.





<a id="ae62d490c1685125c77ecc4b6482767a2" name="ae62d490c1685125c77ecc4b6482767a2"></a>## [◆ ](#ae62d490c1685125c77ecc4b6482767a2)DisplayObjectField

 str DisplayObjectField = property(fget=\_\_GetDisplayObjectField, fset=\_\_SetDisplayObjectField)  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.





<a id="ac2983e1196890b29cbeda75b824a9344" name="ac2983e1196890b29cbeda75b824a9344"></a>## [◆ ](#ac2983e1196890b29cbeda75b824a9344)DistortionFilePath

 str DistortionFilePath = property(fget=\_\_GetDistortionFilePath, fset=\_\_SetDistortionFilePath)  static 

Gets or sets the distortion file path.

**Value type**: String.

The default value is an empty file path (string).





<a id="a3a76a25b83be29a1eaf4f98dd4d39bd5" name="a3a76a25b83be29a1eaf4f98dd4d39bd5"></a>## [◆ ](#a3a76a25b83be29a1eaf4f98dd4d39bd5)FNumber

 str FNumber = property(fget=\_\_GetFNumber, fset=\_\_SetFNumber)  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.





<a id="ae8cfcee5f004bdc568f323c19de9f430" name="ae8cfcee5f004bdc568f323c19de9f430"></a>## [◆ ](#ae8cfcee5f004bdc568f323c19de9f430)FocalLength

 str FocalLength = property(fget=\_\_GetFocalLength, fset=\_\_SetFocalLength)  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.





<a id="ac2c4a2fbb62c65cc6cbec857ca9919da" name="ac2c4a2fbb62c65cc6cbec857ca9919da"></a>## [◆ ](#ac2c4a2fbb62c65cc6cbec857ca9919da)GammaCorrection

 str GammaCorrection = property(fget=\_\_GetGammaCorrection, fset=\_\_SetGammaCorrection)  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.





<a id="ab295b63fcc4308c1953aa8d0b01cb8e7" name="ab295b63fcc4308c1953aa8d0b01cb8e7"></a>## [◆ ](#ab295b63fcc4308c1953aa8d0b01cb8e7)GreenGain

 str GreenGain = property(fget=\_\_GetGreenGain, fset=\_\_SetGreenGain)  static 

Gets or sets the green gain.

**Prerequisite**: The WhiteBalanceMode property must be 2.

**Value type**: Double.

The default value is 1.0.





<a id="a37eb7401ae5f6ba4e112d3909cae96f0" name="a37eb7401ae5f6ba4e112d3909cae96f0"></a>## [◆ ](#a37eb7401ae5f6ba4e112d3909cae96f0)Height

 str Height = property(fget=\_\_GetHeight, fset=\_\_SetHeight)  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.





<a id="a02946d0fe38b0f9101891760028ffc57" name="a02946d0fe38b0f9101891760028ffc57"></a>## [◆ ](#a02946d0fe38b0f9101891760028ffc57)HorizontalFOV

 str HorizontalFOV = property(fget=\_\_GetHorizontalFOV)  static 

Gets the Horizontal Field of View.

**Value type**: Double.





<a id="afcfe41111470f3b67568e5a8f450d8c2" name="afcfe41111470f3b67568e5a8f450d8c2"></a>## [◆ ](#afcfe41111470f3b67568e5a8f450d8c2)HorizontalPixels

 str HorizontalPixels = property(fget=\_\_GetHorizontalPixels, fset=\_\_SetHorizontalPixels)  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.





<a id="a6141870e7231b921a2386d327823c395" name="a6141870e7231b921a2386d327823c395"></a>## [◆ ](#a6141870e7231b921a2386d327823c395)ImagerDistance

 str ImagerDistance = property(fget=\_\_GetImagerDistance, fset=\_\_SetImagerDistance)  static 

Gets or sets the Image Distance.

**Value type**: Double (in mm).

The default value is 15.0 mm.





<a id="a80837300dfb3751c003ebb2bce3946ef" name="a80837300dfb3751c003ebb2bce3946ef"></a>## [◆ ](#a80837300dfb3751c003ebb2bce3946ef)Layer

 str Layer = property(fget=\_\_GetLayer, fset=\_\_SetLayer)  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.





<a id="adddf71612af0ed60c665af22d2713147" name="adddf71612af0ed60c665af22d2713147"></a>## [◆ ](#adddf71612af0ed60c665af22d2713147)PNGBits

 str PNGBits = property(fget=\_\_GetPNGBits, fset=\_\_SetPNGBits)  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.





<a id="af0399142a4ec64706903368ba8de0c53" name="af0399142a4ec64706903368ba8de0c53"></a>## [◆ ](#af0399142a4ec64706903368ba8de0c53)RedGain

 str RedGain = property(fget=\_\_GetRedGain, fset=\_\_SetRedGain)  static 

Gets or sets the red gain.

**Prerequisite**: The WhiteBalanceMode property must be 2.

**Value type**: Double.

The default value is 1.0.





<a id="a4925a1b3c302e7273aa7bf211d9a356a" name="a4925a1b3c302e7273aa7bf211d9a356a"></a>## [◆ ](#a4925a1b3c302e7273aa7bf211d9a356a)SensitivityBlueSpectrumFilePath

 str SensitivityBlueSpectrumFilePath = property(fget=\_\_GetSensitivityBlueSpectrumFilePath, fset=\_\_SetSensitivityBlueSpectrumFilePath)  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).





<a id="af68d2d4690da9703d4747c7dc6c3fdc7" name="af68d2d4690da9703d4747c7dc6c3fdc7"></a>## [◆ ](#af68d2d4690da9703d4747c7dc6c3fdc7)SensitivityGreenSpectrumFilePath

 str SensitivityGreenSpectrumFilePath = property(fget=\_\_GetSensitivityGreenSpectrumFilePath, fset=\_\_SetSensitivityGreenSpectrumFilePath)  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).





<a id="a129349ebf40f40194471213480321380" name="a129349ebf40f40194471213480321380"></a>## [◆ ](#a129349ebf40f40194471213480321380)SensitivityMonochromaticSpectrumFilePath

 str SensitivityMonochromaticSpectrumFilePath = property(fget=\_\_GetSensitivityMonochromaticSpectrumFilePath, fset=\_\_SetSensitivityMonochromaticSpectrumFilePath)  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).





<a id="acb311777bc46345b76b598eab8c451b6" name="acb311777bc46345b76b598eab8c451b6"></a>## [◆ ](#acb311777bc46345b76b598eab8c451b6)SensitivityRedSpectrumFilePath

 str SensitivityRedSpectrumFilePath = property(fget=\_\_GetSensitivityRedSpectrumFilePath, fset=\_\_SetSensitivityRedSpectrumFilePath)  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).





<a id="a54bf4cfb85bbf3048ae57ed6bc80b6c3" name="a54bf4cfb85bbf3048ae57ed6bc80b6c3"></a>## [◆ ](#a54bf4cfb85bbf3048ae57ed6bc80b6c3)TransmittanceFilePath

 str TransmittanceFilePath = property(fget=\_\_GetTransmittanceFilePath, fset=\_\_SetTransmittanceFilePath)  static 

Gets or sets the transmittance file path.

**Value type**: String.

The default value is an empty file path (string).





<a id="a90171c807ee2c2cb739641ea43588724" name="a90171c807ee2c2cb739641ea43588724"></a>## [◆ ](#a90171c807ee2c2cb739641ea43588724)VerticalFOV

 str VerticalFOV = property(fget=\_\_GetVerticalFOV)  static 

Gets the Vertical Field of View.

**Value type**: Double.





<a id="a8cf6ebb154d8cc9926c500c352fd53a4" name="a8cf6ebb154d8cc9926c500c352fd53a4"></a>## [◆ ](#a8cf6ebb154d8cc9926c500c352fd53a4)VerticalPixels

 str VerticalPixels = property(fget=\_\_GetVerticalPixels, fset=\_\_SetVerticalPixels)  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.





<a id="a043232eb7c476f89c1ed105dfb49b30d" name="a043232eb7c476f89c1ed105dfb49b30d"></a>## [◆ ](#a043232eb7c476f89c1ed105dfb49b30d)VisualizationRadius

 str VisualizationRadius = property(fget=\_\_GetVisualizationRadius, fset=\_\_SetVisualizationRadius)  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.





<a id="a1d3af865fff16f6eb31305404623a867" name="a1d3af865fff16f6eb31305404623a867"></a>## [◆ ](#a1d3af865fff16f6eb31305404623a867)WavelengthEnd

 str WavelengthEnd = property(fget=\_\_GetWavelengthEnd, fset=\_\_SetWavelengthEnd)  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.





<a id="a4d829d8a46f0614c7c32b78ae1602fd9" name="a4d829d8a46f0614c7c32b78ae1602fd9"></a>## [◆ ](#a4d829d8a46f0614c7c32b78ae1602fd9)WavelengthResolution

 str WavelengthResolution = property(fget=\_\_GetWavelengthResolution)  static 

Gets the Wavelength resolution.

**Prerequisite**: The CameraMode property must be 1.

**Value type**: Double.





<a id="a1a2c2043920b4b7bb6308cb22e73ec13" name="a1a2c2043920b4b7bb6308cb22e73ec13"></a>## [◆ ](#a1a2c2043920b4b7bb6308cb22e73ec13)WavelengthSampling

 str WavelengthSampling = property(fget=\_\_GetWavelengthSampling, fset=\_\_SetWavelengthSampling)  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.





<a id="a93c3bc11064cbd8e5885016a97877d3e" name="a93c3bc11064cbd8e5885016a97877d3e"></a>## [◆ ](#a93c3bc11064cbd8e5885016a97877d3e)WavelengthStart

 str WavelengthStart = property(fget=\_\_GetWavelengthStart, fset=\_\_SetWavelengthStart)  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.





<a id="ac58c98d60a2003a39c7b14f1cfb72589" name="ac58c98d60a2003a39c7b14f1cfb72589"></a>## [◆ ](#ac58c98d60a2003a39c7b14f1cfb72589)WhiteBalanceBlueSpectrumFilePath

 str WhiteBalanceBlueSpectrumFilePath = property(fget=\_\_GetWhiteBalanceBlueSpectrumFilePath, fset=\_\_SetWhiteBalanceBlueSpectrumFilePath)  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).





<a id="abeda2924267b2e290da58a7375b9e53f" name="abeda2924267b2e290da58a7375b9e53f"></a>## [◆ ](#abeda2924267b2e290da58a7375b9e53f)WhiteBalanceGreenSpectrumFilePath

 str WhiteBalanceGreenSpectrumFilePath = property(fget=\_\_GetWhiteBalanceGreenSpectrumFilePath, fset=\_\_SetWhiteBalanceGreenSpectrumFilePath)  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).





<a id="a956903ef214a82a051a7da04daf016e7" name="a956903ef214a82a051a7da04daf016e7"></a>## [◆ ](#a956903ef214a82a051a7da04daf016e7)WhiteBalanceMode

 str WhiteBalanceMode = property(fget=\_\_GetWhiteBalanceMode, fset=\_\_SetWhiteBalanceMode)  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.





<a id="aa9dd2b1b7befe069a71b4c454521f21d" name="aa9dd2b1b7befe069a71b4c454521f21d"></a>## [◆ ](#aa9dd2b1b7befe069a71b4c454521f21d)WhiteBalanceRedSpectrumFilePath

 str WhiteBalanceRedSpectrumFilePath = property(fget=\_\_GetWhiteBalanceRedSpectrumFilePath, fset=\_\_SetWhiteBalanceRedSpectrumFilePath)  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).





<a id="a096a0624e4fd3f618dc24f10ca3d695c" name="a096a0624e4fd3f618dc24f10ca3d695c"></a>## [◆ ](#a096a0624e4fd3f618dc24f10ca3d695c)Width

 str Width = property(fget=\_\_GetWidth, fset=\_\_SetWidth)  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\_2412.py**