Detailed Description

Allows for configuration of the parameters of a Nerian stereo device through a network connection.

Parameters are read and written through a TCP connection. Not all parameters that are available in the web interface can be configured through this class.

If parameters are changed, they are only valid until the device is rebooted or until a parameter change is performed through the web interface.

Since device parameters should be predictable at all times, the functions from this class will internally throw a visiontransfer::TransferException in case of network failure or device reinitialization during parameter access. Please catch this exception if you wish to handle such cases.

Definition at line 62 of file deviceparameters.h.

#include <visiontransfer/deviceparameters.h>

Classes
class	Pimpl

Public Types
enum	OperationMode { PASS_THROUGH = 0, RECTIFY = 1, STEREO_MATCHING = 2 }
	Operation modes supported by Nerian stereo devices. More...

enum	AutoMode { AUTO_EXPOSURE_AND_GAIN = 0, AUTO_EXPOSURE_MANUAL_GAIN = 1, MANUAL_EXPOSORE_AUTO_GAIN = 2, MANUAL_EXPOSURE_MANUAL_GAIN = 3 }
	Possible modes of the automatic exposure and gain control. More...

enum	TargetFrame { LEFT_FRAME = 0, RIGHT_FRAME = 1, BOTH_FRAMES = 2 }
	Possible options for the target frame selection of the automatic exposure and gain control. More...

enum	TriggerInputMode { INTERNAL = 0, EXTERNAL = 1, SOFTWARE = 2 }
	Trigger input modes supported by Nerian stereo devices. More...

Public Member Functions
	DeviceParameters (const DeviceInfo &device)
	Connects to parameter server of a Nerian stereo device by using the device information from device enumeration. More...

	DeviceParameters (const char address, const char service="7683")
	Connects to parameter server of a Nerian stereo device by using a network address. More...

OperationMode	getOperationMode ()
	Gets the current operation mode. More...

void	setOperationMode (OperationMode mode)
	Configures the device to a new operation mode. More...

int	getDisparityOffset ()
	Gets the current offset of the evaluated disparity range. More...

void	setDisparityOffset (int offset)
	Sets the offset of the evaluated disparity range. More...

int	getStereoMatchingP1Edge ()
	Gets the SGM penalty P1 for small disparity changes at image edges. More...

void	setStereoMatchingP1Edge (int p1)
	Sets the SGM penalty P1 for small disparity changes at image edges. More...

int	getStereoMatchingP1NoEdge ()
	Gets the SGM penalty P1 for small disparity changes outside image edges. More...

void	setStereoMatchingP1NoEdge (int p1)
	Sets the SGM penalty P1 for small disparity changes outside image edges. More...

int	getStereoMatchingP2Edge ()
	Gets the SGM penalty P2 for large disparity changes at image edges. More...

void	setStereoMatchingP2Edge (int p2)
	Sets the SGM penalty P2 for large disparity changes at image edges. More...

int	getStereoMatchingP2NoEdge ()
	Gets the SGM penalty P2 for large disparity changes at image edges. More...

void	setStereoMatchingP2NoEdge (int p2)
	Sets the SGM penalty P2 for large disparity changes at image edges. More...

int	getStereoMatchingEdgeSensitivity ()
	Gets the edge sensitivity of the SGM algorithm. More...

void	setStereoMatchingEdgeSensitivity (int sensitivity)
	Sets the edge sensitivity of the SGM algorithm. More...

bool	getMaskBorderPixelsEnabled ()
	Returns true if border pixels are removed from the computed disparity map. More...

void	setMaskBorderPixelsEnabled (bool enabled)
	Enables or disables the removal of border pixels from the computed disparity map. More...

bool	getConsistencyCheckEnabled ()
	Returns true if the consistency check is enabled. More...

void	setConsistencyCheckEnabled (bool enabled)
	Enables or disables the consistency check. More...

int	getConsistencyCheckSensitivity ()
	Gets the current sensitivity value for the consistency check. More...

void	setConsistencyCheckSensitivity (int sensitivity)
	Sets a new sensitivity value for the consistency check. More...

bool	getUniquenessCheckEnabled ()
	Returns true if the consistency check is enabled. More...

void	setUniquenessCheckEnabled (bool enabled)
	Enables or disables the uniqueness check. More...

int	getUniquenessCheckSensitivity ()
	Gets the current sensitivity value for the uniqueness check. More...

void	setUniquenessCheckSensitivity (int sensitivity)
	Sets a new sensitivity value for the uniqueness check. More...

bool	getTextureFilterEnabled ()
	Returns true if the texture filter is enabled. More...

void	setTextureFilterEnabled (bool enabled)
	Enables or disables the texture filter. More...

int	getTextureFilterSensitivity ()
	Gets the current sensitivity value for the texture filter. More...

void	setTextureFilterSensitivity (int sensitivity)
	Sets a new sensitivity value for the texture filter. More...

bool	getGapInterpolationEnabled ()
	Returns true if the texture gap interpolation is enabled. More...

void	setGapInterpolationEnabled (bool enabled)
	Enables or disables the gap interpolation. More...

bool	getNoiseReductionEnabled ()
	Returns true if the noise reduction filter is enabled. More...

void	setNoiseReductionEnabled (bool enabled)
	Enables or disables the noise reduction filter. More...

int	getSpeckleFilterIterations ()
	Returns true if the speckle filter is enabled. More...

void	setSpeckleFilterIterations (int iter)
	Enables or disables the speckle filter. More...

AutoMode	getAutoMode ()
	Gets the current mode of the automatic exposure and gain control. More...

void	setAutoMode (AutoMode mode)
	Sets the current mode of the automatic exposure and gain control. More...

double	getAutoTargetIntensity ()
	Gets the target image intensity of the automatic exposure and gain control. More...

void	setAutoTargetIntensity (double intensity)
	Sets the target image intensity of the automatic exposure and gain control. More...

double	getAutoIntensityDelta ()
	Gets the minimum intensity change that is required for adjusting the camera settings. More...

void	setAutoIntensityDelta (double delta)
	Sets the minimum intensity change that is required for adjusting the camera settings. More...

TargetFrame	getAutoTargetFrame ()
	Gets the selected target frame for automatic exposure and gain control. More...

void	setAutoTargetFrame (TargetFrame target)
	Selects the target frame for automatic exposure and gain control. More...

int	getAutoSkippedFrames ()
	Gets the current interval at which the automatic exposure and gain control is run. More...

void	setAutoSkippedFrames (int skipped)
	Sets the current interval at which the automatic exposure and gain control is run. More...

double	getAutoMaxExposureTime ()
	Gets the maximum exposure time that can be selected automatically. More...

void	setAutoMaxExposureTime (double time)
	Sets the maximum exposure time that can be selected automatically. More...

double	getAutoMaxGain ()
	Gets the maximum gain that can be selected automatically. More...

void	setAutoMaxGain (double gain)
	Gets the maximum gain that can be selected automatically. More...

double	getManualExposureTime ()
	Gets the manually selected exposure time. More...

void	setManualExposureTime (double time)
	Sets the manually selected exposure time. More...

double	getManualGain ()
	Gets the manually selected gain. More...

void	setManualGain (double gain)
	Sets the manually selected gain. More...

bool	getAutoROIEnabled ()
	Returns true if an ROI for automatic exposure and gain control is enabled. More...

void	setAutoROIEnabled (bool enabled)
	Enables or disables an ROI for automatic exposure and gain control. More...

void	getAutoROI (int &x, int &y, int &width, int &height)
	Gets the configured ROI for automatic exposure and gain control. More...

void	setAutoROI (int x, int y, int width, int height)
	Sets the configured ROI for automatic exposure and gain control. More...

int	getMaxFrameTimeDifference ()
	Gets the maximum allowed time difference between two corresponding frames. More...

void	setMaxFrameTimeDifference (int diffMs)
	Sets the maximum allowed time difference between two corresponding frames. More...

double	getTriggerFrequency ()
	Gets the frequency of the trigger signal. More...

void	setTriggerFrequency (double freq)
	Sets the frequency of the trigger signal. More...

bool	getTrigger0Enabled ()
	Returns true if trigger signal 0 is enabled. More...

void	setTrigger0Enabled (bool enabled)
	Enables or disables trigger signal 0. More...

bool	getTrigger0Constant ()
	Returns the constant value that is output when trigger 0 is disabled. More...

void	setTrigger0Constant (bool on)
	Sets the constant value that is output when trigger 0 is disabled. More...

bool	getTrigger0Polarity ()
	Returns false if trigger0 polarity is active-high (non-inverted) and false if polarity is active-low (inverted) More...

void	setTrigger0Polarity (bool invert)
	Sets the polarity for trigger0. If invert is false, the polarity is active-high (non-inverted). Otherwise the polarity is active-low (inverted). More...

bool	getTrigger1Enabled ()
	Returns true if trigger signal 1 is enabled. More...

void	setTrigger1Enabled (bool enabled)
	Enables or disables trigger signal 1. More...

bool	getTrigger1Constant ()
	Returns the constant value that is output when trigger 1 is disabled. More...

void	setTrigger1Constant (bool on)
	Sets the constant value that is output when trigger 1 is disabled. More...

bool	getTrigger1Polarity ()
	Returns false if trigger1 polarity is active-high (non-inverted) and false if polarity is active-low (inverted) More...

void	setTrigger1Polarity (bool invert)
	Sets the polarity for trigger1. If invert is false, the polarity is active-high (non-inverted). Otherwise the polarity is active-low (inverted). More...

double	getTrigger0PulseWidth (int pulse=0)
	Gets the pulse width of trigger signal 0. More...

void	setTrigger0PulseWidth (double width, int pulse=0)
	Sets the pulse width of trigger signal 0. More...

double	getTrigger1PulseWidth (int pulse=0)
	Gets the pulse width of trigger signal 1. More...

void	setTrigger1PulseWidth (double width, int pulse=0)
	Sets the pulse width of trigger signal 1. More...

double	getTrigger1Offset ()
	Gets the time offset between trigger signal 1 and signal 0. More...

void	setTrigger1Offset (double offset)
	Sets the time offset between trigger signal 1 and signal 0. More...

TriggerInputMode	getTriggerInputMode ()
	Returns the current trigger input configuration. More...

void	setTriggerInputMode (TriggerInputMode mode)
	Requests to change the trigger input configuration. More...

bool	getAutoRecalibrationEnabled ()
	Returns true if auto re-calibration is enabled. More...

void	setAutoRecalibrationEnabled (bool enabled)
	Enables or disables auto-recalibration. More...

bool	getSaveAutoRecalibration ()
	Returns true if persistent storage of auto re-calibration results is enabled. More...

void	setSaveAutoRecalibration (bool save)
	Enables or disables persistent storage of auto re-calibration results. More...

bool	getSubpixelOptimizationROIEnabled ()
	Returns true if an ROI for the subpixel optimization algorithm is enabled (otherwise complete frames are used for optimization). More...

void	setSubpixelOptimizationROIEnabled (bool enabled)
	Enables or disables an ROI for the subpixel optimization algorithm. (if disabled, complete frames are used for optimization). More...

void	getSubpixelOptimizationROI (int &x, int &y, int &width, int &height)
	Gets the configured ROI for the subpixel optimization algorithm. More...

void	setSubpixelOptimizationROI (int x, int y, int width, int height)
	Sets the configured ROI for the subpixel optimization algorithm. More...

void	reboot ()
	Remotely triggers a reboot of the device. More...

void	triggerNow ()
	Emit a software trigger event to perform a single acquisition. This only has effect when the External Trigger mode is set to Software. More...

std::map< std::string, ParameterInfo >	getAllParameters ()
	Enumerates all simple parameters as reported by the device [DEPRECATED]. More...

template<typename T >
void	setNamedParameter (const std::string &name, T value)
	Set a parameter by name. ParameterException for invalid names. More...

template<typename T >
void	setParameter (const std::string &name, T value)
	Set a parameter by name. ParameterException for invalid names or values. More...

template<typename T >
T	getNamedParameter (const std::string &name)
	Get a parameter by name, specifying the return type (int, double or bool). ParameterException for invalid names. [DEPRECATED]. More...

Member Enumeration Documentation

◆ AutoMode

enum visiontransfer::DeviceParameters::AutoMode

Possible modes of the automatic exposure and gain control.

Enumerator
AUTO_EXPOSURE_AND_GAIN	Both, exposure and gain are automatically adjusted.
AUTO_EXPOSURE_MANUAL_GAIN	Only exposure is automatically adjusted, gain is set manually.
MANUAL_EXPOSORE_AUTO_GAIN	Only gain is automatically adjusted, exposure is set manually.
MANUAL_EXPOSURE_MANUAL_GAIN	Both, exposure and gain are set manually.

Definition at line 391 of file deviceparameters.h.

◆ OperationMode

enum visiontransfer::DeviceParameters::OperationMode

Operation modes supported by Nerian stereo devices.

Enumerator
PASS_THROUGH	The device passes through the input images without modification.
RECTIFY	The devices outputs the rectified input images.
STEREO_MATCHING	The devices performs stereo matching.

Definition at line 109 of file deviceparameters.h.

◆ TargetFrame

enum visiontransfer::DeviceParameters::TargetFrame

Possible options for the target frame selection of the automatic exposure and gain control.

Enumerator
LEFT_FRAME	Control using only the left frame.
RIGHT_FRAME	Control using only the right frame.
BOTH_FRAMES	Control using both frames.

Definition at line 469 of file deviceparameters.h.

◆ TriggerInputMode

enum visiontransfer::DeviceParameters::TriggerInputMode

Trigger input modes supported by Nerian stereo devices.

Enumerator
INTERNAL	Trigger input disabled; internal triggering configuration is used.
EXTERNAL	External hardware trigger input active (not available on all Nerian devices).
SOFTWARE	Software triggering active (see triggerNow()).

Definition at line 885 of file deviceparameters.h.

Constructor & Destructor Documentation

◆ DeviceParameters() [1/2]

visiontransfer::DeviceParameters::DeviceParameters ( const DeviceInfo & device )

Connects to parameter server of a Nerian stereo device by using the device information from device enumeration.

Parameters

device Information on the device to which a connection should be established.

Definition at line 73 of file deviceparameters.cpp.

◆ DeviceParameters() [2/2]

visiontransfer::DeviceParameters::DeviceParameters	(	const char *	address,
		const char *	service = `"7683"`
	)

Connects to parameter server of a Nerian stereo device by using a network address.

Parameters

address	IP address or host name of the device to which a connection should be established.
service	The port number that should be used as string or as textual service name.

Definition at line 78 of file deviceparameters.cpp.

Member Function Documentation

◆ getAllParameters()

std::map< std::string, ParameterInfo > visiontransfer::DeviceParameters::getAllParameters ( )

Enumerates all simple parameters as reported by the device [DEPRECATED].

Deprecated:: since 10.0

Returns: A map associating available parameter names with visiontransfer::ParameterInfo entries

Note: This function, as well as ParameterInfo, are deprecated and slated to be removed; please use getParameterSet() instead. This function omits all parameters that are not scalar numbers.

Definition at line 115 of file deviceparameters.cpp.

◆ getAutoIntensityDelta()

double visiontransfer::DeviceParameters::getAutoIntensityDelta ( )

inline

Gets the minimum intensity change that is required for adjusting the camera settings.

Intensity values are relatively to the target intensity. A value of 0.01 represents a change of 1%.

Definition at line 450 of file deviceparameters.h.

◆ getAutoMaxExposureTime()

double visiontransfer::DeviceParameters::getAutoMaxExposureTime ( )

inline

Gets the maximum exposure time that can be selected automatically.

Returns: Maximum exposure time in microseconds.

Definition at line 522 of file deviceparameters.h.

◆ getAutoMaxGain()

double visiontransfer::DeviceParameters::getAutoMaxGain ( )

inline

Gets the maximum gain that can be selected automatically.

Returns: Maximum gain in dB.

Definition at line 538 of file deviceparameters.h.

◆ getAutoMode()

AutoMode visiontransfer::DeviceParameters::getAutoMode ( )

inline

Gets the current mode of the automatic exposure and gain control.

See also: AutoMode

Definition at line 409 of file deviceparameters.h.

◆ getAutoRecalibrationEnabled()

bool visiontransfer::DeviceParameters::getAutoRecalibrationEnabled ( )

inline

Returns true if auto re-calibration is enabled.

Definition at line 919 of file deviceparameters.h.

◆ getAutoROI()

void visiontransfer::DeviceParameters::getAutoROI	(	int &	x,
		int &	y,
		int &	width,
		int &	height
	)

inline

Gets the configured ROI for automatic exposure and gain control.

Parameters

x	Horizontal offset of the ROI from the image center. A value of 0 means the ROI is horizontally centered.
y	Vertical offset of the ROI from the image center. A value of 0 means the ROI is vertically centered.
width	Width of the ROI.
height	Height of the ROI.

The ROI must be enabled with setAutoROIEnabled() before it is considered for exposure or gain control.

Definition at line 629 of file deviceparameters.h.

◆ getAutoROIEnabled()

bool visiontransfer::DeviceParameters::getAutoROIEnabled ( )

inline

Returns true if an ROI for automatic exposure and gain control is enabled.

Definition at line 605 of file deviceparameters.h.

◆ getAutoSkippedFrames()

int visiontransfer::DeviceParameters::getAutoSkippedFrames ( )

inline

Gets the current interval at which the automatic exposure and gain control is run.

The return value indicates the number of skipped frames between each adjustment. Typically a value > 0 is desired to give the cameras enough time to react to the new setting.

Definition at line 503 of file deviceparameters.h.

◆ getAutoTargetFrame()

TargetFrame visiontransfer::DeviceParameters::getAutoTargetFrame ( )

inline

Gets the selected target frame for automatic exposure and gain control.

See also: TargetFrame

Definition at line 484 of file deviceparameters.h.

◆ getAutoTargetIntensity()

double visiontransfer::DeviceParameters::getAutoTargetIntensity ( )

inline

Gets the target image intensity of the automatic exposure and gain control.

Returns: The target intensity.

Intensities are measured from 0.0 to 1.0, with 0.0 being the darkest, and 1.0 the brightest possible pixel intensity.

Definition at line 428 of file deviceparameters.h.

◆ getConsistencyCheckEnabled()

bool visiontransfer::DeviceParameters::getConsistencyCheckEnabled ( )

inline

Returns true if the consistency check is enabled.

Definition at line 257 of file deviceparameters.h.

◆ getConsistencyCheckSensitivity()

int visiontransfer::DeviceParameters::getConsistencyCheckSensitivity ( )

inline

Gets the current sensitivity value for the consistency check.

Definition at line 271 of file deviceparameters.h.

◆ getDisparityOffset()

int visiontransfer::DeviceParameters::getDisparityOffset ( )

inline

Gets the current offset of the evaluated disparity range.

Definition at line 143 of file deviceparameters.h.

◆ getGapInterpolationEnabled()

bool visiontransfer::DeviceParameters::getGapInterpolationEnabled ( )

inline

Returns true if the texture gap interpolation is enabled.

Definition at line 347 of file deviceparameters.h.

◆ getManualExposureTime()

double visiontransfer::DeviceParameters::getManualExposureTime ( )

inline

Gets the manually selected exposure time.

Returns: Exposure time in microseconds.

This parameter is only relevant if the auto mode is set to MANUAL_EXPOSORE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.

See also: setAutoMode

Definition at line 559 of file deviceparameters.h.

◆ getManualGain()

double visiontransfer::DeviceParameters::getManualGain ( )

inline

Gets the manually selected gain.

Returns: Gain in dB.

This parameter is only relevant if the auto mode is set to AUTO_EXPOSORE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.

See also: setAutoMode

Definition at line 585 of file deviceparameters.h.

◆ getMaskBorderPixelsEnabled()

bool visiontransfer::DeviceParameters::getMaskBorderPixelsEnabled ( )

inline

Returns true if border pixels are removed from the computed disparity map.

Definition at line 242 of file deviceparameters.h.

◆ getMaxFrameTimeDifference()

int visiontransfer::DeviceParameters::getMaxFrameTimeDifference ( )

inline

Gets the maximum allowed time difference between two corresponding frames.

Returns: Time difference in milliseconds. A value of -1 corresponds to automatic pairing.

Definition at line 664 of file deviceparameters.h.

◆ getNamedParameter()

template<typename T >

T visiontransfer::DeviceParameters::getNamedParameter ( const std::string & name )

Get a parameter by name, specifying the return type (int, double or bool). ParameterException for invalid names. [DEPRECATED].

Deprecated:: since 10.0

Note: This function is deprecated and slated to be removed; please use getParameter(name).getCurrent<T>() instead. This function only supports parameters that are scalar numbers.

◆ getNoiseReductionEnabled()

bool visiontransfer::DeviceParameters::getNoiseReductionEnabled ( )

inline

Returns true if the noise reduction filter is enabled.

Definition at line 361 of file deviceparameters.h.

◆ getOperationMode()

OperationMode visiontransfer::DeviceParameters::getOperationMode ( )

inline

Gets the current operation mode.

Returns: The current operation mode, which can be PASS_THROUGH, RECTIFY or STEREO_MATCHING.

See also: OperationMode

Definition at line 126 of file deviceparameters.h.

◆ getSaveAutoRecalibration()

bool visiontransfer::DeviceParameters::getSaveAutoRecalibration ( )

inline

Returns true if persistent storage of auto re-calibration results is enabled.

Definition at line 933 of file deviceparameters.h.

◆ getSpeckleFilterIterations()

int visiontransfer::DeviceParameters::getSpeckleFilterIterations ( )

inline

Returns true if the speckle filter is enabled.

Definition at line 375 of file deviceparameters.h.

◆ getStereoMatchingEdgeSensitivity()

int visiontransfer::DeviceParameters::getStereoMatchingEdgeSensitivity ( )

inline

Gets the edge sensitivity of the SGM algorithm.

Definition at line 225 of file deviceparameters.h.

◆ getStereoMatchingP1Edge()

int visiontransfer::DeviceParameters::getStereoMatchingP1Edge ( )

inline

Gets the SGM penalty P1 for small disparity changes at image edges.

Definition at line 161 of file deviceparameters.h.

◆ getStereoMatchingP1NoEdge()

int visiontransfer::DeviceParameters::getStereoMatchingP1NoEdge ( )

inline

Gets the SGM penalty P1 for small disparity changes outside image edges.

Definition at line 177 of file deviceparameters.h.

◆ getStereoMatchingP2Edge()

int visiontransfer::DeviceParameters::getStereoMatchingP2Edge ( )

inline

Gets the SGM penalty P2 for large disparity changes at image edges.

Definition at line 193 of file deviceparameters.h.

◆ getStereoMatchingP2NoEdge()

int visiontransfer::DeviceParameters::getStereoMatchingP2NoEdge ( )

inline

Gets the SGM penalty P2 for large disparity changes at image edges.

Definition at line 209 of file deviceparameters.h.

◆ getSubpixelOptimizationROI()

void visiontransfer::DeviceParameters::getSubpixelOptimizationROI	(	int &	x,
		int &	y,
		int &	width,
		int &	height
	)

inline

Gets the configured ROI for the subpixel optimization algorithm.

Parameters

x	Horizontal offset of the ROI from the image center. A value of 0 means the ROI is horizontally centered.
y	Vertical offset of the ROI from the image center. A value of 0 means the ROI is vertically centered.
width	Width of the ROI.
height	Height of the ROI.

The ROI must be enabled with setSubpixelOptimizationROIEnabled(), otherwise the optimization algorithm will consider the full images.

Definition at line 973 of file deviceparameters.h.

◆ getSubpixelOptimizationROIEnabled()

bool visiontransfer::DeviceParameters::getSubpixelOptimizationROIEnabled ( )

inline

Returns true if an ROI for the subpixel optimization algorithm is enabled (otherwise complete frames are used for optimization).

Definition at line 948 of file deviceparameters.h.

◆ getTextureFilterEnabled()

bool visiontransfer::DeviceParameters::getTextureFilterEnabled ( )

inline

Returns true if the texture filter is enabled.

Definition at line 317 of file deviceparameters.h.

◆ getTextureFilterSensitivity()

int visiontransfer::DeviceParameters::getTextureFilterSensitivity ( )

inline

Gets the current sensitivity value for the texture filter.

Definition at line 331 of file deviceparameters.h.

◆ getTrigger0Constant()

bool visiontransfer::DeviceParameters::getTrigger0Constant ( )

inline

Returns the constant value that is output when trigger 0 is disabled.

Definition at line 711 of file deviceparameters.h.

◆ getTrigger0Enabled()

bool visiontransfer::DeviceParameters::getTrigger0Enabled ( )

inline

Returns true if trigger signal 0 is enabled.

Definition at line 697 of file deviceparameters.h.

◆ getTrigger0Polarity()

bool visiontransfer::DeviceParameters::getTrigger0Polarity ( )

inline

Returns false if trigger0 polarity is active-high (non-inverted) and false if polarity is active-low (inverted)

Definition at line 726 of file deviceparameters.h.

◆ getTrigger0PulseWidth()

double visiontransfer::DeviceParameters::getTrigger0PulseWidth ( int pulse = 0 )

inline

Gets the pulse width of trigger signal 0.

Parameters

pulse For a cyclic pulse width configuration, this is the index of the pulse for which to return the width. Valid values are 0 to 7.

Returns: Pulse width in milliseconds.

Definition at line 789 of file deviceparameters.h.

◆ getTrigger1Constant()

bool visiontransfer::DeviceParameters::getTrigger1Constant ( )

inline

Returns the constant value that is output when trigger 1 is disabled.

Definition at line 755 of file deviceparameters.h.

◆ getTrigger1Enabled()

bool visiontransfer::DeviceParameters::getTrigger1Enabled ( )

inline

Returns true if trigger signal 1 is enabled.

Definition at line 741 of file deviceparameters.h.

◆ getTrigger1Offset()

double visiontransfer::DeviceParameters::getTrigger1Offset ( )

inline

Gets the time offset between trigger signal 1 and signal 0.

Returns: Offset in milliseconds.

Definition at line 870 of file deviceparameters.h.

◆ getTrigger1Polarity()

bool visiontransfer::DeviceParameters::getTrigger1Polarity ( )

inline

Returns false if trigger1 polarity is active-high (non-inverted) and false if polarity is active-low (inverted)

Definition at line 770 of file deviceparameters.h.

◆ getTrigger1PulseWidth()

double visiontransfer::DeviceParameters::getTrigger1PulseWidth ( int pulse = 0 )

inline

Gets the pulse width of trigger signal 1.

Parameters

pulse For a cyclic pulse width configuration, this is the index of the pulse for which to return the width. Valid values are 0 to 7.

Returns: Pulse width in milliseconds.

Definition at line 831 of file deviceparameters.h.

◆ getTriggerFrequency()

double visiontransfer::DeviceParameters::getTriggerFrequency ( )

inline

Gets the frequency of the trigger signal.

Returns: Frequency in Hz.

Definition at line 682 of file deviceparameters.h.

◆ getTriggerInputMode()

TriggerInputMode visiontransfer::DeviceParameters::getTriggerInputMode ( )

inline

Returns the current trigger input configuration.

Definition at line 899 of file deviceparameters.h.

◆ getUniquenessCheckEnabled()

bool visiontransfer::DeviceParameters::getUniquenessCheckEnabled ( )

inline

Returns true if the consistency check is enabled.

Definition at line 287 of file deviceparameters.h.

◆ getUniquenessCheckSensitivity()

int visiontransfer::DeviceParameters::getUniquenessCheckSensitivity ( )

inline

Gets the current sensitivity value for the uniqueness check.

Definition at line 301 of file deviceparameters.h.

◆ reboot()

void visiontransfer::DeviceParameters::reboot ( )

inline

Remotely triggers a reboot of the device.

Definition at line 1003 of file deviceparameters.h.

◆ setAutoIntensityDelta()

void visiontransfer::DeviceParameters::setAutoIntensityDelta ( double delta )

inline

Sets the minimum intensity change that is required for adjusting the camera settings.

Intensity values are relatively to the target intensity. A value of 0.01 represents a change of 1%.

Definition at line 461 of file deviceparameters.h.

◆ setAutoMaxExposureTime()

void visiontransfer::DeviceParameters::setAutoMaxExposureTime ( double time )

inline

Sets the maximum exposure time that can be selected automatically.

Parameters

time	Maximum exposure time in microseconds.

Definition at line 530 of file deviceparameters.h.

◆ setAutoMaxGain()

void visiontransfer::DeviceParameters::setAutoMaxGain ( double gain )

inline

Gets the maximum gain that can be selected automatically.

Parameters

gain	Maximum gain in dB.

Definition at line 546 of file deviceparameters.h.

◆ setAutoMode()

void visiontransfer::DeviceParameters::setAutoMode ( AutoMode mode )

inline

Sets the current mode of the automatic exposure and gain control.

See also: AutoMode

Definition at line 417 of file deviceparameters.h.

◆ setAutoRecalibrationEnabled()

void visiontransfer::DeviceParameters::setAutoRecalibrationEnabled ( bool enabled )

inline

Enables or disables auto-recalibration.

Definition at line 926 of file deviceparameters.h.

◆ setAutoROI()

void visiontransfer::DeviceParameters::setAutoROI	(	int	x,
		int	y,
		int	width,
		int	height
	)

inline

Sets the configured ROI for automatic exposure and gain control.

Parameters

x	Horizontal offset of the ROI from the image center. A value of 0 means the ROI is horizontally centered.
y	Vertical offset of the ROI from the image center. A value of 0 means the ROI is vertically centered.
width	Width of the ROI.
height	Height of the ROI.

The ROI must be enabled with setAutoROIEnabled() before it is considered for exposure or gain control.

Definition at line 649 of file deviceparameters.h.

◆ setAutoROIEnabled()

void visiontransfer::DeviceParameters::setAutoROIEnabled ( bool enabled )

inline

Enables or disables an ROI for automatic exposure and gain control.

Definition at line 612 of file deviceparameters.h.

◆ setAutoSkippedFrames()

void visiontransfer::DeviceParameters::setAutoSkippedFrames ( int skipped )

inline

Sets the current interval at which the automatic exposure and gain control is run.

The return value indicates the number of skipped frames between each adjustment. Typically a value > 0 is desired to give the cameras enough time to react to the new setting.

Definition at line 514 of file deviceparameters.h.

◆ setAutoTargetFrame()

void visiontransfer::DeviceParameters::setAutoTargetFrame ( TargetFrame target )

inline

Selects the target frame for automatic exposure and gain control.

See also: TargetFrame

Definition at line 492 of file deviceparameters.h.

◆ setAutoTargetIntensity()

void visiontransfer::DeviceParameters::setAutoTargetIntensity ( double intensity )

inline

Sets the target image intensity of the automatic exposure and gain control.

Parameters

intensity The new target intensity.

Intensities are measured from 0.0 to 1.0, with 0.0 being the darkest, and 1.0 the brightest possible pixel intensity.

Definition at line 439 of file deviceparameters.h.

◆ setConsistencyCheckEnabled()

void visiontransfer::DeviceParameters::setConsistencyCheckEnabled ( bool enabled )

inline

Enables or disables the consistency check.

Definition at line 264 of file deviceparameters.h.

◆ setConsistencyCheckSensitivity()

void visiontransfer::DeviceParameters::setConsistencyCheckSensitivity ( int sensitivity )

inline

Sets a new sensitivity value for the consistency check.

This parameter must be in the range of 0 to 15.

Definition at line 280 of file deviceparameters.h.

◆ setDisparityOffset()

void visiontransfer::DeviceParameters::setDisparityOffset ( int offset )

inline

Sets the offset of the evaluated disparity range.

The offset plus the number of disparities must be smaller or equal to 256.

Definition at line 152 of file deviceparameters.h.

◆ setGapInterpolationEnabled()

void visiontransfer::DeviceParameters::setGapInterpolationEnabled ( bool enabled )

inline

Enables or disables the gap interpolation.

Definition at line 354 of file deviceparameters.h.

◆ setManualExposureTime()

void visiontransfer::DeviceParameters::setManualExposureTime ( double time )

inline

Sets the manually selected exposure time.

Parameters

time	Exposure time in microseconds.

This parameter is only relevant if the auto mode is set to MANUAL_EXPOSORE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.

See also: setAutoMode

Definition at line 572 of file deviceparameters.h.

◆ setManualGain()

void visiontransfer::DeviceParameters::setManualGain ( double gain )

inline

Sets the manually selected gain.

Parameters

gain	Gain in dB.

This parameter is only relevant if the auto mode is set to AUTO_EXPOSORE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.

See also: setAutoMode

Definition at line 598 of file deviceparameters.h.

◆ setMaskBorderPixelsEnabled()

void visiontransfer::DeviceParameters::setMaskBorderPixelsEnabled ( bool enabled )

inline

Enables or disables the removal of border pixels from the computed disparity map.

Definition at line 250 of file deviceparameters.h.

◆ setMaxFrameTimeDifference()

void visiontransfer::DeviceParameters::setMaxFrameTimeDifference ( int diffMs )

inline

Sets the maximum allowed time difference between two corresponding frames.

Parameters

diffMs Time difference in milliseconds. If automatic pairing is desired, a value of -1 should be set.

Definition at line 674 of file deviceparameters.h.

◆ setNamedParameter()

template<typename T >

void visiontransfer::DeviceParameters::setNamedParameter	(	const std::string &	name,
		T	value
	)

Set a parameter by name. ParameterException for invalid names.

Deprecated:: since 10.0

Note: This function is deprecated and slated to be removed; please use setParameter() instead. This function only supports parameters that are scalar numbers.

◆ setNoiseReductionEnabled()

void visiontransfer::DeviceParameters::setNoiseReductionEnabled ( bool enabled )

inline

Enables or disables the noise reduction filter.

Definition at line 368 of file deviceparameters.h.

◆ setOperationMode()

void visiontransfer::DeviceParameters::setOperationMode ( OperationMode mode )

inline

Configures the device to a new operation mode.

Parameters

mode	The new operation mode, which can be PASS_THROUGH, RECTIFY or STEREO_MATCHING.

See also: OperationMode

Definition at line 136 of file deviceparameters.h.

◆ setParameter()

template<typename T >

void visiontransfer::DeviceParameters::setParameter	(	const std::string &	name,
		T	value
	)

Set a parameter by name. ParameterException for invalid names or values.

◆ setSaveAutoRecalibration()

void visiontransfer::DeviceParameters::setSaveAutoRecalibration ( bool save )

inline

Enables or disables persistent storage of auto re-calibration results.

Definition at line 940 of file deviceparameters.h.

◆ setSpeckleFilterIterations()

void visiontransfer::DeviceParameters::setSpeckleFilterIterations ( int iter )

inline

Enables or disables the speckle filter.

Definition at line 382 of file deviceparameters.h.