#include <MultiSenseTypes.hh>
Class used to store a specific camera configuration. Members in this class are set via get and set methods. The class is used as an input to a channel object to query or set camera parameters.
Example code to query an image configuration: 
     throw std::runtime_error("Unable to query image configuration");
}
Example code to set an image configurations: 
     throw std::runtime_error("Unable to query image configuration");
}
     throw std::runtime_error("Unable to set image configuration");
}
Definition at line 790 of file MultiSenseTypes.hh.
◆ Config()
  
  | 
        
          | crl::multisense::image::Config::Config | ( |  | ) |  |  | inline | 
 
Default constructor for a image configuration. Initializes all image configuration members to their default values 
Definition at line 1316 of file MultiSenseTypes.hh.
 
 
◆ autoExposure()
  
  | 
        
          | bool crl::multisense::image::Config::autoExposure | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure enable setting
- Returns
- The current image configuration's auto-exposure enable flag 
Definition at line 1063 of file MultiSenseTypes.hh.
 
 
◆ autoExposureDecay()
  
  | 
        
          | uint32_t crl::multisense::image::Config::autoExposureDecay | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure decay rate
- Returns
- The current configuration's auto-exposure decay rate 
Definition at line 1079 of file MultiSenseTypes.hh.
 
 
◆ autoExposureMax()
  
  | 
        
          | uint32_t crl::multisense::image::Config::autoExposureMax | ( |  | ) | const |  | inline | 
 
Query the current image configuration's maximum auto-exposure value
- Returns
- The current image configuration's maximum auto-exposure value 
Definition at line 1071 of file MultiSenseTypes.hh.
 
 
◆ autoExposureRoiHeight()
  
  | 
        
          | uint16_t crl::multisense::image::Config::autoExposureRoiHeight | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure ROI height value Will return crl::multisense::Roi_Full_Image for the default setting, when the ROI covers the entire image regardless of current resolution
- Returns
- The current image configuration's auto-exposure ROI height value 
Definition at line 1182 of file MultiSenseTypes.hh.
 
 
◆ autoExposureRoiWidth()
  
  | 
        
          | uint16_t crl::multisense::image::Config::autoExposureRoiWidth | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure ROI width value Will return crl::multisense::Roi_Full_Image for the default setting, when the ROI covers the entire image regardless of current resolution
- Returns
- The current image configuration's auto-exposure ROI width value 
Definition at line 1173 of file MultiSenseTypes.hh.
 
 
◆ autoExposureRoiX()
  
  | 
        
          | uint16_t crl::multisense::image::Config::autoExposureRoiX | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure ROI X value
- Returns
- The current image configuration's auto-exposure ROI X value 
Definition at line 1157 of file MultiSenseTypes.hh.
 
 
◆ autoExposureRoiY()
  
  | 
        
          | uint16_t crl::multisense::image::Config::autoExposureRoiY | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure ROI Y value
- Returns
- The current image configuration's auto-exposure ROI Y value 
Definition at line 1164 of file MultiSenseTypes.hh.
 
 
◆ autoExposureTargetIntensity()
  
  | 
        
          | float crl::multisense::image::Config::autoExposureTargetIntensity | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure target intensity
- Returns
- The current image configuration's auto-exposure target intensity 
Definition at line 1087 of file MultiSenseTypes.hh.
 
 
◆ autoExposureThresh()
  
  | 
        
          | float crl::multisense::image::Config::autoExposureThresh | ( |  | ) | const |  | inline | 
 
Query the current image configuration's auto-exposure threshold
- Returns
- The current image configuration's auto-exposure threshold 
Definition at line 1095 of file MultiSenseTypes.hh.
 
 
◆ autoWhiteBalance()
  
  | 
        
          | bool crl::multisense::image::Config::autoWhiteBalance | ( |  | ) | const |  | inline | 
 
Query the current image configuration's white-balance enable setting
- Returns
- The current image configuration's white-balance enable flag 
Definition at line 1119 of file MultiSenseTypes.hh.
 
 
◆ autoWhiteBalanceDecay()
  
  | 
        
          | uint32_t crl::multisense::image::Config::autoWhiteBalanceDecay | ( |  | ) | const |  | inline | 
 
Query the current image configuration's white-balance decay rate
- Returns
- The current image configuration's white-balance decay rate 
Definition at line 1127 of file MultiSenseTypes.hh.
 
 
◆ autoWhiteBalanceThresh()
  
  | 
        
          | float crl::multisense::image::Config::autoWhiteBalanceThresh | ( |  | ) | const |  | inline | 
 
Query the current image configuration's white-balance threshold
- Returns
- The current image configuration's white-balance threshold 
Definition at line 1135 of file MultiSenseTypes.hh.
 
 
◆ cameraProfile()
  
  | 
        
          | CameraProfile crl::multisense::image::Config::cameraProfile | ( |  | ) | const |  | inline | 
 
Query the current image configurations camera profile
- Returns
- The current image configurations camera profile 
Definition at line 1189 of file MultiSenseTypes.hh.
 
 
◆ cx()
  
  | 
        
          | float crl::multisense::image::Config::cx | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations left rectified image center in the x dimension
Note this value is scaled based on the current image resolution
- Returns
- The current camera calibrations rectified image center in the x dimension 
Definition at line 1236 of file MultiSenseTypes.hh.
 
 
◆ cy()
  
  | 
        
          | float crl::multisense::image::Config::cy | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations left rectified image center in the y dimension
Note this value is scaled based on the current image resolution
- Returns
- The current camera calibrations rectified image center in the y dimension 
Definition at line 1248 of file MultiSenseTypes.hh.
 
 
◆ disparities()
  
  | 
        
          | uint32_t crl::multisense::image::Config::disparities | ( |  | ) | const |  | inline | 
 
Query the current image configuration's number of disparities
- Returns
- The current number of disparities used when searching for stereo feature matches 
Definition at line 1031 of file MultiSenseTypes.hh.
 
 
◆ exposure()
  
  | 
        
          | uint32_t crl::multisense::image::Config::exposure | ( |  | ) | const |  | inline | 
 
Query the current image configuration's exposure setting
- Returns
- the current image exposure setting in microseconds 
Definition at line 1055 of file MultiSenseTypes.hh.
 
 
◆ fps()
  
  | 
        
          | float crl::multisense::image::Config::fps | ( |  | ) | const |  | inline | 
 
Query the current image configuration's frames-per-second setting
- Returns
- The current frames per second 
Definition at line 1039 of file MultiSenseTypes.hh.
 
 
◆ fx()
  
  | 
        
          | float crl::multisense::image::Config::fx | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations rectified projection focal length in the x dimension.
Note this value is scaled based on the current image resolution
- Returns
- The current camera calibrations focal length in the x dimension 
Definition at line 1213 of file MultiSenseTypes.hh.
 
 
◆ fy()
  
  | 
        
          | float crl::multisense::image::Config::fy | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations rectified projection focal length in the y dimension.
Note this value is scaled based on the current image resolution
- Returns
- The current camera calibrations focal length in the y dimension 
Definition at line 1224 of file MultiSenseTypes.hh.
 
 
◆ gain()
  
  | 
        
          | float crl::multisense::image::Config::gain | ( |  | ) | const |  | inline | 
 
Query the current image configuration's gain setting
- Returns
- The current image gain setting 
Definition at line 1046 of file MultiSenseTypes.hh.
 
 
◆ gamma()
  
  | 
        
          | float crl::multisense::image::Config::gamma | ( |  | ) | const |  | inline | 
 
Query the gamma correction factor. Gamma correction factor will be applied to all images.
- Returns
- Return the gamma factor applied to images 
Definition at line 1197 of file MultiSenseTypes.hh.
 
 
◆ hdrEnabled()
  
  | 
        
          | bool crl::multisense::image::Config::hdrEnabled | ( |  | ) | const |  | inline | 
 
Query the current image configuration's HDR enable flag
- Returns
- The current image configuration's HDR enable flag 
Definition at line 1150 of file MultiSenseTypes.hh.
 
 
◆ height()
  
  | 
        
          | uint32_t crl::multisense::image::Config::height | ( |  | ) | const |  | inline | 
 
Query the current image configuration's height
- Returns
- The current image height 
Definition at line 1022 of file MultiSenseTypes.hh.
 
 
◆ pitch()
  
  | 
        
          | float crl::multisense::image::Config::pitch | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations pitch value. This is the Euler pitch angle to rotate the right camera frame into the left camera frame. For rectified images this value will be 0.
- Returns
- the current camera calibrations pitch value 
Definition at line 1300 of file MultiSenseTypes.hh.
 
 
◆ roll()
  
  | 
        
          | float crl::multisense::image::Config::roll | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations roll value. This is the Euler roll angle to rotate the right camera frame into the left camera frame. For rectified images this value will be 0.
- Returns
- the current camera calibrations roll value 
Definition at line 1290 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposure()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposure | ( | bool | e | ) |  |  | inline | 
 
Set auto-exposure enable flag. Default value: true
- Parameters
- 
  
    | e | A boolean used to enable or disable auto-exposure |  
 
Definition at line 870 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposureDecay()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposureDecay | ( | uint32_t | d | ) |  |  | inline | 
 
Set the desired auto-exposure decay rate. Default value: 7
- Parameters
- 
  
    | d | The auto-exposure decay rate [0, 20] |  
 
Definition at line 886 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposureMax()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposureMax | ( | uint32_t | m | ) |  |  | inline | 
 
Set the desired maximum auto-exposure value. Default value: 5000000
- Parameters
- 
  
    | m | The maximum auto-exposure value in microseconds |  
 
Definition at line 878 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposureRoi()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposureRoi | ( | uint16_t | start_x, |  
          |  |  | uint16_t | start_y, |  
          |  |  | uint16_t | width, |  
          |  |  | uint16_t | height |  
          |  | ) |  |  |  | inline | 
 
Set the desired ROI to use when computing the auto-exposure. x axis is horizontal and y axis is vertical. (0,0) coordinate starts in the upper left corner of the image. If (x + w > image width) or (y + h > image height) the sensor will return an error Setting to default:(0,0,crl::multisense::Roi_Full_Image,crl::multisense::Roi_Full_Image) will use the entire image for the ROI regardless of the current resolution This feature is only available in sensor firmware version 4.3 and greater
- Parameters
- 
  
    | start_x | The X coordinate where the ROI starts |  | start_y | The Y coordinate where the ROI starts |  | width | The width of the ROI |  | height | The height of the ROI |  
 
Definition at line 980 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposureTargetIntensity()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposureTargetIntensity | ( | float | d | ) |  |  | inline | 
 
Set the desired auto-exposure target Intensity. Default value: 0.95
- Parameters
- 
  
    | d | The auto-exposure target intensity [0.0, 1.0] |  
 
Definition at line 894 of file MultiSenseTypes.hh.
 
 
◆ setAutoExposureThresh()
  
  | 
        
          | void crl::multisense::image::Config::setAutoExposureThresh | ( | float | t | ) |  |  | inline | 
 
Set the desired auto-exposure threshold. This is the percentage of the image that should be white. Default value: 0.75
- Parameters
- 
  
    | t | The desired auto-exposure threshold [0.0, 1.0] |  
 
Definition at line 903 of file MultiSenseTypes.hh.
 
 
◆ setAutoWhiteBalance()
  
  | 
        
          | void crl::multisense::image::Config::setAutoWhiteBalance | ( | bool | e | ) |  |  | inline | 
 
Set the white-balance enable flag. Default value: true
- Parameters
- 
  
    | e | A boolean used to enable or disable white-balance |  
 
Definition at line 923 of file MultiSenseTypes.hh.
 
 
◆ setAutoWhiteBalanceDecay()
  
  | 
        
          | void crl::multisense::image::Config::setAutoWhiteBalanceDecay | ( | uint32_t | d | ) |  |  | inline | 
 
Set the white-balance decay rate. Default value: 3
- Parameters
- 
  
    | d | The white-balance decay rate [0, 20] |  
 
Definition at line 931 of file MultiSenseTypes.hh.
 
 
◆ setAutoWhiteBalanceThresh()
  
  | 
        
          | void crl::multisense::image::Config::setAutoWhiteBalanceThresh | ( | float | t | ) |  |  | inline | 
 
Set the white-balance threshold. Default value: 0.5
- Parameters
- 
  
    | t | The desired white-balance threshold [0.0, 1.0] |  
 
Definition at line 939 of file MultiSenseTypes.hh.
 
 
◆ setCameraProfile()
  
  | 
        
          | void crl::multisense::image::Config::setCameraProfile | ( | const CameraProfile & | profile | ) |  |  | inline | 
 
Set the operation profile for the camera to use. Profile settings subsume other user settings.
- Parameters
- 
  
    | profile | The operation profile to use on the camera |  
 
Definition at line 990 of file MultiSenseTypes.hh.
 
 
◆ setDisparities()
  
  | 
        
          | void crl::multisense::image::Config::setDisparities | ( | uint32_t | d | ) |  |  | inline | 
 
For stereo sensors, set the desired number of disparities used to search for matching features between the left and right images when computing the output disparity image. Default value: 128
- Parameters
- 
  
    | d | The number of disparities |  
 
Definition at line 816 of file MultiSenseTypes.hh.
 
 
◆ setExposure()
  
  | 
        
          | void crl::multisense::image::Config::setExposure | ( | uint32_t | e | ) |  |  | inline | 
 
Set the exposure time used to capture images. Note auto exposure must be disabled for this to take effect. Default value: 10000
- Parameters
- 
  
    | e | The output exposure time in microseconds [10, 5000000] |  
 
Definition at line 862 of file MultiSenseTypes.hh.
 
 
◆ setFps()
  
  | 
        
          | void crl::multisense::image::Config::setFps | ( | float | f | ) |  |  | inline | 
 
Set the desired output frames per second. Default value: 5
- Note
- If an external trigger is selected, this value acts as an upper bounds to the framerate.
- Parameters
- 
  
    | f | The desired frames per second |  
 
Definition at line 845 of file MultiSenseTypes.hh.
 
 
◆ setGain()
  
  | 
        
          | void crl::multisense::image::Config::setGain | ( | float | g | ) |  |  | inline | 
 
Set the desired output image's gain. Default value: 1
- Parameters
- 
  
  
Definition at line 853 of file MultiSenseTypes.hh.
 
 
◆ setGamma()
  
  | 
        
          | void crl::multisense::image::Config::setGamma | ( | const float | g | ) |  |  | inline | 
 
Set the gamma correction factor.
Gamma is a nonlinear operation used to encode and decode luminance. Typical values for gamma range between 1 and 2.2.
- Parameters
- 
  
    | g | the gamma constant applied to the camera sources |  
 
Definition at line 1003 of file MultiSenseTypes.hh.
 
 
◆ setHdr()
  
  | 
        
          | void crl::multisense::image::Config::setHdr | ( | bool | e | ) |  |  | inline | 
 
Set the HDR enable flag. This feature is only available in sensor firmware version greater than 3.1. Default value: false. Note enabling HDR will disable image white balance. It may also degrade the stereo performance. It is advised to manually tune exposure and gain settings to achieve desired performance.
- Parameters
- 
  
    | e | A boolean used to enable or disable HDR on the camera imagers |  
 
Definition at line 963 of file MultiSenseTypes.hh.
 
 
◆ setHeight()
  
  | 
        
          | void crl::multisense::image::Config::setHeight | ( | uint32_t | h | ) |  |  | inline | 
 
Set the height of the desired output resolution. Default value: 544
- Parameters
- 
  
    | h | The new resolution's height |  
 
Definition at line 834 of file MultiSenseTypes.hh.
 
 
◆ setResolution()
  
  | 
        
          | void crl::multisense::image::Config::setResolution | ( | uint32_t | w, |  
          |  |  | uint32_t | h |  
          |  | ) |  |  |  | inline | 
 
Set a desired output resolution. Default value: 1024x544
- Parameters
- 
  
    | w | The new resolutions width |  | h | The new resolutions height |  
 
Definition at line 804 of file MultiSenseTypes.hh.
 
 
◆ setStereoPostFilterStrength()
  
  | 
        
          | void crl::multisense::image::Config::setStereoPostFilterStrength | ( | float | s | ) |  |  | inline | 
 
Set the desired stereo post-filter strength. This is used to filter low confidence stereo data before it is sent to the host. Larger numbers indicate more aggressive filtering. This feature is only available on sensor firmware versions greater than 3.0. Default value: 0.5
- Parameters
- 
  
    | s | The desired stereo post-filter strength [0.0, 1.0] |  
 
Definition at line 951 of file MultiSenseTypes.hh.
 
 
◆ setWhiteBalance()
  
  | 
        
          | void crl::multisense::image::Config::setWhiteBalance | ( | float | r, |  
          |  |  | float | b |  
          |  | ) |  |  |  | inline | 
 
Set the desired image white-balance. Default value: 1.0 for both r and b
- Parameters
- 
  
    | r | The input read white-balance value [0.25, 4.0] |  | b | The input blue white-balance value [0.25, 4.0] |  
 
Definition at line 914 of file MultiSenseTypes.hh.
 
 
◆ setWidth()
  
  | 
        
          | void crl::multisense::image::Config::setWidth | ( | uint32_t | w | ) |  |  | inline | 
 
Set the width of the desired output resolution. Default value: 1024
- Parameters
- 
  
    | w | The new resolution's width |  
 
Definition at line 825 of file MultiSenseTypes.hh.
 
 
◆ stereoPostFilterStrength()
  
  | 
        
          | float crl::multisense::image::Config::stereoPostFilterStrength | ( |  | ) | const |  | inline | 
 
Query the current image configuration's stereo post-filter strength
- Returns
- The current image configuration's stereo post-filter strength 
Definition at line 1143 of file MultiSenseTypes.hh.
 
 
◆ tx()
  
  | 
        
          | float crl::multisense::image::Config::tx | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations stereo baseline. This is the component of the vector in the x dimension which points from the right rectified camera frame to the left rectified camera frame
- Returns
- The x component of the current calibrations stereo baseline 
Definition at line 1258 of file MultiSenseTypes.hh.
 
 
◆ ty()
  
  | 
        
          | float crl::multisense::image::Config::ty | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations stereo baseline. This is the component of the vector in the y dimension which points from the right rectified camera frame to the left rectified camera frame. For rectified images this value will be 0.
- Returns
- The y component of the current calibrations stereo baseline 
Definition at line 1269 of file MultiSenseTypes.hh.
 
 
◆ tz()
  
  | 
        
          | float crl::multisense::image::Config::tz | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations stereo baseline. This is the component of the vector in the z dimension which points from the right rectified frame center to the left rectified camera frame. For rectified images this value will be 0.
- Returns
- The z component of the current calibrations stereo baseline 
Definition at line 1280 of file MultiSenseTypes.hh.
 
 
◆ whiteBalanceBlue()
  
  | 
        
          | float crl::multisense::image::Config::whiteBalanceBlue | ( |  | ) | const |  | inline | 
 
Query the current image configuration's blue white-balance setting
- Returns
- The current image configuration's blue white-balance setting 
Definition at line 1111 of file MultiSenseTypes.hh.
 
 
◆ whiteBalanceRed()
  
  | 
        
          | float crl::multisense::image::Config::whiteBalanceRed | ( |  | ) | const |  | inline | 
 
Query the current image configuration's red white-balance setting
- Returns
- The current image configuration's red white-balance setting 
Definition at line 1103 of file MultiSenseTypes.hh.
 
 
◆ width()
  
  | 
        
          | uint32_t crl::multisense::image::Config::width | ( |  | ) | const |  | inline | 
 
Query the current image configuration's width
- Returns
- The current image width 
Definition at line 1014 of file MultiSenseTypes.hh.
 
 
◆ yaw()
  
  | 
        
          | float crl::multisense::image::Config::yaw | ( |  | ) | const |  | inline | 
 
Query the current camera calibrations yaw value. This is the Euler yaw angle to rotate the right camera frame into the left camera frame. For rectified images this value will be 0.
- Returns
- the current camera calibrations yaw value 
Definition at line 1310 of file MultiSenseTypes.hh.
 
 
◆ m_cx
  
  | 
        
          | float crl::multisense::image::Config::m_cx |  | protected | 
 
 
◆ m_cy
  
  | 
        
          | float crl::multisense::image::Config::m_cy |  | protected | 
 
 
◆ m_disparities
  
  | 
        
          | uint32_t crl::multisense::image::Config::m_disparities |  | private | 
 
 
◆ m_exposure
◆ m_fps
  
  | 
        
          | float crl::multisense::image::Config::m_fps |  | private | 
 
 
◆ m_fx
  
  | 
        
          | float crl::multisense::image::Config::m_fx |  | protected | 
 
 
◆ m_fy
  
  | 
        
          | float crl::multisense::image::Config::m_fy |  | protected | 
 
 
◆ m_gain
  
  | 
        
          | float crl::multisense::image::Config::m_gain |  | private | 
 
 
◆ m_gamma
  
  | 
        
          | float crl::multisense::image::Config::m_gamma |  | private | 
 
 
◆ m_hdrEnabled
  
  | 
        
          | bool crl::multisense::image::Config::m_hdrEnabled |  | private | 
 
 
◆ m_height
  
  | 
        
          | uint32_t crl::multisense::image::Config::m_height |  | private | 
 
 
◆ m_pitch
  
  | 
        
          | float crl::multisense::image::Config::m_pitch |  | protected | 
 
 
◆ m_profile
◆ m_roll
  
  | 
        
          | float crl::multisense::image::Config::m_roll |  | protected | 
 
 
◆ m_spfStrength
  
  | 
        
          | float crl::multisense::image::Config::m_spfStrength |  | private | 
 
 
◆ m_tx
  
  | 
        
          | float crl::multisense::image::Config::m_tx |  | protected | 
 
 
◆ m_ty
  
  | 
        
          | float crl::multisense::image::Config::m_ty |  | protected | 
 
 
◆ m_tz
  
  | 
        
          | float crl::multisense::image::Config::m_tz |  | protected | 
 
 
◆ m_wbBlue
  
  | 
        
          | float crl::multisense::image::Config::m_wbBlue |  | private | 
 
 
◆ m_wbDecay
  
  | 
        
          | uint32_t crl::multisense::image::Config::m_wbDecay |  | private | 
 
 
◆ m_wbEnabled
  
  | 
        
          | bool crl::multisense::image::Config::m_wbEnabled |  | private | 
 
 
◆ m_wbRed
  
  | 
        
          | float crl::multisense::image::Config::m_wbRed |  | private | 
 
 
◆ m_wbThresh
  
  | 
        
          | float crl::multisense::image::Config::m_wbThresh |  | private | 
 
 
◆ m_width
  
  | 
        
          | uint32_t crl::multisense::image::Config::m_width |  | private | 
 
 
◆ m_yaw
  
  | 
        
          | float crl::multisense::image::Config::m_yaw |  | protected | 
 
 
The documentation for this class was generated from the following file: