NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseSensorInformation Class Reference

#include <NetLighthouseSensorInformation.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseSensorInformation ()
 
virtual unsigned int getActivePixelCount (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned short > getActivePixelIndices (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned short > getBadPixelIndices (unsigned int deviceID, int %errorCode)
 
virtual unsigned int getOpticalDarkPixelCount (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned short > getOpticalDarkPixelIndices (unsigned int deviceID, int %errorCode)
 
virtual unsigned int getTotalPixelCount (unsigned int deviceID, int %errorCode)
 
virtual unsigned int getTransitionPixelCount (unsigned int deviceID, int %errorCode)
 
virtual array< unsigned short > getTransitionPixelIndices (unsigned int deviceID, int %errorCode)
 

Static Public Member Functions

static NetLighthouseSensorInformation getInstance ()
 

Protected Member Functions

 NetLighthouseSensorInformation ()
 

Static Protected Attributes

static NetLighthouseSensorInformation sensorInfo
 

Constructor & Destructor Documentation

◆ NetLighthouseSensorInformation()

NetLighthouseSensorInformation::NetLighthouseSensorInformation ( )
protected

◆ ~NetLighthouseSensorInformation()

virtual NetLighthouse::NetLighthouseSensorInformation::~NetLighthouseSensorInformation ( )
inlinevirtual

Member Function Documentation

◆ getActivePixelCount()

unsigned int NetLighthouseSensorInformation::getActivePixelCount ( unsigned int deviceID,
int % errorCode )
virtual

.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
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of active pixels or 0 on error.

◆ getActivePixelIndices()

array< unsigned short > NetLighthouseSensorInformation::getActivePixelIndices ( unsigned int deviceID,
int % errorCode )
virtual

.getActivePixelIndices Determine the indices of the active pixels in the device sensor.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the active pixel indices.

◆ getBadPixelIndices()

array< unsigned short > NetLighthouseSensorInformation::getBadPixelIndices ( unsigned int deviceID,
int % errorCode )
virtual

.getBadPixelIndices Determine the indices of pixels that have been determined to be "bad" e.g. hot pixels.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the bad pixel indices.

◆ getInstance()

NetLighthouseSensorInformation NetLighthouseSensorInformation::getInstance ( )
static

◆ getOpticalDarkPixelCount()

unsigned int NetLighthouseSensorInformation::getOpticalDarkPixelCount ( unsigned int deviceID,
int % errorCode )
virtual

.getOpticalDarkPixelCount Return the total number of optically dark pixels in the device sensor. Optically dark pixels are not light sensitive.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of optically dark pixels or 0 on error.

◆ getOpticalDarkPixelIndices()

array< unsigned short > NetLighthouseSensorInformation::getOpticalDarkPixelIndices ( unsigned int deviceID,
int % errorCode )
virtual

.getOpticalDarkPixelIndices Determine the indices of the optically dark pixels in the device sensor.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the optically dark pixel indices.

◆ getTotalPixelCount()

unsigned int NetLighthouseSensorInformation::getTotalPixelCount ( unsigned int deviceID,
int % errorCode )
virtual

.getTotalPixelCount Return the total number of pixels in the device sensor. Note: this is the total number; not all pixels will be "active".

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the total number of pixels or 0 on error.

◆ getTransitionPixelCount()

unsigned int NetLighthouseSensorInformation::getTransitionPixelCount ( unsigned int deviceID,
int % errorCode )
virtual

.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
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the number of transition pixels or 0 on error.

◆ getTransitionPixelIndices()

array< unsigned short > NetLighthouseSensorInformation::getTransitionPixelIndices ( unsigned int deviceID,
int % errorCode )
virtual

.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
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
an array containing the transition pixel indices.

Member Data Documentation

◆ sensorInfo

NetLighthouseSensorInformation NetLighthouse::NetLighthouseSensorInformation::sensorInfo
staticprotected

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