Orfeo Toolbox  4.0
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::MeshRegion Class Reference

A mesh region represents an unstructured region of data. More...

#include <itkMeshRegion.h>

+ Inheritance diagram for itk::MeshRegion:
+ Collaboration diagram for itk::MeshRegion:

Public Types

enum  RegionType {
  ITK_UNSTRUCTURED_REGION,
  ITK_STRUCTURED_REGION
}
 
typedef MeshRegion Self
 
typedef Region Superclass
 

Public Member Functions

 MeshRegion ()
 
virtual ~MeshRegion ()
 
virtual const char * GetNameOfClass () const
 
SizeValueType GetNumberOfRegions () const
 
SizeValueType GetRegion () const
 
virtual RegionType GetRegionType () const
 
virtual void Print (std::ostream &os, Indent indent=0) const
 
void SetNumberOfRegions (SizeValueType num)
 
void SetRegion (SizeValueType region)
 

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
 

Private Attributes

SizeValueType m_NumberOfRegions
 
SizeValueType m_Region
 

Detailed Description

A mesh region represents an unstructured region of data.

MeshRegion is an class that represents some unstructured portion or piece of a Mesh. The MeshRegion is described as piece i out of N total pieces.

See Also
Region
ImageRegion

Definition at line 51 of file itkMeshRegion.h.

Member Typedef Documentation

Standard class typedefs.

Definition at line 55 of file itkMeshRegion.h.

Definition at line 56 of file itkMeshRegion.h.

Member Enumeration Documentation

enum itk::Region::RegionType
inherited

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

itk::MeshRegion::MeshRegion ( )

Constructor. MeshRegion is a lightweight object and is not reference counted.

Instantiate object.

Definition at line 26 of file itkMeshRegion.cxx.

itk::MeshRegion::~MeshRegion ( )
virtual

Destructor. MeshRegion is a lightweight object and is not reference counted.

Destructor for the MeshRegion class.

Definition at line 36 of file itkMeshRegion.cxx.

Member Function Documentation

virtual const char* itk::MeshRegion::GetNameOfClass ( ) const
virtual

Standard part of all itk objects.

Reimplemented from itk::Region.

SizeValueType itk::MeshRegion::GetNumberOfRegions ( ) const
inline

Get the number of regions.

Definition at line 74 of file itkMeshRegion.h.

References m_NumberOfRegions.

SizeValueType itk::MeshRegion::GetRegion ( ) const
inline

Get the current region.

Definition at line 84 of file itkMeshRegion.h.

References m_Region.

virtual RegionType itk::MeshRegion::GetRegionType ( ) const
inlinevirtual

Return the region type. Meshes are described with unstructured regions.

Implements itk::Region.

Definition at line 70 of file itkMeshRegion.h.

References itk::Region::ITK_UNSTRUCTURED_REGION.

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

Definition at line 43 of file itkRegion.cxx.

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

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 otb::RemoteSensingRegion< TType >, otb::RemoteSensingRegion< double >, otb::RemoteSensingRegion< typename VertexType::CoordRepType >, itk::ImageRegion< VImageDimension >, itk::ImageRegion< VDimension >, itk::ImageRegion< OutputImageType::ImageDimension >, itk::ImageIORegion, and itk::TemporalRegion.

Definition at line 55 of file itkRegion.cxx.

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

Definition at line 50 of file itkRegion.cxx.

void itk::MeshRegion::SetNumberOfRegions ( SizeValueType  num)
inline

Set the number of regions.

Definition at line 78 of file itkMeshRegion.h.

References m_NumberOfRegions.

void itk::MeshRegion::SetRegion ( SizeValueType  region)
inline

Set the number of regions.

Definition at line 88 of file itkMeshRegion.h.

References m_Region.

Member Data Documentation

SizeValueType itk::MeshRegion::m_NumberOfRegions
private

Definition at line 95 of file itkMeshRegion.h.

Referenced by GetNumberOfRegions(), and SetNumberOfRegions().

SizeValueType itk::MeshRegion::m_Region
private

Definition at line 98 of file itkMeshRegion.h.

Referenced by GetRegion(), and SetRegion().


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

Generated at Sat Mar 8 2014 17:25:01 for Orfeo Toolbox with doxygen 1.8.3.1