 |
ITK
4.8.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.8.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageAlgorithm.h>
Inheritance diagram for itk::VectorImage< TPixelType, VImageDimension >: Collaboration diagram for itk::VectorImage< TPixelType, VImageDimension >:Templated n-dimensional vector image class.
This class differs from Image in that it is intended to represent multiple images. Each pixel represents k measurements, each of datatype TPixel. The memory organization of the resulting image is as follows: ... Pi0 Pi1 Pi2 Pi3 P(i+1)0 P(i+1)1 P(i+1)2 P(i+1)3 P(i+2)0 ... where Pi0 represents the 0th measurement of the pixel at index i.
Conceptually, a VectorImage< TPixel, 3 > is the same as a Image< VariableLengthVector< TPixel >, 3 >. The difference lies in the memory organization. The latter results in a fragmented organization with each location in the Image holding a pointer to an VariableLengthVector holding the actual pixel. The former stores the k pixels instead of a pointer reference, which apart from avoiding fragmentation of memory also avoids storing a 8 bytes of pointer reference for each pixel. The parameter k can be set using SetVectorLength.
The API of the class is such that it returns a pixeltype VariableLengthVector< TPixel > when queried, with the data internally pointing to the buffer. (the container does not manage the memory). Similarly SetPixel calls can be made with VariableLengthVector< TPixel >.
The API of this class is similar to Image.
Definition at line 40 of file itkImageAlgorithm.h.
Classes | |
| struct | Rebind |
Public Member Functions | |
| virtual void | Allocate (bool UseDefaultConstructor=false) override |
| virtual ::itk::LightObject::Pointer | CreateAnother () const |
| void | FillBuffer (const PixelType &value) |
| virtual const char * | GetNameOfClass () const |
| NeighborhoodAccessorFunctorType | GetNeighborhoodAccessor () |
| const NeighborhoodAccessorFunctorType | GetNeighborhoodAccessor () const |
| virtual unsigned int | GetNumberOfComponentsPerPixel () const override |
| const PixelType | GetPixel (const IndexType &index) const |
| PixelType | GetPixel (const IndexType &index) |
| AccessorType | GetPixelAccessor (void) |
| const AccessorType | GetPixelAccessor (void) const |
| PixelContainer * | GetPixelContainer () |
| const PixelContainer * | GetPixelContainer () const |
| virtual void | Graft (const DataObject *data) override |
| virtual void | Initialize () override |
| PixelType | operator[] (const IndexType &index) |
| const PixelType | operator[] (const IndexType &index) const |
| virtual void | SetNumberOfComponentsPerPixel (unsigned int n) override |
| void | SetPixel (const IndexType &index, const PixelType &value) |
| void | SetPixelContainer (PixelContainer *container) |
| InternalPixelType * | GetBufferPointer () |
| const InternalPixelType * | GetBufferPointer () const |
| virtual void | SetVectorLength (VectorLengthType _arg) |
| virtual const VectorLengthType & | GetVectorLength () const |
| 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 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 | SetOrigin (PointType _arg) |
| virtual void | SetOrigin (const double origin[VImageDimension]) |
| virtual void | SetOrigin (const float origin[VImageDimension]) |
| virtual void | SetRegions (const RegionType ®ion) |
| const OffsetValueType * | GetOffsetTable () const |
| IndexType | ComputeIndex (OffsetValueType offset) const |
| virtual void | SetSpacing (const SpacingType &spacing) |
| virtual void | SetSpacing (const double spacing[VImageDimension]) |
| virtual void | SetSpacing (const float spacing[VImageDimension]) |
| 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 |
| 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 unsigned int | ImageDimension = VImageDimension |
Protected Member Functions | |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| VectorImage () | |
| virtual | ~VectorImage () |
| Protected Member Functions inherited from itk::ImageBase< VImageDimension > | |
| virtual void | ComputeIndexToPhysicalPointMatrices () |
| void | ComputeOffsetTable () |
| ImageBase () | |
| virtual void | InitializeBufferedRegion () |
| ~ImageBase () | |
| 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 &) |
| VectorImage (const Self &) | |
Private Attributes | |
| PixelContainerPointer | m_Buffer |
| VectorLengthType | m_VectorLength |
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 DefaultVectorPixelAccessorFunctor< Self > itk::VectorImage< TPixelType, VImageDimension >::AccessorFunctorType |
Functor to provide a common API between DefaultPixelAccessor and DefaultVectorPixelAccessor
Definition at line 120 of file itkVectorImage.h.
| typedef DefaultVectorPixelAccessor< InternalPixelType > itk::VectorImage< TPixelType, VImageDimension >::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 116 of file itkVectorImage.h.
| typedef SmartPointer< const Self > itk::VectorImage< TPixelType, VImageDimension >::ConstPointer |
Definition at line 89 of file itkVectorImage.h.
| typedef WeakPointer< const Self > itk::VectorImage< TPixelType, VImageDimension >::ConstWeakPointer |
Definition at line 90 of file itkVectorImage.h.
| typedef Superclass::DirectionType itk::VectorImage< TPixelType, VImageDimension >::DirectionType |
Direction typedef support. A matrix of direction cosines.
Definition at line 147 of file itkVectorImage.h.
| typedef Superclass::IndexType itk::VectorImage< TPixelType, VImageDimension >::IndexType |
Index typedef support. An index is used to access pixel values.
Definition at line 134 of file itkVectorImage.h.
| typedef Superclass::IndexValueType itk::VectorImage< TPixelType, VImageDimension >::IndexValueType |
Definition at line 135 of file itkVectorImage.h.
| typedef TPixel itk::VectorImage< TPixelType, VImageDimension >::InternalPixelType |
This is the actual pixel type contained in the buffer. Each vector pixel is composed of 'm_VectorLength' contiguous InternalPixelType.
Definition at line 107 of file itkVectorImage.h.
| typedef InternalPixelType itk::VectorImage< TPixelType, VImageDimension >::IOPixelType |
Definition at line 112 of file itkVectorImage.h.
| typedef VectorImageNeighborhoodAccessorFunctor< Self > itk::VectorImage< TPixelType, VImageDimension >::NeighborhoodAccessorFunctorType |
Typedef for the functor used to access a neighborhood of pixel pointers.
Definition at line 125 of file itkVectorImage.h.
| typedef Superclass::OffsetType itk::VectorImage< TPixelType, VImageDimension >::OffsetType |
Offset typedef support. An offset is used to access pixel values.
Definition at line 138 of file itkVectorImage.h.
| typedef Superclass::OffsetValueType itk::VectorImage< TPixelType, VImageDimension >::OffsetValueType |
Offset typedef (relative position between indices)
Definition at line 166 of file itkVectorImage.h.
| typedef ImportImageContainer< SizeValueType, InternalPixelType > itk::VectorImage< TPixelType, VImageDimension >::PixelContainer |
Container used to store pixels in the image.
Definition at line 144 of file itkVectorImage.h.
| typedef PixelContainer::ConstPointer itk::VectorImage< TPixelType, VImageDimension >::PixelContainerConstPointer |
Definition at line 163 of file itkVectorImage.h.
| typedef PixelContainer::Pointer itk::VectorImage< TPixelType, VImageDimension >::PixelContainerPointer |
A pointer to the pixel container.
Definition at line 162 of file itkVectorImage.h.
| typedef VariableLengthVector< TPixel > itk::VectorImage< TPixelType, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations. This is not the actual pixel type contained in the buffer, ie m_Buffer. The image exhibits an external API of an VariableLengthVector< T > and internally stores its data as type T.
Definition at line 96 of file itkVectorImage.h.
| typedef SmartPointer< Self > itk::VectorImage< TPixelType, VImageDimension >::Pointer |
Definition at line 88 of file itkVectorImage.h.
| typedef Superclass::PointType itk::VectorImage< TPixelType, VImageDimension >::PointType |
Origin typedef support. The origin is the geometric coordinates of the index (0,0).
Definition at line 159 of file itkVectorImage.h.
| typedef Superclass::RegionType itk::VectorImage< TPixelType, VImageDimension >::RegionType |
Region typedef support. A region is used to specify a subset of an image.
Definition at line 151 of file itkVectorImage.h.
| typedef VectorImage itk::VectorImage< TPixelType, VImageDimension >::Self |
Standard class typedefs
Definition at line 86 of file itkVectorImage.h.
| typedef Superclass::SizeType itk::VectorImage< TPixelType, VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Definition at line 141 of file itkVectorImage.h.
| typedef Superclass::SpacingType itk::VectorImage< TPixelType, VImageDimension >::SpacingType |
Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.
Definition at line 155 of file itkVectorImage.h.
| typedef ImageBase< VImageDimension > itk::VectorImage< TPixelType, VImageDimension >::Superclass |
Definition at line 87 of file itkVectorImage.h.
| typedef PixelType itk::VectorImage< TPixelType, VImageDimension >::ValueType |
Typedef alias for PixelType
Definition at line 110 of file itkVectorImage.h.
| typedef unsigned int itk::VectorImage< TPixelType, VImageDimension >::VectorLengthType |
Definition at line 168 of file itkVectorImage.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 342 of file itkVectorImage.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::VectorImage< TPixelType, VImageDimension >::FillBuffer | ( | const PixelType & | 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 278 of file itkVectorImage.h.
|
inline |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 282 of file itkVectorImage.h.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageBase< VImageDimension >.
|
inline |
Return the NeighborhoodAccessor functor
Definition at line 317 of file itkVectorImage.h.
|
inline |
Return the NeighborhoodAccessor functor
Definition at line 323 of file itkVectorImage.h.
|
overridevirtual |
Get/Set the number of components each pixel has, ie the VectorLength
Reimplemented from itk::ImageBase< VImageDimension >.
|
inline |
Get a pixel (read only version).
For efficiency, this function does not check that the image has actually been allocated yet. Note that the method returns a pixel on the stack.
Definition at line 232 of file itkVectorImage.h.
Referenced by itk::VectorImage< TPixelType, Dimension >::operator[]().
|
inline |
Get a "reference" to a pixel. This result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.
To use the results to modify this image, return value optimization must be relied upon.
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 250 of file itkVectorImage.h.
|
inline |
Return the Pixel Accessor object
Definition at line 311 of file itkVectorImage.h.
|
inline |
Return the Pixel Accesor object
Definition at line 314 of file itkVectorImage.h.
|
inline |
Return a pointer to the container.
Definition at line 289 of file itkVectorImage.h.
|
inline |
Return a pointer to the container.
Definition at line 292 of file itkVectorImage.h.
|
virtual |
Set/Get macros for the length of each vector in the vector image
|
overridevirtual |
Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.
Reimplemented from itk::ImageBase< VImageDimension >.
|
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 result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.
To use the results to modify this image, return value optimization must be relied upon.
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 268 of file itkVectorImage.h.
|
inline |
Access a pixel.
For efficiency, this function does not check that the image has actually been allocated yet.
Definition at line 274 of file itkVectorImage.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 >.
|
overridevirtual |
INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.
Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage
Returns/Sets the number of components in the image. Note that in the ImageBase implementation, this always returns 1. Image returns the
returns the vector length set by the user.
Reimplemented from itk::ImageBase< VImageDimension >.
|
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 217 of file itkVectorImage.h.
| void itk::VectorImage< TPixelType, VImageDimension >::SetPixelContainer | ( | PixelContainer * | container | ) |
Set the container to use. Note that this does not cause the DataObject to be modified.
|
virtual |
Set/Get macros for the length of each vector in the vector image
|
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 131 of file itkVectorImage.h.
|
private |
Memory for the current buffer.
Definition at line 352 of file itkVectorImage.h.
Referenced by itk::VectorImage< TPixelType, Dimension >::GetBufferPointer(), itk::VectorImage< TPixelType, Dimension >::GetPixel(), and itk::VectorImage< TPixelType, Dimension >::GetPixelContainer().
|
private |
Length of the "vector pixel"
Definition at line 349 of file itkVectorImage.h.
Referenced by itk::VectorImage< TPixelType, Dimension >::GetNeighborhoodAccessor(), itk::VectorImage< TPixelType, Dimension >::GetPixel(), itk::VectorImage< TPixelType, Dimension >::GetPixelAccessor(), and itk::VectorImage< TPixelType, Dimension >::SetPixel().
1.8.5
