#include <LHSensorAPI.h>
|
virtual | ~LHSensorAPI ()=default |
|
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) |
|
◆ ~LHSensorAPI()
virtual oceandirect::api::LHSensorAPI::~LHSensorAPI |
( |
| ) |
|
|
virtualdefault |
◆ getActivePixelCount()
.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
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the number of active pixels or 0 on error.
◆ getActivePixelIndices()
.getActivePixelIndices Determine the indices of the active pixels in the device sensor.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
indices | the array to receive the indices of the active pixels. |
indicesSize | the actual size of the indices array. |
- Returns
- the actual number of indices copied into the buffer or 0 on error.
◆ getBadPixelIndices()
.getBadPixelIndices Determine the indices of pixels that have been determined to be "bad" e.g. hot pixels.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
indices | the array to receive the indices of the bad pixels. |
indicesSize | the actual size of the indices array. |
- Returns
- the actual number of indices copied int the buffer or 0 on error.
◆ getOpticalDarkPixelCount()
.getOpticalDarkPixelCount Return the total number of optically dark pixels in the device sensor. Optically dark pixels are not light sensitive.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the number of optically dark pixels or 0 on error.
◆ getOpticalDarkPixelIndices()
.getOpticalDarkPixelIndices Determine the indices of the optically dark pixels in the device sensor.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
indices | the array to receive the indices of the optically dark pixels. |
indicesSize | the actual size of the indices array. |
- Returns
- the actual number of indices copied int the buffer or 0 on error.
◆ getTotalPixelCount()
.getTotalPixelCount Return the total number of pixels in the device sensor. Note: this is the total number; not all pixels will be "active".
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the total number of pixels or 0 on error.
◆ getTransitionPixelCount()
.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
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the number of transition pixels or 0 on error.
◆ getTransitionPixelIndices()
.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
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
indices | the array to receive the indices of the transition pixels. |
indicesSize | the 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: