libvisiontransfer  6.5.0
Classes | Public Types | Public Member Functions | List of all members
visiontransfer::SceneScanParameters Class Reference

Allows a configuration of SceneScan's parameters through a network connection. More...

#include <visiontransfer/scenescanparameters.h>

Classes

class  Pimpl
 

Public Types

enum  OperationMode { PASS_THROUGH = 0, RECTIFY = 1, STEREO_MATCHING = 2 }
 Operation modes supported by SceneScan. 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...
 

Public Member Functions

 SceneScanParameters (const DeviceInfo &device)
 Connects to SceneScan's parameter server by using the device information from device enumeration. More...
 
 SceneScanParameters (const char *address, const char *service="7683")
 Connects to SceneScan's parameter server 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 getStereoMatchingP1 ()
 Gets the SGM penalty P1 for small disparity changes. More...
 
void setStereoMatchingP1 (int p1)
 Sets the SGM penalty P1 for small disparity changes. More...
 
int getStereoMatchingP2 ()
 Gets the SGM penalty P2 for large disparity changes. More...
 
void setStereoMatchingP2 (int p2)
 Sets the SGM penalty P2 for large disparity changes. 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...
 
AutoMode 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 getTrigger1Enabled ()
 Returns true if trigger signal 1 is enabled. More...
 
void setTrigger1Enabled (bool enabled)
 Enables or disables trigger signal 1. More...
 
double getTrigger0PulseWidth ()
 Gets the pulse width of trigger signal 0. More...
 
void setTrigger0PulseWidth (double width)
 Sets the pulse width of trigger signal 0. More...
 
double getTrigger1PulseWidth ()
 Gets the pulse width of trigger signal 1. More...
 
void setTrigger1PulseWidth (double width)
 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...
 
bool getAutoRecalibrationEnabled ()
 Returns true if auto re-calibration is enabled. More...
 
void setAutoRecalibrationEnabled (bool enabled)
 Enables or disables auto-recalibration. More...
 
bool getSaveAutoReclabration ()
 Returns true if persistent storage of auto re-calibration results is enabled. More...
 
void setSaveAutoReclabration (bool save)
 Enables or disables persistent storage of auto re-calibration results. More...
 
std::map< std::string, ParameterInfogetAllParameters ()
 Enumerates all parameters as reported by the device. 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 >
getNamedParameter (const std::string &name)
 Get a parameter by name, specifying the return type (int, double or bool). ParameterException for invalid names. More...
 

Detailed Description

Allows a configuration of SceneScan's parameters 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.

Definition at line 40 of file scenescanparameters.h.

Member Enumeration Documentation

◆ 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 303 of file scenescanparameters.h.

◆ OperationMode

Operation modes supported by SceneScan.

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 69 of file scenescanparameters.h.

◆ 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 381 of file scenescanparameters.h.

Constructor & Destructor Documentation

◆ SceneScanParameters() [1/2]

visiontransfer::SceneScanParameters::SceneScanParameters ( const DeviceInfo device)

Connects to SceneScan's parameter server by using the device information from device enumeration.

Parameters
deviceInformation on the device to which a connection should be established.

Definition at line 108 of file scenescanparameters.cpp.

◆ SceneScanParameters() [2/2]

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

Connects to SceneScan's parameter server by using a network address.

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

Definition at line 113 of file scenescanparameters.cpp.

Member Function Documentation

◆ getAllParameters()

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

Enumerates all parameters as reported by the device.

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

Definition at line 164 of file scenescanparameters.cpp.

◆ getAutoIntensityDelta()

double visiontransfer::SceneScanParameters::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 362 of file scenescanparameters.h.

◆ getAutoMaxExposureTime()

double visiontransfer::SceneScanParameters::getAutoMaxExposureTime ( )
inline

Gets the maximum exposure time that can be selected automatically.

Returns
Maximum exposure time in microseconds.

Definition at line 434 of file scenescanparameters.h.

◆ getAutoMaxGain()

double visiontransfer::SceneScanParameters::getAutoMaxGain ( )
inline

Gets the maximum gain that can be selected automatically.

Returns
Maximum gain in dB.

Definition at line 450 of file scenescanparameters.h.

◆ getAutoMode()

AutoMode visiontransfer::SceneScanParameters::getAutoMode ( )
inline

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

See also
AutoMode

Definition at line 321 of file scenescanparameters.h.

◆ getAutoRecalibrationEnabled()

bool visiontransfer::SceneScanParameters::getAutoRecalibrationEnabled ( )
inline

Returns true if auto re-calibration is enabled.

Definition at line 685 of file scenescanparameters.h.

◆ getAutoROI()

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

Gets the configured ROI for automatic exposure and gain control.

Parameters
xHorizontal offset of the ROI from the image center. A value of 0 means the ROI is horizontally centered.
yVertical offset of the ROI from the image center. A value of 0 means the ROI is vertically centered.
widthWidth of the ROI.
heightHeight of the ROI.

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

Definition at line 541 of file scenescanparameters.h.

◆ getAutoROIEnabled()

bool visiontransfer::SceneScanParameters::getAutoROIEnabled ( )
inline

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

Definition at line 517 of file scenescanparameters.h.

◆ getAutoSkippedFrames()

int visiontransfer::SceneScanParameters::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 415 of file scenescanparameters.h.

◆ getAutoTargetFrame()

AutoMode visiontransfer::SceneScanParameters::getAutoTargetFrame ( )
inline

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

See also
TargetFrame

Definition at line 396 of file scenescanparameters.h.

◆ getAutoTargetIntensity()

double visiontransfer::SceneScanParameters::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 340 of file scenescanparameters.h.

◆ getConsistencyCheckEnabled()

bool visiontransfer::SceneScanParameters::getConsistencyCheckEnabled ( )
inline

Returns true if the consistency check is enabled.

Definition at line 169 of file scenescanparameters.h.

◆ getConsistencyCheckSensitivity()

int visiontransfer::SceneScanParameters::getConsistencyCheckSensitivity ( )
inline

Gets the current sensitivity value for the consistency check.

Definition at line 183 of file scenescanparameters.h.

◆ getDisparityOffset()

int visiontransfer::SceneScanParameters::getDisparityOffset ( )
inline

Gets the current offset of the evaluated disparity range.

Definition at line 103 of file scenescanparameters.h.

◆ getGapInterpolationEnabled()

bool visiontransfer::SceneScanParameters::getGapInterpolationEnabled ( )
inline

Returns true if the texture gap interpolation is enabled.

Definition at line 259 of file scenescanparameters.h.

◆ getManualExposureTime()

double visiontransfer::SceneScanParameters::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 471 of file scenescanparameters.h.

◆ getManualGain()

double visiontransfer::SceneScanParameters::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 497 of file scenescanparameters.h.

◆ getMaskBorderPixelsEnabled()

bool visiontransfer::SceneScanParameters::getMaskBorderPixelsEnabled ( )
inline

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

Definition at line 154 of file scenescanparameters.h.

◆ getMaxFrameTimeDifference()

int visiontransfer::SceneScanParameters::getMaxFrameTimeDifference ( )
inline

Gets the maximum allowed time difference between two corresponding frames.

Returns
Time difference in milliseconds.

Definition at line 575 of file scenescanparameters.h.

◆ getNamedParameter()

template<typename T >
T visiontransfer::SceneScanParameters::getNamedParameter ( const std::string &  name)

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

◆ getNoiseReductionEnabled()

bool visiontransfer::SceneScanParameters::getNoiseReductionEnabled ( )
inline

Returns true if the noise reduction filter is enabled.

Definition at line 273 of file scenescanparameters.h.

◆ getOperationMode()

OperationMode visiontransfer::SceneScanParameters::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 86 of file scenescanparameters.h.

◆ getSaveAutoReclabration()

bool visiontransfer::SceneScanParameters::getSaveAutoReclabration ( )
inline

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

Definition at line 699 of file scenescanparameters.h.

◆ getSpeckleFilterIterations()

int visiontransfer::SceneScanParameters::getSpeckleFilterIterations ( )
inline

Returns true if the speckle filter is enabled.

Definition at line 287 of file scenescanparameters.h.

◆ getStereoMatchingP1()

int visiontransfer::SceneScanParameters::getStereoMatchingP1 ( )
inline

Gets the SGM penalty P1 for small disparity changes.

Definition at line 121 of file scenescanparameters.h.

◆ getStereoMatchingP2()

int visiontransfer::SceneScanParameters::getStereoMatchingP2 ( )
inline

Gets the SGM penalty P2 for large disparity changes.

Definition at line 137 of file scenescanparameters.h.

◆ getTextureFilterEnabled()

bool visiontransfer::SceneScanParameters::getTextureFilterEnabled ( )
inline

Returns true if the texture filter is enabled.

Definition at line 229 of file scenescanparameters.h.

◆ getTextureFilterSensitivity()

int visiontransfer::SceneScanParameters::getTextureFilterSensitivity ( )
inline

Gets the current sensitivity value for the texture filter.

Definition at line 243 of file scenescanparameters.h.

◆ getTrigger0Enabled()

bool visiontransfer::SceneScanParameters::getTrigger0Enabled ( )
inline

Returns true if trigger signal 0 is enabled.

Definition at line 607 of file scenescanparameters.h.

◆ getTrigger0PulseWidth()

double visiontransfer::SceneScanParameters::getTrigger0PulseWidth ( )
inline

Gets the pulse width of trigger signal 0.

Returns
Pulse width in milliseconds.

Definition at line 636 of file scenescanparameters.h.

◆ getTrigger1Enabled()

bool visiontransfer::SceneScanParameters::getTrigger1Enabled ( )
inline

Returns true if trigger signal 1 is enabled.

Definition at line 621 of file scenescanparameters.h.

◆ getTrigger1Offset()

double visiontransfer::SceneScanParameters::getTrigger1Offset ( )
inline

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

Returns
Offset in milliseconds.

Definition at line 668 of file scenescanparameters.h.

◆ getTrigger1PulseWidth()

double visiontransfer::SceneScanParameters::getTrigger1PulseWidth ( )
inline

Gets the pulse width of trigger signal 1.

Returns
Pulse width in milliseconds.

Definition at line 652 of file scenescanparameters.h.

◆ getTriggerFrequency()

double visiontransfer::SceneScanParameters::getTriggerFrequency ( )
inline

Gets the frequency of the trigger signal.

Returns
Frequency in Hz.

Definition at line 592 of file scenescanparameters.h.

◆ getUniquenessCheckEnabled()

bool visiontransfer::SceneScanParameters::getUniquenessCheckEnabled ( )
inline

Returns true if the consistency check is enabled.

Definition at line 199 of file scenescanparameters.h.

◆ getUniquenessCheckSensitivity()

int visiontransfer::SceneScanParameters::getUniquenessCheckSensitivity ( )
inline

Gets the current sensitivity value for the uniqueness check.

Definition at line 213 of file scenescanparameters.h.

◆ setAutoIntensityDelta()

void visiontransfer::SceneScanParameters::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 373 of file scenescanparameters.h.

◆ setAutoMaxExposureTime()

void visiontransfer::SceneScanParameters::setAutoMaxExposureTime ( double  time)
inline

Sets the maximum exposure time that can be selected automatically.

Parameters
timeMaximum exposure time in microseconds.

Definition at line 442 of file scenescanparameters.h.

◆ setAutoMaxGain()

void visiontransfer::SceneScanParameters::setAutoMaxGain ( double  gain)
inline

Gets the maximum gain that can be selected automatically.

Parameters
gainMaximum gain in dB.

Definition at line 458 of file scenescanparameters.h.

◆ setAutoMode()

void visiontransfer::SceneScanParameters::setAutoMode ( AutoMode  mode)
inline

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

See also
AutoMode

Definition at line 329 of file scenescanparameters.h.

◆ setAutoRecalibrationEnabled()

void visiontransfer::SceneScanParameters::setAutoRecalibrationEnabled ( bool  enabled)
inline

Enables or disables auto-recalibration.

Definition at line 692 of file scenescanparameters.h.

◆ setAutoROI()

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

Sets the configured ROI for automatic exposure and gain control.

Parameters
xHorizontal offset of the ROI from the image center. A value of 0 means the ROI is horizontally centered.
yVertical offset of the ROI from the image center. A value of 0 means the ROI is vertically centered.
widthWidth of the ROI.
heightHeight of the ROI.

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

Definition at line 561 of file scenescanparameters.h.

◆ setAutoROIEnabled()

void visiontransfer::SceneScanParameters::setAutoROIEnabled ( bool  enabled)
inline

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

Definition at line 524 of file scenescanparameters.h.

◆ setAutoSkippedFrames()

void visiontransfer::SceneScanParameters::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 426 of file scenescanparameters.h.

◆ setAutoTargetFrame()

void visiontransfer::SceneScanParameters::setAutoTargetFrame ( TargetFrame  target)
inline

Selects the target frame for automatic exposure and gain control.

See also
TargetFrame

Definition at line 404 of file scenescanparameters.h.

◆ setAutoTargetIntensity()

void visiontransfer::SceneScanParameters::setAutoTargetIntensity ( double  intensity)
inline

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

Parameters
intensityThe 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 351 of file scenescanparameters.h.

◆ setConsistencyCheckEnabled()

void visiontransfer::SceneScanParameters::setConsistencyCheckEnabled ( bool  enabled)
inline

Enables or disables the consistency check.

Definition at line 176 of file scenescanparameters.h.

◆ setConsistencyCheckSensitivity()

void visiontransfer::SceneScanParameters::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 192 of file scenescanparameters.h.

◆ setDisparityOffset()

void visiontransfer::SceneScanParameters::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 112 of file scenescanparameters.h.

◆ setGapInterpolationEnabled()

void visiontransfer::SceneScanParameters::setGapInterpolationEnabled ( bool  enabled)
inline

Enables or disables the gap interpolation.

Definition at line 266 of file scenescanparameters.h.

◆ setManualExposureTime()

void visiontransfer::SceneScanParameters::setManualExposureTime ( double  time)
inline

Sets the manually selected exposure time.

Parameters
timeExposure 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 484 of file scenescanparameters.h.

◆ setManualGain()

void visiontransfer::SceneScanParameters::setManualGain ( double  gain)
inline

Sets the manually selected gain.

Parameters
gainGain 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 510 of file scenescanparameters.h.

◆ setMaskBorderPixelsEnabled()

void visiontransfer::SceneScanParameters::setMaskBorderPixelsEnabled ( bool  enabled)
inline

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

Definition at line 162 of file scenescanparameters.h.

◆ setMaxFrameTimeDifference()

void visiontransfer::SceneScanParameters::setMaxFrameTimeDifference ( int  diffMs)
inline

Sets the maximum allowed time difference between two corresponding frames.

Parameters
diffMsTime difference in milliseconds.

Definition at line 584 of file scenescanparameters.h.

◆ setNamedParameter()

template<typename T >
void visiontransfer::SceneScanParameters::setNamedParameter ( const std::string &  name,
value 
)

Set a parameter by name. ParameterException for invalid names.

◆ setNoiseReductionEnabled()

void visiontransfer::SceneScanParameters::setNoiseReductionEnabled ( bool  enabled)
inline

Enables or disables the noise reduction filter.

Definition at line 280 of file scenescanparameters.h.

◆ setOperationMode()

void visiontransfer::SceneScanParameters::setOperationMode ( OperationMode  mode)
inline

Configures the device to a new operation mode.

Parameters
modeThe new operation mode, which can be PASS_THROUGH, RECTIFY or STEREO_MATCHING.
See also
OperationMode

Definition at line 96 of file scenescanparameters.h.

◆ setSaveAutoReclabration()

void visiontransfer::SceneScanParameters::setSaveAutoReclabration ( bool  save)
inline

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

Definition at line 706 of file scenescanparameters.h.

◆ setSpeckleFilterIterations()

void visiontransfer::SceneScanParameters::setSpeckleFilterIterations ( int  iter)
inline

Enables or disables the speckle filter.

Definition at line 294 of file scenescanparameters.h.

◆ setStereoMatchingP1()

void visiontransfer::SceneScanParameters::setStereoMatchingP1 ( int  p1)
inline

Sets the SGM penalty P1 for small disparity changes.

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

Definition at line 130 of file scenescanparameters.h.

◆ setStereoMatchingP2()

void visiontransfer::SceneScanParameters::setStereoMatchingP2 ( int  p2)
inline

Sets the SGM penalty P2 for large disparity changes.

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

Definition at line 146 of file scenescanparameters.h.

◆ setTextureFilterEnabled()

void visiontransfer::SceneScanParameters::setTextureFilterEnabled ( bool  enabled)
inline

Enables or disables the texture filter.

Definition at line 236 of file scenescanparameters.h.

◆ setTextureFilterSensitivity()

void visiontransfer::SceneScanParameters::setTextureFilterSensitivity ( int  sensitivity)
inline

Sets a new sensitivity value for the texture filter.

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

Definition at line 252 of file scenescanparameters.h.

◆ setTrigger0Enabled()

void visiontransfer::SceneScanParameters::setTrigger0Enabled ( bool  enabled)
inline

Enables or disables trigger signal 0.

Definition at line 614 of file scenescanparameters.h.

◆ setTrigger0PulseWidth()

void visiontransfer::SceneScanParameters::setTrigger0PulseWidth ( double  width)
inline

Sets the pulse width of trigger signal 0.

Parameters
widthPulse width in milliseconds.

Definition at line 644 of file scenescanparameters.h.

◆ setTrigger1Enabled()

void visiontransfer::SceneScanParameters::setTrigger1Enabled ( bool  enabled)
inline

Enables or disables trigger signal 1.

Definition at line 628 of file scenescanparameters.h.

◆ setTrigger1Offset()

void visiontransfer::SceneScanParameters::setTrigger1Offset ( double  offset)
inline

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

Parameters
offsetOffset in milliseconds.

Definition at line 676 of file scenescanparameters.h.

◆ setTrigger1PulseWidth()

void visiontransfer::SceneScanParameters::setTrigger1PulseWidth ( double  width)
inline

Sets the pulse width of trigger signal 1.

Parameters
widthPulse width in milliseconds.

Definition at line 660 of file scenescanparameters.h.

◆ setTriggerFrequency()

void visiontransfer::SceneScanParameters::setTriggerFrequency ( double  freq)
inline

Sets the frequency of the trigger signal.

Parameters
freqFrequency in Hz.

Definition at line 600 of file scenescanparameters.h.

◆ setUniquenessCheckEnabled()

void visiontransfer::SceneScanParameters::setUniquenessCheckEnabled ( bool  enabled)
inline

Enables or disables the uniqueness check.

Definition at line 206 of file scenescanparameters.h.

◆ setUniquenessCheckSensitivity()

void visiontransfer::SceneScanParameters::setUniquenessCheckSensitivity ( int  sensitivity)
inline

Sets a new sensitivity value for the uniqueness check.

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

Definition at line 222 of file scenescanparameters.h.


The documentation for this class was generated from the following files:
Nerian Vision Technologies