indicorrelator.h

Go to the documentation of this file.

/*******************************************************************************
 Copyright(c) 2010, 2017 Ilia Platone, Jasem Mutlaq. All rights reserved.
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#pragma once
 
#include "indisensorinterface.h"
#include "dsp.h"
#include <fitsio.h>
 
#ifdef HAVE_WEBSOCKET
#include "indiwsserver.h"
#endif
 
#include <fitsio.h>
 
#include <memory>
#include <cstring>
#include <chrono>
#include <stdint.h>
#include <mutex>
#include <thread>
 
//JM 2019-01-17: Disabled until further notice
//#define WITH_EXPOSURE_LOOPING
 
 
namespace INDI
{
class StreamManager;
 
class Correlator : public SensorInterface
{
    public:
        typedef union
        {
            struct
            {
                double x;
                double y;
                double z;
            };
            double values[3];
        } Baseline;
 
        typedef union
        {
            struct
            {
                double u;
                double v;
            };
            double values[2];
        } UVCoordinate;
 
        typedef struct
        {
            Baseline baseline;
            UVCoordinate coordinate;
            double coefficient;
        } Correlation;
 
        enum
        {
            CORRELATOR_MAX_CAPABILITY                  = SENSOR_MAX_CAPABILITY << 0, 
        } CorrelatorCapability;
 
        Correlator();
        virtual ~Correlator();
 
        bool initProperties() override;
        bool updateProperties() override;
        void ISGetProperties(const char *dev) override;
        bool ISNewNumber(const char *dev, const char *name, double values[], char *names[], int n) override;
        bool ISNewSwitch(const char *dev, const char *name, ISState *states, char *names[], int n) override;
        bool ISNewText(const char *dev, const char *name, char *texts[], char *names[], int n) override;
        bool ISNewBLOB(const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[],
                       char *names[], int n) override;
        bool ISSnoopDevice(XMLEle *root) override;
 
        virtual bool StartIntegration(double duration) override;
 
        virtual inline double getCorrelationDegree()
        {
            return 0.0;
        }
 
        inline Correlation getCorrelation()
        {
            Correlation ret;
            ret.coordinate = getUVCoordinates();
            ret.baseline = baseline;
            ret.coefficient = getCorrelationDegree();
            return ret;
        }
 
        void setBaseline(Baseline bl);
 
        void setWavelength(double wl);
 
        void setBandwidth(double bw);
 
        inline Baseline getBaseline()
        {
            return baseline;
        }
 
        inline double getWavelength()
        {
            return wavelength;
        }
 
        UVCoordinate getUVCoordinates();
 
        UVCoordinate getUVCoordinates(double lst);
 
        UVCoordinate getUVCoordinates(double alt, double az);
 
        double getDelay();
 
        double getDelay(double lst);
 
        double getDelay(double alt, double az);
 
        inline double setBandwidth()
        {
            return bandwidth;
        }
 
        inline INumberVectorProperty *getCorrelatorSettings()
        {
            return &CorrelatorSettingsNP;
        }
 
        uint32_t GetCorrelatorCapability() const
        {
            return capability;
        }
 
        void SetCorrelatorCapability(uint32_t cap);
 
        virtual void setMinMaxStep(const char *property, const char *element, double min, double max, double step,
                                   bool sendToClient) override;
 
        typedef enum
        {
            CORRELATOR_BASELINE_X = 0,
            CORRELATOR_BASELINE_Y,
            CORRELATOR_BASELINE_Z,
            CORRELATOR_WAVELENGTH,
            CORRELATOR_BANDWIDTH,
        } CORRELATOR_INFO_INDEX;
        INumberVectorProperty CorrelatorSettingsNP;
 
    private:
        Baseline baseline;
        double wavelength;
        double bandwidth;
        INumber CorrelatorSettingsN[5];
};
}