OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHAutoNullingAPI Class Reference

#include <LHAutoNullingAPI.h>

Public Member Functions

virtual ~LHAutoNullingAPI ()=default
 
virtual lh_autonull_baseline_t getBaselineLevel (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_autonull_fpga_digital_t getFPGADigitalGain (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_autonull_fpga_digital_t getFPGADigitalOffset (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_pixel_intensity_t getMaximumADCCount (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual lh_autonull_saturation_t getSaturationLevel (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 

Constructor & Destructor Documentation

◆ ~LHAutoNullingAPI()

virtual oceandirect::api::LHAutoNullingAPI::~LHAutoNullingAPI ( )
virtualdefault

Member Function Documentation

◆ getBaselineLevel()

virtual lh_autonull_baseline_t oceandirect::api::LHAutoNullingAPI::getBaselineLevel ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getBaselineLevel Return the baseline intensity value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the baseline intensity value or 0 on error.

◆ getFPGADigitalGain()

virtual lh_autonull_fpga_digital_t oceandirect::api::LHAutoNullingAPI::getFPGADigitalGain ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getFPGADigitalGain Return the fpga digital gain value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the digital gain value or 0 on error.

◆ getFPGADigitalOffset()

virtual lh_autonull_fpga_digital_t oceandirect::api::LHAutoNullingAPI::getFPGADigitalOffset ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getFPGADigitalOffset Return the fpga digital offset value.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the digital offset value or 0 on error.

◆ getMaximumADCCount()

virtual lh_pixel_intensity_t oceandirect::api::LHAutoNullingAPI::getMaximumADCCount ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getMaximumADCCount Return the maximum value that can be returned by the analog to digital converter (ADC) on the device.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum ADC value or 0 on error.

◆ getSaturationLevel()

virtual lh_autonull_saturation_t oceandirect::api::LHAutoNullingAPI::getSaturationLevel ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getSaturationLevel Return the value at which the device is saturated.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the saturation value or 0 on error.

The documentation for this class was generated from the following file: