OOISpectrometerFeature.h

Go to the documentation of this file.

/***************************************************/
#ifndef OOISPECTROMETERFEATURE_H
#define OOISPECTROMETERFEATURE_H

#include <vector>
#include "common/features/FeatureImpl.h"
#include "common/protocols/Protocol.h"
#include "common/buses/Bus.h"
#include "common/exceptions/FeatureException.h"
#include "common/exceptions/IllegalArgumentException.h"
#include "vendors/OceanOptics/features/spectrometer/SpectrometerTriggerMode.h"
#include "vendors/OceanOptics/features/spectrometer/OOISpectrometerFeatureInterface.h"

namespace seabreeze {

    class OOISpectrometerFeature : public FeatureImpl,
            public OOISpectrometerFeatureInterface {
    public:
        OOISpectrometerFeature();
        virtual ~OOISpectrometerFeature();
        /* Request and read out a spectrum formatted into intensity (A/D counts) */
        virtual std::vector<double> *getSpectrum(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* Request and read out the raw spectrum data stream */
        virtual std::vector<byte> *getUnformattedSpectrum(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* Request and read out the wavelengths in nanometers as a vector of doubles */
        virtual std::vector<double> *getWavelengths(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* Read the raw spectrum data stream.  No request is made first. */
        virtual std::vector<byte> *readUnformattedSpectrum(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* Set the integration time of the spectrometer */
        virtual void setIntegrationTimeMicros(const Protocol &protocol,
                const Bus &bus, unsigned long time_usec)
                throw (FeatureException, IllegalArgumentException);

        /* Request that the spectrometer make a spectrum available for
         * reading (e.g. with readUnformattedSpectrum())
         */
        virtual void writeRequestSpectrum(const Protocol &protocol,
                const Bus &bus) throw (FeatureException);

        /* Setting the external trigger mode for the spectrometer */
        virtual void setTriggerMode(const Protocol &protocol,
                const Bus &bus, SpectrometerTriggerMode &mode) throw (FeatureException);

        virtual std::vector<SpectrometerTriggerMode *> getTriggerModes() const;

        virtual std::vector<int> getElectricDarkPixelIndices() const;

        virtual long getIntegrationTimeMinimum() const;
        virtual long getIntegrationTimeMaximum() const;
        virtual long getIntegrationTimeIncrement() const;

        virtual int getNumberOfPixels() const;
        virtual int getMaximumIntensity() const;

        /* Overriding from Feature */
        virtual FeatureFamily getFeatureFamily();

    protected:
        /* Detector details */
        int numberOfPixels;
        int maxIntensity;

        /* Integration time parameters (measured in microseconds) */
        long integrationTimeMinimum;
        long integrationTimeMaximum;
        long integrationTimeBase;
        long integrationTimeIncrement;

        std::vector<SpectrometerTriggerMode *> triggerModes;
        std::vector<int> electricDarkPixelIndices;
    };

}

#endif /* OOISPECTROMETERFEATURE_H */