VisBufferUtil.h

Go to the documentation of this file.

//# VisBufferUtil.h: Definitions for VisBuffer utilities
//# Copyright (C) 1996-2014
//# Associated Universities, Inc. Washington DC, USA.
//#
//# 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 adressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$

#ifndef MSVIS_VISBUFFERUTIL_H
#define MSVIS_VISBUFFERUTIL_H

#include <casa/aips.h>
#include <msvis/MSVis/VisBuffer.h>
#include <msvis/MSVis/VisBuffer2.h>
#include <measures/Measures/MDirection.h>
#include <measures/Measures/MPosition.h>
#include <measures/Measures/MFrequency.h>
#include <ms/MeasurementSets/MeasurementSet.h>
#include <scimath/Mathematics/InterpolateArray1D.h>
namespace casa { //# NAMESPACE CASA - BEGIN
//forward 
class VisBuffer;
// <summary> 
// </summary>

// <reviewed reviewer="" date="" tests="" demos="">

// <prerequisite>
// </prerequisite>
//
// <etymology>
// </etymology>
//
// <synopsis> 
// </synopsis> 
//
// <example>
// <srcblock>
// </srcblock>
// </example>
//
// <motivation>
// </motivation>
//
// <todo asof="">
// </todo>
class VisBufferUtil{

public:

  //Empty Constructor
  VisBufferUtil();

  // Construct from a VisBuffer (sets a MeasFrame)
  VisBufferUtil(const VisBuffer& vb);

  // Same as above but with VisBuffer2;
  // It has to be attached to a VisIter2 as the frame is determined that way
  // otherwise use one of the constructors below or the empty constructor above
  VisBufferUtil(const vi::VisBuffer2& vb);
  // Construct with the vi2 to get access to the ms to define frame

  VisBufferUtil(const vi::VisibilityIterator2& iter);

  VisBufferUtil(const MeasFrame& mframe);

  // Make PSF VisBuffer
  void makePSFVisBuffer(VisBuffer& vb);
  

  //Regrid the data on a new frequency grid (defined by outFreqGrid) , on the frequency 
  //frame (defined by freqFrame). It will pass back the interpolated data and flags 
 
  Bool interpolateFrequency(Cube<Complex>& data, 
                            Cube<Bool>& flags, 
                            const VisBuffer& vb,
                            const Vector<Float>& outFreqGrid, const MS::PredefinedColumns whichCol=MS::DATA,
                            const MFrequency::Types freqFrame=MFrequency::LSRK,
                            const InterpolateArray1D< Float, Complex>::InterpolationMethod interp = 
                            (InterpolateArray1D<Float,Complex>::nearestNeighbour));

  // Converts the frequency in this visbuffer to the frame requested
  void convertFrequency(Vector<Double>& outFreq, 
                        const VisBuffer& vb, 
                        const MFrequency::Types freqFrame);
  //This one is just to test VisBuffer2 internal conversions
  void convertFrequency(Vector<Double>& outFreq, 
                        const vi::VisBuffer2& vb, 
                        const MFrequency::Types freqFrame);
  //This is a helper function as vi2 does not have a get Freq range for the data selected
  static void getFreqRange(Double& freqMin, Double& freqMax,  vi::VisibilityIterator2& vi, MFrequency::Types freqFrame);
  

  // Converts the frequency in this VisBuffer to velocity in the frame/def requested
  void toVelocity(Vector<Double>& outVel, 
                  const VisBuffer& vb, 
                  const MFrequency::Types freqFrame,
                  const MVFrequency restFreq,
                  const MDoppler::Types veldef);

  // Converts the frequencies on given row of VisBuffer2 to velocity in the frame/def requested
  void toVelocity(Vector<Double>& outVel,
                  const vi::VisBuffer2& vb,
                  const MFrequency::Types freqFrame,
                  const MVFrequency restFreq,
                  const MDoppler::Types veldef,
                  const Int row=0);

  void toVelocity(Vector<Double>& outVel,
                  const vi::VisBuffer2& vb,
                  const vi::VisibilityIterator2& iter,
                  const MFrequency::Types freqFrame,
                  const MVFrequency restFreq,
                  const MDoppler::Types veldef,
                  const Int row=0);


  void toVelocity(Vector<Double>& outVel,
                  const MFrequency::Types outfreqFrame,
                  const Vector<Double>& inFreq,
                  const MFrequency::Types inFreqFrame,
                  const MEpoch& ep,
                  const MDirection& dir,
                  const MVFrequency restFreq,
                  const MDoppler::Types veldef);

  //Rotate the uvw in the vb along with giving the phase needed to convert the visibilities to a new phasecenter
  // will return a False if it is a NoOP...don't need then to waste time
  //applying the phasor etc 
   Bool rotateUVW(const vi::VisBuffer2&vb, const MDirection& desiredDir,
                  Matrix<Double>& uvw, Vector<Double>& dphase);

   MDirection getPointingDir(const VisBuffer& vb, const Int antid, const Int row);
 private:
  void swapyz(Cube<Bool>& out, const Cube<Bool>& in);
  void swapyz(Cube<Complex>& out, const Cube<Complex>& in);
  void rejectConsecutive(const Vector<Double>& t, Vector<Double>& retval);
  // A MeasFrame for conversions
  MeasFrame mframe_;
  Int oldMSId_p;
  Vector<std::map<String, Int> > timeAntIndex_p;
  Vector<Vector<MDirection> > cachedPointingDir_p;

};

} //# NAMESPACE CASA - END

#endif