libvisiontransfer
6.5.0
|
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, ParameterInfo > | getAllParameters () |
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 > | |
T | getNamedParameter (const std::string &name) |
Get a parameter by name, specifying the return type (int, double or bool). ParameterException for invalid names. More... | |
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.
Possible modes of the automatic exposure and gain control.
Definition at line 303 of file scenescanparameters.h.
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.
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.
visiontransfer::SceneScanParameters::SceneScanParameters | ( | const DeviceInfo & | device | ) |
Connects to SceneScan's parameter server by using the device information from device enumeration.
device | Information on the device to which a connection should be established. |
Definition at line 108 of file scenescanparameters.cpp.
visiontransfer::SceneScanParameters::SceneScanParameters | ( | const char * | address, |
const char * | service = "7683" |
||
) |
Connects to SceneScan's parameter server by using a network address.
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 113 of file scenescanparameters.cpp.
std::map< std::string, ParameterInfo > visiontransfer::SceneScanParameters::getAllParameters | ( | ) |
Enumerates all parameters as reported by the device.
Definition at line 164 of file scenescanparameters.cpp.
|
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.
|
inline |
Gets the maximum exposure time that can be selected automatically.
Definition at line 434 of file scenescanparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically.
Definition at line 450 of file scenescanparameters.h.
|
inline |
Gets the current mode of the automatic exposure and gain control.
Definition at line 321 of file scenescanparameters.h.
|
inline |
Returns true if auto re-calibration is enabled.
Definition at line 685 of file scenescanparameters.h.
|
inline |
Gets the configured ROI for automatic exposure and gain control.
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 541 of file scenescanparameters.h.
|
inline |
Returns true if an ROI for automatic exposure and gain control is enabled.
Definition at line 517 of file scenescanparameters.h.
|
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.
|
inline |
Gets the selected target frame for automatic exposure and gain control.
Definition at line 396 of file scenescanparameters.h.
|
inline |
Gets the target image intensity of the automatic exposure and gain control.
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.
|
inline |
Returns true if the consistency check is enabled.
Definition at line 169 of file scenescanparameters.h.
|
inline |
Gets the current sensitivity value for the consistency check.
Definition at line 183 of file scenescanparameters.h.
|
inline |
Gets the current offset of the evaluated disparity range.
Definition at line 103 of file scenescanparameters.h.
|
inline |
Returns true if the texture gap interpolation is enabled.
Definition at line 259 of file scenescanparameters.h.
|
inline |
Gets the manually selected exposure time.
This parameter is only relevant if the auto mode is set to MANUAL_EXPOSORE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 471 of file scenescanparameters.h.
|
inline |
Gets the manually selected gain.
This parameter is only relevant if the auto mode is set to AUTO_EXPOSORE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 497 of file scenescanparameters.h.
|
inline |
Returns true if border pixels are removed from the computed disparity map.
Definition at line 154 of file scenescanparameters.h.
|
inline |
Gets the maximum allowed time difference between two corresponding frames.
Definition at line 575 of file scenescanparameters.h.
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.
|
inline |
Returns true if the noise reduction filter is enabled.
Definition at line 273 of file scenescanparameters.h.
|
inline |
Gets the current operation mode.
Definition at line 86 of file scenescanparameters.h.
|
inline |
Returns true if persistent storage of auto re-calibration results is enabled.
Definition at line 699 of file scenescanparameters.h.
|
inline |
Returns true if the speckle filter is enabled.
Definition at line 287 of file scenescanparameters.h.
|
inline |
Gets the SGM penalty P1 for small disparity changes.
Definition at line 121 of file scenescanparameters.h.
|
inline |
Gets the SGM penalty P2 for large disparity changes.
Definition at line 137 of file scenescanparameters.h.
|
inline |
Returns true if the texture filter is enabled.
Definition at line 229 of file scenescanparameters.h.
|
inline |
Gets the current sensitivity value for the texture filter.
Definition at line 243 of file scenescanparameters.h.
|
inline |
Returns true if trigger signal 0 is enabled.
Definition at line 607 of file scenescanparameters.h.
|
inline |
Gets the pulse width of trigger signal 0.
Definition at line 636 of file scenescanparameters.h.
|
inline |
Returns true if trigger signal 1 is enabled.
Definition at line 621 of file scenescanparameters.h.
|
inline |
Gets the time offset between trigger signal 1 and signal 0.
Definition at line 668 of file scenescanparameters.h.
|
inline |
Gets the pulse width of trigger signal 1.
Definition at line 652 of file scenescanparameters.h.
|
inline |
Gets the frequency of the trigger signal.
Definition at line 592 of file scenescanparameters.h.
|
inline |
Returns true if the consistency check is enabled.
Definition at line 199 of file scenescanparameters.h.
|
inline |
Gets the current sensitivity value for the uniqueness check.
Definition at line 213 of file scenescanparameters.h.
|
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.
|
inline |
Sets the maximum exposure time that can be selected automatically.
time | Maximum exposure time in microseconds. |
Definition at line 442 of file scenescanparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically.
gain | Maximum gain in dB. |
Definition at line 458 of file scenescanparameters.h.
|
inline |
Sets the current mode of the automatic exposure and gain control.
Definition at line 329 of file scenescanparameters.h.
|
inline |
Enables or disables auto-recalibration.
Definition at line 692 of file scenescanparameters.h.
|
inline |
Sets the configured ROI for automatic exposure and gain control.
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 561 of file scenescanparameters.h.
|
inline |
Enables or disables an ROI for automatic exposure and gain control.
Definition at line 524 of file scenescanparameters.h.
|
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.
|
inline |
Selects the target frame for automatic exposure and gain control.
Definition at line 404 of file scenescanparameters.h.
|
inline |
Sets the target image intensity of the automatic exposure and gain control.
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 351 of file scenescanparameters.h.
|
inline |
Enables or disables the consistency check.
Definition at line 176 of file scenescanparameters.h.
|
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.
|
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.
|
inline |
Enables or disables the gap interpolation.
Definition at line 266 of file scenescanparameters.h.
|
inline |
Sets the manually selected exposure time.
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.
Definition at line 484 of file scenescanparameters.h.
|
inline |
Sets the manually selected gain.
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.
Definition at line 510 of file scenescanparameters.h.
|
inline |
Enables or disables the removal of border pixels from the computed disparity map.
Definition at line 162 of file scenescanparameters.h.
|
inline |
Sets the maximum allowed time difference between two corresponding frames.
diffMs | Time difference in milliseconds. |
Definition at line 584 of file scenescanparameters.h.
void visiontransfer::SceneScanParameters::setNamedParameter | ( | const std::string & | name, |
T | value | ||
) |
Set a parameter by name. ParameterException for invalid names.
|
inline |
Enables or disables the noise reduction filter.
Definition at line 280 of file scenescanparameters.h.
|
inline |
Configures the device to a new operation mode.
mode | The new operation mode, which can be PASS_THROUGH, RECTIFY or STEREO_MATCHING. |
Definition at line 96 of file scenescanparameters.h.
|
inline |
Enables or disables persistent storage of auto re-calibration results.
Definition at line 706 of file scenescanparameters.h.
|
inline |
Enables or disables the speckle filter.
Definition at line 294 of file scenescanparameters.h.
|
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.
|
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.
|
inline |
Enables or disables the texture filter.
Definition at line 236 of file scenescanparameters.h.
|
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.
|
inline |
Enables or disables trigger signal 0.
Definition at line 614 of file scenescanparameters.h.
|
inline |
Sets the pulse width of trigger signal 0.
width | Pulse width in milliseconds. |
Definition at line 644 of file scenescanparameters.h.
|
inline |
Enables or disables trigger signal 1.
Definition at line 628 of file scenescanparameters.h.
|
inline |
Sets the time offset between trigger signal 1 and signal 0.
offset | Offset in milliseconds. |
Definition at line 676 of file scenescanparameters.h.
|
inline |
Sets the pulse width of trigger signal 1.
width | Pulse width in milliseconds. |
Definition at line 660 of file scenescanparameters.h.
|
inline |
Sets the frequency of the trigger signal.
freq | Frequency in Hz. |
Definition at line 600 of file scenescanparameters.h.
|
inline |
Enables or disables the uniqueness check.
Definition at line 206 of file scenescanparameters.h.
|
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.