LatticeUtilities.h

Go to the documentation of this file.

// # LatticeUtilities.h: useful global functions for Lattices
// # Copyright (C) 1995,1996,1997,1999,2000,2001,2002,2004
// # 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: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
 
#ifndef LATTICES_LATTICEUTILITIES_H
#define LATTICES_LATTICEUTILITIES_H
 
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/ArrayFwd.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
template <class T>
class Lattice;
template <class T>
class MaskedLattice;
class IPosition;
class LogIO;
class Slicer;
 
// <summary>Static functions for Lattices</summary>
// <use visibility=export>
 
// <reviewed reviewer="" date="yyyy/mm/dd" tests="tLatticeUtilities.cc" demos="">
// </reviewed>
//
// <prerequisite>
//   <li> <linkto class="Lattice">Lattice</linkto>
// </prerequisite>
//
// <synopsis>
// Some static helper functions for Lattices
// </synopsis>
//
// <motivation>
// Common functionality not appropriate for Lattice member functions
// </motivation>
//
// <todo asof="2001/08/27">
//   <li> nothing I know of
// </todo>
//
 
class LatticeUtilities {
 public:
  // Copy data and mask from input to output.  If the input has no mask,
  // that means all True (good), and these values will be transferred
  // to the output.   Mask transfer only  occurs if the output has
  // a writeable mask.
  template <class T>
  static void copyDataAndMask(LogIO& os, MaskedLattice<T>& out, const MaskedLattice<T>& in,
                              Bool zeroMasked = False);
 
  // Replicate array through lattice in the specified region.
  // The shape of <src>pixels</src> has to fit exactly into the shape of
  // the selected region for each axis of <src>pixels</src>. Otherwise
  // and exception will be thrown. For example,
  // if the shape of the region is [10,20], the shape of pixels could
  // be [10] and it will be replicated 20 times.  Another example would
  // be that the shape of pixels could be [5,10] and it would be
  // replicated 4 times fitting into the Lattice
  template <class T>
  static void replicate(Lattice<T>& lat, const Slicer& region, const Array<T>& pixels);
 
  // Bin up one axis of MaskedArray (uses Lattices in implementation)
  template <class T>
  static void bin(MaskedArray<T>& out, const MaskedArray<T>& in, uInt axis, uInt bin);
 
  // Add degenerate axes to the lattice if needed (nDim is the desired number of dimensions
  // for the output lattice).  If the shapes are the same, the returned
  // pointer holds a SubLattice.  If a reshape was necessary, the pointer
  // holds an ExtendLattice.  The pointer is the callers responsibility to delete.
  template <class T>
  static void addDegenerateAxes(Lattice<T>*& pLatOut, const Lattice<T>& latIn, uInt nDim);
};
 
}  // namespace casacore
 
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/lattices/Lattices/LatticeUtilities.tcc>
#endif  // # CASACORE_NO_AUTO_TEMPLATES
#endif