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

struct	StreamTransmitFlags

Enumerations
enum	NodeMapType { NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 }

enum	NodeMapType { NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 }

enum	NodeMapType { NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 , NodeMapType_Camera = 0 , NodeMapType_TLStream = 1 }

Functions
bool	IsDeviceBumblebeeX (CameraPtr pCam)

gcstring	GetSerialNumber (CameraPtr pCam)

bool	ConfigureGVCPHeartbeat (CameraPtr pCam, bool doEnable)
	Configures the GVCP heartbeat setting.

bool	ResetGVCPHeartbeat (CameraPtr pCam)

bool	DisableGVCPHeartbeat (CameraPtr pCam)
	Disables the GVCP heartbeat.

bool	SetAcquisitionMode (INodeMap &nodeMap)

bool	SetStreamBufferHandlingMode (INodeMap &nodeMapTLDevice)

bool	ConfigureStereoProcessing (INodeMap &nodeMapCamera, StereoParameters &stereoParameters)

bool	ConfigureAcquisition (CameraPtr pCam, StreamTransmitFlags &streamTransmitFlags)

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	GetFloatValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, float &nodeVal)
	Gets a float value from a specified node.

bool	ConfigureCameraStreams (CameraPtr pCam, StreamTransmitFlags &streamTransmitFlags)
	Configures the camera streams.

bool	SetSGBM_params (CameraPtr pCam, StereoParameters &camParameters)
	Sets up the Semi-Global Block Matching algorithm parameters.

bool	EnableAutoExposure (CameraPtr pCam)
	Enables automatic exposure.

bool	GetExposureTime (CameraPtr pCam, double &exposureTime)
	Retrieves the current exposure time.

bool	GetBooleanValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, bool &nodeVal)
	Gets a boolean value from a specified node.

bool	GetIntValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, int64_t &nodeVal)
	Gets an integer value from a specified node.

bool	GetMaxIntValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, int64_t &nodeVal)
	Gets the max integer value for a specified node.

bool	GetMaxFloatValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, float &nodeVal)
	Gets the max float value for a specified node.

bool	GetEnumValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, int64_t &enumVal)
	Gets an enumerated (int) value from a specified node.

bool	GetEnumAsStringValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, int64_t &nodeValAsInt, gcstring &nodeValAsStr)
	Gets an enumerated string value from a specified node.

bool	GetStringValueFromNode (INodeMap &nodeMap, const gcstring &nodeName, string &nodeVal)
	Gets a string value from a specified node.

bool	SetExposureTime (CameraPtr pCam, double exposureTime)
	Sets the exposure time.

bool	EnableAutoGain (CameraPtr pCam)
	Enables automatic gain control.

bool	GetGainValue (CameraPtr pCam, double &gainValue)
	Retrieves the current gain value.

bool	SetGainValue (CameraPtr pCam, double gainValue)
	Sets the gain value.

bool	SetBooleanValueToNode (INodeMap &nodeMap, const gcstring &nodeName, bool isChecked)
	Sets a boolean value to a specified node.

bool	SetIntValueToNode (INodeMap &nodeMap, const gcstring &nodeName, int64_t nodeVal)
	Sets an integer value to a specified node.

bool	SetFloatValueToNode (INodeMap &nodeMap, const gcstring &nodeName, float nodeVal)
	Sets a double value to a specified node.

bool	SetEnumValueToNode (INodeMap &nodeMap, const gcstring &nodeName, const int64_t nodeVal, NodeMapType nodeMapType=NodeMapType_Camera)
	Sets an enumerated value to a specified node.

bool	SetEnumAsStringValueToNode (INodeMap &nodeMap, const gcstring &nodeName, gcstring nodeEnumValAsStr)
	Sets an enumerated string value to a specified node.

bool	SetStringValueToNode (INodeMap &nodeMap, const gcstring &nodeName, string &nodeVal)
	Sets a string value to a specified node.

bool	ValidateImageList (const StreamTransmitFlags &streamTransmitFlags, ImageList &imageList)

bool	GetScan3dCoordinateOffset (INodeMap &nodeMapCamera, float &coordinateOffset)
	Retrieves the coordinateOffset parameter.

bool	GetScan3dInvalidDataFlag (INodeMap &nodeMapCamera, bool &scan3dInvalidDataFlag)
	Retrieves the scan3dInvalidDataFlag parameter.

bool	GetScan3dInvalidDataValue (INodeMap &nodeMap, float &scan3dInvalidDataValue)
	Retrieves the scan3dInvalidDataValue parameter.

bool	GetTotalDisparity (CameraPtr pCam, int64_t &totalDisparity)
	Retrieves the number of disparities parameter.

bool	GetSmallPenalty (CameraPtr pCam, int64_t &smallPenalty)
	Retrieves the small penalty parameter.

bool	GetLargePenalty (CameraPtr pCam, int64_t &largePenalty)
	Retrieves the large penalty parameter.

bool	GetUniquenessRatio (CameraPtr pCam, int64_t &uniquenessRatio)
	Retrieves the SGBM Uniqueness Ratio parameter.

bool	PrintCameraCalibrationParams (INodeMap &nodeMap)
	Prints the camera calibration parameters.

bool	PrintSGBM_params (CameraPtr pCam)
	Retrieves the camera SGBM related parameters.

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	PrintDeviceInfo (INodeMap &nodeMap)
	Prints device information using a specific node map.

bool	EnableAutoWhiteBalance (CameraPtr pCam)
	Enables Automatic White Balance (AWB).

bool	SetAutoWhiteBalance (CameraPtr pCam, double redValue, double blueValue)
	Sets the Automatic White Balance (AWB) using specified red and blue values.

bool	ResetGVCPHeartbeat ()
	Resets the GVCP heartbeat to its default state.

bool	SetStreamBufferHandlingMode (CameraPtr pCam)

bool	ConfigureStereoProcessing (CameraPtr pCam, StereoParameters &stereoParameters)

bool	GetScan3dCoordinateScale (CameraPtr pCam, float &scaleFactor)
	Retrieves the disparity scale factor (the factor to multiply to get from integer value to sub-pixel (floating point) disparity).

bool	GetScan3dCoordinateOffset (CameraPtr pCam, float &coordinateOffset)
	Retrieves the coordinateOffset parameter.

bool	GetScan3dInvalidDataFlag (CameraPtr pCam, bool &scan3dInvalidDataFlag)
	Retrieves the scan3dInvalidDataFlag parameter.

bool	GetScan3dInvalidDataValue (CameraPtr pCam, float &scan3dInvalidDataValue)
	Retrieves the scan3dInvalidDataValue parameter.

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.

bool	PrintDeviceInfo (CameraPtr pCam)
	Prints device information using a specific node map.

Enumeration Type Documentation

◆ NodeMapType [1/3]

enum NodeMapType

Enumerator
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream

◆ NodeMapType [2/3]

enum NodeMapType

Enumerator
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream

◆ NodeMapType [3/3]

enum NodeMapType

Enumerator
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream
NodeMapType_Camera
NodeMapType_TLStream

Function Documentation

◆ ConfigureAcquisition()

bool ConfigureAcquisition	(	CameraPtr	pCam,
		StreamTransmitFlags &	streamTransmitFlags
	)

Examples: StereoAcquisition.cpp, StereoAcquisition_QuickSpin.cpp, and StereoGPIO.cpp.

◆ ConfigureStereoProcessing() [1/2]

bool ConfigureStereoProcessing	(	CameraPtr	pCam,
		StereoParameters &	stereoParameters
	)

◆ ConfigureStereoProcessing() [2/2]

bool ConfigureStereoProcessing	(	INodeMap &	nodeMapCamera,
		StereoParameters &	stereoParameters
	)

Examples: StereoAcquisition.cpp, and StereoAcquisition_QuickSpin.cpp.

◆ GetLargePenalty()

bool GetLargePenalty	(	CameraPtr	pCam,
		int64_t &	largePenalty
	)

Retrieves the large penalty parameter.

Parameters

largePenalty Variable to store the large penalty parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dCoordinateOffset() [1/2]

bool GetScan3dCoordinateOffset	(	CameraPtr	pCam,
		float &	coordinateOffset
	)

Retrieves the coordinateOffset parameter.

Parameters

coordinateOffset Variable to store the min disparity parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dCoordinateOffset() [2/2]

bool GetScan3dCoordinateOffset	(	INodeMap &	nodeMapCamera,
		float &	coordinateOffset
	)

Retrieves the coordinateOffset parameter.

Parameters

coordinateOffset Variable to store the min disparity parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dCoordinateScale() [1/2]

bool GetScan3dCoordinateScale	(	CameraPtr	pCam,
		float &	scaleFactor
	)

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

Parameters

scaleFactor Variable to store the scale factor for the disparity.

Returns: True if successful, false otherwise.

◆ GetScan3dCoordinateScale() [2/2]

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

scaleFactor Variable to store the scale factor for the disparity.

Returns: True if successful, false otherwise.

◆ GetScan3dInvalidDataFlag() [1/2]

bool GetScan3dInvalidDataFlag	(	CameraPtr	pCam,
		bool &	scan3dInvalidDataFlag
	)

Retrieves the scan3dInvalidDataFlag parameter.

Parameters

scan3dInvalidDataFlag Variable to store the invalidDataFlag parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dInvalidDataFlag() [2/2]

bool GetScan3dInvalidDataFlag	(	INodeMap &	nodeMapCamera,
		bool &	scan3dInvalidDataFlag
	)

Retrieves the scan3dInvalidDataFlag parameter.

Parameters

scan3dInvalidDataFlag Variable to store the invalidDataFlag parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dInvalidDataValue() [1/2]

bool GetScan3dInvalidDataValue	(	CameraPtr	pCam,
		float &	scan3dInvalidDataValue
	)

Retrieves the scan3dInvalidDataValue parameter.

Parameters

scan3dInvalidDataValue Variable to store the scan3dInvalidDataValue parameter.

Returns: True if successful, false otherwise.

◆ GetScan3dInvalidDataValue() [2/2]

bool GetScan3dInvalidDataValue	(	INodeMap &	nodeMap,
		float &	scan3dInvalidDataValue
	)

Retrieves the scan3dInvalidDataValue parameter.

Parameters

scan3dInvalidDataValue Variable to store the scan3dInvalidDataValue parameter.

Returns: True if successful, false otherwise.

◆ GetSerialNumber()

gcstring GetSerialNumber ( CameraPtr pCam )

◆ GetSmallPenalty()

bool GetSmallPenalty	(	CameraPtr	pCam,
		int64_t &	smallPenalty
	)

Retrieves the small penalty parameter.

Parameters

smallPenalty Variable to store the small penalty parameter.

Returns: True if successful, false otherwise.

◆ GetTotalDisparity()

bool GetTotalDisparity	(	CameraPtr	pCam,
		int64_t &	totalDisparity
	)

Retrieves the number of disparities parameter.

Parameters

totalDisparity Variable to store the number of disparities parameter.

Returns: True if successful, false otherwise.

◆ GetUniquenessRatio()

bool GetUniquenessRatio	(	CameraPtr	pCam,
		int64_t &	uniquenessRatio
	)

Retrieves the SGBM Uniqueness Ratio parameter.

Parameters

uniquenessRatio Variable to store the SGBM Uniqueness Ratio parameter.

Returns: True if successful, false otherwise.

◆ IsDeviceBumblebeeX()

bool IsDeviceBumblebeeX ( CameraPtr pCam )

◆ ResetGVCPHeartbeat()

bool ResetGVCPHeartbeat ( CameraPtr pCam )

◆ SetAcquisitionMode()

bool SetAcquisitionMode ( INodeMap & nodeMap )

◆ SetStreamBufferHandlingMode() [1/2]

bool SetStreamBufferHandlingMode ( CameraPtr pCam )

◆ SetStreamBufferHandlingMode() [2/2]

bool SetStreamBufferHandlingMode ( INodeMap & nodeMapTLDevice )

◆ ValidateImageList()

bool ValidateImageList	(	const StreamTransmitFlags &	streamTransmitFlags,
		ImageList &	imageList
	)

Examples: StereoAcquisition.cpp, StereoAcquisition_QuickSpin.cpp, and StereoGPIO.cpp.

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ NodeMapType [1/3]

◆ NodeMapType [2/3]

◆ NodeMapType [3/3]

Function Documentation

◆ ConfigureAcquisition()

◆ ConfigureStereoProcessing() [1/2]

◆ ConfigureStereoProcessing() [2/2]

◆ GetLargePenalty()

◆ GetScan3dCoordinateOffset() [1/2]

◆ GetScan3dCoordinateOffset() [2/2]

◆ GetScan3dCoordinateScale() [1/2]

◆ GetScan3dCoordinateScale() [2/2]

◆ GetScan3dInvalidDataFlag() [1/2]

◆ GetScan3dInvalidDataFlag() [2/2]

◆ GetScan3dInvalidDataValue() [1/2]

◆ GetScan3dInvalidDataValue() [2/2]

◆ GetSerialNumber()

◆ GetSmallPenalty()

◆ GetTotalDisparity()

◆ GetUniquenessRatio()

◆ IsDeviceBumblebeeX()

◆ ResetGVCPHeartbeat()

◆ SetAcquisitionMode()

◆ SetStreamBufferHandlingMode() [1/2]

◆ SetStreamBufferHandlingMode() [2/2]

◆ ValidateImageList()