NetOceanDirect 3.1.3
OceanDirect .NET API
NetOceanDirect::Pixel Class Reference

#include <Pixel.h>

Inherits NetOceanDirect::ManagedObject< PixelAPI >.

Public Member Functions

 Pixel (PixelAPI *instance)
 
virtual ~Pixel ()
 
int getActivePixelCount (long deviceID, int% errorCode)
 
array< int > getActivePixelRange (long deviceID, int% errorCode)
 
array< int > getBadPixelIndices (long deviceID, int% errorCode)
 
int getOpticalDarkPixelCount (long deviceID, int% errorCode)
 
array< int > getOpticalDarkPixelRange (long deviceID, int% errorCode)
 
int getPixelCount (long deviceID, int% errorCode)
 
int getTransitionPixelCount (long deviceID, int% errorCode)
 
array< int > getTransitionPixelRange (long deviceID, int% errorCode)
 
void setBadPixelIndices (long deviceID, int% errorCode, array< int >^ indices)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< PixelAPI >
 ManagedObject (PixelAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
PixelAPI * GetInstance ()
 

Static Public Member Functions

static Pixel getInstance ()
 

Protected Member Functions

 Pixel ()
 

Static Protected Attributes

static Pixel pixel
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< PixelAPI >
PixelAPI * m_Instance
 

Constructor & Destructor Documentation

◆ Pixel() [1/2]

Pixel::Pixel ( )
protected

◆ Pixel() [2/2]

Pixel::Pixel ( PixelAPI * instance)

◆ ~Pixel()

virtual NetOceanDirect::Pixel::~Pixel ( )
inlinevirtual

Member Function Documentation

◆ getActivePixelCount()

int Pixel::getActivePixelCount ( long deviceID,
int% errorCode )

◆ getActivePixelRange()

array< int > Pixel::getActivePixelRange ( long deviceID,
int% errorCode )

Read the active pixel range from the sensor pixel array.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
An array containing active pixel range indices.

◆ getBadPixelIndices()

array< int > Pixel::getBadPixelIndices ( long deviceID,
int% errorCode )

Read bad pixel indices from the sensor pixel array. This command only supported OceanNR, NIRQuest256, and NIRQuest512.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
An array containing bad pixel range indices.

◆ getInstance()

Pixel Pixel::getInstance ( )
static

◆ getOpticalDarkPixelCount()

int Pixel::getOpticalDarkPixelCount ( long deviceID,
int% errorCode )

◆ getOpticalDarkPixelRange()

array< int > Pixel::getOpticalDarkPixelRange ( long deviceID,
int% errorCode )

Read the optical dark pixel range from the sensor pixel array.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
An array containing optical dark pixel range indices.

◆ getPixelCount()

int Pixel::getPixelCount ( long deviceID,
int% errorCode )

Return the pixel count. The pixel count refers to all the pixels from the spectra we received from the device.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
The pixel count.

◆ getTransitionPixelCount()

int Pixel::getTransitionPixelCount ( long deviceID,
int% errorCode )

◆ getTransitionPixelRange()

array< int > Pixel::getTransitionPixelRange ( long deviceID,
int% errorCode )

Read the transition pixel range from the sensor pixel array.

Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
Returns
An array containing transition pixel range indices.

◆ setBadPixelIndices()

void Pixel::setBadPixelIndices ( long deviceID,
int% errorCode,
array< int >^ indices )

Store the pixel indices of the pixels identified as "bad" e.g. hot pixels.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise ERROR_NO_DEVICE if deviceID is not a valid and open deviceID ERROR_FEATURE_NOT_FOUND if device does not support this feature ERROR_TRANSFER_ERROR if data transfer to/from device fails
[in]indicesthe array containing the desired bad pixel indices.

Member Data Documentation

◆ pixel

Pixel NetOceanDirect::Pixel::pixel
staticprotected

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