OceanDirectLighthouse  3.1.1
OceanDirect Lighthouse C++/C API
oceandirect::api::LHSensorAPI Class Reference

Public Member Functions

virtual size_t getActivePixelCount (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual size_t getActivePixelIndices (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
 
virtual size_t getBadPixelIndices (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
 
virtual size_t getOpticalDarkPixelCount (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual size_t getOpticalDarkPixelIndices (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
 
virtual size_t getTotalPixelCount (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual size_t getTransitionPixelCount (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual size_t getTransitionPixelIndices (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_pixel_index_t indices[], size_t indicesSize)
 

Member Function Documentation

◆ getActivePixelCount()

virtual size_t oceandirect::api::LHSensorAPI::getActivePixelCount ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode 
)
virtual

.getActivePixelCount Return the total number of active pixels in the device sensor. Active pixels are light sensitive and return the intensities of the measured spectrum.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of active pixels or 0 on error.

◆ getActivePixelIndices()

virtual size_t oceandirect::api::LHSensorAPI::getActivePixelIndices ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode,
lh_pixel_index_t  indices[],
size_t  indicesSize 
)
virtual

.getActivePixelIndices Determine the indices of the active pixels in the device sensor.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
indicesthe array to receive the indices of the active pixels.
indicesSizethe actual size of the indices array.
Returns
the actual number of indices copied into the buffer or 0 on error.

◆ getBadPixelIndices()

virtual size_t oceandirect::api::LHSensorAPI::getBadPixelIndices ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode,
lh_pixel_index_t  indices[],
size_t  indicesSize 
)
virtual

.getBadPixelIndices Determine the indices of pixels that have been determined to be "bad" e.g. hot pixels.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
indicesthe array to receive the indices of the bad pixels.
indicesSizethe actual size of the indices array.
Returns
the actual number of indices copied int the buffer or 0 on error.

◆ getOpticalDarkPixelCount()

virtual size_t oceandirect::api::LHSensorAPI::getOpticalDarkPixelCount ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode 
)
virtual

.getOpticalDarkPixelCount Return the total number of optically dark pixels in the device sensor. Optically dark pixels are not light sensitive.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of optically dark pixels or 0 on error.

◆ getOpticalDarkPixelIndices()

virtual size_t oceandirect::api::LHSensorAPI::getOpticalDarkPixelIndices ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode,
lh_pixel_index_t  indices[],
size_t  indicesSize 
)
virtual

.getOpticalDarkPixelIndices Determine the indices of the optically dark pixels in the device sensor.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
indicesthe array to receive the indices of the optically dark pixels.
indicesSizethe actual size of the indices array.
Returns
the actual number of indices copied int the buffer or 0 on error.

◆ getTotalPixelCount()

virtual size_t oceandirect::api::LHSensorAPI::getTotalPixelCount ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode 
)
virtual

.getTotalPixelCount Return the total number of pixels in the device sensor. Note: this is the total number; not all pixels will be "active".

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the total number of pixels or 0 on error.

◆ getTransitionPixelCount()

virtual size_t oceandirect::api::LHSensorAPI::getTransitionPixelCount ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode 
)
virtual

.getTransitionPixelCount Return the total number of transition pixels in the device sensor. Transition pixels lie between the active and optically dark pixels so they may return intensities that appear to be plausible but cannot be relied upon.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of transition pixels or 0 on error.

◆ getTransitionPixelIndices()

virtual size_t oceandirect::api::LHSensorAPI::getTransitionPixelIndices ( lh_device_id_t  deviceID,
lh_error_code_t *  errorCode,
lh_pixel_index_t  indices[],
size_t  indicesSize 
)
virtual

.getTransitionPixelIndices Determine the indices of the transition pixels in the device sensor. Transition pixels lie between the active and optically dark pixels so they may return intensities that appear to be plausible but cannot be relied upon.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
indicesthe array to receive the indices of the transition pixels.
indicesSizethe actual size of the indices array.
Returns
the actual number of indices copied into the buffer or 0 on error.

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