casa6

//# MomentCalcBase.h:

//# Copyright (C) 1997,1999,2000,2001,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 addressed 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: MomentCalculator.h 20299 2008-04-03 05:56:44Z gervandiepen $

​

#ifndef IMAGEANALYSIS_MOMENTCALCBASE_H

#define IMAGEANALYSIS_MOMENTCALCBASE_H

​

namespace casa {

​

//# Forward Declarations

template <class T> class MomentsBase;

// <summary>

// Abstract base class for moment calculator classes

// </summary>

// <use visibility=export>

// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">

// </reviewed>

//

// <prerequisite>

//   <li> <linkto class="MomentsBase">MomentsBase</linkto>

//   <li> <linkto class="ImageMoments">ImageMoments</linkto>

//   <li> <linkto class="casacore::LatticeApply">casacore::LatticeApply</linkto>

//   <li> <linkto class="casacore::LineCollapser">casacore::LineCollapser</linkto>

// </prerequisite>

//

// <synopsis>

//  This class, its concrete derived classes, and the classes casacore::LineCollapser,

//  ImageMoments, MSMoments, and casacore::LatticeApply are connected as follows.   casacore::LatticeApply offers 

//  functions so that the application programmer does not need to worry about how 

//  to optimally iterate through a casacore::Lattice; it deals with tiling and to a 

//  lesser extent memory.    casacore::LatticeApply functions are used by offering a class 

//  object to them that has a member function with a name and signature 

//  specified by an abstract base class that casacore::LatticeApply uses and the 

//  offered class inherits from.   Specifically, in this case, MomentCalcBase

//  inherits from casacore::LineCollapser and casacore::LatticeApply uses objects and methods of this

//  class (but does not inherit from it).  This defines the functions

//  <src>collapse</src> and <src>multiProcess</src> which operate on a vector

//  extracted from a Lattice.  The former returns one number, the latter a vector

//  of numbers from that profile.  MomentCalcBase is a base class for

//  for moment calculation and the <src>multiProcess</src>