MultiTermFTNew.h

Go to the documentation of this file.

//# NewMultiTermFT.h: Definition for NewMultiTermFT
//# Copyright (C) 1996,1997,1998,1999,2000,2002
//# 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 SYNTHESIS_MULTITERMFTNEW_H
#define SYNTHESIS_MULTITERMFTNEW_H

#include <synthesis/TransformMachines/FTMachine.h>
#include <casa/Arrays/Matrix.h>
#include <scimath/Mathematics/FFTServer.h>
#include <msvis/MSVis/VisBuffer.h>
#include <images/Images/ImageInterface.h>
#include <images/Images/ImageInterface.h>
#include <casa/Containers/Block.h>
#include <casa/Arrays/Array.h>
#include <casa/Arrays/Vector.h>
#include <casa/Arrays/Matrix.h>
#include <scimath/Mathematics/ConvolveGridder.h>
#include <lattices/Lattices/LatticeCache.h>
#include <lattices/Lattices/ArrayLattice.h>
//#include <synthesis/MeasurementComponents/SynthesisPeek.h>
#include <casa/OS/Timer.h>

namespace casa { //# NAMESPACE CASA - BEGIN

class UVWMachine;

class MultiTermFTNew : public FTMachine {
public:

  // Construct using an existing FT-Machine 
  MultiTermFTNew(CountedPtr<FTMachine>& subftm, Int nterms=1, Bool forward=False);

  // Construct from a Record containing the MultiTermFTNew state
  MultiTermFTNew(const RecordInterface& stateRec);

  // Copy constructor. 
  // This first calls the default "=" operator, and then instantiates objects for member pointers.
  MultiTermFTNew(const MultiTermFTNew &other);

  // Assignment operator --- leave it as the default
  MultiTermFTNew &operator=(const MultiTermFTNew &other);

  // Destructor
  ~MultiTermFTNew();

  // Called at the start of de-gridding : subftm->initializeToVis()
  // Note : Pre-de-gridding model-image divisions by PBs will go here.
  void initializeToVis(ImageInterface<Complex>& /*image*/, 
                       const VisBuffer& /*vb*/)
  {throw(AipsError("MultiTermFTNew::initializeToVis called without vectors !"));};

   // Vectorized InitializeToVis
  //  void initializeToVis(Block<CountedPtr<ImageInterface<Complex> > > & compImageVec,PtrBlock<SubImage<Float> *> & modelImageVec, PtrBlock<SubImage<Float> *>& weightImageVec, PtrBlock<SubImage<Float> *>& fluxScaleVec, Block<Matrix<Float> >& weightsVec, const VisBuffer& vb);

  virtual void initializeToVisNew(const VisBuffer& vb,
                                             CountedPtr<SIImageStore> imstore);

  // Called at the end of de-gridding : subftm->finalizeToVis()
  void finalizeToVis();

  // Called at the start of gridding : subftm->initializeToSky()
  void initializeToSky(ImageInterface<Complex>& /*image*/,  
                       Matrix<Float>& /*weight*/, const VisBuffer& /*vb*/) 
   {throw(AipsError("MultiTermFTNew::initializeToSky() called without vectors!"));};

  //  void initializeToSky(Block<CountedPtr<ImageInterface<Complex> > > & compImageVec, Block<Matrix<Float> >& weightsVec, const VisBuffer& vb, const Bool dopsf);

  virtual void initializeToSkyNew(const Bool dopsf,
                                  const VisBuffer& vb, 
                                  CountedPtr<SIImageStore> imstore);


  // Called at the end of gridding : subftm->finalizeToSky()
  void finalizeToSky(){throw(AipsError("MultiTermFTNew::finalizeToSky() called without arguments!"));};

  //void finalizeToSky(Block<CountedPtr<ImageInterface<Complex> > > & compImageVec, PtrBlock<SubImage<Float> *> & resImageVec, PtrBlock<SubImage<Float> *>& weightImageVec, PtrBlock<SubImage<Float> *>& fluxScaleVec, Bool dopsf, Block<Matrix<Float> >& weightsVec, const VisBuffer& vb);

  virtual void finalizeToSkyNew(Bool dopsf, 
                                           const VisBuffer& vb,
                                           CountedPtr<SIImageStore> imstore  );

  //  void normalizeToSky(ImageInterface<Complex>& compImage, ImageInterface<Float>& resImage, ImageInterface<Float>& weightImage, Bool dopsf, Matrix<Float>& weights)
  // {throw(AipsError("MultiTermFTNew::normalizeToSky should not get called !"));};


  // Do the degridding via subftm->get() and modify model-visibilities by Taylor-weights
  void get(VisBuffer& vb, Int row=-1);

  // Modify imaging weights with Taylor-weights and do gridding via subftm->put()
  void put(VisBuffer& vb, Int row=-1, Bool dopsf=False,
           FTMachine::Type type=FTMachine::OBSERVED);

  // Have a const version for compatibility with other FTMs.. Throw an exception if called.
  void put(const VisBuffer& /*vb*/, Int /*row*/=-1, Bool /*dopsf*/=False,
           FTMachine::Type /*type*/=FTMachine::OBSERVED)
  {throw(AipsError("MultiTermFTNew::put called with a const vb. This FTM needs to modify the vb."));};

  // Calculate residual visibilities if possible.
  // The purpose is to allow rGridFT to make this multi-threaded
  virtual void ComputeResiduals(VisBuffer&vb, Bool useCorrected); 

  // Make an image : subftm->makeImage()
  void makeImage(FTMachine::Type type,
                 VisSet& vs,
                 ImageInterface<Complex>& image,
                 Matrix<Float>& weight);
  
  // Get the final image: do the Fourier transform grid-correct, then 
  // optionally normalize by the summed weights
  // Note : Post-gridding residual-image divisions by PBs will go here.
  //           For now, it just calls subftm->getImage()
  //  ImageInterface<Complex>& getImage(Matrix<Float>& weights, Bool normalize=True)
  //{return getImage(weights,normalize,0);};
  //ImageInterface<Complex>& getImage(Matrix<Float>& weights, Bool normalize=True, 
  //                                                         const Int taylorindex=0);
  ImageInterface<Complex>& getImage(Matrix<Float>& /*weights*/, Bool /*normalize*/=True)
  {throw(AipsError("MultiTermFTNew::getImage() should not be called"));}
 
  virtual Bool useWeightImage()
  {AlwaysAssert(subftms_p.nelements()>0,AipsError); return subftms_p[0]->useWeightImage(); };

  void getWeightImage(ImageInterface<Float>& weightImage, Matrix<Float>& weights)
  {AlwaysAssert(subftms_p.nelements()>0,AipsError); 
    subftms_p[0]->getWeightImage(weightImage, weights);}
  //  {throw(AipsError("MultiTermFTNew::getWeightImage() should not be called"));}

  // Save and restore the MultiTermFTNew to and from a record
  virtual Bool toRecord(String& error, RecordInterface& outRec, Bool withImage=False,
                        const String diskimage="");
  virtual Bool fromRecord(String& error, const RecordInterface& inRec);

  // Various small inline functions
  virtual Bool isFourier() {return True;}
  virtual void setNoPadding(Bool nopad){subftms_p[0]->setNoPadding(nopad);};
  virtual String name()const {return machineName_p;};
  virtual void setMiscInfo(const Int qualifier){(void)qualifier;};

  void printFTTypes()
  {
    cout << "** Number of FTs : " << subftms_p.nelements() << " -- " ;
    for(uInt tix=0; tix<(subftms_p).nelements(); tix++)
      cout << tix << " : " << (subftms_p[tix])->name() << "   " ;
    cout << endl;
  };

  FTMachine* cloneFTM();
  virtual void setDryRun(Bool val) 
  {
    isDryRun=val;
    //cerr << "MTFTMN: " << isDryRun << endl;
    for (uInt i=0;i<subftms_p.nelements();i++)
      subftms_p[i]->setDryRun(val);
  };
  virtual Bool isUsingCFCache() {Bool v=False; if (subftms_p.nelements() > 0) v=subftms_p[0]->isUsingCFCache(); return v;};

protected:
  // have to call the initmaps of subftm
  virtual void initMaps(const VisBuffer& vb);
  // Instantiate a new sub FTM
  CountedPtr<FTMachine> getNewFTM(const CountedPtr<FTMachine>& ftm);

  // Multiply Imaging weights by Taylor-function weights - during "put"
  Bool modifyVisWeights(VisBuffer& vb, uInt thisterm);
  // Multiply model visibilities by Taylor-function weights - during "get"
  Bool modifyModelVis(VisBuffer &vb, uInt thisterm);
  // Restore vb.imagingweights to the original
  void restoreImagingWeights(VisBuffer &vb);

  // Helper function to write ImageInterfaces to disk
  Bool storeAsImg(String fileName, ImageInterface<Float> & theImg);


  Cube<Complex> modviscube_p;

  uInt nterms_p, psfnterms_p;
  Double reffreq_p;
  Matrix<Float> imweights_p;
  String machineName_p;

  //  Bool donePSF_p;

  Block< CountedPtr<FTMachine> > subftms_p;

};

} //# NAMESPACE CASA - END

#endif