SIMapperCollection.h

Go to the documentation of this file.

//# SIMapperCollection.h: Imager functionality sits here; 
//# Copyright (C) 1996,1997,1998,1999,2000,2001,2002,2003
//# 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 addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#
//# $Id$

#ifndef SYNTHESIS_SIMAPPERCOLLECTION_H
#define SYNTHESIS_SIMAPPERCOLLECTION_H

#include <casa/aips.h>
#include <casa/OS/Timer.h>
#include <casa/Containers/Record.h>
#include <ms/MeasurementSets/MeasurementSet.h>
#include <casa/Arrays/IPosition.h>
#include <casa/Quanta/Quantum.h>
#include <measures/Measures/MDirection.h>

#include <synthesis/ImagerObjects/SIMapper.h>
#include <synthesis/ImagerObjects/SIMapperImageMosaic.h>

namespace casa { //# NAMESPACE CASA - BEGIN

class SIMapperCollection 
{
 public:
  // Default constructor

  SIMapperCollection();
  ~SIMapperCollection();

  void addMapper(casacore::CountedPtr <SIMapper> map);
  casacore::Int nMappers();
  casacore::Vector<casacore::String> getImageNames();

  /*  // No need for now.
      // Write this function only if we need to support multiple facets on outlier fields too.
      // In that case, hold a list of original ImageStores and a map to the list of Mappers
      //  to keep track of which original image points to which subset of the Mapper list.
      //  Also add code into "finalizeGrid" to copy only one PSF to the original. 
  void addMapper( casacore::Int mapperId, 
                  casacore::String mapperType,
                  casacore::uInt nTaylorTerms,
                  casacore::CountedPtr<FTMachine> ftm,
                  casacore::CountedPtr<FTMachine> iftm,
                  casacore::String imageName,
                  casacore::CoordinateSystem& cSys,
                  casacore::IPosition imShape, 
                  const casacore::Bool overwrite );
  */
  void initializeGrid(vi::VisBuffer2& vb, casacore::Bool dopsf=false,const casacore::Int mapperid=-1);
  void initializeGrid(vi::VisibilityIterator2& vi, casacore::Bool dopsf=false, const casacore::Int mapperid=-1);
  void grid(vi::VisBuffer2& vb, casacore::Bool dopsf=false, refim::FTMachine::Type col=refim::FTMachine::CORRECTED,
            const casacore::Int mapperid=-1);
  void finalizeGrid(vi::VisBuffer2& vb, casacore::Bool dopsf=false,const casacore::Int mapperid=-1);
  void initializeDegrid(vi::VisBuffer2& vb,const casacore::Int mapperid=-1);
  void degrid(vi::VisBuffer2& vb, casacore::Bool saveVirtualMod=false,const casacore::Int mapperid=-1);
  void saveVirtualModel(vi::VisBuffer2& vb);
  void finalizeDegrid(vi::VisBuffer2& vb,const casacore::Int mapperid=-1);
  void addPB(vi::VisBuffer2& vb, PBMath& pbMath, const casacore::MDirection& altDir=casacore::MDirection(), const casacore::Bool useAltDir=False);

  void initializeGrid(VisBuffer& vb, casacore::Bool dopsf=false,const casacore::Int mapperid=-1);
  void grid(VisBuffer& vb, casacore::Bool dopsf=false, FTMachine::Type col=FTMachine::CORRECTED,
            const casacore::Int mapperid=-1);
  void finalizeGrid(VisBuffer& vb, casacore::Bool dopsf=false,const casacore::Int mapperid=-1);
  void initializeDegrid(VisBuffer& vb,const casacore::Int mapperid=-1);
  void degrid(VisBuffer& vb, casacore::Bool saveVirtualMod=false,const casacore::Int mapperid=-1);
  void saveVirtualModel(VisBuffer& vb);
  void finalizeDegrid(VisBuffer& vb,const casacore::Int mapperid=-1);
  void addPB(VisBuffer& vb, PBMath& pbMath);
  casacore::Record getFTMRecord(casacore::Int mapperid);

  casacore::CountedPtr<SIImageStore> imageStore(const casacore::Int id=0);
  casacore::Bool releaseImageLocks();

  void checkOverlappingModels(casacore::String action); // action='blank' or 'restore'

  casacore::Bool anyNonZeroModels();

  const casacore::CountedPtr<FTMachine> getFTM(casacore::Int which, const casacore::Bool ift=true) 
  {
    AlwaysAssert(which>=0 && which<(casacore::Int)itsMappers.nelements(),casacore::AipsError);
    return itsMappers[which]->getFTM(ift);
  };
  const casacore::CountedPtr<refim::FTMachine>& getFTM2(casacore::Int which, const casacore::Bool ift=true) 
  {
    AlwaysAssert(which>=0 && which<(casacore::Int)itsMappers.nelements(),casacore::AipsError);
    return itsMappers[which]->getFTM2(ift);
  };

  
  void initPB();

  const casacore::CountedPtr<SIMapper> getMapper(casacore::Int which)
  {AlwaysAssert(which>=0 && which<(casacore::Int)itsMappers.nelements(),casacore::AipsError);
    return itsMappers[which];};
  virtual casacore::Long estimateRAM();
  
protected:


  casacore::Block<casacore::CountedPtr<SIMapper> >  itsMappers;
  casacore::Int oldMsId_p;

  casacore::Bool itsIsNonZeroModel;

};


} //# NAMESPACE CASA - END

#endif