Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PermuteAxesImageFilter< TImage > Class Template Reference
[Geometric Transformation FiltersMultithreaded FiltersFilters supporting Streaming]

#include <itkPermuteAxesImageFilter.h>

Inheritance diagram for itk::PermuteAxesImageFilter< TImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::PermuteAxesImageFilter< TImage >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TImage>
class itk::PermuteAxesImageFilter< TImage >

Permutes the image axes according to a user specified order.

PermuateAxesImageFilter permutes the image axes according to a user specified order. The permutation order is set via method SetOrder( order ) where the input is an array of ImageDimension number of unsigned int. The elements of the array must be a rearrangment of the numbers from 0 to ImageDimension - 1.

The i-th axis of the output image corresponds with the order[i]-th axis of the input image.

The output meta image information (LargestPossibleRegion, spacing, origin) is computed by permuting the corresponding input meta information.

Definition at line 46 of file itkPermuteAxesImageFilter.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef DataObject::Pointer DataObjectPointer
typedef std::vector< DataObjectPointerDataObjectPointerArray
typedef DataObjectPointerArray::size_type DataObjectPointerArraySizeType
typedef InputImageType::ConstPointer InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef Superclass::InputImagePointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TImage InputImageType
typedef Superclass::OutputImagePixelType OutputImagePixelType
typedef Superclass::OutputImagePointer OutputImagePointer
typedef Superclass::OutputImageRegionType OutputImageRegionType
typedef TImage OutputImageType
typedef FixedArray< unsigned
int, itkGetStaticConstMacro(ImageDimension)> 
PermuteOrderArrayType
typedef SmartPointer< SelfPointer
typedef PermuteAxesImageFilter Self
typedef ImageToImageFilter<
TImage, TImage > 
Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual const bool & GetAbortGenerateData ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
const InputImageTypeGetInput (unsigned int idx)
const InputImageTypeGetInput (void)
DataObjectPointerArrayGetInputs ()
virtual const PermuteOrderArrayTypeGetInverseOrder ()
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
MultiThreaderGetMultiThreader ()
virtual const char * GetNameOfClass () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
virtual const PermuteOrderArrayTypeGetOrder ()
OutputImageTypeGetOutput (unsigned int idx)
OutputImageTypeGetOutput (void)
virtual const float & GetProgress ()
virtual int GetReferenceCount () const
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
 itkStaticConstMacro (OutputImageDimension, unsigned int, TImage::ImageDimension)
 itkStaticConstMacro (InputImageDimension, unsigned int, TImage::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
virtual DataObjectPointer MakeOutput (unsigned int idx)
virtual void Modified () const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PrepareOutputs ()
void Print (std::ostream &os, Indent indent=0) const
virtual void PropagateRequestedRegion (DataObject *output)
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
void SetDebug (bool debugFlag) const
virtual void SetInput (unsigned int, const TImage *image)
virtual void SetInput (const InputImageType *image)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetOrder (const PermuteOrderArrayType &order)
virtual void SetProgress (float _arg)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
DataObjectPointerArraySizeType GetNumberOfOutputs () const
DataObjectPointerArrayGetOutputs ()
virtual const int & GetNumberOfThreads ()
virtual void SetNumberOfThreads (int _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOff ()
void ReleaseDataFlagOn ()
virtual void SetReleaseDataFlag (bool flag)

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef ImageToImageFilterDetail::ImageRegionCopier<
itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension)> 
InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier<
itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension)> 
OutputToInputRegionCopierType
typedef int InternalReferenceCountType

Protected Member Functions

virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
virtual void CacheInputReleaseDataFlags ()
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateData ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
 PermuteAxesImageFilter ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PropagateResetPipeline ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
virtual void ReleaseInputs ()
virtual void RestoreInputReleaseDataFlags ()
void SetNumberOfInputs (unsigned int num)
void SetNumberOfOutputs (unsigned int num)
virtual int SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
 ~PermuteAxesImageFilter ()
virtual void AddInput (DataObject *input)
virtual const unsigned int & GetNumberOfRequiredInputs ()
virtual void RemoveInput (DataObject *input)
virtual void SetNthInput (unsigned int num, DataObject *input)
virtual void SetNumberOfRequiredInputs (unsigned int _arg)
virtual void AddOutput (DataObject *output)
virtual const unsigned int & GetNumberOfRequiredOutputs ()
virtual void RemoveOutput (DataObject *output)
virtual void SetNthOutput (unsigned int num, DataObject *output)
virtual void SetNumberOfRequiredOutputs (unsigned int _arg)
const DataObjectGetInput (unsigned int idx) const
const DataObjectGetOutput (unsigned int idx) const
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

Protected Attributes

TimeStamp m_OutputInformationMTime
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
bool m_Updating


Member Typedef Documentation

template<class TImage>
typedef SmartPointer<const Self> itk::PermuteAxesImageFilter< TImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 55 of file itkPermuteAxesImageFilter.h.

typedef DataObject::Pointer itk::ImageSource< TImage >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkImageSource.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

typedef InputImageType::ConstPointer itk::ImageToImageFilter< TImage , TImage >::InputImageConstPointer [inherited]

Reimplemented in itk::CheckerBoardImageFilter< TImage >, itk::FlipImageFilter< TImage >, itk::TwoOutputExampleImageFilter< TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1, TFunction2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, LessThan, GreaterThan, LessEqual, GreaterEqual >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::InPlaceImageFilter< TImage, TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::TImage::PixelType >, std::less_equal< TImage::TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::TImage::PixelType >, std::greater_equal< TImage::TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType >, std::greater_equal< TImage::PixelType >, std::less_equal< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType >, std::less_equal< TImage::PixelType >, std::greater_equal< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MinFunctor< TImage::PixelType > >, and itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MaxFunctor< TImage::PixelType > >.

Definition at line 84 of file itkImageToImageFilter.h.

typedef InputImageType::PixelType itk::ImageToImageFilter< TImage , TImage >::InputImagePixelType [inherited]

Reimplemented in itk::ThresholdImageFilter< TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1, TFunction2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, LessThan, GreaterThan, LessEqual, GreaterEqual >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::InPlaceImageFilter< TImage, TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::TImage::PixelType >, std::less_equal< TImage::TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::TImage::PixelType >, std::greater_equal< TImage::TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType >, std::greater_equal< TImage::PixelType >, std::less_equal< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType >, std::less_equal< TImage::PixelType >, std::greater_equal< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MinFunctor< TImage::PixelType > >, and itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MaxFunctor< TImage::PixelType > >.

Definition at line 86 of file itkImageToImageFilter.h.

template<class TImage>
typedef Superclass::InputImagePointer itk::PermuteAxesImageFilter< TImage >::InputImagePointer

Inherited types

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 68 of file itkPermuteAxesImageFilter.h.

typedef InputImageType::RegionType itk::ImageToImageFilter< TImage , TImage >::InputImageRegionType [inherited]

Reimplemented in itk::ThresholdImageFilter< TImage >, itk::VotingBinaryIterativeHoleFillingImageFilter< TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1, TFunction2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, LessThan, GreaterThan, LessEqual, GreaterEqual >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::InPlaceImageFilter< TImage, TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::TImage::PixelType >, std::less_equal< TImage::TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::TImage::PixelType >, std::greater_equal< TImage::TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType >, std::greater_equal< TImage::PixelType >, std::less_equal< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType >, std::less_equal< TImage::PixelType >, std::greater_equal< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MinFunctor< TImage::PixelType > >, and itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MaxFunctor< TImage::PixelType > >.

Definition at line 85 of file itkImageToImageFilter.h.

typedef TImage itk::ImageToImageFilter< TImage , TImage >::InputImageType [inherited]

Some convenient typedefs.

Reimplemented in itk::CheckerBoardImageFilter< TImage >, itk::ThresholdImageFilter< TImage >, itk::VotingBinaryIterativeHoleFillingImageFilter< TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1, TFunction2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, LessThan, GreaterThan, LessEqual, GreaterEqual >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::InPlaceImageFilter< TImage, TImage >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::TImage::PixelType >, std::less_equal< TImage::TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::TImage::PixelType >, std::greater_equal< TImage::TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType >, std::greater_equal< TImage::PixelType >, std::less_equal< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType >, std::less_equal< TImage::PixelType >, std::greater_equal< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MinFunctor< TImage::PixelType > >, and itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, itk::MaxFunctor< TImage::PixelType > >.

Definition at line 82 of file itkImageToImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TImage , TImage >::InputToOutputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 164 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef Superclass::OutputImagePixelType itk::ImageToImageFilter< TImage , TImage >::OutputImagePixelType [inherited]

Reimplemented from itk::ImageSource< TImage >.

Reimplemented in itk::ThresholdImageFilter< TImage >, itk::TwoOutputExampleImageFilter< TImage >, and itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 79 of file itkImageToImageFilter.h.

template<class TImage>
typedef Superclass::OutputImagePointer itk::PermuteAxesImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TImage >.

Definition at line 69 of file itkPermuteAxesImageFilter.h.

template<class TImage>
typedef Superclass::OutputImageRegionType itk::PermuteAxesImageFilter< TImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 70 of file itkPermuteAxesImageFilter.h.

typedef TImage itk::ImageSource< TImage >::OutputImageType [inherited]

Some convenient typedefs.

Reimplemented in itk::CheckerBoardImageFilter< TImage >, itk::ThresholdImageFilter< TImage >, itk::TwoOutputExampleImageFilter< TImage >, itk::VotingBinaryIterativeHoleFillingImageFilter< TImage >, and itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 65 of file itkImageSource.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TImage , TImage >::OutputToInputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 169 of file itkImageToImageFilter.h.

template<class TImage>
typedef FixedArray<unsigned int, itkGetStaticConstMacro(ImageDimension)> itk::PermuteAxesImageFilter< TImage >::PermuteOrderArrayType

PermuteOrderArray type.

Definition at line 73 of file itkPermuteAxesImageFilter.h.

template<class TImage>
typedef SmartPointer<Self> itk::PermuteAxesImageFilter< TImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 54 of file itkPermuteAxesImageFilter.h.

template<class TImage>
typedef PermuteAxesImageFilter itk::PermuteAxesImageFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 52 of file itkPermuteAxesImageFilter.h.

template<class TImage>
typedef ImageToImageFilter<TImage,TImage> itk::PermuteAxesImageFilter< TImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

Definition at line 53 of file itkPermuteAxesImageFilter.h.


Constructor & Destructor Documentation

template<class TImage>
itk::PermuteAxesImageFilter< TImage >::PermuteAxesImageFilter (  )  [protected]

template<class TImage>
itk::PermuteAxesImageFilter< TImage >::~PermuteAxesImageFilter (  )  [inline, protected]

Definition at line 103 of file itkPermuteAxesImageFilter.h.


Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff (  )  [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn (  )  [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject input  )  [protected, virtual, inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject output  )  [protected, virtual, inherited]

virtual void itk::ImageSource< TImage >::AfterThreadedGenerateData ( void   )  [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 254 of file itkImageSource.h.

virtual void itk::ImageSource< TImage >::AllocateOutputs (  )  [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

Reimplemented in itk::InPlaceImageFilter< TImage, TImage >.

virtual void itk::ImageSource< TImage >::BeforeThreadedGenerateData ( void   )  [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 242 of file itkImageSource.h.

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags (  )  [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

virtual void itk::ImageToImageFilter< TImage , TImage >::CallCopyInputRegionToOutputRegion ( OutputImageRegionType destRegion,
const InputImageRegionType srcRegion 
) [protected, virtual, inherited]

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

virtual void itk::ImageToImageFilter< TImage , TImage >::CallCopyOutputRegionToInputRegion ( InputImageRegionType destRegion,
const OutputImageRegionType srcRegion 
) [protected, virtual, inherited]

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject  )  [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented in itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >, itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >, itk::FFTRealToComplexConjugateImageFilter< TPixel, Dimension >, itk::ImagePCAShapeModelEstimator< TInputImage, TOutputImage >, itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >, itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >, itk::KLMRegionGrowImageFilter< TInputImage, TOutputImage >, itk::MRFImageFilter< TInputImage, TClassifiedImage >, itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, itk::ReinitializeLevelSetImageFilter< TLevelSet >, itk::VoronoiSegmentationImageFilterBase< TInputImage, TOutputImage, TBinaryPriorImage >, itk::WatershedImageFilter< TInputImage >, itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::BSplineDecompositionImageFilter< TInputImage, TOutputImage >, itk::ClosingByReconstructionImageFilter< TInputImage, TOutputImage, TKernel >, itk::ConfidenceConnectedImageFilter< TInputImage, TOutputImage >, itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, itk::ConnectedThresholdImageFilter< TInputImage, TOutputImage >, itk::ContourDirectedMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::ContourMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DirectedHausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DoubleThresholdImageFilter< TInputImage, TOutputImage >, itk::ExtractOrthogonalSwath2DImageFilter< TImage >, itk::GradientMagnitudeRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::GrayscaleConnectedClosingImageFilter< TInputImage, TOutputImage >, itk::GrayscaleConnectedOpeningImageFilter< TInputImage, TOutputImage >, itk::GrayscaleFillholeImageFilter< TInputImage, TOutputImage >, itk::GrayscaleGeodesicDilateImageFilter< TInputImage, TOutputImage >, itk::GrayscaleGeodesicErodeImageFilter< TInputImage, TOutputImage >, itk::GrayscaleGrindPeakImageFilter< TInputImage, TOutputImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::HausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::HConcaveImageFilter< TInputImage, TOutputImage >, itk::HConvexImageFilter< TInputImage, TOutputImage >, itk::HessianRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::HMaximaImageFilter< TInputImage, TOutputImage >, itk::HMinimaImageFilter< TInputImage, TOutputImage >, itk::HoughTransform2DCirclesImageFilter< TInputPixelType, TOutputPixelType >, itk::HoughTransform2DLinesImageFilter< TInputPixelType, TOutputPixelType >, itk::ImportImageFilter< TPixel, VImageDimension >, itk::IsolatedConnectedImageFilter< TInputImage, TOutputImage >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::NeighborhoodConnectedImageFilter< TInputImage, TOutputImage >, itk::OpeningByReconstructionImageFilter< TInputImage, TOutputImage, TKernel >, itk::OrientImageFilter< TInputImage, TOutputImage >, itk::ReconstructionImageFilter< TInputImage, TOutputImage, TCompare >, itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >, itk::RegionOfInterestImageFilter< TInputImage, TOutputImage >, itk::ShrinkImageFilter< TInputImage, TOutputImage >, itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >, itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::TobogganImageFilter< TInputImage >, itk::VectorConfidenceConnectedImageFilter< TInputImage, TOutputImage >, itk::WhiteTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageFileReader< TOutputImage, ConvertPixelTraits >, itk::ImageSeriesReader< TOutputImage >, itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >, itk::MorphologicalWatershedImageFilter< TInputImage, TOutputImage >, itk::RegionalMaximaImageFilter< TInputImage, TOutputImage >, itk::RegionalMinimaImageFilter< TInputImage, TOutputImage >, itk::SliceBySliceImageFilter< TInputImage, TOutputImage, TInputFilter, TOutputFilter, TInternalInputImage, TInternalOutputImage >, itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, TFunction1, TFunction2 >, itk::VoronoiSegmentationImageFilterBase< TInputImage, TOutputImage >, itk::ReconstructionImageFilter< TInputImage, TOutputImage, std::greater< TOutputImage::PixelType > >, itk::ReconstructionImageFilter< TInputImage, TOutputImage, std::less< TOutputImage::PixelType > >, itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, std::greater< TInputImage::PixelType >, std::greater< TOutputImage::PixelType > >, and itk::ValuedRegionalExtremaImageFilter< TInputImage, TOutputImage, std::less< TInputImage::PixelType >, std::less< TOutputImage::PixelType > >.

Definition at line 225 of file itkProcessObject.h.

virtual void itk::ImageSource< TImage >::GenerateData ( void   )  [protected, virtual, inherited]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::VotingBinaryIterativeHoleFillingImageFilter< TImage >.

template<class TImage>
virtual void itk::PermuteAxesImageFilter< TImage >::GenerateInputRequestedRegion (  )  [virtual]

PermuteAxesImageFilter needs different input requested region than the output requested region. As such, PermuteAxesImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TImage, TImage >.

template<class TImage>
virtual void itk::PermuteAxesImageFilter< TImage >::GenerateOutputInformation (  )  [virtual]

PermuteAxesImageFilter produces an image which is a different resolution and with a different pixel spacing than its input image. As such, PermuteAxesImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:
ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

virtual void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject output  )  [protected, virtual, inherited]

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::watershed::Segme