FITSOutputFile.h

/***************************************************************************
 *
 *   Copyright (C) 2015 by Matthew Kerr
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// This is a bit a of kluge.  Use a psrchive/FITSArchive to handle writing
// out all of the extensions -- this way we can take advantage of the
// development done there.  This all happens in "write header".
 
// Then we do the data separately, writing rows directly through cfitsio.
 
// NB -- we need to deal with the reference spectrum, somehow.  It would
// be a REALLY GOOD idea to set tblk to the same value as the Rescale
// operation!
 
// Recall the PSRFITS output is in TPF order.
 
// TODO -- since the user can set nbit/nsblk, the instance can be made
// inconsistent if these methods are called after initialize
 
#ifndef __FITSOutputFile_h
#define __FITSOutputFile_h
 
#include "dsp/OutputFile.h"
#include <fitsio.h>
 
namespace dsp {
 
  class FITSDigitizer;
 
  int get_colnum (fitsfile* fptr, const char* label);
 
  class FITSOutputFile : public OutputFile 
  {
  public:
   
    FITSOutputFile (const char* filename=0);
 
    ~FITSOutputFile ();
 
    void set_reference_spectrum (FITSDigitizer*);
 
    void set_nsblk ( unsigned nblk );
 
    void set_nbit ( unsigned _nbit );
 
    void set_atnf ( bool );
 
    void set_upper_sideband_output ( bool );
 
    void set_mangle_output ( bool );
 
    void set_max_length( double );
 
  protected:
 
    virtual void operation ();
 
    void write_header ();
 
    void finalize_fits ();
 
    std::string get_extension () const;
 
    virtual int64_t unload_bytes (const void* buffer, uint64_t bytes);
 
    void write_bytes (int colnum, int isub, int offset, unsigned bytes_to_write, unsigned char** buffer);
 
    unsigned nsblk;
 
    unsigned nbblk;
 
    double tblk;
 
    unsigned nbit;
 
    unsigned npol;
 
    unsigned nchan;
 
    double max_length;
 
    std::vector<float> dat_wts;
 
    std::vector<float> dat_scl;
 
    std::vector<float> dat_offs;
 
    std::vector<double> dat_freq;
 
    fitsfile* fptr;
 
    unsigned isub;
 
  private:
 
    unsigned offset;
 
    int64_t written;
 
    int64_t max_bytes;
 
    void initialize ();
 
    void write_row ();
 
    bool use_atnf;
 
    bool mangle_output;
    std::string mangled_output_filename;
 
    int64_t samples_written;
 
    bool upper_sideband_output;
 
  };
 
}
 
#endif