OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::PixelAPI Class Reference

Public Member Functions

int getActivePixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 
int getBadPixelIndices (long deviceID, int *error_code, int *badPixelIndices, int badPixelSize)
 
int getOpticalDarkPixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 
int getPixelCount (long deviceID, int *error_code)
 
int getTransitionPixelRange (long deviceID, int *error_code, int *range, int rangeSize)
 

Static Public Member Functions

static PixelAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getActivePixelRange()

int oceandirect::api::PixelAPI::getActivePixelRange ( long  deviceID,
int *  error_code,
int *  range,
int  rangeSize 
)

Get the optically active pixel indices.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
rangethe buffer to receive the optically active pixel indices.
rangeSizethe size of the buffer.
Returns
the number of optically active pixels.

◆ getBadPixelIndices()

int oceandirect::api::PixelAPI::getBadPixelIndices ( long  deviceID,
int *  error_code,
int *  badPixelIndices,
int  badPixelSize 
)

Get the pixel indices of the pixels marked as "bad" e.g. hot pixels.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
badPixelIndicesthe buffer to receive the bad pixel indices.
badPixelSizethe size of the buffer.
Returns
the number of bad pixels.

◆ getOpticalDarkPixelRange()

int oceandirect::api::PixelAPI::getOpticalDarkPixelRange ( long  deviceID,
int *  error_code,
int *  range,
int  rangeSize 
)

Get the optically dark pixel indices.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
rangethe buffer to receive the optically dark pixel indices.
rangeSizethe size of the buffer.
Returns
the number of optically dark pixels.

◆ getPixelCount()

int oceandirect::api::PixelAPI::getPixelCount ( long  deviceID,
int *  error_code 
)

Get the total number of pixels.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.

◆ getTransitionPixelRange()

int oceandirect::api::PixelAPI::getTransitionPixelRange ( long  deviceID,
int *  error_code,
int *  range,
int  rangeSize 
)

Get the transition pixel indices.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
rangethe buffer to receive the transition pixel indices.
rangeSizethe size of the buffer.
Returns
the number of transition pixels.

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