itk::ImageIORegion Class Reference

An ImageIORegion represents a structured region of data. More...

#include <itkImageIORegion.h>

Inheritance diagram for itk::ImageIORegion:

[legend]

Collaboration diagram for itk::ImageIORegion:

[legend]

List of all members.

Public Types
typedef ImageIORegion	Self
typedef Region	Superclass
typedef vcl_size_t	SizeValueType
typedef ptrdiff_t	IndexValueType
typedef ptrdiff_t	OffsetValueType
typedef std::vector < IndexValueType >	IndexType
typedef std::vector < SizeValueType >	SizeType
typedef Superclass::RegionType	RegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
unsigned int	GetImageDimension () const
unsigned int	GetRegionDimension () const
virtual RegionType	GetRegionType () const
	ImageIORegion (unsigned int dimension)
	ImageIORegion ()
virtual	~ImageIORegion ()
	ImageIORegion (const Self &region)
void	operator= (const Self &region)
void	SetIndex (const IndexType &index)
const IndexType &	GetIndex () const
void	SetSize (const SizeType &size)
const SizeType &	GetSize () const
SizeValueType	GetSize (unsigned long i) const
IndexValueType	GetIndex (unsigned long i) const
void	SetSize (const unsigned long i, SizeValueType size)
void	SetIndex (const unsigned long i, IndexValueType idx)
bool	operator== (const Self &region) const
bool	operator!= (const Self &region) const
bool	IsInside (const IndexType &index) const
bool	IsInside (const Self &region) const
SizeValueType	GetNumberOfPixels (void) const
virtual void	Print (std::ostream &os, Indent indent=0) const
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
Private Attributes
unsigned int	m_ImageDimension
IndexType	m_Index
SizeType	m_Size

---

Detailed Description

An ImageIORegion represents a structured region of data.

ImageIORegion is an class that represents some structured portion or piece of an Image. The ImageIORegion is represented with an index and a size in each of the n-dimensions of the image. (The index is the corner of the image, the size is the lengths of the image in each of the topological directions.) ImageIORegion is not templated over dimension, but uses dynamic arrays instead.

The first pixel of an image always have a Zero index. Therefore the index values of ImageIORegion may not directly correspond to those of ImageRegion. When translation between the two is performed one much consider the largest possible region who has a non-zero starting index for the image.

See also:

Region

ImageRegion

Index

Size

MeshRegion

Definition at line 53 of file itkImageIORegion.h.

---

Member Typedef Documentation

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs.

Reimplemented from itk::Region.

Definition at line 57 of file itkImageIORegion.h.

typedef vcl_size_t itk::ImageIORegion::SizeValueType

these types correspond to those of itk::Size, itk::Offset and itk::Index

Definition at line 61 of file itkImageIORegion.h.

typedef std::vector<IndexValueType> itk::ImageIORegion::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 67 of file itkImageIORegion.h.

typedef std::vector<SizeValueType> itk::ImageIORegion::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 70 of file itkImageIORegion.h.

typedef Superclass::RegionType itk::ImageIORegion::RegionType

Region type taken from the superclass

Reimplemented from itk::Region.

Definition at line 73 of file itkImageIORegion.h.

---

Constructor & Destructor Documentation

itk::ImageIORegion::ImageIORegion

(

unsigned int

dimension

)

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public.

Definition at line 44 of file itkImageIORegion.cxx.

{
  m_ImageDimension = dimension;
  m_Index.resize(m_ImageDimension);
  m_Size.resize(m_ImageDimension);
  std::fill(m_Index.begin(), m_Index.end(), 0);
  std::fill(m_Size.begin(), m_Size.end(), 0);
}

itk::ImageIORegion::ImageIORegion

(

)

Constructor. ImageIORegion is a lightweight object that is not reference counted, so the constructor is public. Default dimension is 2.

Definition at line 27 of file itkImageIORegion.cxx.

{
  m_ImageDimension = 2;
  m_Index.resize(2);
  m_Size.resize(2);
  std::fill(m_Index.begin(), m_Index.end(), 0);
  std::fill(m_Size.begin(), m_Size.end(), 0);
}

itk::ImageIORegion::~ImageIORegion

(

)

[virtual]

Destructor. ImageIORegion is a lightweight object that is not reference counted, so the destructor is public.

Definition at line 38 of file itkImageIORegion.cxx.

{
}

itk::ImageIORegion::ImageIORegion

(

const Self &

region

)

Copy constructor. ImageIORegion is a lightweight object that is not reference counted, so the copy constructor is public.

Definition at line 55 of file itkImageIORegion.cxx.

                                 : Region()
{ 
  m_Index =region.m_Index; 
  m_Size = region.m_Size; 
  m_ImageDimension = region.m_ImageDimension;
}

---

Member Function Documentation

virtual const char* itk::ImageIORegion::GetNameOfClass

(

)

const [virtual]

Standard part of all itk objects.

Reimplemented from itk::Region.

unsigned int itk::ImageIORegion::GetImageDimension

(

)

const

Dimension of the image available at run time.

Definition at line 118 of file itkImageIORegion.cxx.

Referenced by itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), and itk::MetaImageIO::Read().

{ 
  return m_ImageDimension;
}

unsigned int itk::ImageIORegion::GetRegionDimension

(

)

const

Dimension of the region to be written. This differs from the the image dimension and is calculated at run-time by examining the size of the image in each coordinate direction.

Definition at line 133 of file itkImageIORegion.cxx.

{  
  unsigned int dim=0;
  for (unsigned int i=0; i<m_ImageDimension; i++)
    {
    if ( m_Size[i] > 1 ) dim++;
    }
  return dim;
}

ImageIORegion::RegionType itk::ImageIORegion::GetRegionType

(

)

const [virtual]

Return the region type. Images are described with structured regions.

Implements itk::Region.

Definition at line 126 of file itkImageIORegion.cxx.

{
  return Superclass::ITK_STRUCTURED_REGION;
}

void itk::ImageIORegion::operator=

(

const Self &

region

)

operator=. ImageIORegion is a lightweight object that is not reference counted, so operator= is public.

Definition at line 65 of file itkImageIORegion.cxx.

{
  m_Index = region.m_Index;  
  m_Size = region.m_Size;
  m_ImageDimension = region.m_ImageDimension;
}

void itk::ImageIORegion::SetIndex

(

const IndexType &

index

)

Set the index defining the corner of the region.

Definition at line 83 of file itkImageIORegion.cxx.

Referenced by otb::ImageFileReader< TOutputImage >::GenerateData(), itk::MetaImageIO::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), itk::MetaImageIO::Read(), otb::StreamingImageFileWriter< TInputImage >::UpdateOutputData(), and itk::MetaImageIO::Write().

{
  m_Index = index;
}

const ImageIORegion::IndexType & itk::ImageIORegion::GetIndex

(

void

)

const

Get index defining the corner of the region.

Definition at line 92 of file itkImageIORegion.cxx.

Referenced by itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion(), otb::ImageFileReader< TOutputImage >::GenerateData(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::TileMapImageIO::Read(), itk::NiftiImageIO::Read(), itk::MetaImageIO::Read(), itk::ImageFileWriter< TInputImage >::Write(), otb::TileMapImageIO::Write(), and itk::MetaImageIO::Write().

{
  return m_Index;
}

void itk::ImageIORegion::SetSize

(

const SizeType &

size

)

Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region.

Definition at line 102 of file itkImageIORegion.cxx.

Referenced by otb::ImageFileReader< TOutputImage >::GenerateData(), itk::MetaImageIO::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), itk::MetaImageIO::Read(), otb::StreamingImageFileWriter< TInputImage >::UpdateOutputData(), and itk::MetaImageIO::Write().

{
  m_Size = size;
}

const ImageIORegion::SizeType & itk::ImageIORegion::GetSize

(

void

)

const

Get the size of the region.

Definition at line 110 of file itkImageIORegion.cxx.

Referenced by otb::ImageFileReader< TOutputImage >::GenerateData(), itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::TileMapImageIO::Read(), itk::NiftiImageIO::Read(), itk::MetaImageIO::Read(), itk::MetaImageIO::Write(), and otb::TileMapImageIO::Write().

{
  return m_Size;
}

ImageIORegion::SizeValueType itk::ImageIORegion::GetSize

(

unsigned long

i

)

const

Convenience methods to get the size of the image in a particular coordinate direction i. Do not try to access image sizes beyond the the ImageDimension.

Definition at line 146 of file itkImageIORegion.cxx.

{
  if( i >= m_Size.size() )
    {
    itkExceptionMacro("Invalid index in GetSize()");
    }
  return m_Size[i];
}

bool itk::ImageIORegion::operator==

(

const Self &

region

)

const

Compare two regions.

Definition at line 256 of file itkImageIORegion.cxx.

{
  bool same;
  same = (m_Index == region.m_Index);
  same = same && (m_Size == region.m_Size);
  same = same && (m_ImageDimension == region.m_ImageDimension);
  return same;
}

bool itk::ImageIORegion::operator!=

(

const Self &

region

)

const

Compare two regions.

Definition at line 268 of file itkImageIORegion.cxx.

{
  bool same;
  same = (m_Index == region.m_Index);
  same = same && (m_Size == region.m_Size);
  same = same && (m_ImageDimension == region.m_ImageDimension);
  return !same;
}

bool itk::ImageIORegion::IsInside

(

const IndexType &

index

)

const

Test if an index is inside

Definition at line 194 of file itkImageIORegion.cxx.

Referenced by itk::ImageFileWriter< TInputImage >::Write().

{
  if (m_ImageDimension != index.size())
    {
    return false;
    }
  for(unsigned int i=0; i<m_ImageDimension; i++)
    {
    if( index[i] < m_Index[i] ) 
      {
      return false;
      }
    if( static_cast<SizeValueType>(index[i]-m_Index[i]) >= m_Size[i] ) 
      {
      return false;
      }
    }
  return true;
}

bool itk::ImageIORegion::IsInside

(

const Self &

region

)

const

Test if a region (the argument) is completly inside of this region

Definition at line 217 of file itkImageIORegion.cxx.

{
  IndexType beginCorner = region.GetIndex();
  if( ! this->IsInside( beginCorner ) )
    {
    return false;
    }
  IndexType endCorner(region.m_ImageDimension);
  SizeType  size = region.GetSize();
  for(unsigned int i=0; i<m_ImageDimension; i++)
    {
    endCorner[i] = beginCorner[i] + size[i] - 1;
    }
  if( ! this->IsInside( endCorner ) )
    {
    return false;
    }
  return true;
}

ImageIORegion::SizeValueType itk::ImageIORegion::GetNumberOfPixels

(

void

)

const

Get the number of pixels contained in this region. This just multiplies the size components.

Definition at line 241 of file itkImageIORegion.cxx.

Referenced by itk::MetaImageIO::Read().

{
  size_t numPixels=1;
  
  for ( unsigned int d = 0; d < this->GetImageDimension(); ++d )
    {
    numPixels *= m_Size[d];
    }
  
  return numPixels;
}

void itk::ImageIORegion::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 from itk::Region.

Definition at line 280 of file itkImageIORegion.cxx.

{
  Superclass::PrintSelf(os, indent);
  
  os << indent << "Dimension: " << this->GetImageDimension() << std::endl;
  os << indent << "Index: ";
  for(ImageIORegion::IndexType::const_iterator i = this->GetIndex().begin();
      i != this->GetIndex().end(); ++i)
    {
    os << *i << " ";
    }
  os << std::endl;
  os << indent << "Size: ";
  for(ImageIORegion::SizeType::const_iterator k = this->GetSize().begin();
      k != this->GetSize().end(); ++k)
    {
    os << *k << " ";
    }
  os << std::endl;
}

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

Print the region.

Definition at line 27 of file itkRegion.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::ImageIOBase::PrintSelf().

{
  this->PrintHeader(os,indent); 
  this->PrintSelf(os, indent.GetNextIndent());
  this->PrintTrailer(os,indent);
}  

---

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

• itkImageIORegion.h
• itkImageIORegion.cxx