 |
ITK
4.9.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.9.0
Insight Segmentation and Registration Toolkit
|
#include <itkSpecialCoordinatesImage.h>
Inheritance diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >: Collaboration diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:Templated n-dimensional nonrectilinear-coordinate image base class.
SpecialCoordinatesImages are templated over a pixel type (modeling the dependent variables), and a dimension (number of independent variables). The container for the pixel data is the ImportImageContainer.
Within the pixel container, images are modelled as arrays, defined by a start index and a size.
Almost arbitrary mappings between index space & Cartesian physical space are possible, and so m_Origin and m_Spacing should be ignored. They exist only to allow the possibility of running a "spatially-aware" filter in raw index space, as if the SpecialCoordinatesImage data was laid out on a regular grid. Note that this may or may not produce useful results, and it is up the the user to determine the appropriateness of running a filter designed for normal images on special-coordinates images.
The only correct generic method for operating on a SpecialCoordinatesImage in physical space is to use the virtual functions TransformPhysicalPointToIndex, TransformPhysicalPointToContinuousIndex, TransformIndexToPhysicalPoint, and TransformContinuousIndexToPhysicalPoint. All of these methods transform points in Cartesian physical space to and from indices in the special (typically non-Cartesian) index space. It is also possible to check the type of coordinate representation being used by a SpecialCoordinatesImage, and then use representation-specific code to speed up the filter for certain coordinate representations, falling back to the generic method for unrecognized and/or unoptimized coordinate representations.
There are three sets of meta-data describing portions of a SpecialCoordinatesImages. These are "Region" objects that define a portion of an image via a starting index for the image array and a size. The ivar LargestPossibleRegion defines the size and starting index of the image dataset. The entire image dataset, however, need not be resident in memory. The region of the image that is resident in memory is defined by the "BufferedRegion". The Buffer is a contiguous block of memory. The third set of meta-data defines a region of interest, called the "RequestedRegion". The RequestedRegion is used by the pipeline execution model to define what a filter is requested to produce.
[RegionIndex, RegionSize] C [BufferIndex, BufferSize] C [ImageIndex, ImageSize]
Pixels can be accessed direcly using the SetPixel() and GetPixel() methods or can be accessed via iterators. Begin() creates an iterator that can walk a specified region of a buffer.
The pixel type may be one of the native types; a Insight-defined class type such as Vector; or a user-defined type. Note that depending on the type of pixel that you use, the process objects (i.e., those filters processing data objects) may not operate on the image and/or pixel type. This becomes apparent at compile-time because operator overloading (for the pixel type) is not supported.
The data in an image is arranged in a 1D array as [][][][slice][row][col] with the column index varying most rapidly. The Index type reverses the order so that with Index[0] = col, Index[1] = row, Index[2] = slice, ...
Definition at line 95 of file itkSpecialCoordinatesImage.h.
Public Member Functions | |
| virtual void | Allocate (bool initialize=false) override |
| virtual ::itk::LightObject::Pointer | CreateAnother () const |
| void | FillBuffer (const TPixel &value) |
| virtual const char * | GetNameOfClass () const |
| const TPixel & | GetPixel (const IndexType &index) const |
| TPixel & | GetPixel (const IndexType &index) |
| AccessorType | GetPixelAccessor (void) |
| const AccessorType | GetPixelAccessor (void) const |
| PixelContainer * | GetPixelContainer () |
| const PixelContainer * | GetPixelContainer () const |
| virtual void | Initialize () override |
| TPixel & | operator[] (const IndexType &index) |
| const TPixel & | operator[] (const IndexType &index) const |
| void | SetPixel (const IndexType &index, const TPixel &value) |
| void | SetPixelContainer (PixelContainer *container) |
| TPixel * | GetBufferPointer () |
| const TPixel * | GetBufferPointer () const |
| virtual void | SetSpacing (const SpacingType &) override |
| virtual void | SetSpacing (const double[VImageDimension]) override |
| virtual void | SetSpacing (const float[VImageDimension]) override |
| virtual void | SetOrigin (const PointType) override |
| virtual void | SetOrigin (const double[VImageDimension]) override |
| virtual void | SetOrigin (const float[VImageDimension]) override |
| Public Member Functions inherited from itk::ImageBase< VImageDimension > | |
| OffsetValueType | ComputeOffset (const IndexType &ind) const |
| virtual void | CopyInformation (const DataObject *data) override |
| virtual const RegionType & | GetBufferedRegion () const |
| virtual const DirectionType & | GetDirection () const |
| virtual const DirectionType & | GetInverseDirection () const |
| virtual const RegionType & | GetLargestPossibleRegion () const |
| virtual const PointType & | GetOrigin () const |
| virtual const RegionType & | GetRequestedRegion () const |
| virtual const SpacingType & | GetSpacing () const |
| virtual void | Graft (const DataObject *data) override |
| virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () override |
| virtual void | SetBufferedRegion (const RegionType ®ion) |
| virtual void | SetDirection (const DirectionType &direction) |
| virtual void | SetLargestPossibleRegion (const RegionType ®ion) |
| virtual void | SetRegions (const SizeType &size) |
| virtual void | SetRequestedRegion (const RegionType ®ion) |
| virtual void | SetRequestedRegion (const DataObject *data) override |
| virtual void | SetRequestedRegionToLargestPossibleRegion () override |
| template<typename TCoordRep > | |
| void | TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const |
| template<typename TCoordRep , typename TIndexRep > | |
| bool | TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const |
| template<typename TCoordRep > | |
| bool | TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const |
| template<typename TCoordRep > | |
| void | TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const |
| virtual void | UpdateOutputData () override |
| virtual void | UpdateOutputInformation () override |
| virtual bool | VerifyRequestedRegion () override |
| virtual void | SetRegions (const RegionType ®ion) |
| const OffsetValueType * | GetOffsetTable () const |
| IndexType | ComputeIndex (OffsetValueType offset) const |
| template<typename TCoordRep , typename TIndexRep > | |
| void | TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const |
| template<typename TCoordRep > | |
| void | TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const |
| virtual unsigned int | GetNumberOfComponentsPerPixel () const |
| virtual void | SetNumberOfComponentsPerPixel (unsigned int) |
| Public Member Functions inherited from itk::DataObject | |
| virtual void | DataHasBeenGenerated () |
| void | DisconnectPipeline () |
| bool | GetDataReleased () const |
| virtual const bool & | GetReleaseDataFlag () const |
| SmartPointerForwardReference < ProcessObject > | GetSource () const |
| DataObjectPointerArraySizeType | GetSourceOutputIndex () const |
| const DataObjectIdentifierType & | GetSourceOutputName () const |
| virtual ModifiedTimeType | GetUpdateMTime () const |
| virtual void | PrepareForNewData () |
| virtual void | PropagateRequestedRegion () |
| void | ReleaseData () |
| virtual void | ReleaseDataFlagOff () |
| virtual void | ReleaseDataFlagOn () |
| virtual void | ResetPipeline () |
| void | SetReleaseDataFlag (bool flag) |
| bool | ShouldIReleaseData () const |
| virtual void | Update () |
| void | SetPipelineMTime (ModifiedTimeType time) |
| virtual const ModifiedTimeType & | GetPipelineMTime () const |
| virtual void | SetRealTimeStamp (RealTimeStamp _arg) |
| virtual const RealTimeStamp & | GetRealTimeStamp () const |
| Public Member Functions inherited from itk::Object | |
| unsigned long | AddObserver (const EventObject &event, Command *) |
| unsigned long | AddObserver (const EventObject &event, Command *) const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| MetaDataDictionary & | GetMetaDataDictionary () |
| const MetaDataDictionary & | GetMetaDataDictionary () const |
| virtual ModifiedTimeType | GetMTime () const |
| virtual const TimeStamp & | GetTimeStamp () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) |
| void | InvokeEvent (const EventObject &) const |
| virtual void | Modified () const |
| virtual void | Register () const override |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| void | SetDebug (bool debugFlag) const |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetReferenceCount (int) override |
| virtual void | UnRegister () const noexceptoverride |
| virtual void | SetObjectName (std::string _arg) |
| virtual const std::string & | GetObjectName () const |
| Public Member Functions inherited from itk::LightObject | |
| virtual void | Delete () |
| virtual int | GetReferenceCount () const |
| itkCloneMacro (Self) | |
| void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from itk::ImageBase< VImageDimension > | |
| static unsigned int | GetImageDimension () |
| static Pointer | New () |
| Static Public Member Functions inherited from itk::DataObject | |
| static bool | GetGlobalReleaseDataFlag () |
| static void | GlobalReleaseDataFlagOff () |
| static void | GlobalReleaseDataFlagOn () |
| static void | SetGlobalReleaseDataFlag (bool val) |
| Static Public Member Functions inherited from itk::Object | |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| static void | SetGlobalWarningDisplay (bool flag) |
| Static Public Member Functions inherited from itk::LightObject | |
| static void | BreakOnError () |
| static Pointer | New () |
Static Public Attributes | |
| static const unsigned int | ImageDimension = VImageDimension |
| Static Public Attributes inherited from itk::ImageBase< VImageDimension > | |
| static const ImageDimensionType | ImageDimension = VImageDimension |
Protected Member Functions | |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| SpecialCoordinatesImage () | |
| virtual | ~SpecialCoordinatesImage () |
| Protected Member Functions inherited from itk::ImageBase< VImageDimension > | |
| virtual void | ComputeIndexToPhysicalPointMatrices () |
| void | ComputeOffsetTable () |
| ImageBase () | |
| virtual void | InitializeBufferedRegion () |
| ~ImageBase () | |
| OffsetValueType | FastComputeOffset (const IndexType &ind) const |
| IndexType | FastComputeIndex (OffsetValueType offset) const |
| Protected Member Functions inherited from itk::DataObject | |
| DataObject () | |
| virtual void | PropagateResetPipeline () |
| ~DataObject () | |
| Protected Member Functions inherited from itk::Object | |
| Object () | |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| virtual void | SetTimeStamp (const TimeStamp &time) |
| virtual | ~Object () |
| Protected Member Functions inherited from itk::LightObject | |
| virtual LightObject::Pointer | InternalClone () const |
| LightObject () | |
| virtual void | PrintHeader (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| virtual | ~LightObject () |
Private Member Functions | |
| void | operator= (const Self &) ITK_DELETE_FUNCTION |
| SpecialCoordinatesImage (const Self &) ITK_DELETE_FUNCTION | |
Private Attributes | |
| PixelContainerPointer | m_Buffer |
Additional Inherited Members | |
| Protected Attributes inherited from itk::ImageBase< VImageDimension > | |
| DirectionType | m_Direction |
| DirectionType | m_IndexToPhysicalPoint |
| DirectionType | m_InverseDirection |
| PointType | m_Origin |
| DirectionType | m_PhysicalPointToIndex |
| SpacingType | m_Spacing |
| Protected Attributes inherited from itk::LightObject | |
| AtomicInt< int > | m_ReferenceCount |
| typedef DefaultPixelAccessorFunctor< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorFunctorType |
Accessor functor to choose between accessors: DefaultPixelAccessor for the Image, and DefaultVectorPixelAccessor for the vector image. The functor provides a generic API between the two accessors.
Definition at line 133 of file itkSpecialCoordinatesImage.h.
| typedef DefaultPixelAccessor< PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 128 of file itkSpecialCoordinatesImage.h.
| typedef SmartPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstPointer |
Definition at line 102 of file itkSpecialCoordinatesImage.h.
| typedef WeakPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstWeakPointer |
Definition at line 103 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::IndexType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 142 of file itkSpecialCoordinatesImage.h.
| typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::InternalPixelType |
Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation.
Definition at line 122 of file itkSpecialCoordinatesImage.h.
| typedef PixelType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IOPixelType |
Definition at line 124 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::OffsetType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::OffsetType |
Offset typedef support. An offset is used to access pixel values.
Definition at line 145 of file itkSpecialCoordinatesImage.h.
| typedef ImportImageContainer< SizeValueType, PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainer |
Container used to store pixels in the image.
Definition at line 151 of file itkSpecialCoordinatesImage.h.
| typedef PixelContainer::ConstPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerConstPointer |
Definition at line 169 of file itkSpecialCoordinatesImage.h.
| typedef PixelContainer::Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerPointer |
A pointer to the pixel container.
Definition at line 168 of file itkSpecialCoordinatesImage.h.
| typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations.
Definition at line 109 of file itkSpecialCoordinatesImage.h.
| typedef SmartPointer< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Pointer |
Definition at line 101 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::PointType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PointType |
Origin typedef support. The origin is the "fake" geometric coordinates of the index (0,0). Also for use w/ filters designed for normal images.
Definition at line 165 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::RegionType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::RegionType |
Region typedef support. A region is used to specify a subset of an image.
Definition at line 155 of file itkSpecialCoordinatesImage.h.
| typedef SpecialCoordinatesImage itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Self |
Standard class typedefs
Definition at line 99 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::SizeType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Definition at line 148 of file itkSpecialCoordinatesImage.h.
| typedef Superclass::SpacingType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpacingType |
Spacing typedef support. Spacing holds the "fake" size of a pixel, making each pixel look like a 1 unit hyper-cube to filters that were designed for normal images and that therefore use m_Spacing. The spacing is the geometric distance between image samples.
Definition at line 161 of file itkSpecialCoordinatesImage.h.
| typedef ImageBase< VImageDimension > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Superclass |
Definition at line 100 of file itkSpecialCoordinatesImage.h.
| typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ValueType |
Typedef alias for PixelType
Definition at line 116 of file itkSpecialCoordinatesImage.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 288 of file itkSpecialCoordinatesImage.h.
|
private |
|
overridevirtual |
Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().
Reimplemented from itk::ImageBase< VImageDimension >.
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::ImageBase< VImageDimension >.
| void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::FillBuffer | ( | const TPixel & | value | ) |
Fill the image buffer with a value. Be sure to call Allocate() first.
|
inline |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 228 of file itkSpecialCoordinatesImage.h.
|
inline |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 229 of file itkSpecialCoordinatesImage.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
|
inline |
Get a pixel (read only version).
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 198 of file itkSpecialCoordinatesImage.h.
Referenced by itk::SpecialCoordinatesImage< TPixel, 3 >::operator[]().
|
inline |
Get a reference to a pixel (e.g. for editing).
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 208 of file itkSpecialCoordinatesImage.h.
|
inline |
Return the Pixel Accessor object
Definition at line 242 of file itkSpecialCoordinatesImage.h.
|
inline |
Return the Pixel Accesor object
Definition at line 245 of file itkSpecialCoordinatesImage.h.
|
inline |
Return a pointer to the container.
Definition at line 233 of file itkSpecialCoordinatesImage.h.
|
inline |
Definition at line 235 of file itkSpecialCoordinatesImage.h.
|
overridevirtual |
Restore the data object to its initial state. This means releasing memory.
Reimplemented from itk::ImageBase< VImageDimension >.
|
static |
Method for creation through the object factory.
|
private |
|
inline |
Access a pixel. This version can be an lvalue.
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 218 of file itkSpecialCoordinatesImage.h.
|
inline |
Access a pixel. This version can only be an rvalue.
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 224 of file itkSpecialCoordinatesImage.h.
|
overrideprotectedvirtual |
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::ImageBase< VImageDimension >.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 255 of file itkSpecialCoordinatesImage.h.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 256 of file itkSpecialCoordinatesImage.h.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 257 of file itkSpecialCoordinatesImage.h.
|
inline |
Set a pixel value.
Allocate() needs to have been called first – for efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 188 of file itkSpecialCoordinatesImage.h.
| void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixelContainer | ( | PixelContainer * | container | ) |
Set the container to use. Note that this does not cause the DataObject to be modified.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 252 of file itkSpecialCoordinatesImage.h.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 253 of file itkSpecialCoordinatesImage.h.
|
inlineoverridevirtual |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 254 of file itkSpecialCoordinatesImage.h.
|
static |
Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.
Definition at line 139 of file itkSpecialCoordinatesImage.h.
|
private |
Memory for the current buffer.
Definition at line 295 of file itkSpecialCoordinatesImage.h.
Referenced by itk::SpecialCoordinatesImage< TPixel, 3 >::GetBufferPointer(), itk::SpecialCoordinatesImage< TPixel, 3 >::GetPixel(), and itk::SpecialCoordinatesImage< TPixel, 3 >::GetPixelContainer().
1.8.5
