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

itk::ChangeInformationImageFilter< TInputImage > Class Template Reference
[Geometric Transformation Filters]

#include <itkChangeInformationImageFilter.h>

Inheritance diagram for itk::ChangeInformationImageFilter< TInputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::ChangeInformationImageFilter< TInputImage >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TInputImage>
class itk::ChangeInformationImageFilter< TInputImage >

Change the origin, spacing and/or region of an Image.

Change the origin, spacing, direction and/or buffered region of an itkImage. This "Information" along with an Image's container comprise the itkImage. By default, the output's information is set to the input's information. The methods ChangeSpacingOn/Off, ChangeOriginOn/Off, ChangeDirectionOn/Off and ChangeRegionOn/Off control whether the default origin, spacing, direction or buffered region should be changed. If On, the associated information will be replaced with either the ReferenceImage information (if UseReferenceImage is true) or the ivars OutputSpacing, OutputOrigin, OutputDirection, OutputOffset.

In addition, the method CenterImageOn will recompute the output image origin (using the selected output spacing) the align the center of the image with the coordinate 0.

Definition at line 48 of file itkChangeInformationImageFilter.h.

Public Types

typedef SmartPointer< const
Self > 		ConstPointer
typedef DataObject::Pointer DataObjectPointer
typedef std::vector< DataObjectPointer > DataObjectPointerArray
typedef DataObjectPointerArray::size_type DataObjectPointerArraySizeType
typedef TInputImage::DirectionType DirectionType
typedef InputImageType::ConstPointer InputImageConstPointer
typedef TInputImage::DirectionType InputImageDirectionType
typedef TInputImage::IndexType InputImageIndexType
typedef TInputImage::OffsetType InputImageOffsetType
typedef TInputImage::PixelType InputImagePixelType
typedef TInputImage::Pointer InputImagePointer
typedef TInputImage::RegionType InputImageRegionType
typedef TInputImage::SizeType InputImageSizeType
typedef TInputImage InputImageType
typedef TInputImage::DirectionType OutputImageDirectionType
typedef TInputImage::IndexType OutputImageIndexType
typedef TInputImage::OffsetType OutputImageOffsetType
typedef TInputImage::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef TInputImage::RegionType OutputImageRegionType
typedef TInputImage::SizeType OutputImageSizeType
typedef TInputImage OutputImageType
typedef SmartPointer< Self > Pointer
typedef TInputImage::PointType PointType
typedef ChangeInformationImageFilter Self
typedef TInputImage::SpacingType SpacingType
typedef ImageToImageFilter<
TInputImage, TInputImage > 		Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void ChangeDirectionOff ()
virtual void ChangeDirectionOn ()
virtual void ChangeOriginOff ()
virtual void ChangeOriginOn ()
virtual void ChangeRegionOff ()
virtual void ChangeRegionOn ()
virtual void ChangeSpacingOff ()
virtual void ChangeSpacingOn ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
void GenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual const bool & GetAbortGenerateData ()
virtual bool GetChangeDirection ()
virtual bool GetChangeOrigin ()
virtual bool GetChangeRegion ()
virtual bool GetChangeSpacing ()
Command * GetCommand (unsigned long tag)
bool GetDebug () const
const InputImageType * GetInput (unsigned int idx)
const InputImageType * GetInput (void)
DataObjectPointerArray & GetInputs ()
const MetaDataDictionary & GetMetaDataDictionary (void) const
MetaDataDictionary & GetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
MultiThreader * GetMultiThreader ()
virtual const char * GetNameOfClass () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
OutputImageType * GetOutput (unsigned int idx)
OutputImageType * GetOutput (void)
virtual const float & GetProgress ()
virtual int GetReferenceCount () const
virtual bool GetUseReferenceImage ()
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, TInputImage::ImageDimension)
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::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)
virtual void SetChangeDirection (bool _arg)
virtual void SetChangeOrigin (bool _arg)
virtual void SetChangeRegion (bool _arg)
virtual void SetChangeSpacing (bool _arg)
void SetDebug (bool debugFlag) const
virtual void SetInput (unsigned int, const TInputImage *image)
virtual void SetInput (const InputImageType *image)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetProgress (float _arg)
virtual void SetReferenceCount (int)
virtual void SetUseReferenceImage (bool _arg)
virtual void UnRegister () const
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
virtual void UseReferenceImageOff ()
virtual void UseReferenceImageOn ()
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
virtual void CenterImageOff ()
virtual void CenterImageOn ()
virtual bool GetCenterImage ()
virtual void SetCenterImage (bool _arg)
void ChangeAll ()
void ChangeNone ()
DataObjectPointerArraySizeType GetNumberOfOutputs () const
DataObjectPointerArray & GetOutputs ()
virtual const int & GetNumberOfThreads ()
virtual void SetNumberOfThreads (int _arg)
virtual const DirectionType & GetOutputDirection ()
virtual void SetOutputDirection (DirectionType _arg)
virtual const long * GetOutputOffset () const
virtual void SetOutputOffset (long data[])
virtual const PointType & GetOutputOrigin ()
virtual void SetOutputOrigin (PointType _arg)
virtual const SpacingType & GetOutputSpacing ()
virtual void SetOutputSpacing (SpacingType _arg)
virtual TInputImage * GetReferenceImage ()
void SetReferenceImage (TInputImage *image)
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

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)
 ChangeInformationImageFilter ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
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
 ~ChangeInformationImageFilter ()
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 DataObject * GetInput (unsigned int idx) const
const DataObject * GetOutput (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
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
bool m_Updating

Member Typedef Documentation

template<class TInputImage>
typedef SmartPointer<const Self> itk::ChangeInformationImageFilter< TInputImage >::ConstPointer

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

Definition at line 56 of file itkChangeInformationImageFilter.h.

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

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

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.

template<class TInputImage>
typedef TInputImage::DirectionType itk::ChangeInformationImageFilter< TInputImage >::DirectionType

Definition at line 89 of file itkChangeInformationImageFilter.h.

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

Reimplemented in itk::InPlaceImageFilter< TInputImage >.

Definition at line 84 of file itkImageToImageFilter.h.

template<class TInputImage>
typedef TInputImage::DirectionType itk::ChangeInformationImageFilter< TInputImage >::InputImageDirectionType

Definition at line 80 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::IndexType itk::ChangeInformationImageFilter< TInputImage >::InputImageIndexType

Definition at line 74 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::OffsetType itk::ChangeInformationImageFilter< TInputImage >::InputImageOffsetType

Definition at line 78 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::PixelType itk::ChangeInformationImageFilter< TInputImage >::InputImagePixelType

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

Definition at line 70 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::Pointer itk::ChangeInformationImageFilter< TInputImage >::InputImagePointer

Typedef to describe the pointer to the input.

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

Definition at line 66 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::RegionType itk::ChangeInformationImageFilter< TInputImage >::InputImageRegionType

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

Definition at line 63 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::SizeType itk::ChangeInformationImageFilter< TInputImage >::InputImageSizeType

Definition at line 76 of file itkChangeInformationImageFilter.h.

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

Some convenient typedefs.

Reimplemented in itk::MinimumMaximumImageFilter< TInputImage >, and itk::InPlaceImageFilter< TInputImage >.

Definition at line 82 of file itkImageToImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImage , TInputImage >::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.

template<class TInputImage>
typedef TInputImage::DirectionType itk::ChangeInformationImageFilter< TInputImage >::OutputImageDirectionType

Definition at line 79 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::IndexType itk::ChangeInformationImageFilter< TInputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 73 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::OffsetType itk::ChangeInformationImageFilter< TInputImage >::OutputImageOffsetType

Definition at line 77 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::PixelType itk::ChangeInformationImageFilter< TInputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

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

Definition at line 69 of file itkChangeInformationImageFilter.h.

typedef OutputImageType::Pointer itk::ImageSource< TInputImage >::OutputImagePointer [inherited]

Reimplemented in itk::ShiftScaleInPlaceImageFilter< TInputImage >, and itk::InPlaceImageFilter< TInputImage >.

Definition at line 69 of file itkImageSource.h.

template<class TInputImage>
typedef TInputImage::RegionType itk::ChangeInformationImageFilter< TInputImage >::OutputImageRegionType

Typedef to describe the output and input image region types.

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

Definition at line 59 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::SizeType itk::ChangeInformationImageFilter< TInputImage >::OutputImageSizeType

Definition at line 75 of file itkChangeInformationImageFilter.h.

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

Some convenient typedefs.

Reimplemented in itk::InPlaceImageFilter< TInputImage >.

Definition at line 65 of file itkImageSource.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImage , TInputImage >::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 TInputImage>
typedef SmartPointer<Self> itk::ChangeInformationImageFilter< TInputImage >::Pointer

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

Definition at line 55 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::PointType itk::ChangeInformationImageFilter< TInputImage >::PointType

Definition at line 88 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef ChangeInformationImageFilter itk::ChangeInformationImageFilter< TInputImage >::Self

Standard class typedefs.

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

Definition at line 53 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef TInputImage::SpacingType itk::ChangeInformationImageFilter< TInputImage >::SpacingType

Image spacing, origin and direction typedefs

Definition at line 87 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
typedef ImageToImageFilter<TInputImage,TInputImage> itk::ChangeInformationImageFilter< TInputImage >::Superclass

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

Definition at line 54 of file itkChangeInformationImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage>
itk::ChangeInformationImageFilter< TInputImage >::ChangeInformationImageFilter (  )  [protected]

template<class TInputImage>
itk::ChangeInformationImageFilter< TInputImage >::~ChangeInformationImageFilter (  )  [inline, protected]

Definition at line 221 of file itkChangeInformationImageFilter.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< TInputImage >::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.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::ShiftScaleInPlaceImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

Definition at line 254 of file itkImageSource.h.

virtual void itk::ImageSource< TInputImage >::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::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::StatisticsImageFilter< TInputImage >, and itk::InPlaceImageFilter< TInputImage >.

virtual void itk::ImageSource< TInputImage >::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.

Reimplemented in itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::ShiftScaleInPlaceImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

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< TInputImage , TInputImage >::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< TInputImage , TInputImage >::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).

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::CenterImageOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::CenterImageOn (  )  [virtual]

template<class TInputImage>
void itk::ChangeInformationImageFilter< TInputImage >::ChangeAll (  )  [inline]

Change the origin, spacing and region of the output image.

Definition at line 146 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeDirectionOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeDirectionOn (  )  [virtual]

template<class TInputImage>
void itk::ChangeInformationImageFilter< TInputImage >::ChangeNone (  )  [inline]

Do not change the origin, spacing, direction or region of the output image.

Definition at line 157 of file itkChangeInformationImageFilter.h.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeOriginOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeOriginOn (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeRegionOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeRegionOn (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeSpacingOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::ChangeSpacingOn (  )  [virtual]

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

template<class TInputImage>
void itk::ChangeInformationImageFilter< TInputImage >::GenerateData (  )  [virtual]

Copy the input buffer.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::GenerateInputRequestedRegion (  )  [virtual]

Apply changes to the input image requested region.

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

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::GenerateOutputInformation (  )  [virtual]

Apply changes to the output image information.

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::SegmentTreeGenerator< InputImageType::PixelType >.

virtual const bool& itk::ProcessObject::GetAbortGenerateData (  )  [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetCenterImage (  )  [virtual]

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeDirection (  )  [virtual]

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeOrigin (  )  [virtual]

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeRegion (  )  [virtual]

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetChangeSpacing (  )  [virtual]

Command* itk::Object::GetCommand ( unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (  )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

const DataObject* itk::ProcessObject::GetInput ( unsigned int  idx  )  const [protected, inherited]

const InputImageType* itk::ImageToImageFilter< TInputImage , TInputImage >::GetInput ( unsigned int  idx  )  [inherited]

Method used internally for getting an input.

Reimplemented from itk::ProcessObject.

const InputImageType* itk::ImageToImageFilter< TInputImage , TInputImage >::GetInput ( void   )  [inherited]

DataObjectPointerArray& itk::ProcessObject::GetInputs (  )  [inline, inherited]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader (  )  [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TInputImage>
virtual const char* itk::ChangeInformationImageFilter< TInputImage >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

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

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs (  )  const [inline, inherited]

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs (  )  const [inline, inherited]

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs (  )  [protected, virtual, inherited]

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs (  )  [protected, virtual, inherited]

virtual const int& itk::ProcessObject::GetNumberOfThreads (  )  [virtual, inherited]

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs (  )  const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int  idx  )  const [protected, inherited]

OutputImageType* itk::ImageSource< TInputImage >::GetOutput ( unsigned int  idx  )  [inherited]

Method used internally for getting an output.

Reimplemented from itk::ProcessObject.

OutputImageType* itk::ImageSource< TInputImage >::GetOutput ( void   )  [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();


   someFilter->Update();
   image = someFilter->GetOutput();
(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

template<class TInputImage>
virtual const DirectionType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputDirection (  )  [virtual]

template<class TInputImage>
virtual const long* itk::ChangeInformationImageFilter< TInputImage >::GetOutputOffset (  )  const [virtual]

template<class TInputImage>
virtual const PointType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputOrigin (  )  [virtual]

DataObjectPointerArray& itk::ProcessObject::GetOutputs (  )  [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

template<class TInputImage>
virtual const SpacingType& itk::ChangeInformationImageFilter< TInputImage >::GetOutputSpacing (  )  [virtual]

virtual const float& itk::ProcessObject::GetProgress (  )  [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

template<class TInputImage>
virtual TInputImage* itk::ChangeInformationImageFilter< TInputImage >::GetReferenceImage (  )  [virtual]

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag (  )  [virtual, inherited]

virtual bool itk::ProcessObject::GetReleaseDataFlag (  )  const [virtual, inherited]

template<class TInputImage>
virtual bool itk::ChangeInformationImageFilter< TInputImage >::GetUseReferenceImage (  )  [virtual]

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::ImageSource< TInputImage >::GraftNthOutput ( unsigned int  idx,
DataObject *  output 
) [virtual, inherited]

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

virtual void itk::ImageSource< TInputImage >::GraftOutput ( DataObject *  output  )  [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

bool itk::Object::HasObserver ( const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

itk::ImageToImageFilter< TInputImage , TInputImage >::itkStaticConstMacro ( OutputImageDimension  ,
unsigned  int,
TInputImage ::ImageDimension   
) [inherited]

Reimplemented in itk::MinimumMaximumImageFilter< TInputImage >, and itk::InPlaceImageFilter< TInputImage >.

itk::ImageToImageFilter< TInputImage , TInputImage >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
TInputImage ::ImageDimension   
) [inherited]

ImageDimension constants

Reimplemented in itk::MinimumMaximumImageFilter< TInputImage >, and itk::InPlaceImageFilter< TInputImage >.

template<class TInputImage>
itk::ChangeInformationImageFilter< TInputImage >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
TInputImage::ImageDimension   
)

Image related typedefs.

virtual DataObjectPointer itk::ImageSource< TInputImage >::MakeOutput ( unsigned int  idx  )  [virtual, inherited]

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Reimplemented in itk::MinimumMaximumImageFilter< TInputImage >, and itk::StatisticsImageFilter< TInputImage >.

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

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage>
static Pointer itk::ChangeInformationImageFilter< TInputImage >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::PopBackInput (  )  [virtual, inherited]

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::PopFrontInput (  )  [virtual, inherited]

Reimplemented from itk::ProcessObject.

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

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

template<class TInputImage>
void itk::ChangeInformationImageFilter< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

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

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject *  output  )  [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::VTKImageImport< TOutputImage >.

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

Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

void itk::ImageToImageFilter< TInputImage , TInputImage >::PushBackInput ( const DataObject *  input  )  [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 251 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::PushBackInput ( const InputImageType *  image  )  [virtual, inherited]

Push/Pop the input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

void itk::ImageToImageFilter< TInputImage , TInputImage >::PushFrontInput ( const DataObject *  input  )  [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 253 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::PushFrontInput ( const InputImageType *  image  )  [virtual, inherited]

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

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

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

void itk::ProcessObject::ReleaseDataFlagOff (  )  [inline, inherited]

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn (  )  [inline, inherited]

Definition at line 256 of file itkProcessObject.h.

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

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:
InPlaceImageFilter::ReleaseInputs()

Reimplemented in itk::InPlaceImageFilter< TInputImage, TOutputImage >, itk::InPlaceImageFilter< TDeformationField, TDeformationField >, itk::InPlaceImageFilter< TLabelImage, TOutputImage >, itk::InPlaceImageFilter< TInputImage >, itk::InPlaceImageFilter< TInputImage, TSparseOutputImage >, itk::InPlaceImageFilter< TFeatureImageType, Superclass::ImageType >, itk::InPlaceImageFilter< TInputImage1, TOutputImage >, itk::InPlaceImageFilter< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >, itk::InPlaceImageFilter< TInputImage1, itk::Functor::MakeJoin< TInputImage1, TInputImage2 >::ImageType >, itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >, and itk::InPlaceImageFilter< TImage, TImage >.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

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

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

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

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

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

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

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool  _arg  )  [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetCenterImage ( bool  _arg  )  [virtual]

Set the Origin of the output so that image coordinate (0,0,0) lies at the Center of the Image. This will override SetOutputOrigin.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeDirection ( bool  _arg  )  [virtual]

Change the direction of the output image. If false, the output image direction will be set to the input image direction. If true, the output image direction will be set to: the ReferenceImage direction (if UseReferenceImage is true) or OutputDirection.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeOrigin ( bool  _arg  )  [virtual]

Change the Origin of the output image. If false, the output image origin will be set to the input image origin. If true, the output image origin will be set to: the ReferenceImage origin (if UseReferenceImage is true) or OutputOrigin.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeRegion ( bool  _arg  )  [virtual]

Change the BufferedRegion of the output image.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetChangeSpacing ( bool  _arg  )  [virtual]

Change the Spacing of the output image. If false, the output image spacing will be set to the input image spacing. If true, the output image spacing will be set to: the ReferenceImage spacing (if UseReferenceImage is true) or OutputSpacing.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::SetInput ( unsigned  int,
const TInputImage *  image 
) [virtual, inherited]

virtual void itk::ImageToImageFilter< TInputImage , TInputImage >::SetInput ( const InputImageType *  image  )  [virtual, inherited]

Set/Get the image input of this process object.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary &  rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput ( unsigned int  num,
DataObject *  input 
) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetInputImage(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::SetInputSegmentTable(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput ( unsigned int  num,
DataObject *  output 
) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< TInputImage >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::SetOutputImage(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< TInputImage >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int  num  )  [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int  num  )  [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int  _arg  )  [protected, virtual, inherited]

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int  _arg  )  [protected, virtual, inherited]

virtual void itk::ProcessObject::SetNumberOfThreads ( int  _arg  )  [virtual, inherited]

Get/Set the number of threads to create when executing.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputDirection ( DirectionType  _arg  )  [virtual]

Specify a new direciton cosine matrix explicitly. The default is to use the direction of the Input, or of the ReferenceImage if UseReferenceImage is true.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOffset ( long  data[]  )  [virtual]

Specify an offset for the buffered region. The default is to use the same buffered region as the input or an Offset computed from the ReferenceImage's buffered region (if UseReferenceImage is true.) NOTE: Changing the buffered region should not be done without a corresponding change in the requested region. Of course, the pipeline controls the requested region. Therefore, changing the buffered region may mean the filter cannot produce the requested region.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputOrigin ( PointType  _arg  )  [virtual]

Specify a new data origin explicitly. The default is to use the origin of the Input, or of the ReferenceImage if UseReferenceImage is true.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetOutputSpacing ( SpacingType  _arg  )  [virtual]

Specify a new data spacing explicitly. The default is to use the spacing of the Input, or of the ReferenceImage if UseReferenceImage is set.

virtual void itk::ProcessObject::SetProgress ( float  _arg  )  [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TInputImage>
void itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage ( TInputImage *  image  )  [inline]

Copy the information from another Image. By default, the information is copied from the input image.

Definition at line 96 of file itkChangeInformationImageFilter.h.

References itk::ProcessObject::SetNthInput().

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool  _arg  )  [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool  flag  )  [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::SetUseReferenceImage ( bool  _arg  )  [virtual]

virtual int itk::ImageSource< TInputImage >::SplitRequestedRegion ( int  i,
int  num,
OutputImageRegionType &  splitRegion 
) [protected, virtual, inherited]

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

virtual void itk::ImageSource< TInputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
int  threadId 
) [protected, virtual, inherited]

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:
GenerateData(), SplitRequestedRegion()

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TInputImage >::ThreaderCallback ( void *  arg  )  [static, protected, inherited]

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

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

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

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

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject *  output  )  [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

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

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented in itk::watershed::Segmenter< TInputImage >, and itk::VTKImageImport< TOutputImage >.

void itk::ProcessObject::UpdateProgress ( float  amount  )  [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::UseReferenceImageOff (  )  [virtual]

template<class TInputImage>
virtual void itk::ChangeInformationImageFilter< TInputImage >::UseReferenceImageOn (  )  [virtual]

Member Data Documentation

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

The documentation for this class was generated from the following file:
Generated at Mon Apr 14 16:19:51 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000