Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions

itk::Region Class Reference
[Data Representation Objects]

A region represents some portion or piece of data. More...

#include <itkRegion.h>

Inheritance diagram for itk::Region:
Inheritance graph
[legend]

List of all members.

Public Types

enum  RegionType {
  ITK_UNSTRUCTURED_REGION,
  ITK_STRUCTURED_REGION
}
typedef Region Self

Public Member Functions

virtual const char * GetNameOfClass () const
virtual RegionType GetRegionType () const =0
virtual void Print (std::ostream &os, Indent indent=0) const
 Region ()
virtual ~Region ()

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Detailed Description

A region represents some portion or piece of data.

Region is an abstract class that represents some portion or piece of a DataObject. A region is used by the pipeline when processing just a portion of the data, either because 1) memory limits dictate that the pipeline cannot fit the entire dataset into memory; 2) the user has requested that only a piece of the dataset is to be processed; or 3) parallel (multi-threaded) processing of the data is required.

There are two types of regions in itk: a structured region that specifies a rectangular piece of an image (ImageRegion), and a unstructured region that specifies piece i of N total pieces (MeshRegion). Depending on the filter (its input and output types, and its position in the pipeline), ImageRegion or MeshRegion will be used to describe the region.

Region is a light-weight object and not reference counted. This means that is behaves differently than ITK classes that are reference counted. For example, smart pointer access is not provided, and the (subclasses') constructor, destructor, copy constructor and operator= are all public.

See also:
ImageRegion
MeshRegion

Definition at line 56 of file itkRegion.h.


Member Typedef Documentation


Member Enumeration Documentation

Enums used to describe the extent types.

Enumerator:
ITK_UNSTRUCTURED_REGION 
ITK_STRUCTURED_REGION 

Reimplemented in itk::ImageIORegion.

Definition at line 63 of file itkRegion.h.


Constructor & Destructor Documentation

itk::Region::Region (  )  [inline]

Definition at line 75 of file itkRegion.h.

virtual itk::Region::~Region (  )  [inline, virtual]

Definition at line 76 of file itkRegion.h.


Member Function Documentation

virtual const char* itk::Region::GetNameOfClass (  )  const [virtual]
virtual RegionType itk::Region::GetRegionType (  )  const [pure virtual]

Subclasses must return a region type describing whether the region is structured or unstructured.

Implemented in itk::ImageRegion< VImageDimension >, itk::MeshRegion, itk::ImageIORegion, itk::ImageRegion< itkGetStaticConstMacro(SpaceDimension)>, and itk::ImageRegion< TDimension >.

virtual void itk::Region::Print ( std::ostream &  os,
Indent  indent = 0 
) const [virtual]

Print the region.

virtual void itk::Region::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::Region::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented in itk::ImageRegion< VImageDimension >, itk::ImageIORegion, itk::ImageRegion< itkGetStaticConstMacro(SpaceDimension)>, and itk::ImageRegion< TDimension >.

virtual void itk::Region::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.


The documentation for this class was generated from the following file:

Generated at Tue Jul 13 2010 01:12:34 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000