Loading...
Searching...
No Matches
ImageAttrHandlerCasa.h
Go to the documentation of this file.
//# ImageAttrHandlerCasa.h: Attributes handler for CASA images
//# Copyright (C) 2012
//# 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 IMAGES_IMAGEATTRHANDLERCASA_H
#define IMAGES_IMAGEATTRHANDLERCASA_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Images/ImageAttrHandler.h>
#include <casacore/images/Images/ImageAttrGroupCasa.h>
#include <map>
namespace casacore {
// <summary>
// Abstract base class for an image attributes handler.
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tPagedmage.cc" demos="dPagedImage.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class=ImageInterface>ImageInterface</linkto>
// </prerequisite>
// <etymology>
// This class makes it possible to store extra attributes with an image to
// describe atrbitrary meta information.
// </etymology>
// <synopsis>
// For LOFAR it was needed to store extra meta information and to be able to
// convert it from casacore table format to HDF5 format and vice-versa.
// Furthermore, it must be possible to access the information in a way that
// arbitrary info can be stored and retrieved.
//
// The attributes are divided into handlers. Each handler can reside in a subtable
// of the image or in a handler in HDF5. All attributes in a handler have the
// same number of values, where each value can be a scalar or (small) array.
// It is possible to define units and measure info for an attribute.
// </synopsis>
// <example>
// This example shows how to get attributes from an image.
// make it known to the image.
// <srcblock>
// // Open the image (as readonly for the moment).
// PagedImage<Float> myimage ("image.name");
// // Get access to attibute handler LOFAR_SOURCE.
// ImageExtrAttr& = myimage.attrHandler ("LOFAR_SOURCE");
// // Get the data for some field.
// Vector<String> names = ImageExtrAttr->getString("NAME");
// </srcblock>
// </example>
//
// <motivation>
// LOFAR needed functionality to store arbitrary attributes.
// </motivation>
class ImageAttrHandlerCasa : public ImageAttrHandler
{
public:
// Default construct from the image table.
ImageAttrHandlerCasa();
// Attach the table and return this object.
// It looks for the table keyword ATTRGROUPS which contains the subtables
// defining the attribute groups.
// If the keyword does not exist, it will be added if <src>createHandler</src>
// is set.
// Otherwise the handler is an empty one and no groups can be added to it.
ImageAttrHandlerCasa& attachTable (const Table& image,
Bool createHandler = False);
virtual ~ImageAttrHandlerCasa();
// Flush the attibrutes if needed.
virtual void flush();
// Test if the given attribute group is present.
virtual Bool hasGroup (const String& name);
// Get all attribute group names.
virtual Vector<String> groupNames() const;
// Get access to a group.
virtual ImageAttrGroup& openGroup (const String& groupName);
// Create an attribute group with the given name.
virtual ImageAttrGroup& createGroup (const String& groupName);
// Close the group with the given name. It will flush its attributes.
// Nothing is done if it is not open.
virtual void closeGroup (const String& groupName);
private:
Bool itsCanAdd; //# can groups be added?
Table itsImageTable; //# Table object of image
std::map<String,ImageAttrGroupCasa> itsGroupMap; //# attribute groups
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ImageAttrGroup
Definition ImageAttrGroup.h:114
casacore::ImageAttrHandlerCasa::~ImageAttrHandlerCasa
virtual ~ImageAttrHandlerCasa()
casacore::ImageAttrHandlerCasa::attachTable
ImageAttrHandlerCasa & attachTable(const Table &image, Bool createHandler=False)
Attach the table and return this object.
casacore::ImageAttrHandlerCasa::openGroup
virtual ImageAttrGroup & openGroup(const String &groupName)
Get access to a group.
casacore::ImageAttrHandlerCasa::itsGroupMap
std::map< String, ImageAttrGroupCasa > itsGroupMap
Definition ImageAttrHandlerCasa.h:124
casacore::ImageAttrHandlerCasa::hasGroup
virtual Bool hasGroup(const String &name)
Test if the given attribute group is present.
casacore::ImageAttrHandlerCasa::flush
virtual void flush()
Flush the attibrutes if needed.
casacore::ImageAttrHandlerCasa::ImageAttrHandlerCasa
ImageAttrHandlerCasa()
Default construct from the image table.
casacore::ImageAttrHandlerCasa::createGroup
virtual ImageAttrGroup & createGroup(const String &groupName)
Create an attribute group with the given name.
casacore::ImageAttrHandlerCasa::closeGroup
virtual void closeGroup(const String &groupName)
Close the group with the given name.
casacore::ImageAttrHandlerCasa::itsCanAdd
Bool itsCanAdd
Definition ImageAttrHandlerCasa.h:122
casacore::ImageAttrHandlerCasa::groupNames
virtual Vector< String > groupNames() const
Get all attribute group names.
casacore::ImageAttrHandlerCasa::itsImageTable
Table itsImageTable
Definition ImageAttrHandlerCasa.h:123
casacore::ImageAttrHandler::ImageAttrHandler
ImageAttrHandler()
Default constructor.
Definition ImageAttrHandler.h:93
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Table
Definition Table.h:157
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::False
const Bool False
Definition aipstype.h:42
casacore::name
String name() const
Return the name of the field.
Definition RecordField.h:163
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40