libvisiontransfer
10.8.0
|
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 64 of file deviceparameters.h.
#include <visiontransfer/deviceparameters.h>
Classes | |
class | Pimpl |
class | TransactionLock |
A (thread-local) parameter transaction lock for queued writes. [C++11] More... | |
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_EXPOSURE_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... | |
bool | isConnected () const |
Returns true if a remote connection is currently established and the full host-device handshake has succeeded. 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 for the left and right cameras. More... | |
void | setAutoTargetIntensity (double intensity) |
Sets the target image intensity of the automatic exposure and gain control for the left and right cameras. More... | |
double | getAutoTargetIntensityThirdCamera () |
Gets the target image intensity of the automatic exposure and gain control for the third, center, color camera (if present in the device). More... | |
void | setAutoTargetIntensityThirdCamera (double intensity) |
Sets the target image intensity of the automatic exposure and gain control for the third, center, color camera (if present in the device). 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 for the left and right cameras. More... | |
void | setAutoMaxGain (double gain) |
Gets the maximum gain that can be selected automatically for the left and right cameras. More... | |
double | getAutoMaxGainThirdCamera () |
Gets the maximum gain that can be selected automatically for the third, center, color camera (if present in the device). More... | |
void | setAutoMaxGainThirdCamera (double gain) |
Gets the maximum gain that can be selected automatically for the third, center, color camera (if present in the device). More... | |
double | getManualExposureTime () |
Gets the manually selected exposure time for the left and right cameras. More... | |
void | setManualExposureTime (double time) |
Sets the manually selected exposure time for the left and right cameras. More... | |
double | getManualExposureTimeThirdCamera () |
Gets the manually selected exposure time for the third, center, color camera (if present in the device). More... | |
void | setManualExposureTimeThirdCamera (double time) |
Sets the manually selected exposure time for the third, center, color camera (if present in the device). More... | |
double | getManualGain () |
Gets the manually selected gain for the left and right cameras. More... | |
void | setManualGain (double gain) |
Sets the manually selected gain for the left and right cameras. More... | |
double | getManualGainThirdCamera () |
Gets the manually selected gain for the third, center, color camera (if present in the device). More... | |
void | setManualGainThirdCamera (double gain) |
Sets the manually selected gain for the third, center, color camera (if present in the device). 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... | |
double | getGamma () |
Gets the gamma parameter for the left and right cameras. More... | |
void | setGamma (double gamma) |
Sets the gamma parameter for the left and right cameras. More... | |
double | getGammaThirdCamera () |
Gets the gamma parameter for the third, center, color camera (if present in the device). More... | |
void | setGammaThirdCamera (double gamma) |
Sets the gamma parameter for the third, center, color camera (if present in the device). 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... | |
int | getSkippedTriggerCount () |
Returns the number of skipped (unhandled) trigger pulses. 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). Throws ParameterException for invalid names. [DEPRECATED]. More... | |
void | saveParameter (const char *uid, bool blockingCall=true) |
Save the specified parameter to persistent device storage. More... | |
bool | hasParameter (const std::string &name) const |
Tests whether a specific named parameter is available for this device. [C++11] More... | |
visiontransfer::param::Parameter | getParameter (const std::string &name) const |
Returns a Parameter object for the named device parameter. Throws ParameterException for invalid or inaccessible parameter names. [C++11] More... | |
visiontransfer::param::ParameterSet | getParameterSet () const |
Returns all API-accessible parameters as reported by the device. [C++11] More... | |
visiontransfer::param::Parameter | pollParameter (const std::string &name, bool blockingCall=true) |
Polls a parameter to report with updated internal values. Only meaningful if parameter.isPolled()==true, otherwise works like getParameter. More... | |
void | setParameterUpdateCallback (std::function< void(const std::string &uid)> callback, bool threaded=true) |
Sets the optional user parameter update callback. This is then called for all asynchronous value or metadata changes that the server sends. [C++11] More... | |
void | setConnectionStateChangeCallback (std::function< void(visiontransfer::ConnectionState)> callback) |
Install a handler that will be called when the connection state changes (e.g. socket is disconnected). [C++11] More... | |
std::unique_ptr< TransactionLock > | transactionLock () |
Obtain a scoped TransactionLock for the current thread [C++11] More... | |
void | saveParameter (const std::string &uid, bool blockingCall=true) |
See saveParameter(const char*) [C++11] More... | |
void | saveParameter (const visiontransfer::param::Parameter ¶m, bool blockingCall=true) |
See saveParameter(const char*); this uses the specified Parameter reference [C++11] More... | |
void | saveParameters (const std::vector< std::string > &uids, bool blockingCall=true) |
See saveParameter(const char*) [C++11] More... | |
void | saveParameters (const std::set< std::string > &uids, bool blockingCall=true) |
See saveParameter(const char*) [C++11] More... | |
void | saveParameters (std::initializer_list< std::string > uids, bool blockingCall=true) |
See saveParameter(const char*) [C++11] More... | |
Friends | |
class | TransactionLock |
Possible modes of the automatic exposure and gain control.
Definition at line 403 of file deviceparameters.h.
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 121 of file deviceparameters.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 503 of file deviceparameters.h.
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 1027 of file deviceparameters.h.
visiontransfer::DeviceParameters::DeviceParameters | ( | const DeviceInfo & | device | ) |
Connects to parameter server of a Nerian stereo device by using the device information from device enumeration.
device | Information on the device to which a connection should be established. |
Definition at line 81 of file deviceparameters.cpp.
visiontransfer::DeviceParameters::DeviceParameters | ( | const char * | address, |
const char * | service = "7683" |
||
) |
Connects to parameter server of a Nerian stereo device 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 86 of file deviceparameters.cpp.
std::map< std::string, ParameterInfo > visiontransfer::DeviceParameters::getAllParameters | ( | ) |
Enumerates all simple parameters as reported by the device [DEPRECATED].
Definition at line 127 of file deviceparameters.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 484 of file deviceparameters.h.
|
inline |
Gets the maximum exposure time that can be selected automatically.
Definition at line 556 of file deviceparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically for the left and right cameras.
Definition at line 572 of file deviceparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically for the third, center, color camera (if present in the device).
Definition at line 588 of file deviceparameters.h.
|
inline |
Gets the current mode of the automatic exposure and gain control.
Definition at line 421 of file deviceparameters.h.
|
inline |
Returns true if auto re-calibration is enabled.
Definition at line 1078 of file deviceparameters.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 731 of file deviceparameters.h.
|
inline |
Returns true if an ROI for automatic exposure and gain control is enabled.
Definition at line 707 of file deviceparameters.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 537 of file deviceparameters.h.
|
inline |
Gets the selected target frame for automatic exposure and gain control.
Definition at line 518 of file deviceparameters.h.
|
inline |
Gets the target image intensity of the automatic exposure and gain control for the left and right cameras.
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 440 of file deviceparameters.h.
|
inline |
Gets the target image intensity of the automatic exposure and gain control for the third, center, color camera (if present in the device).
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 462 of file deviceparameters.h.
|
inline |
Returns true if the consistency check is enabled.
Definition at line 269 of file deviceparameters.h.
|
inline |
Gets the current sensitivity value for the consistency check.
Definition at line 283 of file deviceparameters.h.
|
inline |
Gets the current offset of the evaluated disparity range.
Definition at line 155 of file deviceparameters.h.
|
inline |
Gets the gamma parameter for the left and right cameras.
Definition at line 765 of file deviceparameters.h.
|
inline |
Gets the gamma parameter for the third, center, color camera (if present in the device).
Definition at line 783 of file deviceparameters.h.
|
inline |
Returns true if the texture gap interpolation is enabled.
Definition at line 359 of file deviceparameters.h.
|
inline |
Gets the manually selected exposure time for the left and right cameras.
This parameter is only relevant if the auto mode is set to MANUAL_EXPOSURE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 609 of file deviceparameters.h.
|
inline |
Gets the manually selected exposure time for the third, center, color camera (if present in the device).
This parameter is only relevant if the auto mode is set to MANUAL_EXPOSURE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 635 of file deviceparameters.h.
|
inline |
Gets the manually selected gain for the left and right cameras.
This parameter is only relevant if the auto mode is set to AUTO_EXPOSURE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 661 of file deviceparameters.h.
|
inline |
Gets the manually selected gain for the third, center, color camera (if present in the device).
This parameter is only relevant if the auto mode is set to AUTO_EXPOSURE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 687 of file deviceparameters.h.
|
inline |
Returns true if border pixels are removed from the computed disparity map.
Definition at line 254 of file deviceparameters.h.
|
inline |
Gets the maximum allowed time difference between two corresponding frames.
Definition at line 806 of file deviceparameters.h.
T visiontransfer::DeviceParameters::getNamedParameter | ( | const std::string & | name | ) |
Get a parameter by name, specifying the return type (int, double or bool). Throws ParameterException for invalid names. [DEPRECATED].
|
inline |
Returns true if the noise reduction filter is enabled.
Definition at line 373 of file deviceparameters.h.
|
inline |
Gets the current operation mode.
Definition at line 138 of file deviceparameters.h.
Parameter visiontransfer::DeviceParameters::getParameter | ( | const std::string & | name | ) | const |
Returns a Parameter object for the named device parameter. Throws ParameterException for invalid or inaccessible parameter names. [C++11]
The returned object is a detached copy of the internal parameter at invocation time; it is not updated when the device sends a new value. Likewise, any modifications must be requested using setParameter or the various parameter-specific setters.
Definition at line 197 of file deviceparameters.cpp.
ParameterSet visiontransfer::DeviceParameters::getParameterSet | ( | ) | const |
Returns all API-accessible parameters as reported by the device. [C++11]
Returned map entries are detached copies of the internal parameters at invocation time; they are not updated when the device sends new values. Likewise, any modifications must be requested using setParameter or the various parameter-specific setters.
Definition at line 201 of file deviceparameters.cpp.
|
inline |
Returns true if persistent storage of auto re-calibration results is enabled.
Definition at line 1092 of file deviceparameters.h.
|
inline |
Returns the number of skipped (unhandled) trigger pulses.
An increasing counter indicates that the trigger frequency is set too high for the current image size, processing settings, or network connection bandwidth.
This counter is reset to 0 when setTriggerInputMode is used (or the "trigger_input" parameter value is set).
Definition at line 1069 of file deviceparameters.h.
|
inline |
Returns true if the speckle filter is enabled.
Definition at line 387 of file deviceparameters.h.
|
inline |
Gets the edge sensitivity of the SGM algorithm.
Definition at line 237 of file deviceparameters.h.
|
inline |
Gets the SGM penalty P1 for small disparity changes at image edges.
Definition at line 173 of file deviceparameters.h.
|
inline |
Gets the SGM penalty P1 for small disparity changes outside image edges.
Definition at line 189 of file deviceparameters.h.
|
inline |
Gets the SGM penalty P2 for large disparity changes at image edges.
Definition at line 205 of file deviceparameters.h.
|
inline |
Gets the SGM penalty P2 for large disparity changes at image edges.
Definition at line 221 of file deviceparameters.h.
|
inline |
Gets the configured ROI for the subpixel optimization algorithm.
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 1132 of file deviceparameters.h.
|
inline |
Returns true if an ROI for the subpixel optimization algorithm is enabled (otherwise complete frames are used for optimization).
Definition at line 1107 of file deviceparameters.h.
|
inline |
Returns true if the texture filter is enabled.
Definition at line 329 of file deviceparameters.h.
|
inline |
Gets the current sensitivity value for the texture filter.
Definition at line 343 of file deviceparameters.h.
|
inline |
Returns the constant value that is output when trigger 0 is disabled.
Definition at line 853 of file deviceparameters.h.
|
inline |
Returns true if trigger signal 0 is enabled.
Definition at line 839 of file deviceparameters.h.
|
inline |
Returns false if trigger0 polarity is active-high (non-inverted) and false if polarity is active-low (inverted)
Definition at line 868 of file deviceparameters.h.
|
inline |
Gets the pulse width of trigger signal 0.
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. |
Definition at line 931 of file deviceparameters.h.
|
inline |
Returns the constant value that is output when trigger 1 is disabled.
Definition at line 897 of file deviceparameters.h.
|
inline |
Returns true if trigger signal 1 is enabled.
Definition at line 883 of file deviceparameters.h.
|
inline |
Gets the time offset between trigger signal 1 and signal 0.
Definition at line 1012 of file deviceparameters.h.
|
inline |
Returns false if trigger1 polarity is active-high (non-inverted) and false if polarity is active-low (inverted)
Definition at line 912 of file deviceparameters.h.
|
inline |
Gets the pulse width of trigger signal 1.
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. |
Definition at line 973 of file deviceparameters.h.
|
inline |
Gets the frequency of the trigger signal.
Definition at line 824 of file deviceparameters.h.
|
inline |
Returns the current trigger input configuration.
Definition at line 1041 of file deviceparameters.h.
|
inline |
Returns true if the consistency check is enabled.
Definition at line 299 of file deviceparameters.h.
|
inline |
Gets the current sensitivity value for the uniqueness check.
Definition at line 313 of file deviceparameters.h.
bool visiontransfer::DeviceParameters::hasParameter | ( | const std::string & | name | ) | const |
Tests whether a specific named parameter is available for this device. [C++11]
Definition at line 193 of file deviceparameters.cpp.
bool visiontransfer::DeviceParameters::isConnected | ( | ) | const |
Returns true if a remote connection is currently established and the full host-device handshake has succeeded.
May be temporarily false during a network disconnection and background re-connection phase.
See also setConnectionStateChangeCallback for the event-driven account
Definition at line 95 of file deviceparameters.cpp.
Parameter visiontransfer::DeviceParameters::pollParameter | ( | const std::string & | name, |
bool | blockingCall = true |
||
) |
Polls a parameter to report with updated internal values. Only meaningful if parameter.isPolled()==true, otherwise works like getParameter.
Returns a Parameter object for the named device parameter after polling and receiving an updated version. Throws ParameterException for invalid or inaccessible parameter names. [C++11]
The returned object is a detached copy of the internal parameter at invocation time; it is not updated when the device sends a new value. Likewise, any modifications must be requested using setParameter or the various parameter-specific setters.
name | The parameter UID to query |
blockingCall | Whether to block for the reply before returning (default true). If false, this is the pure polling update request, and the returned Parameter will not contain the updated value yet (use the update callbacks in this case). |
Definition at line 205 of file deviceparameters.cpp.
|
inline |
Remotely triggers a reboot of the device.
Definition at line 1162 of file deviceparameters.h.
void visiontransfer::DeviceParameters::saveParameter | ( | const char * | uid, |
bool | blockingCall = true |
||
) |
Save the specified parameter to persistent device storage.
uid | The parameter UID of the parameter to save |
blockingCall | If true, block until the request is accepted or denied by the device (actual write can take slightly longer). If denied, this throws a ParameterException. In non-blocking mode, no such diagnosis is possible. |
NOTE: Caution - this operation writes to permanent storage and flushes the file system on the remote device. You should use it only when required, to avoid increased wear of the flash memory inside the device.
NOTE: Calling this with a TransactionLock active will throw a TransferException. Saving must occur after the transaction has been ended.
Definition at line 230 of file deviceparameters.cpp.
void visiontransfer::DeviceParameters::saveParameter | ( | const std::string & | uid, |
bool | blockingCall = true |
||
) |
See saveParameter(const char*) [C++11]
Definition at line 233 of file deviceparameters.cpp.
void visiontransfer::DeviceParameters::saveParameter | ( | const visiontransfer::param::Parameter & | param, |
bool | blockingCall = true |
||
) |
See saveParameter(const char*); this uses the specified Parameter reference [C++11]
Definition at line 236 of file deviceparameters.cpp.
void visiontransfer::DeviceParameters::saveParameters | ( | const std::set< std::string > & | uids, |
bool | blockingCall = true |
||
) |
See saveParameter(const char*) [C++11]
This saves all specified parameters at once. If any error occurs, none are saved.
Definition at line 242 of file deviceparameters.cpp.
void visiontransfer::DeviceParameters::saveParameters | ( | const std::vector< std::string > & | uids, |
bool | blockingCall = true |
||
) |
See saveParameter(const char*) [C++11]
This saves all specified parameters at once. If any error occurs, none are saved.
Definition at line 239 of file deviceparameters.cpp.
void visiontransfer::DeviceParameters::saveParameters | ( | std::initializer_list< std::string > | uids, |
bool | blockingCall = true |
||
) |
See saveParameter(const char*) [C++11]
This saves all specified parameters at once. If any error occurs, none are saved.
Definition at line 247 of file deviceparameters.cpp.
|
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 495 of file deviceparameters.h.
|
inline |
Sets the maximum exposure time that can be selected automatically.
time | Maximum exposure time in microseconds. |
Definition at line 564 of file deviceparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically for the left and right cameras.
gain | Maximum gain in dB. |
Definition at line 580 of file deviceparameters.h.
|
inline |
Gets the maximum gain that can be selected automatically for the third, center, color camera (if present in the device).
gain | Maximum gain in dB. |
Definition at line 596 of file deviceparameters.h.
|
inline |
Sets the current mode of the automatic exposure and gain control.
Definition at line 429 of file deviceparameters.h.
|
inline |
Enables or disables auto-recalibration.
Definition at line 1085 of file deviceparameters.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 751 of file deviceparameters.h.
|
inline |
Enables or disables an ROI for automatic exposure and gain control.
Definition at line 714 of file deviceparameters.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 548 of file deviceparameters.h.
|
inline |
Selects the target frame for automatic exposure and gain control.
Definition at line 526 of file deviceparameters.h.
|
inline |
Sets the target image intensity of the automatic exposure and gain control for the left and right cameras.
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 451 of file deviceparameters.h.
|
inline |
Sets the target image intensity of the automatic exposure and gain control for the third, center, color camera (if present in the device).
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 473 of file deviceparameters.h.
void visiontransfer::DeviceParameters::setConnectionStateChangeCallback | ( | std::function< void(visiontransfer::ConnectionState)> | callback | ) |
Install a handler that will be called when the connection state changes (e.g. socket is disconnected). [C++11]
callback | The callback function to call on connection state change events |
Definition at line 253 of file deviceparameters.cpp.
|
inline |
Enables or disables the consistency check.
Definition at line 276 of file deviceparameters.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 292 of file deviceparameters.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 164 of file deviceparameters.h.
|
inline |
Sets the gamma parameter for the left and right cameras.
gamma | New gamma value. |
Definition at line 774 of file deviceparameters.h.
|
inline |
Sets the gamma parameter for the third, center, color camera (if present in the device).
gamma | New gamma value. |
Definition at line 792 of file deviceparameters.h.
|
inline |
Enables or disables the gap interpolation.
Definition at line 366 of file deviceparameters.h.
|
inline |
Sets the manually selected exposure time for the left and right cameras.
time | Exposure time in microseconds. |
This parameter is only relevant if the auto mode is set to MANUAL_EXPOSURE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 622 of file deviceparameters.h.
|
inline |
Sets the manually selected exposure time for the third, center, color camera (if present in the device).
time | Exposure time in microseconds. |
This parameter is only relevant if the auto mode is set to MANUAL_EXPOSURE_AUTO_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 648 of file deviceparameters.h.
|
inline |
Sets the manually selected gain for the left and right cameras.
gain | Gain in dB. |
This parameter is only relevant if the auto mode is set to AUTO_EXPOSURE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 674 of file deviceparameters.h.
|
inline |
Sets the manually selected gain for the third, center, color camera (if present in the device).
gain | Gain in dB. |
This parameter is only relevant if the auto mode is set to AUTO_EXPOSURE_MANUAL_GAIN or MANUAL_EXPOSURE_MANUAL_GAIN.
Definition at line 700 of file deviceparameters.h.
|
inline |
Enables or disables the removal of border pixels from the computed disparity map.
Definition at line 262 of file deviceparameters.h.
|
inline |
Sets the maximum allowed time difference between two corresponding frames.
diffMs | Time difference in milliseconds. If automatic pairing is desired, a value of -1 should be set. |
Definition at line 816 of file deviceparameters.h.
void visiontransfer::DeviceParameters::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 380 of file deviceparameters.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 148 of file deviceparameters.h.
void visiontransfer::DeviceParameters::setParameter | ( | const std::string & | name, |
T | value | ||
) |
Set a parameter by name. ParameterException for invalid names or values.
void visiontransfer::DeviceParameters::setParameterUpdateCallback | ( | std::function< void(const std::string &uid)> | callback, |
bool | threaded = true |
||
) |
Sets the optional user parameter update callback. This is then called for all asynchronous value or metadata changes that the server sends. [C++11]
The callback is called with the parameter UID; use getParameter(uid) to obtain the data.
callback | The callback function to call on parameter change events |
threaded | Whether to dispatch every handler in a dedicated thread. If threaded==true (default), parameter write operations are valid inside the callback, at the expense of threading overhead. If threaded==false (legacy), the callback is invoked by the background receiver thread. In that case, please queue the data suitably for consumption and perform costly operations outside this thread; any parameter write attempt will fail with a ParameterExeception. |
Note: In the event that the parameter server connection was lost and is then re-established by the background thread, a callback will be invoked for all existing parameters.
Definition at line 209 of file deviceparameters.cpp.
|
inline |
Enables or disables persistent storage of auto re-calibration results.
Definition at line 1099 of file deviceparameters.h.
|
inline |
Enables or disables the speckle filter.
Definition at line 394 of file deviceparameters.h.
|
inline |
Sets the edge sensitivity of the SGM algorithm.
This parameter must be in the range of 0 to 255.
Definition at line 246 of file deviceparameters.h.
|
inline |
Sets the SGM penalty P1 for small disparity changes at image edges.
This parameter must be in the range of 0 to 255.
Definition at line 182 of file deviceparameters.h.
|
inline |
Sets the SGM penalty P1 for small disparity changes outside image edges.
This parameter must be in the range of 0 to 255.
Definition at line 198 of file deviceparameters.h.
|
inline |
Sets the SGM penalty P2 for large disparity changes at image edges.
This parameter must be in the range of 0 to 255.
Definition at line 214 of file deviceparameters.h.
|
inline |
Sets the SGM penalty P2 for large disparity changes at image edges.
This parameter must be in the range of 0 to 255.
Definition at line 230 of file deviceparameters.h.
|
inline |
Sets the configured ROI for the subpixel optimization algorithm.
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 1152 of file deviceparameters.h.
|
inline |
Enables or disables an ROI for the subpixel optimization algorithm. (if disabled, complete frames are used for optimization).
Definition at line 1115 of file deviceparameters.h.
|
inline |
Enables or disables the texture filter.
Definition at line 336 of file deviceparameters.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 352 of file deviceparameters.h.
|
inline |
Sets the constant value that is output when trigger 0 is disabled.
Definition at line 860 of file deviceparameters.h.
|
inline |
Enables or disables trigger signal 0.
Definition at line 846 of file deviceparameters.h.
|
inline |
Sets the polarity for trigger0. If invert is false, the polarity is active-high (non-inverted). Otherwise the polarity is active-low (inverted).
Definition at line 876 of file deviceparameters.h.
|
inline |
Sets the pulse width of trigger signal 0.
width | Pulse width in milliseconds. |
pulse | For a cyclic pulse width configuration, this is the index of the pulse for which to set the width. Valid values are 0 to 7. |
Definition at line 952 of file deviceparameters.h.
|
inline |
Sets the constant value that is output when trigger 1 is disabled.
Definition at line 904 of file deviceparameters.h.
|
inline |
Enables or disables trigger signal 1.
Definition at line 890 of file deviceparameters.h.
|
inline |
Sets the time offset between trigger signal 1 and signal 0.
offset | Offset in milliseconds. |
Definition at line 1020 of file deviceparameters.h.
|
inline |
Sets the polarity for trigger1. If invert is false, the polarity is active-high (non-inverted). Otherwise the polarity is active-low (inverted).
Definition at line 920 of file deviceparameters.h.
|
inline |
Sets the pulse width of trigger signal 1.
width | Pulse width in milliseconds. |
pulse | For a cyclic pulse width configuration, this is the index of the pulse for which to set the width. Valid values are 0 to 7. |
Definition at line 994 of file deviceparameters.h.
|
inline |
Sets the frequency of the trigger signal.
freq | Frequency in Hz. |
Definition at line 832 of file deviceparameters.h.
|
inline |
Requests to change the trigger input configuration.
mode | The desired input mode. |
External hardware trigger input (EXTERNAL) is not available on all devices.
Definition at line 1052 of file deviceparameters.h.
|
inline |
Enables or disables the uniqueness check.
Definition at line 306 of file deviceparameters.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 322 of file deviceparameters.h.
std::unique_ptr< DeviceParameters::TransactionLock > visiontransfer::DeviceParameters::transactionLock | ( | ) |
Obtain a scoped TransactionLock for the current thread [C++11]
Definition at line 226 of file deviceparameters.cpp.
|
inline |
Emit a software trigger event to perform a single acquisition. This only has effect when the External Trigger mode is set to Software.
Definition at line 1170 of file deviceparameters.h.