Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

typedef Region Self
enum  RegionType { ITK_UNSTRUCTURED_REGION, ITK_STRUCTURED_REGION }

Public Methods

virtual const char * GetClassName () const
virtual RegionType GetRegionType () const=0
virtual void Print (std::ostream &os) const

Protected Methods

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

typedef Region itk::Region::Self
 

Standard class typedefs.

Reimplemented in itk::ImageRegion< VImageDimension >, itk::MeshRegion, itk::ImageIORegion, and itk::ImageRegion< PipelineDimension >.

Definition at line 60 of file itkRegion.h.


Member Enumeration Documentation

enum itk::Region::RegionType
 

Enums used to describe the extent types.

Enumeration values:
ITK_UNSTRUCTURED_REGION 
ITK_STRUCTURED_REGION 

Definition at line 63 of file itkRegion.h.


Member Function Documentation

virtual const char* itk::Region::GetClassName   const [virtual]
 

Standard part of all itk objects.

Reimplemented in itk::ImageRegion< VImageDimension >, itk::MeshRegion, itk::ImageIORegion, and itk::ImageRegion< PipelineDimension >.

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, and itk::ImageRegion< PipelineDimension >.

virtual void itk::Region::Print std::ostream &    os 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 >, and itk::ImageRegion< PipelineDimension >.

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 Wed Mar 12 01:20:33 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000