Hyperion
IntroductionClass that encapsulates the behavior of the hyperion instrument. GroupsAcquisition APIGroup members:
Utility FunctionsGroup members:
System APIGroup members:
ConstructorsGroup members:
Net APIGroup members:
Member Functions
close_commpublic DiscussionCloses the comm and streamComm sockets if currently open. connect_commpublic DiscussionRe-connects the comm object if not already connected disable_peak_streamingpublic DiscussionDisables streaming of peak data disable_spectrum_streamingpublic DiscussionDisables streaming of spectrum data enable_peak_streamingpublic ParametersDiscussionEnable streaming of peak data from the instrument. enable_spectrum_streamingpublic ParametersDiscussionEnable streaming of spectrum data from the instrument. get_active_network_settingspublic Return ValueReturns a hNetworkSettings structure that contains the returned network settings. DiscussionGets the current active network settings for the instrument get_available_laser_scan_speedspublic Return Valuereturns A vector<int> containing all of the speeds that are supported on the instrument. DiscussionGets the valid laser scan speeds that can be set on this instrument. get_commpublic DiscussionReturns a pointer to the active hComm object. get_instrument_namepublic Return ValueReturns a string that contains the instrument name.. DiscussionGets the instrument name get_laser_scan_speedpublic Return ValueReturns the current laser scanning rate in Hz. DiscussionGets the current laser scanning speed. get_last_errorpublic ParametersDiscussionReturns the error message associated with the most recent instrument or system error. get_library_versionpublic Return ValueReturns String containing the library version. DiscussionGet the version of this API library get_network_ip_modepublic Return ValueReturns a string indicating the current network IP mode (STATIC or DHCP) DiscussionGets the current network mode, static or dynamic (DHCP) get_peak_streaming_statuspublic ParametersReturn ValueReturns 1 if the peak streaming is enabled on the instrument AND the peak streaming comm port is open on the client, and 0 otherwise. DiscussionGets the current status and available buffer for peak streaming get_peakspublic Return ValueReturns a hACQPeaks structure that contains the peak data. DiscussionAcquires a set of peaks from the Hyperion instrument get_power_calibration_infopublic ParametersDiscussionGets the calibration offset and scale used for converting spectra to dBm power units. Converting spectral data is done by taking spectrumData/scale + offset. get_raw_spectrumpublic ParametersReturn ValueResturns an hACQSpectrum structure containing the spectrum data. Only the rawSpectrumData vector will contain data. DiscussionAcquires a raw spectrum for the specified channel. If channel == -1, then this will get data for all channels. get_scan_parameterspublic ParametersDiscussionGet the parameters that define the wavelength scan range and number of points. get_serial_numberpublic Return ValueReturns a string containing the serial number. DiscussionGet the serial number of the Hyperion instrument get_spectrumpublic ParametersReturn ValueReturns an hACQSpectrum structure containing the spectrum data. DiscussionAcquires a full spectrum data from the Hyperion instrument get_spectrum_streaming_statuspublic ParametersReturn ValueReturns 1 if the spectrum streaming is enabled on the instrument AND the spectrum streaming comm port is open on the client, and 0 otherwise. DiscussionGets the current status and available buffer for spectrum streaming get_static_network_settingspublic Return ValueReturns a hNetworkSettings structure that contains the returned network settings. DiscussionGets the current static network settings. get_versionpublic ParametersDiscussionReturns the firmware, fpga, and libray versions Hyperion(hComm *)public DiscussionConstructor that takes a pointer to an hComm object (or descendant) Hyperion(std :: string, int, int)public ParametersDiscussionConstructor that takes TCP parameters. set_instrument_namepublic ParametersDiscussionSet the instrument name. set_laser_scan_speedpublic ParametersDiscussionSets the laser scan speed. set_network_ip_modepublic ParametersDiscussionsets the network IP mode (static or DHCP). Note that if this is different than the current settings, then the hComm object will no longer be able to establish a connection and should be closed and re-initiated. set_peak_stream_dividerpublic ParametersDiscussionSets the value of the peak streaming divider, which determines the rate at which streaming peak data is returned. if peakStreamingDivider = 5, then every 5th sample is streamed out on the peak streaming port. set_spectrum_stream_dividerpublic ParametersDiscussionSets the value of the spectrum streaming divider, which determines the rate at which streaming spectrum data is returned. if peakStreamingDivider = 5, then every 5th spectrum is streamed out on the spectrum streaming port. set_static_network_settingspublic ParametersDiscussionsets the static network settings. Note that if the current IP mode is static, then changing these parameters will result in not being able to communicate with the instrument and the hComm object should be closed and re-initiated. stream_peakspublic Return ValueReturns an hACQPeaks structure. DiscussionAcquires a set of streamed peaks from the Hyperion instrument. stream_spectrumpublic Return ValueResturns an hACQSpectrum structure containing the spectrum data. Only the rawSpectrumData vector will contain data. DiscussionAcquires streamed spectrum data from the Hyperion instrument, and stores it in the spectrum instance variable. ~Hyperionpublic DiscussionDestructor for Hyperion object |