hLibrary.h

Includes:
<iostream>
<string>
<vector>
<cstdint>
<time.h>
"hCommLibrary.h"

Introduction

Use the links in the table of contents to the left to access the documentation.



Classes

hACQPeaks
Hyperion


Structs and Unions

hACQPeaksHeader
hACQSpectrum
hACQSpectrumHeader
hNetworkSettings

hACQPeaksHeader


struct hACQPeaksHeader { 
    uint16_t length; 
    uint16_t version; 
    uint32_t reserved; 
    uint64_t serialNumber; 
    uint32_t timeStampInt; 
    uint32_t timeStampFrac; 
    uint16_t peakCounts[H_MAX_NUM_CHANNELS]; 
};  
Fields
length

uint16_t The lenght of the header.

version

The version of the header implementation.

reserved

Reserved for future use.

serialNumber

uint64_t Sequential number assigned to each sample of peak data.

timeStampInt

Timestamp for data, expressed as number of seconds since 00:00:00, Jan. 1, 1970

timeStampFrac

Number of nanoseconds elapsed after timeStampInt

peakCounts

Number of peaks detected for each channel

Discussion

Header data returned with each call to Hyperion.get_peaks or Hyperion.stream_peaks


hACQSpectrum


struct hACQSpectrum { 
    hACQSpectrumHeader *spectrumHeader; 
    std::vector<uint16_t> rawSpectrumData; 
    std::vector<double> calibratedSpectrumData;  
};  
Fields
spectrumHeader

A pointer to the hACQSpectrumHeader structure for this spectrum

rawSpectrumData

A vector containing the raw spectrum data.

calibratedSpectrumData

A vector containing the calibrated spectrum data. This may be empty if the spectrum was returned with get_raw_spectrum()

Discussion

Spectrum data returned with each call to Hyperion.get_raw_spectrum()


hACQSpectrumHeader


struct hACQSpectrumHeader { 
    uint16_t length; 
    uint16_t version; 
    uint32_t reserved; 
    uint64_t serialNumber; 
    uint32_t timeStampInt; 
    uint32_t timeStampFrac; 
    double startWavelength; 
    double wavelengthIncrement; 
    uint32_t numPoints; 
    uint16_t numChannels; 
    uint16_t reserved2; 
};  
Fields
length

The length of this header in bytes.

version

The version number of this header format.

reserved

Reserve for future use

serialNumber

uint64_t Sequential number assigned to each sample of peak data.

timeStampInt

Timestamp for data, expressed as number of seconds since 00:00:00, Jan. 1, 1970

timeStampFrac

Number of nanoseconds elapsed after timeStampInt

startWavelength

The wavelength of the first datapoint in the acquired spectrum.

wavelengthIncrement

The wavelength increment for each datapoint in the spectrum.

numPoints

The number of points in the spectrum.

numChannels

The number of channels returned.

reserved2

Reserved for future use.

Discussion

Header returned with each call to Hyperion.get_spectrum()


hNetworkSettings


struct hNetworkSettings { 
    std::string ipAddress; 
    std::string mask; 
    std::string gateway; 
};  
Fields
ipAddress

An IP address in #.#.#.# format.

mask

Network mask in #.#.#.# format.

gateway

Network gateway in #.#.#.# format.

Discussion

Structure containing network settings