LibMultiSense
LibMultiSense Documentation
crl::multisense::image::SensorCalibration Class Reference

Class to store sensor gains used to perform a DC level adjustment to calibrate the left imager to the right imager. More...

#include <MultiSenseTypes.hh>

Public Attributes

uint8_t adc_gain [2]
 The CMV2000/CMV4000 ADC gain applied to each pixel value. More...
 
int16_t bl_offset [2]
 The imager black level offset for each imager. More...
 
uint8_t vramp [2]
 The imager vramp pair for each imager. More...
 

Detailed Description

Class to store sensor gains used to perform a DC level adjustment to calibrate the left imager to the right imager.

For more information on the specific applications please email suppo.nosp@m.rt@c.nosp@m.arneg.nosp@m.iero.nosp@m.botic.nosp@m.s.co.nosp@m.m

Example code to query a devices's imager calibration:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a instance of SensorCalibration to store the device's imager
// calibration
//
// Query the imager calibration from the Channel instance
crl::multisense::Status status = channel->getSensorCalibration(sensorCalibration));
//
// Check to see if the network configuration query succeeded
throw std::runtime_error("Unable to query device's imager calibration");
}
//
// Use the image calibration...
//
// Destroy the channel instance

Example code to set a devices imager calibration:

//
// Instantiate a channel connecting to a sensor at the factory default
// IP address
channel = crl::multisense::Channel::Create("10.66.171.21");
channel->setMtu(7200);
//
// Create a instance of SensorCalibration to store the device's imager
// calibration
//
// Query the imager calibration from the Channel instance
crl::multisense::Status status = channel->getSensorCalibration(sensorCalibration));
//
// Modify the imager calibration gains based on the pre-existing default
// values
sensorCalibration.adc_gain[0] += 1;
sensorCalibration.adc_gain[1] += 1;
sensorCalibration.bl_offset[0] += 1;
sensorCalibration.bl_offset[1] += 1;
//
// Send the new imager calibration to the device
crl::multisense::Status status = channel->setSensorCalibration(sensorCalibration));
//
// Check to see if the new network configuration was received
throw std::runtime_error("Unable to set the devices's imager calibration");
}
//
// Destroy the channel instance

Definition at line 1652 of file MultiSenseTypes.hh.

Member Data Documentation

◆ adc_gain

uint8_t crl::multisense::image::SensorCalibration::adc_gain[2]

The CMV2000/CMV4000 ADC gain applied to each pixel value.

Index 0 corresponds to the left imager, index 1 corresponds to the right imager

Definition at line 1657 of file MultiSenseTypes.hh.

◆ bl_offset

int16_t crl::multisense::image::SensorCalibration::bl_offset[2]

The imager black level offset for each imager.

Index 0 corresponds to the left imager, index 1 corresponds to the right imager

Definition at line 1661 of file MultiSenseTypes.hh.

◆ vramp

uint8_t crl::multisense::image::SensorCalibration::vramp[2]

The imager vramp pair for each imager.

Index 0 corresponds to the left imager, index 1 corresponds to the right imager

Definition at line 1665 of file MultiSenseTypes.hh.


The documentation for this class was generated from the following file:
crl::multisense::Channel
Class which manages all communications with a MultiSense device.
Definition: MultiSenseChannel.hh:69
crl::multisense::Status_Ok
static CRL_CONSTEXPR Status Status_Ok
Definition: MultiSenseTypes.hh:98
crl::multisense::image::SensorCalibration::adc_gain
uint8_t adc_gain[2]
The CMV2000/CMV4000 ADC gain applied to each pixel value.
Definition: MultiSenseTypes.hh:1657
crl::multisense::Channel::setSensorCalibration
virtual Status setSensorCalibration(const image::SensorCalibration &c)=0
Set the devices imager calibration.
crl::multisense::Channel::Destroy
static void Destroy(Channel *instanceP)
Destroy a channel instance that was created using the static member function Channel::Create().
crl::multisense::image::SensorCalibration::bl_offset
int16_t bl_offset[2]
The imager black level offset for each imager.
Definition: MultiSenseTypes.hh:1661
crl::multisense::Status
int32_t Status
General status typdef used as a return value for get/set crl::multisense::Channel methods.
Definition: MultiSenseTypes.hh:93
crl::multisense::Channel::setMtu
virtual Status setMtu(int32_t mtu)=0
Set the current sensor's MTU.
crl::multisense::image::SensorCalibration
Class to store sensor gains used to perform a DC level adjustment to calibrate the left imager to the...
Definition: MultiSenseTypes.hh:1652
crl::multisense::Channel::getSensorCalibration
virtual Status getSensorCalibration(image::SensorCalibration &c)=0
Query the current device imager calibration.
crl::multisense::Channel::Create
static Channel * Create(const std::string &sensorAddress)
Create a Channel instance, used to manage all communications with a sensor.