NetOceanDirect  2.4.0
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | List of all members
NetOceanDirect::Pixel Class Reference

Inherits NetOceanDirect::ManagedObject< PixelAPI >.

Public Member Functions

array< int > getActivePixelRange (long deviceID, int% errorCode)
 
array< int > getBadPixelIndices (long deviceID, int% errorCode)
 
array< int > getOpticalDarkPixelRange (long deviceID, int% errorCode)
 
int getPixelCount (long deviceID, int% errorCode)
 
array< int > getTransitionPixelRange (long deviceID, int% errorCode)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< PixelAPI >
 ManagedObject (PixelAPI *instance)
 
PixelAPI * GetInstance ()
 

Static Public Member Functions

static Pixel getInstance ()
 

Additional Inherited Members

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

Member Function Documentation

◆ 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.

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.

◆ 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.

◆ 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.

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