Source
xxxxxxxxxx
//# ImageMetaData.h: Meta information for Images
//# Copyright (C) 2009
//# 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$
namespace casa {
// <summary>
// A class in which to store and allow read-only access to image metadata.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=casacore::ImageInterface>ImageInterface</linkto>
// </prerequisite>
// <etymology>
// The ImageMetaData class name is derived from its role as holding image metadata.
// </etymology>
// <synopsis>
// The ImageMetaData object is meant to allow access to image metadata (eg, shape,
// coordinate system info such as spectral and polarization axes numbers, etc).
// </synopsis>
// <example>
// Construct an object of this class by passing the associated image to the constructor.
// <srcblock>
// casacore::PagedImage<casacore::Float> myImage("myImage");
// ImageMetaData<casacore::Float> myImageMetaData(myImage);
// </srcblock>
// </example>
// <motivation>
// This class is meant to provide an object-oriented interface for accessing
// image metadata without polluting the casacore::ImageInterface and CoordinateSystem
// classes with these methods.
// </motivation>
// <todo>
// Merge casacore::ImageInfo class into this class.
// </todo>
template <class T> class ImageMetaData : public ImageMetaDataBase<T> {
public:
ImageMetaData() = delete;
ImageMetaData(SPCIIT image);
~ImageMetaData() {}
casacore::Record toRecord(casacore::Bool verbose) const;
// For ia.summary() moved from ImageAnalysis