itk::ImageRegion< VImageDimension > Class Template Reference
[Image Representation Objects]
#include <itkImageRegion.h>
Detailed Description
template<unsigned int VImageDimension>
class itk::ImageRegion< VImageDimension >
An image region represents a structured region of data.
ImageRegion is an class that represents some structured portion or piece of an Image. The ImageRegion 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.)
- See also:
- Region
Definition at line 55 of file itkImageRegion.h.
Public Types | |
| typedef Index< VImageDimension > | IndexType |
| typedef IndexType::IndexValueType | IndexValueType |
| enum | RegionType { ITK_UNSTRUCTURED_REGION, ITK_STRUCTURED_REGION } |
| typedef ImageRegion | Self |
| typedef Size< VImageDimension > | SizeType |
| typedef SizeType::SizeValueType | SizeValueType |
| typedef ImageRegion < itkGetStaticConstMacro(SliceDimension)> | SliceRegion |
| typedef Region | Superclass |
Public Member Functions | |
| bool | Crop (const Self ®ion) |
| const IndexType & | GetIndex () const |
| virtual const char * | GetNameOfClass () const |
| unsigned long | GetNumberOfPixels () const |
| virtual Superclass::RegionType | GetRegionType () const |
| const SizeType & | GetSize () const |
| ImageRegion (const SizeType &size) | |
| ImageRegion (const IndexType &index, const SizeType &size) | |
| ImageRegion (const Self ®ion) | |
| ImageRegion () | |
| itkStaticConstMacro (SliceDimension, unsigned int,(VImageDimension-(VImageDimension > 1))) | |
| itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension) | |
| void | operator= (const Self ®ion) |
| virtual void | Print (std::ostream &os, Indent indent=0) const |
| void | SetIndex (const IndexType &index) |
| void | SetSize (const SizeType &size) |
| SliceRegion | Slice (const unsigned long dim) const |
| virtual | ~ImageRegion () |
| IndexValueType | GetIndex (unsigned long i) const |
| void | SetIndex (unsigned long i, IndexValueType sze) |
| SizeValueType | GetSize (unsigned long i) const |
| void | SetSize (unsigned long i, SizeValueType sze) |
| bool | IsInside (const Self ®ion) const |
| template<typename TCoordRepType> | |
| bool | IsInside (const ContinuousIndex< TCoordRepType, VImageDimension > &index) const |
| bool | IsInside (const IndexType &index) const |
| bool | operator!= (const Self ®ion) const |
| bool | operator== (const Self ®ion) const |
| void | PadByRadius (const SizeType &radius) |
| void | PadByRadius (const unsigned long radius[VImageDimension]) |
| void | PadByRadius (unsigned long radius) |
Static Public Member Functions | |
| static unsigned int | GetImageDimension () |
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 |
Friends | |
| class | ImageBase< VImageDimension > |
Member Typedef Documentation
| typedef Index<VImageDimension> itk::ImageRegion< VImageDimension >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 78 of file itkImageRegion.h.
| typedef IndexType::IndexValueType itk::ImageRegion< VImageDimension >::IndexValueType |
Definition at line 79 of file itkImageRegion.h.
| typedef ImageRegion itk::ImageRegion< VImageDimension >::Self |
Standard class typedefs.
Reimplemented from itk::Region.
Definition at line 59 of file itkImageRegion.h.
| typedef Size<VImageDimension> itk::ImageRegion< VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Definition at line 82 of file itkImageRegion.h.
| typedef SizeType::SizeValueType itk::ImageRegion< VImageDimension >::SizeValueType |
Definition at line 83 of file itkImageRegion.h.
| typedef ImageRegion<itkGetStaticConstMacro(SliceDimension)> itk::ImageRegion< VImageDimension >::SliceRegion |
Slice region typedef. SliceRegion is one dimension less than Self.
Definition at line 86 of file itkImageRegion.h.
| typedef Region itk::ImageRegion< VImageDimension >::Superclass |
Definition at line 60 of file itkImageRegion.h.
Member Enumeration Documentation
enum itk::Region::RegionType [inherited] |
Enums used to describe the extent types.
Reimplemented in itk::ImageIORegion.
Definition at line 63 of file itkRegion.h.
Constructor & Destructor Documentation
| itk::ImageRegion< VImageDimension >::ImageRegion | ( | ) |
Constructor. ImageRegion is a lightweight object that is not reference counted, so the constructor is public.
| virtual itk::ImageRegion< VImageDimension >::~ImageRegion | ( | ) | [virtual] |
Destructor. ImageRegion is a lightweight object that is not reference counted, so the destructor is public.
| itk::ImageRegion< VImageDimension >::ImageRegion | ( | const Self & | region | ) | [inline] |
Copy constructor. ImageRegion is a lightweight object that is not reference counted, so the copy constructor is public.
Definition at line 102 of file itkImageRegion.h.
| itk::ImageRegion< VImageDimension >::ImageRegion | ( | const IndexType & | index, | |
| const SizeType & | size | |||
| ) | [inline] |
Constructor that takes an index and size. ImageRegion is a lightweight object that is not reference counted, so this constructor is public.
Definition at line 106 of file itkImageRegion.h.
| itk::ImageRegion< VImageDimension >::ImageRegion | ( | const SizeType & | size | ) | [inline] |
Constructor that takes a size and assumes an index of zeros. ImageRegion is lightweight object that is not reference counted so this constructor is public.
Definition at line 112 of file itkImageRegion.h.
Member Function Documentation
| bool itk::ImageRegion< VImageDimension >::Crop | ( | const Self & | region | ) |
Crop a region by another region. If this region is outside of the crop, this method returns false and does not modify the region. Otherwise, this method returns true and the region is modified to reflect the crop.
| static unsigned int itk::ImageRegion< VImageDimension >::GetImageDimension | ( | ) | [inline, static] |
Dimension of the image available at run time.
Definition at line 74 of file itkImageRegion.h.
| IndexValueType itk::ImageRegion< VImageDimension >::GetIndex | ( | unsigned long | i | ) | const [inline] |
Definition at line 147 of file itkImageRegion.h.
| const IndexType& itk::ImageRegion< VImageDimension >::GetIndex | ( | void | ) | const [inline] |
Get index defining the corner of the region.
Definition at line 125 of file itkImageRegion.h.
Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeIndex(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeOffset(), itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion().
| virtual const char* itk::ImageRegion< VImageDimension >::GetNameOfClass | ( | ) | const [virtual] |
Standard part of all itk objects.
Reimplemented from itk::Region.
| unsigned long itk::ImageRegion< VImageDimension >::GetNumberOfPixels | ( | ) | const |
Get the number of pixels contained in this region. This just multiplies the size components.
| virtual Superclass::RegionType itk::ImageRegion< VImageDimension >::GetRegionType | ( | ) | const [inline, virtual] |
Return the region type. Images are described with structured regions.
Implements itk::Region.
Definition at line 89 of file itkImageRegion.h.
| SizeValueType itk::ImageRegion< VImageDimension >::GetSize | ( | unsigned long | i | ) | const [inline] |
Definition at line 140 of file itkImageRegion.h.
| const SizeType& itk::ImageRegion< VImageDimension >::GetSize | ( | void | ) | const [inline] |
Get the size of the region.
Definition at line 134 of file itkImageRegion.h.
Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformContinuousIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformIndexToPhysicalPoint(), itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), and itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex().
| bool itk::ImageRegion< VImageDimension >::IsInside | ( | const Self & | region | ) | const [inline] |
Test if a region (the argument) is completely inside of this region
Definition at line 232 of file itkImageRegion.h.
| bool itk::ImageRegion< VImageDimension >::IsInside | ( | const ContinuousIndex< TCoordRepType, VImageDimension > & | index | ) | const [inline] |
Test if a continuous index is inside the region. If ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is on, we take into account the fact that each voxel has its center at the integer coordinate and extends half way to the next integer coordinate.
Definition at line 200 of file itkImageRegion.h.
| bool itk::ImageRegion< VImageDimension >::IsInside | ( | const IndexType & | index | ) | const [inline] |
Test if an index is inside
Definition at line 176 of file itkImageRegion.h.
Referenced by itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToContinuousIndex(), and itk::PhasedArray3DSpecialCoordinatesImage< TPixel >::TransformPhysicalPointToIndex().
| itk::ImageRegion< VImageDimension >::itkStaticConstMacro | ( | SliceDimension | , | |
| unsigned | int, | |||
| (VImageDimension-(VImageDimension > 1)) | ||||
| ) |
Dimension one lower than the image unless the image is one dimensional in which case the SliceDimension is also one dimensional.
| itk::ImageRegion< VImageDimension >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| VImageDimension | ||||
| ) |
Dimension of the image available at compile time.
| bool itk::ImageRegion< VImageDimension >::operator!= | ( | const Self & | region | ) | const [inline] |
Compare two regions.
Definition at line 164 of file itkImageRegion.h.
| void itk::ImageRegion< VImageDimension >::operator= | ( | const Self & | region | ) | [inline] |
operator=. ImageRegion is a lightweight object that is not reference counted, so operator= is public.
Definition at line 117 of file itkImageRegion.h.
| bool itk::ImageRegion< VImageDimension >::operator== | ( | const Self & | region | ) | const [inline] |
Compare two regions.
Definition at line 153 of file itkImageRegion.h.
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | const SizeType & | radius | ) |
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | const unsigned long | radius[VImageDimension] | ) |
| void itk::ImageRegion< VImageDimension >::PadByRadius | ( | unsigned long | radius | ) |
Pad an image region by the specified radius. Region can be padded uniformly in all dimensions or can be padded by different amounts in each dimension.
| virtual void itk::Region::Print | ( | std::ostream & | os, | |
| Indent | indent = 0 | |||
| ) | const [virtual, inherited] |
Print the region.
| virtual void itk::Region::PrintHeader | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| virtual void itk::ImageRegion< VImageDimension >::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.
| virtual void itk::Region::PrintTrailer | ( | std::ostream & | os, | |
| Indent | indent | |||
| ) | const [protected, virtual, inherited] |
| void itk::ImageRegion< VImageDimension >::SetIndex | ( | unsigned long | i, | |
| IndexValueType | sze | |||
| ) | [inline] |
Convenience methods to get and set the index of the particular dimension i.
Definition at line 145 of file itkImageRegion.h.
| void itk::ImageRegion< VImageDimension >::SetIndex | ( | const IndexType & | index | ) | [inline] |
Set the index defining the corner of the region.
Definition at line 121 of file itkImageRegion.h.
Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion().
| void itk::ImageRegion< VImageDimension >::SetSize | ( | unsigned long | i, | |
| SizeValueType | sze | |||
| ) | [inline] |
Convenience methods to get and set the size of the particular dimension i.
Definition at line 138 of file itkImageRegion.h.
| void itk::ImageRegion< VImageDimension >::SetSize | ( | const SizeType & | size | ) | [inline] |
Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region.
Definition at line 130 of file itkImageRegion.h.
Referenced by itk::ImageIORegionAdaptor< VDimension >::Convert(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(), itk::Image< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >::SetRegions(), itk::SpecialCoordinatesImage< TPixel, 3 >::SetRegions(), and itk::VectorImage< TPixelType, Dimension >::SetRegions().
| SliceRegion itk::ImageRegion< VImageDimension >::Slice | ( | const unsigned long | dim | ) | const |
Slice a region, producing a region that is one dimension lower than the current region. Parameter "dim" specifies which dimension to remove.
Friends And Related Function Documentation
friend class ImageBase< VImageDimension > [friend] |
Friends of ImageRegion
Definition at line 288 of file itkImageRegion.h.
The documentation for this class was generated from the following file:
