Документ взят из кэша поисковой машины. Адрес оригинального документа : http://www.atnf.csiro.au/computing/software/casacore/casacore-1.2.0/doc/html/classcasa_1_1ImageRegion.html
Дата изменения: Unknown
Дата индексирования: Mon Feb 14 21:47:42 2011
Кодировка:

Поисковые слова: п п п п п п п п п п п п п п п
casacore: casa::ImageRegion Class Reference
Public Member Functions | Static Public Member Functions | Private Attributes

casa::ImageRegion Class Reference
[Regions_module]

Class to hold a region of interest in an image. More...

#include <ImageRegion.h>

Inheritance diagram for casa::ImageRegion:
casa::LattRegionHolder

List of all members.

Public Member Functions

 ImageRegion ()
 Default constructor (has no region at all).
 ImageRegion (const LCRegion &)
 Construct from a region based on lattice coordinates.
 ImageRegion (const LCSlicer &)
 Construct from a slicer based on lattice coordinates.
 ImageRegion (const WCRegion &)
 Construct from a region based on world coordinates.
 ImageRegion (LCRegion *)
 Similar constructors as above, but using a pointer.
 ImageRegion (LCSlicer *)
 ImageRegion (WCRegion *)
 ImageRegion (const ImageRegion &other)
 Copy constructor (copy semantics).
virtual ~ImageRegion ()
ImageRegionoperator= (const ImageRegion &other)
 Assignment (copy semantics).
virtual ImageRegionclone () const
 Clone the object.
virtual Bool operator== (const LattRegionHolder &other) const
 Comparison.
virtual Bool isWCRegion () const
 Test if the underlying region is an WCRegion.
virtual const WCRegionasWCRegionPtr () const
 Get the region as a pointer to WCRegion.
const LCRegionasLCRegion () const
 Get the region as an LCSlicer or WCRegion.
const LCSlicerasLCSlicer () const
const WCRegionasWCRegion () const
LCRegionasMask ()
 Get the region as a writable mask.
virtual LatticeRegion toLatticeRegion (const CoordinateSystem &cSys, const IPosition &shape) const
 Convert to a LatticeRegion using the given coordinate system (with reference pixel) and shape.
LCRegiontoLCRegion (const CoordinateSystem &cSys, const IPosition &shape) const
 Convert to an LCRegion using the given coordinate system (with reference pixel) and shape.
TableRecord toRecord (const String &tableName) const
 Convert the (derived) object to a record.
virtual LattRegionHoldermakeUnion (const LattRegionHolder &other) const
 Form a compound from this and the other region.
virtual LattRegionHoldermakeIntersection (const LattRegionHolder &other) const
virtual LattRegionHoldermakeDifference (const LattRegionHolder &other) const
virtual LattRegionHoldermakeComplement () const

Static Public Member Functions

static ImageRegionfromRecord (const TableRecord &, const String &tableName)
 Convert correct object from a record.

Private Attributes

WCRegionitsWC

Detailed Description

Class to hold a region of interest in an image.

Intended use:

Public interface

Prerequisite

Synopsis

The only purpose of ImageRegion is to have a single object for the various kinds of regions. It can hold a LCRegion , LCSlicer , and WCRegion .

Example

Motivation

It was felt that making an abstract base class LatticeRegion for LCRegion and WCRegion would create undesirable dependencies of module Lattices on module Coordinates. E.g. it would be impossible to have a function toWCRegion. Therefore the container class ImageRegion is chosen.

Definition at line 85 of file ImageRegion.h.


Constructor & Destructor Documentation

casa::ImageRegion::ImageRegion (  ) 

Default constructor (has no region at all).

casa::ImageRegion::ImageRegion ( const LCRegion  ) 

Construct from a region based on lattice coordinates.

casa::ImageRegion::ImageRegion ( const LCSlicer  ) 

Construct from a slicer based on lattice coordinates.

casa::ImageRegion::ImageRegion ( const WCRegion  ) 

Construct from a region based on world coordinates.

casa::ImageRegion::ImageRegion ( LCRegion  )  [explicit]

Similar constructors as above, but using a pointer.

It takes over the pointer, so the user should not delete the object. It is deleted by the ImageRegion destructor.

casa::ImageRegion::ImageRegion ( LCSlicer  )  [explicit]
casa::ImageRegion::ImageRegion ( WCRegion  )  [explicit]
casa::ImageRegion::ImageRegion ( const ImageRegion other  ) 

Copy constructor (copy semantics).

virtual casa::ImageRegion::~ImageRegion (  )  [virtual]

Member Function Documentation

const LCRegion & casa::ImageRegion::asLCRegion (  )  const [inline]

Get the region as an LCSlicer or WCRegion.

An exception is thrown if the region is not the correct type. Functions isWCRegion(), etc. can be used to test the type.

Definition at line 183 of file ImageRegion.h.

References casa::LattRegionHolder::asLCRegionPtr().

const LCSlicer & casa::ImageRegion::asLCSlicer (  )  const [inline]

Definition at line 188 of file ImageRegion.h.

References casa::LattRegionHolder::asLCSlicerPtr().

LCRegion& casa::ImageRegion::asMask (  ) 

Get the region as a writable mask.

It throws an exception if the region is not an LCRegion or if its mask is not writable.

const WCRegion & casa::ImageRegion::asWCRegion (  )  const [inline]

Definition at line 193 of file ImageRegion.h.

References asWCRegionPtr().

virtual const WCRegion* casa::ImageRegion::asWCRegionPtr (  )  const [virtual]

Get the region as a pointer to WCRegion.

An exception is thrown if the region is not the correct type. Functions isWCRegion() can be used to test the type.

Reimplemented from casa::LattRegionHolder.

Referenced by asWCRegion().

virtual ImageRegion* casa::ImageRegion::clone (  )