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

#include <itkImageIORegion.h>

Inheritance diagram for itk::ImageIORegion:

Collaboration diagram for itk::ImageIORegion:

Public Types
typedef std::vector < IndexValueType >	IndexType
typedef ptrdiff_t	IndexValueType
typedef ptrdiff_t	OffsetValueType
typedef Superclass::RegionType	RegionType
typedef ImageIORegion	Self
typedef std::vector < SizeValueType >	SizeType
typedef vcl_size_t	SizeValueType
typedef Region	Superclass

Public Member Functions
	ImageIORegion (unsigned int dimension)
	ImageIORegion ()
	ImageIORegion (const Self &region)
virtual	~ImageIORegion ()
unsigned int	GetImageDimension () const
const IndexType &	GetIndex () const
IndexValueType	GetIndex (unsigned long i) const
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfPixels (void) const
unsigned int	GetRegionDimension () const
virtual RegionType	GetRegionType () const
const SizeType &	GetSize () const
SizeValueType	GetSize (unsigned long i) const
bool	IsInside (const IndexType &index) const
bool	IsInside (const Self &region) const
bool	operator!= (const Self &region) const
void	operator= (const Self &region)
bool	operator== (const Self &region) const
virtual void	Print (std::ostream &os, Indent indent=0) const
void	SetIndex (const IndexType &index)
void	SetIndex (const unsigned long i, IndexValueType idx)
void	SetSize (const SizeType &size)
void	SetSize (const unsigned long i, SizeValueType size)

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
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 54 of file itkImageIORegion.h.

Member Typedef Documentation

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

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

Definition at line 68 of file itkImageIORegion.h.

typedef ptrdiff_t itk::ImageIORegion::IndexValueType

Definition at line 63 of file itkImageIORegion.h.

typedef ptrdiff_t itk::ImageIORegion::OffsetValueType

Definition at line 64 of file itkImageIORegion.h.

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

Region type taken from the superclass

Reimplemented from itk::Region.

Definition at line 74 of file itkImageIORegion.h.

typedef ImageIORegion itk::ImageIORegion::Self

Standard class typedefs.

Reimplemented from itk::Region.

Definition at line 58 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 71 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 62 of file itkImageIORegion.h.

typedef Region itk::ImageIORegion::Superclass

Definition at line 59 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.

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.

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.

Member Function Documentation

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::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), itk::MetaImageIO::Read(), and itk::StreamingImageIOBase::StreamWriteBufferAsBinary().

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 otb::ComputeOffsets(), otb::JPEG2000ImageIO::ComputeTileList(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion(), otb::TileMapImageIO::GenerateBuffer(), otb::ImageFileReader< TOutputImage >::GenerateData(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::JPEG2000ImageIO::LoadTileData(), otb::ONERAImageIO::Read(), otb::LUMImageIO::Read(), otb::MWImageIO::Read(), itk::MetaImageIO::Read(), otb::RADImageIO::Read(), otb::BSQImageIO::Read(), itk::NiftiImageIO::Read(), otb::TileMapImageIO::Read(), otb::GDALImageIO::Read(), itk::StreamingImageIOBase::StreamWriteBufferAsBinary(), otb::ONERAImageIO::Write(), otb::LUMImageIO::Write(), otb::MWImageIO::Write(), otb::RADImageIO::Write(), otb::BSQImageIO::Write(), otb::TileMapImageIO::Write(), otb::GDALImageIO::Write(), and itk::ImageFileWriter< TInputImage >::Write().

ImageIORegion::IndexValueType itk::ImageIORegion::GetIndex ( unsigned long i ) const

Definition at line 158 of file itkImageIORegion.cxx.

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

virtual

Standard part of all itk objects.

Reimplemented from itk::Region.

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().

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.

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.

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::ComputeOffsets(), otb::JPEG2000ImageIO::ComputeTileList(), itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::TileMapImageIO::GenerateBuffer(), otb::ImageFileReader< TOutputImage >::GenerateData(), itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::JPEG2000ImageIO::LoadTileData(), otb::MSTARImageIO::Read(), otb::ONERAImageIO::Read(), itk::MetaImageIO::Read(), otb::MWImageIO::Read(), otb::RADImageIO::Read(), otb::LUMImageIO::Read(), otb::BSQImageIO::Read(), itk::NiftiImageIO::Read(), otb::TileMapImageIO::Read(), otb::GDALImageIO::Read(), itk::StreamingImageIOBase::StreamWriteBufferAsBinary(), otb::ONERAImageIO::Write(), otb::MWImageIO::Write(), otb::LUMImageIO::Write(), otb::RADImageIO::Write(), otb::BSQImageIO::Write(), otb::TileMapImageIO::Write(), otb::GDALImageIO::Write(), and otb::MWImageIO::WriteImageInformation().

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.

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::StreamingImageIOBase::StreamWriteBufferAsBinary(), and itk::ImageFileWriter< TInputImage >::Write().

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.

bool itk::ImageIORegion::operator!= ( const Self & region ) const

Compare two regions.

Definition at line 268 of file itkImageIORegion.cxx.

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.

bool itk::ImageIORegion::operator== ( const Self & region ) const

Compare two regions.

Definition at line 256 of file itkImageIORegion.cxx.

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

virtualinherited

Print the region.

Definition at line 27 of file itkRegion.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<(), and itk::ImageIOBase::PrintSelf().

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

protectedvirtualinherited

Definition at line 36 of file itkRegion.cxx.

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

Definition at line 280 of file itkImageIORegion.cxx.

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

protectedvirtualinherited

Definition at line 43 of file itkRegion.cxx.

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 itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageFileReader< TOutputImage >::GenerateData(), itk::StreamingImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::MetaImageIO::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::TileMapImageIO::InternalWrite(), itk::MetaImageIO::Read(), otb::TileMapImageIO::ReadTile(), itk::StreamingImageIOBase::RequestedToStream(), otb::ImageFileWriter< TInputImage >::Update(), and itk::MetaImageIO::Write().

void itk::ImageIORegion::SetIndex	(	const unsigned long	i,
		IndexValueType	idx
	)

Definition at line 182 of file itkImageIORegion.cxx.

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 itk::ImageIORegionAdaptor< VDimension >::Convert(), otb::ImageFileReader< TOutputImage >::GenerateData(), itk::StreamingImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::MetaImageIO::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite(), otb::TileMapImageIO::InternalWrite(), itk::MetaImageIO::Read(), otb::TileMapImageIO::ReadTile(), itk::StreamingImageIOBase::RequestedToStream(), otb::ImageFileWriter< TInputImage >::Update(), and itk::MetaImageIO::Write().

void itk::ImageIORegion::SetSize	(	const unsigned long	i,
		SizeValueType	size
	)

Definition at line 170 of file itkImageIORegion.cxx.

Member Data Documentation

unsigned int itk::ImageIORegion::m_ImageDimension

private

Definition at line 155 of file itkImageIORegion.h.

IndexType itk::ImageIORegion::m_Index

private

Definition at line 156 of file itkImageIORegion.h.

SizeType itk::ImageIORegion::m_Size

private

Definition at line 157 of file itkImageIORegion.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation