#include <PixelAPI.h>
|
| PixelAPI () |
|
virtual | ~PixelAPI () |
|
virtual int | getActivePixelCount (long deviceID, int *error_code) |
|
virtual int | getActivePixelRange (long deviceID, int *error_code, int *range, int rangeSize) |
|
virtual int | getBadPixelIndices (long deviceID, int *error_code, int *badPixelIndices, int badPixelSize) |
|
virtual int | getOpticalDarkPixelCount (long deviceID, int *error_code) |
|
virtual int | getOpticalDarkPixelRange (long deviceID, int *error_code, int *range, int rangeSize) |
|
virtual int | getPixelCount (long deviceID, int *error_code) |
|
virtual int | getTransitionPixelCount (long deviceID, int *error_code) |
|
virtual int | getTransitionPixelRange (long deviceID, int *error_code, int *range, int rangeSize) |
|
virtual void | setBadPixelIndices (long deviceID, int *error_code, int *badPixelIndices, int badPixelSize) |
|
◆ PixelAPI()
oceandirect::api::PixelAPI::PixelAPI |
( |
| ) |
|
◆ ~PixelAPI()
virtual oceandirect::api::PixelAPI::~PixelAPI |
( |
| ) |
|
|
virtual |
◆ getActivePixelCount()
virtual int oceandirect::api::PixelAPI::getActivePixelCount |
( |
long | deviceID, |
|
|
int * | error_code ) |
|
virtual |
◆ getActivePixelRange()
virtual int oceandirect::api::PixelAPI::getActivePixelRange |
( |
long | deviceID, |
|
|
int * | error_code, |
|
|
int * | range, |
|
|
int | rangeSize ) |
|
virtual |
Get the optically active pixel indices.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
range | the buffer to receive the optically active pixel indices. |
rangeSize | the size of the buffer. |
- Returns
- the number of optically active pixels.
◆ getBadPixelIndices()
virtual int oceandirect::api::PixelAPI::getBadPixelIndices |
( |
long | deviceID, |
|
|
int * | error_code, |
|
|
int * | badPixelIndices, |
|
|
int | badPixelSize ) |
|
virtual |
Get the pixel indices of the pixels marked as "bad" e.g. hot pixels.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
badPixelIndices | the buffer to receive the bad pixel indices. |
badPixelSize | the size of the buffer. |
- Returns
- the number of bad pixels.
◆ getInstance()
static PixelAPI * oceandirect::api::PixelAPI::getInstance |
( |
| ) |
|
|
static |
◆ getOpticalDarkPixelCount()
virtual int oceandirect::api::PixelAPI::getOpticalDarkPixelCount |
( |
long | deviceID, |
|
|
int * | error_code ) |
|
virtual |
◆ getOpticalDarkPixelRange()
virtual int oceandirect::api::PixelAPI::getOpticalDarkPixelRange |
( |
long | deviceID, |
|
|
int * | error_code, |
|
|
int * | range, |
|
|
int | rangeSize ) |
|
virtual |
Get the optically dark pixel indices.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
range | the buffer to receive the optically dark pixel indices. |
rangeSize | the size of the buffer. |
- Returns
- the number of optically dark pixels.
◆ getPixelCount()
virtual int oceandirect::api::PixelAPI::getPixelCount |
( |
long | deviceID, |
|
|
int * | error_code ) |
|
virtual |
Get the total number of pixels.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- the total number of pixels.
◆ getTransitionPixelCount()
virtual int oceandirect::api::PixelAPI::getTransitionPixelCount |
( |
long | deviceID, |
|
|
int * | error_code ) |
|
virtual |
◆ getTransitionPixelRange()
virtual int oceandirect::api::PixelAPI::getTransitionPixelRange |
( |
long | deviceID, |
|
|
int * | error_code, |
|
|
int * | range, |
|
|
int | rangeSize ) |
|
virtual |
Get the transition pixel indices.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
range | the buffer to receive the transition pixel indices. |
rangeSize | the size of the buffer. |
- Returns
- the number of transition pixels.
◆ setBadPixelIndices()
virtual void oceandirect::api::PixelAPI::setBadPixelIndices |
( |
long | deviceID, |
|
|
int * | error_code, |
|
|
int * | badPixelIndices, |
|
|
int | badPixelSize ) |
|
virtual |
Set the pixel indices of the pixels marked as "bad" e.g. hot pixels.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
badPixelIndices | the bad pixel indices. |
badPixelSize | the size of the buffer. |
◆ shutdown()
static void oceandirect::api::PixelAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
PixelAPI* oceandirect::api::PixelAPI::instance |
|
staticprotected |
The documentation for this class was generated from the following file: