operaEspadonsImage.h

Go to the documentation of this file.

/*******************************************************************
 ****                           OPERA PIPELINE v1.0                     ****
 ********************************************************************
 Library name: operaEspadonsImage
 Version: 1.0
 Author(s): CFHT OPERA team
 Affiliation: Canada France Hawaii Telescope 
 Location: Hawaii USA
 Date: Jul/2011
 
 Copyright (C) 2011  Opera Pipeline team, Canada France Hawaii Telescope
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 This program 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 General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see:
 http://software.cfht.hawaii.edu/licenses
 -or-
 http://www.gnu.org/licenses/gpl-3.0.html
 ********************************************************************/

#ifndef OPERAESPADONSIMAGE_H
#define OPERAESPADONSIMAGE_H

#include <fitsio.h>
#include "operaFITSImage.h"
#include "operaFITSSubImage.h"

extern "C" {
#include "libraries/operaImage.h"
#include "libraries/operaParameterAccess.h"
#include "libraries/operaConfigurationAccess.h"
}

#define ESPADONS_DEFAULT_NAXIS1 2080
#define ESPADONS_DEFAULT_NAXIS2 4640

using namespace std;

typedef enum { IMTYPE_GENERIC, IMTYPE_BIAS, IMTYPE_FLAT, IMTYPE_COMPARISON, IMTYPE_ALIGN, IMTYPE_OBJECT, IMTYPE_DARK } imtype_t ;
typedef enum { DETECTOR_UNKNOWN, DETECTOR_EEV1, DETECTOR_OLAPA} detector_t;
typedef enum { AMPLIFIER_UNKNOWN, AMPLIFIER_a, AMPLIFIER_ab} amplifier_t;
typedef enum { MODE_UNKNOWN, MODE_STAR_ONLY, MODE_STAR_PLUS_SKY, MODE_POLAR} instrumentmode_t;
typedef enum { SPEED_UNKNOWN, SPEED_FAST, SPEED_NORMAL, SPEED_SLOW} speed_t;
typedef enum { STOKES_UNKNOWN, STOKES_I, STOKES_U, STOKES_Q, STOKES_V} stokes_t;
typedef enum { POLAR_QUAD_UNKNOWN, POLAR_QUAD_1, POLAR_QUAD_2, POLAR_QUAD_3, POLAR_QUAD_4} polarquad_t;

typedef struct DATASEC {
        unsigned startx;
        unsigned nx;
        unsigned starty;
        unsigned ny;
} DATASEC_t;

#define ESPADONS_DEFAULT_DATASEC {21,2068,1,4608}

class operaEspadonsImage;

unsigned *where(operaEspadonsImage* b, unsigned *count);
unsigned *where(operaEspadonsImage& b, unsigned *count);

class operaEspadonsImage : public operaFITSImage {
        
private:
        typedef operaFITSImage& super;  // a way of referring to the super class
        unsigned nx;                    // x-dimension to be figured out from DATASEC (ncols) 
        unsigned ny;                    // y-dimension to be figured out from DATASEC (nrows)
        unsigned startx;                // first DATASEC pixel in x direction 
        unsigned starty;                // first DATASEC pixel in y direction
        unsigned ndpixels;              // number of DATASEC pixels     
        operaFITSSubImage *datasecSubImage;     // the datasec subImage
        imtype_t imagetype;             // (IMTYPE_BIAS, IMTYPE_FLAT, etc)  
        detector_t detector;    // Detector EEV1/OLAPA
        amplifier_t amplifier;  // a ab
        instrumentmode_t mode;  // sp1 sp2 pol
        speed_t speed;                  // sequence # of polar image
        stokes_t stokes;                // (Stokes_(I, U, Q, V))
        polarquad_t sequence;   // sequence # of polar image
        
public:
        operaEspadonsImage();
        
        operaEspadonsImage(string Filename, int mode=READWRITE/*READONLY*/);                    // constructor to read an existing FITSImage
        operaEspadonsImage(string Filename, edatatype Datatype, int mode=READWRITE/*READONLY*/);                // read an existing FITSImage from file
        operaEspadonsImage(string Filename, unsigned Naxis1, unsigned Naxis2, DATASEC_t &datasec,
                                           edatatype Datatype = tushort, unsigned Compression = 0);                     // constructor to create an in-memory espadons image with a datasec
        operaEspadonsImage(unsigned Naxis1, unsigned Naxis2, DATASEC_t &datasec,
                                   edatatype Datatype = tushort, unsigned Compression = 0);     // simply construct an image of a given size
        ~operaEspadonsImage();                                                                                                  // destructor
        
        unsigned short* operaEspadonsImageCloneDatasecUSHORT();                                 // clone the datasec as USHURT
        float* operaEspadonsImageCloneDatasec();                                                                // clone the datasec as float
        
        inline unsigned short getpixelUSHORT(unsigned x, unsigned y) {return ((unsigned short *)pixptr)[(nx<<11)+x];};
        inline float getpixel(unsigned x, unsigned y) {return ((float *)pixptr)[(nx<<11)+x];};
        
        inline void setpixel(unsigned short value, unsigned x, unsigned y) {((unsigned short *)pixptr)[(nx<<11)+x] = value;};
        inline void setpixel(float value, unsigned x, unsigned y) {((float *)pixptr)[(nx<<11)+x] = value;};
        
        void operaEspadonsImageCopyHeader(operaEspadonsImage *from);                                    // copy header unit
        
        operaEspadonsImage *operaEspadonsImageClone(operaEspadonsImage &imageIn);                       // clone image object
        /*
         * getters / setters
         */
        operaFITSSubImage *getDatasecSubImage();
        void operaFITSImageSetData(operaFITSSubImage &datasecSubImage);
        unsigned getnx();
        unsigned getny();
        unsigned getndpixels();
        
        unsigned long getsize();
        
        imtype_t getimtype();
        string getimtypestring();
        
        detector_t getdetector();
        string getdetectorstring();
        
        amplifier_t getamplifier();
        string getamplifierstring();
        
        instrumentmode_t getmode();
        string getmodestring();
        
        speed_t getspeed();
        string getspeedstring();
        
        stokes_t getstokes();
        string getstokesstring();
        
        polarquad_t getpolarquad();
        string getpolarquadstring();
};

#endif