Line data    Source code

       1             : //# PBMath1DGauss.h: Definitions of 1-D Gauss PBMath objects
       2             : //# Copyright (C) 1996,1997,1998,2003
       3             : //# Associated Universities, Inc. Washington DC, USA.
       4             : //#
       5             : //# This library is free software; you can redistribute it and/or modify it
       6             : //# under the terms of the GNU Library General Public License as published by
       7             : //# the Free Software Foundation; either version 2 of the License, or (at your
       8             : //# option) any later version.
       9             : //#
      10             : //# This library is distributed in the hope that it will be useful, but WITHOUT
      11             : //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      12             : //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
      13             : //# License for more details.
      14             : //#
      15             : //# You should have received a copy of the GNU Library General Public License
      16             : //# along with this library; if not, write to the Free Software Foundation,
      17             : //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
      18             : //#
      19             : //# Correspondence concerning AIPS++ should be adressed as follows:
      20             : //#        Internet email: casa-feedback@nrao.edu.
      21             : //#        Postal address: AIPS++ Project Office
      22             : //#                        National Radio Astronomy Observatory
      23             : //#                        520 Edgemont Road
      24             : //#                        Charlottesville, VA 22903-2475 USA
      25             : //#
      26             : //#
      27             : //# $Id$
      28             : 
      29             : #ifndef SYNTHESIS_PBMATH1DGAUSS_H
      30             : #define SYNTHESIS_PBMATH1DGAUSS_H
      31             : 
      32             : #include <casacore/casa/aips.h>
      33             : #include <synthesis/TransformMachines/PBMath1D.h>
      34             : #include <casacore/measures/Measures.h>
      35             : 
      36             : namespace casa { //# NAMESPACE CASA - BEGIN
      37             : 
      38             : //#forward
      39             : 
      40             : // <summary> 
      41             : // PBMath1DGauss is a 1-D Gaussian Primary Beam
      42             : // </summary>
      43             : 
      44             : // <use visibility=export>
      45             : 
      46             : // <reviewed reviewer="" date="" tests="" demos="">
      47             : 
      48             : // <prerequisite>
      49             : // <li> <linkto class="PBMathInterface">PBMathInterface</linkto> class
      50             : // <li> <linkto class="PBMath1D">PBMath1D</linkto> class
      51             : // </prerequisite>
      52             : //
      53             : // <etymology>
      54             : // PBMath1DGauss: derived from  PBMath1D, implements a gaussian PB and VP
      55             : // </etymology>
      56             : //
      57             : // <synopsis> 
      58             : // See PBMath1D for a general synopsis of the 1D PB types.
      59             : // Remember that we construct based on Voltage Patterns rather than
      60             : // primary beams.  The Voltage Pattern HWHM width will be sqrt(2)
      61             : // times larger than the Primary Beam HWHM.
      62             : //
      63             : // VP(x) = exp( - ( x/HWHM )**2 * log(2) ), out to maximumRadius
      64             : // </synopsis> 
      65             : //
      66             : //
      67             : // <example>
      68             : // <srcblock>
      69             : //
      70             : //    PBMath1DGauss myPB  (casacore::Quantity(1.0, "'"),
      71             : //                         casacore::Quantity(3.0, "'"),
      72             : //                         casacore::Quantity(1.0, "GHz"),
      73             : //                         BeamSquint(casacore::MDirection(casacore::Quantity(2.0, "\""),
      74             : //                                                         casacore::Quantity(0.0, "\""),
      75             : //                                                         casacore::MDirection::Ref(casacore::MDirection::AZEL)),
      76             : //                                    casacore::Quantity(2.0, "GHz")),
      77             : //                         false);
      78             : // </srcblock>
      79             : // </example>
      80             : //
      81             : // <motivation>
      82             : // All of the 1-D PB types have everything in common except for the
      83             : // details of their parameterization.  This lightweight class
      84             : // deals with those differences: construction, filling the PBArray
      85             : // from construction parameters, and flushing to disk.
      86             : // BIMA uses a Gaussian PB.
      87             : // </motivation>
      88             : //
      89             : // <todo asof="98/10/21">
      90             : // <li> constructor from a casacore::MS beam subtable
      91             : // <li> flush to casacore::MS beam subtable
      92             : // </todo>
      93             : 
      94             :  
      95             : class PBMath1DGauss : public PBMath1D {
      96             : public:
      97             : 
      98             :   PBMath1DGauss();
      99             : 
     100             :   // Instantiation from arguments; default = no squint
     101             :   // squint is the offset from pointing center if the casacore::Stokes R beam
     102             :   // useSymmetricBeam forces a fit to the squinted beam
     103             :   // width = Half-Width-Half-max
     104             :   // maxRad = half-width at zero intensity
     105             :   PBMath1DGauss( casacore::Quantity halfWidth, casacore::Quantity maxRad, casacore::Quantity refFreq, 
     106             :                  casacore::Bool isThisVP=false,
     107             :                  BeamSquint squint=BeamSquint(casacore::MDirection(casacore::Quantity(0.0, "deg"),
     108             :                                                          casacore::Quantity(0.0, "deg"),
     109             :                                                          casacore::MDirection::Ref(casacore::MDirection::AZEL)),
     110             :                                               casacore::Quantity(1.0, "GHz")),
     111             :                  casacore::Bool useSymmetricBeam=false);
     112             : 
     113             :   // Instantiation from a row in the Beam subTable
     114             :   //  PBMath1DGauss(const casacore::Table& BeamSubTable, casacore::Int row, 
     115             :   //    casacore::Bool useSymmetricBeam=false);
     116             : 
     117             :   // Copy constructor
     118             :   // PBMath1DGauss(const PBMath1DGauss& other);
     119             : 
     120             :   // Assignment operator, by reference
     121             :   PBMath1DGauss& operator=(const PBMath1DGauss& other);
     122             : 
     123             :   // Clone the object
     124             :   //  casacore::CountedPtr<PBMathInterface> clone();
     125             : 
     126             :   // destructor
     127             :   ~PBMath1DGauss();  
     128             : 
     129             :   // Get the type of PB this is
     130           0 :   PBMathInterface::PBClass whichPBClass() { return PBMathInterface::GAUSS; }  
     131             :   
     132             :   // Flush the construction parameters to disk
     133             :   // casacore::Bool flushToTable(casacore::Table& beamSubTable, casacore::Int iRow);
     134             : 
     135             :   // Summarize the construction data for this primary beam
     136             :   void summary(casacore::Int nValues=0);
     137             : 
     138             : protected:
     139             : 
     140             :   // Fill in vp_p array from construction parameters
     141             :   void fillPBArray();
     142             : 
     143             : private:    
     144             : 
     145             :   casacore::Quantity halfWidth_p;
     146             : 
     147             : };
     148             : 
     149             : 
     150             : } //# NAMESPACE CASA - END
     151             : 
     152             : #endif