VPManager.h

Go to the documentation of this file.

//# VPManager functionality sits here; 
//# Copyright (C) 1996-2011
//# Associated Universities, Inc. Washington DC, USA.
//# Copyright by ESO (in the framework of the ALMA collaboration)
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# 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; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#
//# $Id$

#ifndef SYNTHESIS_VPMANAGER_H
#define SYNTHESIS_VPMANAGER_H

#include <imageanalysis/ImageAnalysis/AntennaResponses.h>

namespace casa {
  //Forward declarations
  class Record;

  class VPManager
    {
      
    public: 
      // no need of enums here use the one from PBMathInterface
      //      enum Type{NONE, COMMONPB, AIRY, GAUSS, POLY, IPOLY, COSPOLY,
      //                NUMERIC, IMAGE, ZERNIKE, MAX=ZERNIKE};

      // this is a SINGLETON class
      static VPManager* Instance();

      void reset(Bool verbose=False);

      Bool saveastable(const String& tablename);

      Bool loadfromtable(const String& tablename);

      Bool summarizevps(const Bool verbose);


      Bool setcannedpb(const String& tel, 
                       const String& other, 
                       const Bool dopb,
                       const String& commonpb,
                       const Bool dosquint, 
                       const Quantity& paincrement, 
                       const Bool usesymmetricbeam,
                       Record& rec);

      Bool setpbairy(const String& telescope, const String& othertelescope, 
                     const Bool dopb, const Quantity& dishdiam, 
                     const Quantity& blockagediam, 
                     const Quantity& maxrad, 
                     const Quantity& reffreq, 
                     MDirection& squintdir, 
                     const Quantity& squintreffreq, const Bool dosquint, 
                     const Quantity& paincrement, 
                     const Bool usesymmetricbeam,
                     Record& rec);

      Bool setpbcospoly(const String& telescope, const String& othertelescope,
                        const Bool dopb, const Vector<Double>& coeff,
                        const Vector<Double>& scale,
                        const Quantity& maxrad,
                        const Quantity& reffreq,
                        const String& isthispb,
                        MDirection& squintdir,
                        const Quantity& squintreffreq, const Bool dosquint,
                        const Quantity& paincrement,
                        const Bool usesymmetricbeam,
                        Record& rec);

      Bool setpbgauss(const String& tel, const String& other, const Bool dopb,
                      const Quantity& halfwidth, const Quantity maxrad, 
                      const Quantity& reffreq, const String& isthispb, 
                      MDirection& squintdir, const Quantity& squintreffreq,
                      const Bool dosquint, const Quantity& paincrement, 
                      const Bool usesymmetricbeam, Record& rec);

      
     

      Bool setpbinvpoly(const String& telescope, const String& othertelescope,
                        const Bool dopb, const Vector<Double>& coeff,
                        const Quantity& maxrad,
                        const Quantity& reffreq,
                        const String& isthispb,
                        MDirection& squintdir,
                        const Quantity& squintreffreq, const Bool dosquint,
                        const Quantity& paincrement,
                        const Bool usesymmetricbeam,
                        Record& rec);

      Bool setpbinvpoly(const String& telescope, const String& othertelescope,
                        const Bool dopb, const Matrix<Double>& coeff,
                        const Vector<Double>& freqs,
                        const Quantity& maxrad,
                        const Quantity& reffreq,
                        const String& isthispb,
                        MDirection& squintdir,
                        const Quantity& squintreffreq, const Bool dosquint,
                        const Quantity& paincrement,
                        const Bool usesymmetricbeam,
                        Record& rec);

      Bool setpbnumeric(const String& telescope, const String& othertelescope,
                        const Bool dopb, const Vector<Double>& vect,
                        const Quantity& maxrad,
                        const Quantity& reffreq,
                        const String& isthispb,
                        MDirection& squintdir,
                        const Quantity& squintreffreq, const Bool dosquint,
                        const Quantity& paincrement,
                        const Bool usesymmetricbeam,
                        Record &rec);

      Bool setpbimage(const String& telescope, const String& othertelescope, 
                      const Bool dopb, const String& realimage, 
                      const String& imagimage, const String& compleximage, const Vector<String>& antnames,  Record& rec);
      Bool imagepbinfo(Vector<Vector<String> >& antnames, Vector<Record>& imagebeams);

      Bool setpbpoly(const String& telescope, const String& othertelescope,
                     const Bool dopb, const Vector<Double>& coeff,
                     const Quantity& maxrad,
                     const Quantity& reffreq,
                     const String& isthispb,
                     MDirection& squintdir,
                     const Quantity& squintreffreq, const Bool dosquint,
                     const Quantity& paincrement,
                     const Bool usesymmetricbeam,
                     Record &rec);
      

      Bool setpbantresptable(const String& telescope, const String& othertelescope,
                             const Bool dopb, const String& tablepath);
                            // no record filled, need to access via getvp()

      // set the default voltage pattern for the given telescope
      Bool setuserdefault(const Int vplistfield,
                          const String& telescope,
                          const String& antennatype="");

      Bool getuserdefault(Int& vplistfield,
                          const String& telescope,
                          const String& antennatype="");

      Bool getanttypes(Vector<String>& anttypes,
                       const String& telescope,
                       const MEpoch& obstime,
                       const MFrequency& freq, 
                       const MDirection& obsdirection); // default: Zenith
                              
      // return number of voltage patterns satisfying the given constraints
      Int numvps(const String& telescope,
                 const MEpoch& obstime,
                 const MFrequency& freq, 
                 const MDirection& obsdirection=MDirection(Quantity( 0., "deg"), // default is the Zenith
                                                           Quantity(90., "deg"), 
                                                           MDirection::AZEL)
                 ); 


      // get the voltage pattern satisfying the given constraints
      Bool getvp(Record &rec,
                 const String& telescope,
                 const MEpoch& obstime,
                 const MFrequency& freq, 
                 const String& antennatype="", 
                 const MDirection& obsdirection=MDirection(Quantity( 0., "deg"), // default is the Zenith
                                                           Quantity(90., "deg"), 
                                                           MDirection::AZEL)
                 ); 

      // get a general voltage pattern for the given telescope and ant type if available
      Bool getvp(Record &rec,
                 const String& telescope,
                 const String& antennatype=""
                 ); 

      // get a set of all necessary beams and their properties for a given antenna list
      Bool getvps(Vector<Record> & unique_out_rec_list, // the list of unique beam records
                  Vector<Vector<uInt> >& beam_index, // indices to the above vectors in sync with AntennaNames
                  const String& telescope,
                  const Vector<MEpoch>& inpTimeRange, // only elements 0 and 1 are used; if 1 is not present it is assumed to be inf
                  const Vector<MFrequency>& inpFreqRange, // must contain at least one element; beams will be provided for each element 
                  const Vector<String>& AntennaNames, // characters 0 and 1 are used for ALMA to determine the antenna type
                  const MDirection& obsdirection=MDirection(Quantity( 0., "deg"), // default is the Zenith
                                                            Quantity(90., "deg"), 
                                                            MDirection::AZEL)
                  );

      Bool vpRecIsIdentical(const Record& rec0, const Record& rec1);

    protected:
      VPManager(Bool verbose=False);

    private:
      static VPManager* instance_p;

      static Mutex mutex_p;

      Record vplist_p; 
      SimpleOrderedMap<String, Int > vplistdefaults_p; 
      AntennaResponses aR_p; 

      inline String antennaDescription(const String& telescope,
                                       const String& antennatype){
        if(antennatype.empty()) return telescope;
        return telescope + " " + antennatype;
      };

      inline String telFromAntDesc(const String& antDesc){
        String tempstr = antDesc;
        if(tempstr.contains(" ")) return tempstr.before(" ");
        return tempstr;
      };

      inline String antTypeFromAntDesc(const String& antDesc){
        String tempstr = antDesc;
        if(tempstr.contains(" ")) return tempstr.after(" ");
        tempstr = "";
        return tempstr;
      };

    };

} //# NAMESPACE CASA - END
#endif