CVB++ 14.0
SensorSettings Class Referencefinal

Class to store camera sensor settings. More...

#include <cvb/sensor_settings.hpp>

Public Member Functions

 SensorSettings () noexcept
 Default ctor.
 
 SensorSettings (double rangeScale, SensorPixelPosition pixelPosition, SensorPixelsMirrored pixelsMirrored, Rect< int > sensorRoi, Point2D< double > resolutionReduction)
 Ctor passing sensor settings. More...
 
double RangeScale () const noexcept
 Gets range scale (z factor). More...
 
SensorPixelPosition PixelPosition () const noexcept
 Gets pixel position in y on sensor. More...
 
SensorPixelsMirrored PixelsMirrored () const noexcept
 Gets information if sensor pixels are mirrored. More...
 
Rect< int > SensorRoi () const noexcept
 Gets sensor region of interest (ROI). More...
 
Point2D< double > ResolutionReduction () const noexcept
 Gets horizontal (X) and vertical (Y) resolution reduction factors (due to binning). More...
 
bool operator== (const SensorSettings &other) const noexcept
 Compares to other sensor settings. More...
 
bool operator!= (const SensorSettings &other) const noexcept
 Compares to other sensor settings. More...
 

Detailed Description

Class to store camera sensor settings.

Creating a calibrated point cloud, the camera settings applied during the acquisition of the range map have to be known. Default settings are read from the calibrator loaded from a calibration file. If the actual settings differ from the default ones, the user has to set them and create a calibrated point cloud via function PointCloudFactory::CreateWithSettings() instead of PointCloudFactory::Create(). You can get and check the default settings from the LaserPlaneCalibrator3D object.

Constructor & Destructor Documentation

◆ SensorSettings()

SensorSettings ( double  rangeScale,
SensorPixelPosition  pixelPosition,
SensorPixelsMirrored  pixelsMirrored,
Rect< int >  sensorRoi,
Point2D< double >  resolutionReduction 
)
inline

Ctor passing sensor settings.

For a detailed description of the sensor setting for specific cameras see the CVB online help chapter "Theory of Operation -> Image Manager -> CVB Technology -> 3D Functionality -> Create Point Cloud from Range Map -> Create calibrated point cloud with modified sensor settings".

Parameters
[in]rangeScaleThe range map values will be scaled by this factor. It can be calculated from 1/2^NumSubPixel, where NumSubPixel is the number of subpixels.
[in]pixelPositionThe pixel position on the sensor in Y may be absolute or relative. If it is relative, the sensor coordinates relative to top offset of sensorRoi are used for the range map creation. If this parameter is set to absolute, top offset is 0.
[in]pixelsMirroredIf this parameter is set, the x and/or y sensor coordinates of the profile are mirrored.
[in]sensorRoiSensor region of interest (ROI).
[in]resolutionReductionHorizontal and vertical resolution reduction factor due to sensor binning.
Exceptions
Anyexception derived from std::exception.

Member Function Documentation

◆ operator!=()

bool operator!= ( const SensorSettings other) const
inlinenoexcept

Compares to other sensor settings.

Parameters
[in]otherOther sensor settings.
Returns
True if not equal, otherwise false.
Exceptions
Doesnot throw any exception.

◆ operator==()

bool operator== ( const SensorSettings other) const
inlinenoexcept

Compares to other sensor settings.

Parameters
[in]otherOther sensor settings.
Returns
True if equal, otherwise false.
Exceptions
Doesnot throw any exception.

◆ PixelPosition()

SensorPixelPosition PixelPosition ( ) const
inlinenoexcept

Gets pixel position in y on sensor.

Returns
Pixel position.
Exceptions
Doesnot throw any exception.

◆ PixelsMirrored()

SensorPixelsMirrored PixelsMirrored ( ) const
inlinenoexcept

Gets information if sensor pixels are mirrored.

Returns
Information if sensor pixels are mirrored.
Exceptions
Doesnot throw any exception.

◆ RangeScale()

double RangeScale ( ) const
inlinenoexcept

Gets range scale (z factor).

Returns
Range scale.
Exceptions
Doesnot throw any exception.

◆ ResolutionReduction()

Point2D< double > ResolutionReduction ( ) const
inlinenoexcept

Gets horizontal (X) and vertical (Y) resolution reduction factors (due to binning).

Returns
Resolution reduction factors.
Exceptions
Doesnot throw any exception.

◆ SensorRoi()

Rect< int > SensorRoi ( ) const
inlinenoexcept

Gets sensor region of interest (ROI).

Returns
Sensor ROI.
Exceptions
Doesnot throw any exception.