WasatchVCPP::Proxy::Spectrometer Class Reference

A proxy customer-facing class providing an object-oriented / STL-based interface to command and control an individual Spectrometer. More...

#include <WasatchVCPP.h>

Public Member Functions
	Spectrometer (int specIndex)
	instantiated by WasatchVCPP::Proxy::openAllSpectrometers
bool	close ()
	release resources associated with this spectrometer More...
bool	setIntegrationTimeMS (unsigned long ms)
	set integration time More...
bool	setLaserEnable (bool flag)
	set laser firing state More...
bool	setDetectorGain (float value)
bool	setLaserPowerPerc (float value)
bool	setLaserPowermW (float value)
bool	setDetectorGainOdd (float value)
bool	setDetectorOffset (int16_t value)
bool	setDetectorOffsetOdd (int16_t value)
bool	setDetectorTECEnable (bool flag)
bool	setDetectorTECSetpointDegC (int value)
bool	setHighGainMode (bool flag)
float	getDetectorTemperatureDegC ()
long	getIntegrationTimeMS ()
bool	getLaserEnable ()
float	getDetectorGain ()
float	getDetectorGainOdd ()
int	getDetectorOffset ()
int	getDetectorOffsetOdd ()
bool	getDetectorTECEnable ()
int	getDetectorTECSetpointDegC ()
bool	getHighGainModeEnable ()
int	sendControlMsg (uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint8_t *data, int len)
int	readControlMsg (uint8_t bRequest, uint16_t wIndex, uint8_t *data, int len)
bool	setMaxTimeoutMS (int maxTimeoutMS)
int	getMaxTimeoutMS ()
bool	cancelOperation (bool blocking=false)
std::string	getFirmwareVersion ()
std::string	getFPGAVersion ()
std::vector< double >	getSpectrum ()
	Retrieve one spectrum from the spectrometer. More...
std::vector< uint8_t >	getEEPROMPage (int page)
std::string	getEEPROMFieldName (int index)
std::vector< float >	getWavecalCoeffs ()
	convenience accessor

Public Attributes
int	specIndex
	index of this spectrometer
int	pixels
	number of pixels
std::string	model
	model name
std::string	serialNumber
	serial number
std::map< std::string, std::string >	eepromFields
	a dictionary of EEPROM name-value pairs rendered as strings
std::vector< double >	wavelengths
	expanded wavecal in nm
std::vector< double >	wavenumbers
	expanded wavecal in 1/cm (Raman-only)
float	excitationNM
	configured laser excitation wavelength (Raman-only)

Detailed Description

A proxy customer-facing class providing an object-oriented / STL-based interface to command and control an individual Spectrometer.

By default, methods returning a boolean report 'true' on success and 'false' on error unless specified otherwise.

Member Function Documentation

cancelOperation()

bool WasatchVCPP::Proxy::Spectrometer::cancelOperation ( bool  blocking = false )

inline

See also

wp_cancel_operation

close()

bool WasatchVCPP::Proxy::Spectrometer::close ( )

inline

release resources associated with this spectrometer

Returns

true on success

getDetectorGain()

float WasatchVCPP::Proxy::Spectrometer::getDetectorGain ( )

inline

See also

wp_get_detector_gain

getDetectorGainOdd()

float WasatchVCPP::Proxy::Spectrometer::getDetectorGainOdd ( )

inline

See also

wp_get_detector_gain_odd

getDetectorOffset()

int WasatchVCPP::Proxy::Spectrometer::getDetectorOffset ( )

inline

See also

wp_get_detector_offset

getDetectorOffsetOdd()

int WasatchVCPP::Proxy::Spectrometer::getDetectorOffsetOdd ( )

inline

See also

wp_get_detector_offset_odd

getDetectorTECEnable()

bool WasatchVCPP::Proxy::Spectrometer::getDetectorTECEnable ( )

inline

See also

wp_get_detector_tec_enable

getDetectorTECSetpointDegC()

int WasatchVCPP::Proxy::Spectrometer::getDetectorTECSetpointDegC ( )

inline

See also

wp_get_detector_tec_setpoint_deg_c

getDetectorTemperatureDegC()

float WasatchVCPP::Proxy::Spectrometer::getDetectorTemperatureDegC ( )

inline

See also

wp_get_detector_temperature_deg_c

getEEPROMFieldName()

std::string WasatchVCPP::Proxy::Spectrometer::getEEPROMFieldName ( int  index )

inline

See also

wp_get_eeprom_field_name

getEEPROMPage()

std::vector< uint8_t > WasatchVCPP::Proxy::Spectrometer::getEEPROMPage ( int  page )

inline

See also

wp_get_eeprom_page

getFirmwareVersion()

std::string WasatchVCPP::Proxy::Spectrometer::getFirmwareVersion ( )

inline

See also

wp_get_firmware_version

getFPGAVersion()

std::string WasatchVCPP::Proxy::Spectrometer::getFPGAVersion ( )

inline

See also

wp_get_fpga_version

getHighGainModeEnable()

bool WasatchVCPP::Proxy::Spectrometer::getHighGainModeEnable ( )

inline

See also

wp_get_high_gain_mode_enable

getIntegrationTimeMS()

long WasatchVCPP::Proxy::Spectrometer::getIntegrationTimeMS ( )

inline

See also

wp_get_integration_time_ms

getLaserEnable()

bool WasatchVCPP::Proxy::Spectrometer::getLaserEnable ( )

inline

See also

wp_get_laser_enable

getMaxTimeoutMS()

int WasatchVCPP::Proxy::Spectrometer::getMaxTimeoutMS ( )

inline

See also

wp_get_max_timeout_ms

getSpectrum()

std::vector< double > WasatchVCPP::Proxy::Spectrometer::getSpectrum ( )

inline

Retrieve one spectrum from the spectrometer.

Sends an ACQUIRE command, then enters BLOCKING read on bulk endpoint. Demarshalls retreived little-endian pixel values. Applies minimal post-processing (see WasatchVCPP::Spectrometer::getSpectrum for details).

Returns

spectrum as vector of doubles

readControlMsg()

int WasatchVCPP::Proxy::Spectrometer::readControlMsg ( uint8_t  bRequest, uint16_t  wIndex, uint8_t *  data, int  len  )

inline

See also

wp_read_control_msg

Warning

no seriously, you need to follow that link

sendControlMsg()

int WasatchVCPP::Proxy::Spectrometer::sendControlMsg ( uint8_t  bRequest, uint16_t  wValue, uint16_t  wIndex, uint8_t *  data, int  len  )

inline

See also

wp_send_control_msg

Warning

no seriously, you need to follow that link

setDetectorGain()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorGain ( float  value )

inline

See also

wp_set_detector_gain

setDetectorGainOdd()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorGainOdd ( float  value )

inline

See also

wp_set_detector_gain_odd

setDetectorOffset()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorOffset ( int16_t  value )

inline

See also

wp_set_detector_offset

setDetectorOffsetOdd()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorOffsetOdd ( int16_t  value )

inline

See also

wp_set_detector_offset_odd

setDetectorTECEnable()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorTECEnable ( bool  flag )

inline

See also

wp_set_detector_tec_enable

setDetectorTECSetpointDegC()

bool WasatchVCPP::Proxy::Spectrometer::setDetectorTECSetpointDegC ( int  value )

inline

See also

wp_set_detector_tec_setpoint_deg_c

setHighGainMode()

bool WasatchVCPP::Proxy::Spectrometer::setHighGainMode ( bool  flag )

inline

See also

wp_set_high_gain_mode_enable

setIntegrationTimeMS()

bool WasatchVCPP::Proxy::Spectrometer::setIntegrationTimeMS ( unsigned long  ms )

inline

set integration time

Parameters

ms	(Input) time in milliseconds

Returns

true on success

setLaserEnable()

bool WasatchVCPP::Proxy::Spectrometer::setLaserEnable ( bool  flag )

inline

set laser firing state

Parameters

flag	(Input) desired state (true for firing, false for off)

Returns

true on successful communication (does not represent firing state)

setMaxTimeoutMS()

bool WasatchVCPP::Proxy::Spectrometer::setMaxTimeoutMS ( int  maxTimeoutMS )

inline

See also

wp_set_max_timeout_ms

---

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

• include/WasatchVCPP.h