ITK: itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TAccumulator itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::AccumulatorType

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 81 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef SmartPointer<const Self> itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ConstPointer

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

Definition at line 63 of file itkProjectionImageFilter.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 InputImageType::ConstPointer itk::ImageToImageFilter< TInputImage, TOutputImage >::InputImageConstPointer [inherited]

Definition at line 84 of file itkImageToImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePixelType

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

Definition at line 75 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePointer

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

Definition at line 73 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::RegionType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageRegionType

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

Definition at line 74 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TInputImage itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageType

Some convenient typedefs.

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, and itk::SumProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 69 of file itkProjectionImageFilter.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.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImagePixelType

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

Definition at line 79 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 77 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::RegionType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 78 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TOutputImage itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, and itk::SumProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 76 of file itkProjectionImageFilter.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, class TAccumulator>

typedef SmartPointer<Self> itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Pointer

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

Definition at line 62 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef ProjectionImageFilter itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Self

Standard class typedefs.

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

Definition at line 60 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef ImageToImageFilter<TInputImage,TOutputImage> itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Superclass

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

Definition at line 61 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ProjectionImageFilter ( ) [protected]

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::~ProjectionImageFilter ( ) [inline, protected, virtual]

Definition at line 113 of file itkProjectionImageFilter.h.

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.

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.

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.

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

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 lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

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

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

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

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring ob


Public Types
typedef TAccumulator	AccumulatorType
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ProjectionImageFilter	Self
typedef ImageToImageFilter< 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 const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
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
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 &)
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)
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 InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetInput (const InputImageType *image)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

virtual const int &	GetNumberOfThreads ()
virtual void	SetNumberOfThreads (int _arg)

OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput (void)

virtual const unsigned int &	GetProjectionDimension ()
virtual void	SetProjectionDimension (unsigned int _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)

	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
Protected Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual AccumulatorType	NewAccumulator (unsigned long) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	ProjectionImageFilter ()
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)
virtual	~ProjectionImageFilter ()

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

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
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator > Class Template Reference
[Intensity Image Filters, Singlethreaded Filters]

Detailed Description

template<class TInputImage, class TOutputImage, class TAccumulator>
class itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator > Class Template Reference [Intensity Image Filters, Singlethreaded Filters]

Detailed Description

template<class TInputImage, class TOutputImage, class TAccumulator> class itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator > Class Template Reference
[Intensity Image Filters, Singlethreaded Filters]

template<class TInputImage, class TOutputImage, class TAccumulator>
class itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >