Loading...
Searching...
No Matches
WCCompound.h
Go to the documentation of this file.
//# WCCompound.h: Base class for compound WCRegion objects
//# Copyright (C) 1998,1999,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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef IMAGES_WCCOMPOUND_H
#define IMAGES_WCCOMPOUND_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Regions/WCRegion.h>
#include <casacore/casa/Containers/Block.h>
#include <casacore/casa/Arrays/IPosition.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class ImageRegion;
class LCRegion;
class CoordinateSystem;
class RecordInterface;
class TableRecord;
class String;
// <summary>
// Base class for compound WCRegion objects.
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="" tests="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=WCRegion>WCRegion</linkto>
// </prerequisite>
// <synopsis>
// WCCompound is the base class for world coordinate regions.
// It defines the functionality simply as conversion to an LCRegion.
// This is because you need an LCRegion to be able to access the
// pixels in a Lattice.
// The conversion functions should be flexible in that the
// supplied CoordinateSystem does not have to be the same
// as that with which the derived class was constructed.
// This means that you can apply a WCCompound from one image
// to another, provided that operation has some meaning.
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </example>
//# <todo asof="1997/11/11">
//# <li>
//# </todo>
class WCCompound : public WCRegion
{
public:
// Construct from one or more image regions.
// The image regions have to contain WCRegion objects, otherwise an
// exception is thrown.
// <group>
WCCompound (const ImageRegion& region1, const ImageRegion& region2);
WCCompound (const ImageRegion* region1,
const ImageRegion* region2 = 0,
const ImageRegion* region3 = 0,
const ImageRegion* region4 = 0,
const ImageRegion* region5 = 0,
const ImageRegion* region6 = 0,
const ImageRegion* region7 = 0,
const ImageRegion* region8 = 0,
const ImageRegion* region9 = 0,
const ImageRegion* region10 = 0);
WCCompound (const PtrBlock<const ImageRegion*>& regions);
// </group>
// Construct from multiple regions given as a Block.
// When <src>takeOver</src> is True, the destructor will delete the
// given regions. Otherwise a copy of the regions is made.
WCCompound (Bool takeOver, const PtrBlock<const WCRegion*>& regions);
// Copy constructor (copy semantics).
WCCompound (const WCCompound& other);
virtual ~WCCompound();
// Comparison
virtual Bool operator==(const WCRegion& other) const;
// Get the contributing regions.
const PtrBlock<const WCRegion*>& regions() const;
protected:
// Assignment (copy semantics) makes only sense for a derived class.
WCCompound& operator= (const WCCompound& other);
// Convert each WCRegion to an LCRegion.
// The axes argument tells which axes to use from the coordinate
// system and shape.
void multiToLCRegion (PtrBlock<const LCRegion*>& regions,
const CoordinateSystem& cSys,
const IPosition& shape,
const IPosition& pixelAxesMap,
const IPosition& extendAxes) const;
// Store the contributing regions in a record.
TableRecord makeRecord (const String& tableName) const;
// Retrieve the contributing objects from the record.
static void unmakeRecord (PtrBlock<const WCRegion*>&,
const TableRecord&,
const String& tableName);
private:
// Check if the ImageRegion's contain WCRegion's and extract them.
void makeWCRegion (const PtrBlock<const ImageRegion*>&);
// Check if the regions are correct.
// If needed, make a copy of the region objects.
void init (Bool takeOver);
//# Member variables.
PtrBlock<const WCRegion*> itsRegions;
Block<IPosition> itsAxesUsed;
};
inline const PtrBlock<const WCRegion*>& WCCompound::regions() const
{
return itsRegions;
}
} //# NAMESPACE CASACORE - END
#endif
casacore::Block
simple 1-D array
Definition Block.h:198
casacore::CoordinateSystem
Definition CoordinateSystem.h:215
casacore::IPosition
Definition IPosition.h:117
casacore::ImageRegion
Definition ImageRegion.h:85
casacore::LCRegion
Definition LCRegion.h:86
casacore::PtrBlock
A drop-in replacement for Block<T*>.
Definition Block.h:812
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TableRecord
Definition TableRecord.h:183
casacore::WCCompound::WCCompound
WCCompound(const ImageRegion *region1, const ImageRegion *region2=0, const ImageRegion *region3=0, const ImageRegion *region4=0, const ImageRegion *region5=0, const ImageRegion *region6=0, const ImageRegion *region7=0, const ImageRegion *region8=0, const ImageRegion *region9=0, const ImageRegion *region10=0)
casacore::WCCompound::init
void init(Bool takeOver)
Check if the regions are correct.
casacore::WCCompound::operator==
virtual Bool operator==(const WCRegion &other) const
Comparison.
casacore::WCCompound::itsAxesUsed
Block< IPosition > itsAxesUsed
Definition WCCompound.h:150
casacore::WCCompound::WCCompound
WCCompound(const ImageRegion &region1, const ImageRegion &region2)
Construct from one or more image regions.
casacore::WCCompound::~WCCompound
virtual ~WCCompound()
casacore::WCCompound::makeRecord
TableRecord makeRecord(const String &tableName) const
Store the contributing regions in a record.
casacore::WCCompound::WCCompound
WCCompound(const PtrBlock< const ImageRegion * > &regions)
casacore::WCCompound::operator=
WCCompound & operator=(const WCCompound &other)
Assignment (copy semantics) makes only sense for a derived class.
casacore::WCCompound::WCCompound
WCCompound(const WCCompound &other)
Copy constructor (copy semantics).
casacore::WCCompound::WCCompound
WCCompound(Bool takeOver, const PtrBlock< const WCRegion * > &regions)
Construct from multiple regions given as a Block.
casacore::WCCompound::itsRegions
PtrBlock< const WCRegion * > itsRegions
Definition WCCompound.h:149
casacore::WCCompound::unmakeRecord
static void unmakeRecord(PtrBlock< const WCRegion * > &, const TableRecord &, const String &tableName)
Retrieve the contributing objects from the record.
casacore::WCCompound::regions
const PtrBlock< const WCRegion * > & regions() const
Get the contributing regions.
Definition WCCompound.h:154
casacore::WCCompound::makeWCRegion
void makeWCRegion(const PtrBlock< const ImageRegion * > &)
Check if the ImageRegion's contain WCRegion's and extract them.
casacore::WCCompound::multiToLCRegion
void multiToLCRegion(PtrBlock< const LCRegion * > &regions, const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &extendAxes) const
Convert each WCRegion to an LCRegion.
casacore::WCRegion::WCRegion
WCRegion()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::shape
IPosition shape(const RecordFieldId &) const
Get the actual shape of this field.
casacore::RecordInterface
RecordInterface()
The default constructor creates an empty record with a variable structure.
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40