Stereo Control

Functions and classes for controlling stereo-specific parameters. More...

Classes
struct	StreamTransmitFlags
class	StereoParameters
	Class for handling parameters of the S3D camera. More...

Functions
bool	PrintCameraCalibrationParams (INodeMap &nodeMap)
	Prints the camera calibration parameters.
bool	PrintSGBM_params (CameraPtr pCam)
	Retrieves the camera SGBM related parameters.
bool	GetScan3dCoordinateScale (INodeMap &nodeMap, float &scaleFactor)
	Retrieves the disparity scale factor (the factor to multiply to get from integer value to sub-pixel (floating point) disparity).
bool	GetScan3dCoordinateOffset (INodeMap &nodeMap, float &coordinateOffset)
	Retrieves the coordinateOffset parameter.
bool	GetScan3dInvalidDataFlag (INodeMap &nodeMap, bool &scan3dInvalidDataFlag)
	Retrieves the scan3dInvalidDataFlag parameter.
bool	GetScan3dInvalidDataValue (INodeMap &nodeMap, float &scan3dInvalidDataValue)
	Retrieves the scan3dInvalidDataValue parameter.
bool	GetScan3dFocalLength (INodeMap &nodeMap, float &focalLength)
	Retrieves the focal length of the reference camera.
bool	GetScan3dPrincipalPoint (INodeMap &nodeMap, float &principalPointV, float &principalPointU)
	Retrieves the image center coordinates of the reference camera in pixels.
bool	GetScan3dBaseLine (INodeMap &nodeMap, float &baseline)
	Retrieves the baseline distance between the stereo cameras in meters.
bool	SetSGBM_params (CameraPtr pCam, StereoParameters &camParameters)
	Sets up the Semi-Global Block Matching algorithm parameters.
bool	PrintCameraCalibrationParams (CameraPtr pCam)
	Prints the camera calibration parameters.
bool	GetScan3dFocalLength (CameraPtr pCam, float &focalLength)
	Retrieves the focal length of the reference camera.
bool	GetScan3dPrincipalPoint (CameraPtr pCam, float &principalPointV, float &principalPointU)
	Retrieves the image center coordinates of the reference camera in pixels.
bool	GetScan3dBaseLine (CameraPtr pCam, float &baseline)
	Retrieves the baseline distance between the stereo cameras in meters.

Detailed Description

Functions and classes for controlling stereo-specific parameters.

Function Documentation

GetScan3dBaseLine() [1/2]

bool GetScan3dBaseLine	(	CameraPtr	pCam,
		float &	baseline
	)

Retrieves the baseline distance between the stereo cameras in meters.

Parameters

pCam	Reference to the camera.
baseline	Variable to store the baseline distance.

Returns

True if successful, false otherwise.

GetScan3dBaseLine() [2/2]

bool GetScan3dBaseLine	(	INodeMap &	nodeMap,
		float &	baseline
	)

Retrieves the baseline distance between the stereo cameras in meters.

Parameters

baseline

Variable to store the baseline distance.

Returns

True if successful, false otherwise.

GetScan3dCoordinateOffset()

bool GetScan3dCoordinateOffset	(	INodeMap &	nodeMap,
		float &	coordinateOffset
	)

Retrieves the coordinateOffset parameter.

Parameters

nodeMap	the node map to read the coordinateOffset parameter value from.
coordinateOffset	Variable to store the min disparity parameter.

Returns

True if successful, false otherwise.

GetScan3dCoordinateScale()

bool GetScan3dCoordinateScale	(	INodeMap &	nodeMap,
		float &	scaleFactor
	)

Retrieves the disparity scale factor (the factor to multiply to get from integer value to sub-pixel (floating point) disparity).

Parameters

nodeMap	the node map to read the scaleFactor parameter value from.
scaleFactor	Variable to store the scale factor for the disparity.

Returns

True if successful, false otherwise.

GetScan3dFocalLength() [1/2]

bool GetScan3dFocalLength	(	CameraPtr	pCam,
		float &	focalLength
	)

Retrieves the focal length of the reference camera.

Parameters

pCam	Reference to the camera.
focalLength	Variable to store the focal length.

Returns

True if successful, false otherwise.

GetScan3dFocalLength() [2/2]

bool GetScan3dFocalLength	(	INodeMap &	nodeMap,
		float &	focalLength
	)

Retrieves the focal length of the reference camera.

Parameters

focalLength

Variable to store the focal length.

Returns

True if successful, false otherwise.

GetScan3dInvalidDataFlag()

bool GetScan3dInvalidDataFlag	(	INodeMap &	nodeMap,
		bool &	scan3dInvalidDataFlag
	)

Retrieves the scan3dInvalidDataFlag parameter.

Parameters

nodeMap	the node map to read the invalidDataFlag parameter value from.
scan3dInvalidDataFlag	Variable to store the invalidDataFlag parameter.

Returns

True if successful, false otherwise.

GetScan3dInvalidDataValue()

bool GetScan3dInvalidDataValue	(	INodeMap &	nodeMap,
		float &	scan3dInvalidDataValue
	)

Retrieves the scan3dInvalidDataValue parameter.

Parameters

scan3dInvalidDataValue

Variable to store the scan3dInvalidDataValue parameter.

Returns

True if successful, false otherwise.

GetScan3dPrincipalPoint() [1/2]

bool GetScan3dPrincipalPoint	(	CameraPtr	pCam,
		float &	principalPointV,
		float &	principalPointU
	)

Retrieves the image center coordinates of the reference camera in pixels.

Parameters

pCam	Reference to the camera.
principalPointV	Variable to store the row center (cy) of the camera image.
principalPointU	Variable to store the column center (cx) of the camera image.

Returns

True if successful, false otherwise.

GetScan3dPrincipalPoint() [2/2]

bool GetScan3dPrincipalPoint	(	INodeMap &	nodeMap,
		float &	principalPointV,
		float &	principalPointU
	)

Retrieves the image center coordinates of the reference camera in pixels.

Parameters

principalPointV	Variable to store the row center (cy) of the camera image.
principalPointU	Variable to store the column center (cx) of the camera image.

Returns

True if successful, false otherwise.

PrintCameraCalibrationParams() [1/2]

bool PrintCameraCalibrationParams

(

CameraPtr

pCam

)

Prints the camera calibration parameters.

Parameters

pCam	Reference to the camera.

Returns

True if successful, false otherwise.

PrintCameraCalibrationParams() [2/2]

bool PrintCameraCalibrationParams

(

INodeMap &

nodeMap

)

Prints the camera calibration parameters.

Returns

True if successful, false otherwise.

PrintSGBM_params()

bool PrintSGBM_params

(

CameraPtr

pCam

)

Retrieves the camera SGBM related parameters.

Returns

True if successful, false otherwise.

Parameters

pCam	Reference to the camera.

Returns

True if successful, false otherwise.

SetSGBM_params()

bool SetSGBM_params	(	CameraPtr	pCam,
		StereoParameters &	camParameters
	)

Sets up the Semi-Global Block Matching algorithm parameters.

Parameters

camParameters

Pointer to the camera parameters.

Returns

True if successful, false otherwise.

Parameters

pCam	Reference to the camera.
camParameters	Pointer to the camera parameters.

Returns

True if successful, false otherwise.