OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
|
#include <LighthouseAPI.h>
Public Member Functions | |
virtual | ~LighthouseAPI () |
virtual lh_device_id_t | addNetworkDevices (const char ipAddressStr[], const char deviceTypeStr[], lh_error_code_t *errorCode) |
virtual LHAutoNullingAPI * | AutoNulling () |
void | boxcarCorrectSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float illuminatedSpectrum[], size_t illuminatedSpectrumLength, lh_boxcar_width_t boxcarWidth, float boxcarCorrectedSpectrum[], size_t boxcarCorrectedSpectrumLength) |
virtual void | closeDevice (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | darkCorrectSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float darkSpectrum[], size_t darkSpectrumLength, const float illuminatedSpectrum[], size_t illuminatedSpectrumLength, float darkCorrectedSpectrum[], size_t darkCorrectedSpectrumLength) |
virtual size_t | darkCorrectSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float illuminatedSpectrum[], size_t illuminatedSpectrumLength, float darkCorrectedSpectrum[], size_t darkCorrectedSpectrumLength) |
virtual LHDeviceInformationAPI * | DeviceInformation () |
virtual LHFlashAPI * | Flash () |
virtual LHGainModeAPI * | GainMode () |
virtual lh_microseconds_t | getAcquisitionDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getAcquisitionDelayIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getAcquisitionDelayMaximum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getAcquisitionDelayMinimum (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual void | getAPIRCNumber (uint32_t &candidate) |
virtual void | getAPIVersionNumber (uint32_t &major, uint32_t &minor, uint32_t &point) |
virtual lh_boxcar_width_t | getBoxcarWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getDarkCorrectedSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float darkSpectrum[], size_t darkSpectrumLength, float darkCorrectedSpectrum[], size_t darkCorrectedSpectrumLength) |
virtual size_t | getDarkCorrectedSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, float darkCorrectedSpectrum[], size_t darkCorrectedSpectrumLength) |
virtual size_t | getDeviceIDs (lh_device_id_t ids[], size_t idsLength) |
virtual size_t | getDeviceType (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength) |
virtual lh_enable_state_t | getElectricDarkCorrectionState (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getErrorMessage (lh_error_code_t errorCode, char message[], size_t messageLength) |
virtual size_t | getErrorMessageLength (lh_error_code_t errorCode) |
virtual lh_microseconds_t | getIntegrationTime (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getIntegrationTimeIncrement (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getMaximumIntegrationTime (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_pixel_intensity_t | getMaximumIntensity (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getMinimumAveragingIntegrationTime (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual lh_microseconds_t | getMinimumIntegrationTime (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getNetworkDeviceIDs (lh_device_id_t ids[], size_t idsLength) |
virtual size_t | getNonlinearityCorrectedSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float darkSpectrum[], size_t darkSpectrumLength, float nonlinearityCorrectedSpectrum[], size_t nonlinearityCorrectedSpectrumLength) |
virtual size_t | getNonlinearityCorrectedSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, float nonlinearityCorrectedSpectrum[], size_t nonlinearityCorrectedSpectrumLength) |
virtual lh_enable_state_t | getNonLinearityCorrectionState (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getNumberOfDeviceIDs () |
virtual lh_scan_averaging_t | getScansToAverage (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, float buffer[], size_t bufferLength) |
virtual size_t | getSpectrumLength (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getSpectrumWithMetadata (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_spectrum_with_metadata_t &spectrum) |
virtual size_t | getStoredDarkSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, float darkSpectrum[], size_t darkSpectrumLength) |
virtual lh_trigger_mode_t | getTriggerMode (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | getWavelengthCoefficients (lh_device_id_t deviceID, lh_error_code_t *errorCode, float coeff[], size_t coeffLength) |
virtual size_t | getWavelengths (lh_device_id_t deviceID, lh_error_code_t *errorCode, float wavelengths[], size_t wavelengthsLength) |
virtual LHGpioAPI * | Gpio () |
virtual LHLampAPI * | Lamp () |
virtual LHLedAPI * | Led () |
virtual LHNetworkConfigurationAPI * | Network () |
virtual LHNonlinearityAPI * | Nonlinearity () |
virtual size_t | nonlinearityCorrectSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float darkSpectrum[], size_t darkSpectrumLength, const float illuminatedSpectrum[], size_t illuminatedSpectrumLength, float nonlinearityCorrectedSpectrum[], size_t nonlinearityCorrectedSpectrumLength) |
virtual size_t | nonlinearityCorrectSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float illuminatedSpectrum[], size_t illuminatedSpectrumLength, float nonlinearityCorrectedSpectrum[], size_t nonlinearityCorrectedSpectrumLength) |
virtual void | openDevice (lh_device_id_t deviceID, lh_error_code_t *errorCode) |
virtual size_t | probeAllDevices () |
virtual size_t | probeNetworkDevices () |
virtual size_t | probeUsbDevices () |
virtual LHSensorAPI * | SensorInformation () |
virtual LHSerialPortAPI * | SerialPort () |
virtual void | setAcquisitionDelay (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds) |
virtual void | setBoxcarWidth (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_boxcar_width_t boxcarWidth) |
virtual void | setElectricDarkCorrectionState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state) |
virtual void | setIntegrationTime (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_microseconds_t microseconds) |
virtual void | setMulticastMsgResponseReadDelay (lh_milliseconds_t milliseconds) |
virtual void | setMulticastMsgResponseReadRetry (size_t retryCount) |
virtual void | setMulticastMsgSendRetry (size_t retryCount) |
virtual void | setNonLinearityCorrectionState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state) |
virtual void | setScansToAverage (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_scan_averaging_t scansToAverage) |
virtual void | setStoredDarkSpectrum (lh_device_id_t deviceID, lh_error_code_t *errorCode, const float darkSpectrum[], size_t darkSpectrumLength) |
virtual void | setTriggerMode (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_trigger_mode_t mode) |
virtual LHShutterAPI * | Shutter () |
virtual LHStrobeAPI * | Strobe () |
virtual LHThermoelectricAPI * | Thermoelectric () |
virtual LHUserStringAPI * | UserString () |
Static Public Member Functions | |
static LighthouseAPI * | getInstance () |
static void | shutdown () |
Friends | |
class | InstrumentedLighthouseAPI |
class | NetLighthouseAdmin |
|
virtual |
|
virtual |
.addNetworkDevices Manually create an instance of the network attached device and then open it using the openDevice() function. It is the responsiblitiy of the user to ensure that the device exists and is configured properly. Note that this should only be done by one thread at a time. For multithreaded application this function must be synchronized.
ipAddressStr | The ip address of the device to be opened. |
deviceTypeStr | The device type. This is case sensitive. |
errorCode | see LHErrorCode |
|
virtual |
void oceandirect::api::LighthouseAPI::boxcarCorrectSpectrum | ( | lh_device_id_t | deviceID, |
lh_error_code_t * | errorCode, | ||
const float | illuminatedSpectrum[], | ||
size_t | illuminatedSpectrumLength, | ||
lh_boxcar_width_t | boxcarWidth, | ||
float | boxcarCorrectedSpectrum[], | ||
size_t | boxcarCorrectedSpectrumLength ) |
.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. |
illuminatedSpectrumLength | The actual size of the spectrum. |
boxcarWidth | The boxcar width. |
boxcarCorrectedSpectrum | The output spectrum that were boxcar corrected. |
boxcarCorrectedSpectrumLength | The actual size of the spectrum corrected buffer. |
|
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. |
darkSpectrumLength | the actual size of the dark spectrum buffer. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
illuminatedSpectrumLength | the actual size of the illuminated spectrum buffer. |
darkCorrectedSpectrum | the buffer that will receive the dark corrected spectrum. |
darkCorrectedSpectrumLength | the actual size of the dark corrected buffer. |
|
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. |
illuminatedSpectrumLength | the actual size of the illuminated spectrum buffer. |
darkCorrectedSpectrum | the buffer that will receive the dark corrected spectrum. |
darkCorrectedSpectrumLength | the actual size of the dark corrected buffer. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
.getAcquisitionDelay Get the acquisition delay period in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
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 |
.getAcquisitionDelayMaximum Get the maximum valid acquisition delay period in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getAcquisitionDelayMinimum Get the minimum valid acquisition delay period in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
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. |
darkSpectrumLength | the actual size of the dark spectrum buffer. |
darkCorrectedSpectrum | the buffer that will receive the dark corrected spectrum. |
darkCorrectedSpectrumLength | the actual size of the dark correction buffer. |
|
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. |
darkCorrectedSpectrum | the buffer that will receive the dark corrected spectrum. |
darkCorrectedSpectrumLength | the actual size of the dark corrected buffer. |
|
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.
ids | the buffer to receive the device IDs. |
idsLength | the actual size of the array ids. |
|
virtual |
.getDeviceType 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. |
bufferLength | the length of the supplied buffer. |
|
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. |
message | The output buffer. |
messageLength | output buffer length. |
|
virtual |
.getErrorMessageLength Get error message length associated with the given error code. If the error code is incorrect then the return message length will be 0.
errorCode | see LHErrorCode. |
|
static |
.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. a pointer to the API that can be used to access the API methods.
|
virtual |
.getIntegrationTime Get the current device integration time in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
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 |
.getMaximumIntegrationTime Get maximum device integration time in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getMaximumIntensity Get max intensity (in counts) that can be returned in any pixel.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
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 |
.getMinimumIntegrationTime Get minimum device integration time in microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
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.
ids | the buffer to receive the device IDs. |
idsLength | the actual size of the array ids. |
|
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. |
darkSpectrumLength | the actual size of the dark spectrum buffer. |
nonlinearityCorrectedSpectrum | the buffer that will receive the nonlinearity corrected spectrum. |
nonlinearityCorrectedSpectrumLength | the actual size of the nonlinearity correction buffer. |
|
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. |
nonlinearityCorrectedSpectrum | the buffer that will receive the nonlinearity corrected spectrum. |
nonlinearityCorrectedSpectrumLength | the actual size of the nonlinearity correction buffer. |
|
virtual |
.getNonLinearityCorrectionState
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getNumberOfDeviceIDs This provides the total number of devices that have either been probed or manually specified. Devices are not opened automatically, but this can provide an upper bound for the number of IDs returned by getDeviceIDs(). Note that this should only be done by one thread at a time.
|
virtual |
.getScansToAverage Get the number of spectra to be averaged per returned spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | the buffer that will receive the spectrum. |
bufferLength | the actual size of the buffer. |
|
virtual |
.getSpectrumLength Get spectrum length i.e. the number of pixels in the spectrum.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getSpectrumWithMetadata Get spectrum with meta-data.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
spectrum | the buffer that will receive the formatted spectrum. Note: the buffer should have sufficient memory allocated to receive the number of pixels in the resulting spectrum; a smaller memory allocation will result in a partial spectrum being returned. |
|
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. |
darkSpectrum | the buffer that contains the dark spectrum to be retrieved. |
darkSpectrumLength | the actual size of the dark buffer. |
|
virtual |
.getTriggerMode Get the spectrometer trigger mode (software, edge or level).
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
|
virtual |
.getWavelengthCoefficients Get the coefficients of the polynomial used to calculate the wavelengths.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
coeff | an array to receive the coefficient values. |
coeffLength | the actual length of the supplied coefficients array. |
|
virtual |
.getWavelengths Get the wavelengths (in nanometres) for each pixel of the specified device.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
wavelengths | an array to receive the wavelength values. |
wavelengthsLength | the actual length of the supplied wavelengths array. |
|
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. |
darkSpectrumLength | the actual size of the dark spectrum buffer. |
illuminatedSpectrum | the buffer that contains the illuminated spectrum to be corrected. |
illuminatedSpectrumLength | the actual size of the illuminated spectrum buffer. |
nonlinearityCorrectedSpectrum | the buffer that will receive the nonlinearity corrected spectrum. |
nonlinearityCorrectedSpectrumLength | the actual size of the nonlinearity correction buffer. |
|
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. |
illuminatedSpectrumLength | the actual size of the illuminated spectrum buffer. |
nonlinearityCorrectedSpectrum | the buffer that will receive the nonlinearity corrected spectrum. |
nonlinearityCorrectedSpectrumLength | the actual size of the nonlinearity correction buffer. |
|
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 |
Cause the driver to look for any device that can be found automatically i.e. attached by USB. Until this is 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 |
.setAcquisitionDelay Set the acquisition delay to the specified number of microseconds.
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
microseconds | the acquisition delay period in microseconds. |
|
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. |
darkSpectrumLength | the actual size of the dark spectrum buffer. |
|
virtual |
.setTriggerMode Set the spectrometer trigger mode (software, edge or level).
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
mode | the trigger mode to apply. |
|
static |
|
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 |
|
friend |
|
friend |