#include <itkImageRegion.h>
Inheritance diagram for itk::ImageRegion< VImageDimension >:
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.)
Definition at line 54 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) |
| IndexValueType | GetIndex (unsigned long i) const |
| const IndexType & | GetIndex () const |
| virtual const char * | GetNameOfClass () const |
| unsigned long | GetNumberOfPixels () const |
| virtual Superclass::RegionType | GetRegionType () const |
| SizeValueType | GetSize (unsigned long i) const |
| const SizeType & | GetSize () const |
| ImageRegion (const SizeType &size) | |
| ImageRegion (const IndexType &index, const SizeType &size) | |
| ImageRegion (const Self ®ion) | |
| ImageRegion () | |
| template<typename TCoordRepType> | |
| Test if an index is inside *bool | IsInside (const ContinuousIndex< TCoordRepType, VImageDimension > &index) const |
| Test if an index is inside *bool | IsInside (const IndexType &index) const |
| itkStaticConstMacro (SliceDimension, unsigned int,(VImageDimension-(VImageDimension > 1))) | |
| itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension) | |
| Compare two regions *bool | operator!= (const Self ®ion) const |
| void | operator= (const Self ®ion) |
| Compare two regions *bool | operator== (const Self ®ion) const |
| void | PadByRadius (const SizeType &radius) |
| void | PadByRadius (const unsigned long radius[VImageDimension]) |
| 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 *void | PadByRadius (unsigned long radius) |
| virtual void | Print (std::ostream &os, Indent indent=0) const |
| Test if a | region (the argument) is completly inside of this region */bool IsInside(const Self ®ion) const |
| Convenience methods to get and set the index of the particular dimension i *void | SetIndex (unsigned long i, IndexValueType sze) |
| void | SetIndex (const IndexType &index) |
| Convenience methods to get and set the size of the particular dimension i *void | SetSize (unsigned long i, SizeValueType sze) |
| void | SetSize (const SizeType &size) |
| SliceRegion | Slice (const unsigned long dim) const |
| virtual | ~ImageRegion () |
Static Public Member Functions | |
| static unsigned int | GetImageDimension () |
Protected Member Functions | |
| virtual void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
Protected Attributes | |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
Friends | |
| class | ImageBase< VImageDimension > |
|
|||||
|
Index typedef support. An index is used to access pixel values. Definition at line 77 of file itkImageRegion.h. |
|
|||||
|
Definition at line 78 of file itkImageRegion.h. |
|
|||||
|
Standard class typedefs. Reimplemented from itk::Region. Definition at line 58 of file itkImageRegion.h. |
|
|||||
|
Size typedef support. A size is used to define region bounds. Definition at line 81 of file itkImageRegion.h. |
|
|||||
|
Definition at line 82 of file itkImageRegion.h. |
|
|||||
|
Slice region typedef. SliceRegion is one dimension less than Self. Definition at line 85 of file itkImageRegion.h. |
|
|||||
|
Definition at line 59 of file itkImageRegion.h. |
|
|
Enums used to describe the extent types. Definition at line 63 of file itkRegion.h. |
|
|||||||||
|
Constructor. ImageRegion is a lightweight object that is not reference counted, so the constructor is public. |
|
|||||||||
|
Destructor. ImageRegion is a lightweight object that is not reference counted, so the destructor is public. |
|
||||||||||
|
Copy constructor. ImageRegion is a lightweight object that is not reference counted, so the copy constructor is public. Definition at line 101 of file itkImageRegion.h. |
|
||||||||||||||||
|
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 105 of file itkImageRegion.h. |
|
||||||||||
|
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 111 of file itkImageRegion.h. |
|
||||||||||
|
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. |
|
|||||||||
|
Dimension of the image available at run time. Definition at line 73 of file itkImageRegion.h. |
|
||||||||||
|
Definition at line 146 of file itkImageRegion.h. |
|
||||||||||
|
Get index defining the corner of the region. Definition at line 124 of file itkImageRegion.h. Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeIndex(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::ComputeOffset(), itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(). |
|
|||||||||
|
Standard part of all itk objects. Reimplemented from itk::Region. |
|
|||||||||
|
Get the number of pixels contained in this region. This just multiplies the size components. |
|
|||||||||
|
Return the region type. Images are described with structured regions. Implements itk::Region. Definition at line 88 of file itkImageRegion.h. |
|
||||||||||
|
Definition at line 139 of file itkImageRegion.h. |
|
||||||||||
|
Get the size of the region. Definition at line 133 of file itkImageRegion.h. Referenced by itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(). |
|
||||||||||||||
|
Definition at line 195 of file itkImageRegion.h. |
|
||||||||||
|
Definition at line 175 of file itkImageRegion.h. |
|
||||||||||||||||||||
|
Dimension one lower than the image unless the image is one dimensional in which case the SliceDimension is also one dimensional. |
|
||||||||||||||||||||
|
Dimension of the image available at compile time. |
|
||||||||||
|
Definition at line 163 of file itkImageRegion.h. |
|
||||||||||
|
operator=. ImageRegion is a lightweight object that is not reference counted, so operator= is public. Definition at line 116 of file itkImageRegion.h. |
|
||||||||||
|
Definition at line 152 of file itkImageRegion.h. |
|
||||||||||
|
|
|
||||||||||
|
|
|
||||||||||
|
|
|
||||||||||||
|
Print the region. |
|
||||||||||||||||
|
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. |
|
||||||||||||
|
|
|
||||||||||
|
Definition at line 217 of file itkImageRegion.h. |
|
||||||||||||||||
|
Definition at line 144 of file itkImageRegion.h. |
|
||||||||||
|
Set the index defining the corner of the region. Definition at line 120 of file itkImageRegion.h. Referenced by itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(). |
|
||||||||||||||||
|
Definition at line 137 of file itkImageRegion.h. |
|
||||||||||
|
Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region. Definition at line 129 of file itkImageRegion.h. Referenced by itk::ImageToImageFilterDetail::ExtractImageFilterCopyRegion(), and itk::ImageToImageFilterDetail::ImageToImageFilterDefaultCopyRegion(). |
|
||||||||||
|
Slice a region, producing a region that is one dimension lower than the current region. Parameter "dim" specifies which dimension to remove. |
|
|||||
|
Friends of ImageRegion Definition at line 275 of file itkImageRegion.h. |
|
|
|
1.4.2 written by Dimitri van Heesch,
© 1997-2000