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

itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage > Class Template Reference
[Intensity Image FiltersMultithreaded Filters]

#include <itkBinaryMagnitudeImageFilter.h>

Inheritance diagram for itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TInputImage1, class TInputImage2, class TOutputImage>
class itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >

Implements pixel-wise the computation of square root of the sum of squares.

This filter is parametrized over the types of the two input images and the type of the output image.

Numeric conversions (castings) are done by the C++ defaults.

The filter will walk over all the pixels in the two input images, and for each one of them it will do the following:

The filter expect all images to have the same dimension (e.g. all 2D, or all 3D, or all ND)

Definition at line 75 of file itkBinaryMagnitudeImageFilter.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef DataObject::Pointer DataObjectPointer
typedef std::vector< DataObjectPointerDataObjectPointerArray
typedef DataObjectPointerArray::size_type DataObjectPointerArraySizeType
typedef TFunction FunctorType
typedef Input1ImageType::PixelType Input1ImagePixelType
typedef Input1ImageType::ConstPointer Input1ImagePointer
typedef Input1ImageType::RegionType Input1ImageRegionType
typedef TInputImage1 Input1ImageType
typedef Input2ImageType::PixelType Input2ImagePixelType
typedef Input2ImageType::ConstPointer Input2ImagePointer
typedef Input2ImageType::RegionType Input2ImageRegionType
typedef TInputImage2 Input2ImageType
typedef InputImageType::ConstPointer InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage1 InputImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef BinaryMagnitudeImageFilter Self
typedef BinaryFunctorImageFilter<
TInputImage1, TInputImage2,
TOutputImage, Functor::Modulus2<
typename TInputImage1::PixelType,
typename TInputImage2::PixelType,
typename TOutputImage::PixelType > > 
Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
bool CanRunInPlace () const
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
const FunctorTypeGetFunctor () const
FunctorTypeGetFunctor ()
virtual bool GetInPlace ()
const InputImageTypeGetInput (unsigned int idx)
const InputImageTypeGetInput (void)
DataObjectPointerArrayGetInputs ()
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 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
virtual void InPlaceOff ()
virtual void InPlaceOn ()
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage1::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 SetInPlace (bool _arg)
virtual void SetInput (unsigned int, const TInputImage1 *image)
virtual void SetInput (const InputImageType *image)
void SetInput1 (const TInputImage1 *image1)
void SetInput2 (const TInputImage2 *image2)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
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)
OutputImageTypeGetOutput (unsigned int idx)
OutputImageTypeGetOutput (void)
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)
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
 itkStaticConstMacro (InputImage2Dimension, unsigned int, TInputImage2::ImageDimension)
 itkStaticConstMacro (InputImage1Dimension, unsigned int, TInputImage1::ImageDimension)
void SetFunctor (const FunctorType &functor)

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 ()
 BinaryMagnitudeImageFilter ()
virtual void CacheInputReleaseDataFlags ()
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateData ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
bool PrintObservers (std::ostream &os, Indent indent) const
virtual 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)
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual ~BinaryMagnitudeImageFilter ()
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
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
bool m_Updating


Member Typedef Documentation

template<class TInputImage1, class TInputImage2, class TOutputImage>
typedef SmartPointer<const Self> itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

Definition at line 93 of file itkBinaryMagnitudeImageFilter.h.

template<class TOutputImage>
typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

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

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 TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TFunction itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::FunctorType [inherited]

Some convenient typedefs.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >, and itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >.

Definition at line 53 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePixelType [inherited]

Definition at line 60 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePointer [inherited]

Definition at line 58 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input1ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageRegionType [inherited]

Definition at line 59 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TInputImage1 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageType [inherited]

Definition at line 57 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePixelType [inherited]

Definition at line 64 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePointer [inherited]

Definition at line 62 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef Input2ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageRegionType [inherited]

Definition at line 63 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TInputImage2 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageType [inherited]

Definition at line 61 of file itkBinaryFunctorImageFilter.h.

typedef InputImageType::ConstPointer itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::InputImageConstPointer [inherited]

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Definition at line 84 of file itkInPlaceImageFilter.h.

typedef InputImageType::PixelType itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::InputImagePixelType [inherited]

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Definition at line 86 of file itkInPlaceImageFilter.h.

typedef InputImageType::Pointer itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::InputImagePointer [inherited]

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Definition at line 83 of file itkInPlaceImageFilter.h.

typedef InputImageType::RegionType itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::InputImageRegionType [inherited]

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Definition at line 85 of file itkInPlaceImageFilter.h.

typedef TInputImage1 itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::InputImageType [inherited]

Some convenient typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >.

Definition at line 82 of file itkInPlaceImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImage1 , TOutputImage >::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 TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePixelType [inherited]

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >.

Definition at line 68 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::Pointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePointer [inherited]

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Definition at line 66 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef OutputImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Definition at line 67 of file itkBinaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage, class TFunction>
typedef TOutputImage itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageType [inherited]

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Reimplemented in itk::Compose2DCovariantVectorImageFilter< TInputImage, TOutputImage >, itk::Compose2DVectorImageFilter< TInputImage, TOutputImage >, itk::JoinImageFilter< TInputImage1, TInputImage2 >, and itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >.

Definition at line 65 of file itkBinaryFunctorImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImage1 , TOutputImage >::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 TInputImage1, class TInputImage2, class TOutputImage>
typedef SmartPointer<Self> itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

Definition at line 92 of file itkBinaryMagnitudeImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage>
typedef BinaryMagnitudeImageFilter itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

Definition at line 85 of file itkBinaryMagnitudeImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage>
typedef BinaryFunctorImageFilter<TInputImage1,TInputImage2,TOutputImage, Functor::Modulus2< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType> > itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >.

Definition at line 91 of file itkBinaryMagnitudeImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage1, class TInputImage2, class TOutputImage>
itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::BinaryMagnitudeImageFilter (  )  [inline, protected]

Definition at line 115 of file itkBinaryMagnitudeImageFilter.h.

template<class TInputImage1, class TInputImage2, class TOutputImage>
virtual itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::~BinaryMagnitudeImageFilter (  )  [inline, protected, virtual]

Definition at line 116 of file itkBinaryMagnitudeImageFilter.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]

template<class TOutputImage>
virtual void itk::ImageSource< TOutputImage >::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::HistogramMatchingImageFilter< TInputImage, TOutputImage, THistogramMeasurement >, itk::ContourDirectedMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DirectedHausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::InterpolateImageFilter< TInputImage, TOutputImage >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ShiftScaleImageFilter< TInputImage, TOutputImage >, itk::ShiftScaleInPlaceImageFilter< TInputImage >, itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >, itk::StatisticsImageFilter< TInputImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VotingBinaryHoleFillingImageFilter< TInputImage, TOutputImage >, itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >, itk::DifferenceImageFilter< TInputImage, TOutputImage >, and itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >.

Definition at line 254 of file itkImageSource.h.

virtual void itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::AllocateOutputs (  )  [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage>
virtual void itk::ImageSource< TOutputImage >::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::HistogramMatchingImageFilter< TInputImage, TOutputImage, THistogramMeasurement >, itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >, itk::LabelVotingImageFilter< TInputImage, TOutputImage >, itk::BilateralImageFilter< TInputImage, TOutputImage >, itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::ContourDirectedMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >, itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >, itk::DirectedHausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::ExpandImageFilter< TInputImage, TOutputImage >, itk::ImageToVectorImageFilter< TInputImage >, itk::IntensityWindowingImageFilter< TInputImage, TOutputImage >, itk::InterpolateImageFilter< TInputImage, TOutputImage >, itk::InterpolateImagePointsFilter< TInputImage, TOutputImage, TCoordType, InterpolatorType >, itk::InvertIntensityImageFilter< TInputImage, TOutputImage >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::ModulusImageFilter< TInputImage, TOutputImage >, itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::RescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::ShiftScaleImageFilter< TInputImage, TOutputImage >, itk::ShiftScaleInPlaceImageFilter< TInputImage >, itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >, itk::StatisticsImageFilter< TInputImage >, itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >, itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >, itk::VectorExpandImageFilter< TInputImage, TOutputImage >, itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >, itk::VectorIndexSelectionCastImageFilter< TInputImage, TOutputImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorRescaleIntensityImageFilter< TInputImage, TOutputImage >, itk::VotingBinaryHoleFillingImageFilter< TInputImage, TOutputImage >, itk::WarpImageFilter< TInputImage, TOutputImage, TDeformationField >, itk::WarpVectorImageFilter< TInputImage, TOutputImage, TDeformationField >, itk::DifferenceImageFilter< TInputImage, TOutputImage >, itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TernaryFunctorImageFilter< TInputImage, TInputImage, TInputImage, TOutputImage, itk::Function::Compose3DVector< TInputImage::PixelType > >, itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, itk::Function::Modulus3< TInputImage1::PixelType, TInputImage2::PixelType, TInputImage3::PixelType, TOutputImage::PixelType > >, itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, itk::Function::ModulusSquare3< TInputImage1::PixelType, TInputImage2::PixelType, TInputImage3::PixelType, TOutputImage::PixelType > >, itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, itk::Function::Add3< TInputImage1::PixelType, TInputImage2::PixelType, TInputImage3::PixelType, TOutputImage::PixelType > >, itk::TernaryFunctorImageFilter< TInputImage, TInputImage, TInputImage, TOutputImage, itk::Function::Compose3DCovariantVector< TInputImage::PixelType > >, and itk::TernaryFunctorImageFilter< TInputImage, TInputImage, TInputImage, TOutputImage, itk::Function::ComposeRGB< TInputImage::PixelType > >.

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

bool itk::InPlaceImageFilter< TInputImage1 , TOutputImage >::CanRunInPlace (  )  const [inline, inherited]

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true.

Definition at line 108 of file itkInPlaceImageFilter.h.

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