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

itk::WrapPadImageFilter< TInputImage, TOutputImage > Class Template Reference
[Geometric Transformation Filters]

#include <itkWrapPadImageFilter.h>

Inheritance diagram for itk::WrapPadImageFilter< TInputImage, TOutputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::WrapPadImageFilter< TInputImage, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::WrapPadImageFilter< TInputImage, TOutputImage >

Increase the image size by padding with replicants of the input image value.

WrapPadImageFilter changes the image bounds of an image. Added pixels are filled in with a wrapped replica of the input image. For instance, if the output image needs a pixel that is two pixels to the left of the LargestPossibleRegion of the input image, the value assigned will be from the pixel two pixels inside the right boundary of the LargestPossibleRegion. The image bounds of the output must be specified.

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

See also:
MirrorPadImageFilter, ConstantPadImageFilter

Definition at line 45 of file itkWrapPadImageFilter.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef DataObject::Pointer DataObjectPointer
typedef std::vector< DataObjectPointerDataObjectPointerArray
typedef DataObjectPointerArray::size_type DataObjectPointerArraySizeType
typedef Superclass::InputImageConstPointer InputImageConstPointer
typedef Superclass::InputImageIndexType InputImageIndexType
typedef Superclass::InputImagePixelType InputImagePixelType
typedef Superclass::InputImagePointer InputImagePointer
typedef Superclass::InputImageRegionType InputImageRegionType
typedef Superclass::InputImageSizeType InputImageSizeType
typedef Superclass::InputImageType InputImageType
typedef Superclass::OutputImageIndexType OutputImageIndexType
typedef Superclass::OutputImagePixelType OutputImagePixelType
typedef Superclass::OutputImagePointer OutputImagePointer
typedef Superclass::OutputImageRegionType OutputImageRegionType
typedef Superclass::OutputImageSizeType OutputImageSizeType
typedef Superclass::OutputImageType OutputImageType
typedef SmartPointer< SelfPointer
typedef WrapPadImageFilter Self
typedef PadImageFilter< TInputImage,
TOutputImage > 
Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual void GenerateOutputInformation ()
virtual const bool & GetAbortGenerateData ()
CommandGetCommand (unsigned long tag)
bool GetDebug () const
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
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
 itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual DataObjectPointer MakeOutput (unsigned int idx)
virtual void Modified () const
virtual void PrepareOutputs ()
void Print (std::ostream &os, Indent indent=0) const
virtual void PropagateRequestedRegion (DataObject *output)
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetPadBound (const InputImageSizeType &bound)
void SetPadLowerBound (const InputImageSizeType &bound)
void SetPadUpperBound (const InputImageSizeType &bound)
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 *)
const InputImageTypeGetInput (unsigned int idx)
const InputImageTypeGetInput (void)
virtual void SetInput (unsigned int, const TInputImage *image)
virtual void SetInput (const InputImageType *image)
DataObjectPointerArraySizeType GetNumberOfOutputs () const
DataObjectPointerArrayGetOutputs ()
virtual const int & GetNumberOfThreads ()
virtual void SetNumberOfThreads (int _arg)
OutputImageTypeGetOutput (unsigned int idx)
OutputImageTypeGetOutput (void)
virtual const unsigned long * GetPadLowerBound () const
virtual const unsigned long * GetPadUpperBound () const
virtual void SetPadLowerBound (const unsigned long data[])
virtual void SetPadUpperBound (const unsigned long data[])
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 (InputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)

Static Public Member Functions

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

Protected Types

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

Protected Member Functions

virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
int BuildInterRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
int BuildPostRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
int BuildPreRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)
virtual void CacheInputReleaseDataFlags ()
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
int FindRegionsInArea (long start, long end, long size, long offset)
virtual void GenerateData ()
virtual void GenerateInputRequestedRegion ()
int GenerateNextInputRegion (long *regIndices, long *regLimit, std::vector< long > *indices, std::vector< long > *sizes, InputImageRegionType &outputRegion)
int GenerateNextOutputRegion (long *regIndices, long *regLimit, std::vector< long > *indices, std::vector< long > *sizes, OutputImageRegionType &outputRegion)
virtual void GenerateOutputRequestedRegion (DataObject *output)
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RestoreInputReleaseDataFlags ()
void SetNumberOfInputs (unsigned int num)
void SetNumberOfOutputs (unsigned int num)
virtual int SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
 WrapPadImageFilter ()
 ~WrapPadImageFilter ()
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
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)

Static Protected Member Functions

static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

Protected Attributes

TimeStamp m_OutputInformationMTime
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
bool m_Updating


Member Typedef Documentation

template<class TInputImage, class TOutputImage>
typedef SmartPointer<const Self> itk::WrapPadImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 53 of file itkWrapPadImageFilter.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 TInputImage, class TOutputImage>
typedef Superclass::InputImageConstPointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

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

Definition at line 65 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageIndexType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageIndexType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 77 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImagePixelType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 73 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 63 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageRegionType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 69 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageSizeType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageSizeType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 79 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::InputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 59 of file itkWrapPadImageFilter.h.

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

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

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

Definition at line 139 of file itkLightObject.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageIndexType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

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

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 76 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImagePixelType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 72 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageRegionType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 68 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageSizeType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 78 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef Superclass::OutputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 62 of file itkWrapPadImageFilter.h.

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

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 52 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef WrapPadImageFilter itk::WrapPadImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 50 of file itkWrapPadImageFilter.h.

template<class TInputImage, class TOutputImage>
typedef PadImageFilter<TInputImage,TOutputImage> itk::WrapPadImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::PadImageFilter< TInputImage, TOutputImage >.

Definition at line 51 of file itkWrapPadImageFilter.h.


Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>
itk::WrapPadImageFilter< TInputImage, TOutputImage >::WrapPadImageFilter (  )  [inline, protected]

Definition at line 94 of file itkWrapPadImageFilter.h.

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

Definition at line 95 of file itkWrapPadImageFilter.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::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, 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.

template<class TOutputImage>
virtual void itk::ImageSource< TOutputImage >::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::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::ContourDirectedMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DirectedHausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::ImageToVectorImageFilter< TInputImage >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >, itk::StatisticsImageFilter< TInputImage >, itk::InPlaceImageFilter< TInputImage, TOutputImage >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, 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< itk::Image< TInputPixel1, NDimension >, itk::Image< std::complex< TOutputPixel >, NDimension > >, itk::InPlaceImageFilter< TInputImageType, TSparseOutputImageType >, itk::InPlaceImageFilter< TImage, TImage >, and itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, itk::MaskedRankHistogram< TInputImage::PixelType > >.

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::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, itk::ContourDirectedMeanDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >, itk::DirectedHausdorffDistanceImageFilter< TInputImage1, TInputImage2 >, itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >, 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::RecursiveSeparableImageFilter< TInputImage, TOutputImage >, 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::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, 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.

template<class TInputImage, class TOutputImage>
int itk::WrapPadImageFilter< TInputImage, TOutputImage >::BuildInterRegions ( std::vector< long > &  inputRegionStart,
std::vector< long > &  outputRegionStart,
std::vector< long > &  inputRegionSizes,
std::vector< long > &  outputRegionSizes,
long  inputIndex,
long  outputIndex,
long  inputSize,
long  outputSize,
int  numRegs,
int &  regCtr 
) [protected]

Generate region 0 (inter-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly corresponding to the input region. Padding will be on either side of this region. The algorithmic complications are necessary to support the streaming interface and multithreading.

template<class TInputImage, class TOutputImage>
int itk::WrapPadImageFilter< TInputImage, TOutputImage >::BuildPostRegions ( std::vector< long > &  inputRegionStart,
std::vector< long > &  outputRegionStart,
std::vector< long > &  inputRegionSizes,
std::vector< long > &  outputRegionSizes,
long  inputIndex,
long  outputIndex,
long  inputSize,
long  outputSize,
int  numRegs,
int &  regCtr 
) [protected]

Generate region 2 (post-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly succeeding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

template<class TInputImage, class TOutputImage>
int itk::WrapPadImageFilter< TInputImage, TOutputImage >::BuildPreRegions ( std::vector< long > &  inputRegionStart,
std::vector< long > &  outputRegionStart,
std::vector< long > &  inputRegionSizes,
std::vector< long > &  outputRegionSizes,
long  inputIndex,
long  outputIndex,
long  inputSize,
long  outputSize,
int  numRegs,
int &  regCtr 
) [protected]

Generate region 1 (pre-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly preceding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

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().

template<class TInputImage, class TOutputImage>
virtual void itk::ImageToImageFilter< TInputImage, 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.

template<class TInputImage, class TOutputImage>
virtual void itk::ImageToImageFilter< TInputImage, 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 l