NetOceanDirectLighthouse
3.1.1
OceanDirect Lighthouse .NET API
|
Inherits NetOceanDirect::ManagedObject< LighthouseAPI, MemoryCleanup::noDeletion >.
Public Member Functions | |
Lighthouse (LighthouseAPI *instance) | |
virtual NetLighthouseAutonulling | AutoNulling () |
array< float > | boxcarCorrectSpectrum (long deviceID, int% errorCode, array< float >^% illuminatedSpectrum, unsigned short boxcarWidth) |
virtual void | closeDevice (unsigned int deviceID, int %errorCode) |
virtual array< float > | darkCorrectSpectrum (unsigned int deviceID, int %errorCode, array< float >^% darkSpectrum, array< float >^% illuminatedSpectrum) |
virtual array< float > | darkCorrectSpectrum (unsigned int deviceID, int %errorCode, array< float >^% illuminatedSpectrum) |
virtual NetLighthouseDeviceInformation | DeviceInformation () |
virtual NetLighthouseFlash | Flash () |
virtual NetLighthouseGainMode | GainMode () |
virtual unsigned int | getAcquisitionDelay (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getAcquisitionDelayIncrement (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getAcquisitionDelayMaximum (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getAcquisitionDelayMinimum (unsigned int deviceID, int %errorCode) |
virtual void | getAPIRCNumber (unsigned int %candidate) |
virtual void | getAPIVersionNumber (unsigned int %major, unsigned int %minor, unsigned int %point) |
virtual unsigned short | getBoxcarWidth (unsigned int deviceID, int %errorCode) |
virtual array< float > | getDarkCorrectedSpectrum (unsigned int deviceID, int %errorCode, array< float >^% darkSpectrum) |
virtual array< float > | getDarkCorrectedSpectrum (unsigned int deviceID, int% errorCode) |
virtual array< unsigned int > | getDeviceIDs () |
virtual net_lh_enable_state_t | getElectricDarkCorrectionState (unsigned int deviceID, int %errorCode) |
virtual String | getErrorMessage (int errorCode) |
virtual unsigned int | getErrorMessageLength (int errorCode) |
virtual unsigned int | getIntegrationTime (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getIntegrationTimeIncrement (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getMaximumIntegrationTime (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getMaximumIntensity (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getMinimumAveragingIntegrationTime (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getMinimumIntegrationTime (unsigned int deviceID, int %errorCode) |
virtual array< unsigned int > | getNetworkDeviceIDs () |
virtual array< float > | getNonlinearityCorrectedSpectrum (unsigned int deviceID, int %errorCode, array< float >^% darkSpectrum) |
virtual array< float > | getNonlinearityCorrectedSpectrum (unsigned int deviceID, int% errorCode) |
virtual net_lh_enable_state_t | getNonLinearityCorrectionState (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getScansToAverage (unsigned int deviceID, int %errorCode) |
virtual array< float > | getSpectrum (unsigned int deviceID, int %errorCode) |
virtual unsigned int | getSpectrumLength (unsigned int deviceID, int %errorCode) |
virtual NetLighthouseSpectrumWithMetadata | getSpectrumWithMetadata (unsigned int deviceID, int %errorCode) |
virtual array< float > | getStoredDarkSpectrum (unsigned int deviceID, int %errorCode) |
virtual NetLighthouseTriggerMode | getTriggerMode (unsigned int deviceID, int %errorCode) |
virtual array< float > | getWavelengthCoefficients (unsigned int deviceID, int %errorCode) |
virtual array< float > | getWavelengths (unsigned int deviceID, int %errorCode) |
virtual NetLighthouseGpio | Gpio () |
virtual NetLighthouseLamp | Lamp () |
virtual NetLighthouseLed | Led () |
virtual NetLighthouseNetworkConfiguration | Network () |
virtual NetLighthouseNonlinearity | Nonlinearity () |
virtual array< float > | nonlinearityCorrectSpectrum (unsigned int deviceID, int %errorCode, array< float >^% darkSpectrum, array< float >^% illuminatedSpectrum) |
virtual array< float > | nonlinearityCorrectSpectrum (unsigned int deviceID, int %errorCode, array< float >^% illuminatedSpectrum) |
virtual void | openDevice (unsigned int deviceID, int %errorCode) |
virtual unsigned int | probeAllDevices () |
virtual unsigned int | probeNetworkDevices () |
virtual unsigned int | probeUsbDevices () |
virtual NetLighthouseSensorInformation | SensorInformation () |
virtual NetLighthouseSerialPort | SerialPort () |
virtual void | setAcquisitionDelay (unsigned int deviceID, int %errorCode, unsigned int microseconds) |
virtual void | setBoxcarWidth (unsigned int deviceID, int% errorCode, unsigned short boxcarWidth) |
virtual void | setElectricDarkCorrectionState (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state) |
virtual void | setIntegrationTime (unsigned int deviceID, int %errorCode, unsigned int microseconds) |
virtual void | setMulticastMsgResponseReadDelay (size_t milliseconds) |
virtual void | setMulticastMsgResponseReadRetry (size_t retryCount) |
virtual void | setMulticastMsgSendRetry (size_t retryCount) |
virtual void | setNonLinearityCorrectionState (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state) |
virtual void | setScansToAverage (unsigned int deviceID, int% errorCode, unsigned int scansToAverage) |
virtual void | setStoredDarkSpectrum (unsigned int deviceID, int %errorCode, array< float >^% darkSpectrum) |
virtual void | setTriggerMode (unsigned int deviceID, int %errorCode, NetLighthouseTriggerMode mode) |
virtual void | shutdown () |
virtual NetLighthouseShutter | Shutter () |
virtual NetLighthouseStrobe | Strobe () |
virtual NetLighthouseThermoelectric | Thermoelectric () |
virtual NetLighthouseUserString | UserString () |
Static Public Member Functions | |
static Lighthouse | getInstance () |
Static Protected Attributes | |
static Lighthouse | lighthouseInstance |
|
virtual |
Get a string that describes the type of device
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode |
buffer | a character buffer to receive the device type string. |
length | the length of the supplied buffer. |
array< float > Lighthouse::boxcarCorrectSpectrum | ( | long | deviceID, |
int% | errorCode, | ||
array< float >^% | illuminatedSpectrum, | ||
unsigned short | boxcarWidth | ||
) |
.boxcarCorrectSpectrum Apply a boxcar smoothing on the given illuminated spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
illuminatedSpectrum | The spectrum that will be boxcar corrected. |
boxcarWidth | The boxcar width. |
|
virtual |
.closeDevice This will attempt to close the bus connection to the device with the given ID. The id becomes invalid after closing the device. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode |
|
virtual |
.darkCorrectSpectrum2 Dark correct a previously acquired illuminated spectrum using a previously acquired dark spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
darkSpectrum | the buffer that contains the dark spectrum to be used for the dark correction. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
|
virtual |
.darkCorrectSpectrum1 Dark correct a previously acquired illuminated spectrum using a stored dark spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.getAcquisitionDelayIncrement Get the acquisition delay period increment in microseconds. The increment is the minimum difference (in microseconds) between two adjacent, valid acquisition delay periods.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.getBoxcarWidth Get the width of the boxcar smoothing to be applied to the returned spectrum. When this value has been set greater than 0, boxcar smoothing (a moving average) is applied to the spectrum returned by getFormattedSpectrum (or getRawSpectrumWithMetadata). The width specified is the number of pixels either side of the central pixel of the average i.e. if the result of this function is n, the "full width" of the smoothing is 2*n+1.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getDarkCorrectedSpectrum2 Acquire a spectrum and use the supplied dark spectrum to perform a dark correction then return the dark corrected spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
darkSpectrum | the buffer that contains the dark spectrum to be used for the dark correction. |
|
virtual |
.getDarkCorrectedSpectrum1 Acquire a spectrum and use the previously stored dark spectrum to perform a dark correction then return the dark corrected spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getDeviceIDs This provides a unique ID of each device that is detected or specified. The IDs are copied into the user-provided buffer. These IDs are weak references: attempting to access a device that no longer exists will cause an error value to be returned. A given ID will always refer to the same device until the device is closed or the shutdown method is called. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
|
virtual |
.getElectricDarkCorrectionState
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getErrorMessage Get error message associated with the given error code. If the error code is incorrect then the return message will be "Error. Undefined error".
errorCode | The error code. |
|
virtual |
|
inlinestatic |
.getInstance The API is a singleton and has no public constructor. To use this class you must first call getInstance() to return a pointer/reference to the API.
|
virtual |
|
virtual |
.getIntegrationTimeIncrement Get the device integration time increment in microseconds. Some devices may only allow the integration time to be changed in multiples of this increment value.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
|
virtual |
|
virtual |
.getMinimumAveragingIntegrationTime Get minimum integration time in microseconds when averaging is enabled.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
|
virtual |
.getNetworkDeviceIDs This provides a unique ID of each network attached device that is detected or manually specified. The IDs are copied into the user-provided buffer. These IDs are weak references: attempting to access a device that no longer exists will cause an error value to be returned. A given ID will always refer to the same device until the device is closed or the shutdown method is called. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
|
virtual |
.getNonlinearityCorrectedSpectrum2 Acquire a spectrum and use the supplied dark spectrum to perform a dark correction followed by the nonlinearity correction then return the nonlinearity corrected spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
darkSpectrum | the buffer that contains the dark spectrum to be used for the dark correction. |
|
virtual |
.getNonlinearityCorrectedSpectrum1 Acquire a spectrum and use the previously stored dark spectrum to perform a dark correction followed by a nonlinearity correction then return the nonlinearity corrected spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getNonLinearityCorrectionState
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.getStoredDarkSpectrum Retrieve a previously stored dark spectrum for use in subsequent corrections i.e. dark correction and nonlinearity correction.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.nonlinearityCorrectSpectrum2 Nonlinearity correct a previously acquired illuminated spectrum after dark correction using a previously acquired dark spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
darkSpectrum | the buffer that contains the dark spectrum to be used prior to the nonlinearity correction. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
|
virtual |
.nonlinearityCorrectSpectrum1 Nonlinearity correct a previously acquired illuminated spectrum using a stored dark spectrum. This function performs a dark correction using a previously stored dark spectrum prior to performing the nonlinearity correction.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
|
virtual |
.openDevice This will attempt to open the bus connection to the device with the given ID. After the device is closed the id becomes invalid. You need to call either probeDevices()/addNetworkDevice()/detectNetworkDevices() and getDeviceIDs() in order to have a valid id before reopening the device again. For a network connected device this function may return an error code if the device is not yet ready to accept incoming connection or the device is unreachable. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode |
|
virtual |
.probeAllDevices Cause the driver to look for any device that can be found automatically (i.e. attached by USB and network devices). Until this method called then such devices will not be available for use. Before calling this function, you may want to adjust the multicast settings use for probing network devices. A subsequent call to getDeviceIDs is needed before a device can be "opened" and used. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
|
virtual |
.probeNetworkDevices This provides a way to find all Ethernet discoverable devices. Afterwards, a call to probeDevices is neccessary to grab the interface for opening and connecting to discovered device. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
|
virtual |
.probeUsbDevices Cause the driver to look for any device that can be found automatically i.e. attached by USB. Until this method called then such devices will not be available for use. A subsequent call to getDeviceIDs is needed before a device can be "opened" and used. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.setBoxcarWidth Set the width of the boxcar smoothing to be applied to the returned spectrum. When this value is set greater than 0, boxcar smoothing (a moving average) is applied to the spectrum returned by getFormattedSpectrum (or getRawSpectrumWithMetadata). The width specified is the number of pixels either side of the central pixel of the average i.e. if the result of this function is n, the "full width" of the smoothing is 2*n+1. Setting this value to 0 turns off the boxcar smoothing.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
boxcarWidth | the width of the smoothing to be applied, or zero if smoothing is to be turned off. |
|
virtual |
.setElectricDarkCorrectionState
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
state | "on" if electric dark correction is to be used, "off" otherwise. |
|
virtual |
.setIntegrationTime Set the current device integration time in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
microseconds | the desired integration time in microseconds. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.setNonLinearityCorrectionState
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
state | "on" if nonlinearity correction is to be used, "off" otherwise. |
|
virtual |
.setScansToAverage Set the number of spectra to be averaged per returned spectrum. When this value is set greater than 1 the specified number of spectra are averaged and the resulting average is returned by getFormattedSpectrum (or getRawSpectrumWithMetadata). NOTE: Some devices have a minimum integration time for averaging that is different to the minimum integration time for unaveraged acquisition (see your spectrometer documentation to determine if this is a requirement).
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
scansToAverage | the number of scans to be averaged. |
|
virtual |
.setStoredDarkSpectrum Store a dark spectrum for use in subsequent corrections i.e. dark correction and nonlinearity correction.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
darkSpectrum | the buffer that contains the dark spectrum to be stored. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.Thermoelectric Return a pointer to the thermoelectric temperature (TEC) control functionality. Thermoelectric cooling can improve the sensitivity of the sensor. Note: not all devices have thermoelectric temperature control; attempting to use this functionality on a device without TEC will result in "command not supported" errors being returned.
|
virtual |