ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Region Class Referenceabstract

#include <itkRegion.h>

+ Inheritance diagram for itk::Region:

Public Types

enum  RegionType {
  ITK_UNSTRUCTURED_REGION,
  ITK_STRUCTURED_REGION
}
 
using Self = Region
 

Public Member Functions

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

Protected Member Functions

virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (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 64 of file itkRegion.h.

Member Typedef Documentation

◆ Self

Standard class type aliases.

Definition at line 68 of file itkRegion.h.

Member Enumeration Documentation

◆ RegionType

Enums used to describe the extent types.

Enumerator
ITK_UNSTRUCTURED_REGION 
ITK_STRUCTURED_REGION 

Definition at line 71 of file itkRegion.h.

Constructor & Destructor Documentation

◆ Region()

itk::Region::Region ( )
default

◆ ~Region()

virtual itk::Region::~Region ( )
virtualdefault

Member Function Documentation

◆ GetRegionType()

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::ImageRegion< VDimension >, itk::ImageIORegion, itk::TemporalRegion, and itk::MeshRegion.

◆ itkTypeMacroNoParent()

itk::Region::itkTypeMacroNoParent ( Region  )

Standard part of all itk objects.

◆ Print()

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

◆ PrintHeader()

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

◆ PrintSelf()

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

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::ImageRegion< VDimension >, itk::ImageIORegion, and itk::TemporalRegion.

◆ PrintTrailer()

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

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