ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

#include <itkNaryFunctorImageFilter.h>

+ Inheritance diagram for itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:
+ Collaboration diagram for itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TFunction FunctorType
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef std::vector
< InputImagePixelType
NaryArrayType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef NaryFunctorImageFilter Self
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
FunctorTypeGetFunctor ()
virtual const char * GetNameOfClass () const
 typedef (Concept::SameDimension< InputImageDimension, OutputImageDimension >) SameDimensionCheck
 typedef (Concept::HasZero< OutputImagePixelType >) OutputHasZeroCheck
void SetFunctor (FunctorType &functor)
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool CanRunInPlace () const
virtual void SetInPlace (bool _arg)
virtual bool GetInPlace () const
virtual void InPlaceOn ()
virtual void InPlaceOff ()
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions

 NaryFunctorImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~NaryFunctorImageFilter ()
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void AllocateOutputs ()
virtual bool GetRunningInPlace () const
 InPlaceImageFilter ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void ReleaseInputs ()
 ~InPlaceImageFilter ()
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateInputRequestedRegion ()
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void BeforeThreadedGenerateData ()
virtual void GenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

 NaryFunctorImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

FunctorType m_Functor

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >

Perform a generic pixel-wise operation on N images.

This class is templated over the types of the input images and the type of the output image. It is also templated by the operation to be applied. A Functor style is used to represent the function.

All the input images must be of the same type.

Definition at line 42 of file itkNaryFunctorImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TFunction>
typedef SmartPointer< const Self > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer
template<class TInputImage, class TOutputImage, class TFunction>
typedef TFunction itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some typedefs.

Definition at line 57 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::PixelType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType
template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer
template<class TInputImage, class TOutputImage, class TFunction>
typedef InputImageType::RegionType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType
template<class TInputImage, class TOutputImage, class TFunction>
typedef TInputImage itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Some convenient typedefs.

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

Definition at line 61 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef std::vector< InputImagePixelType > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryArrayType

Definition at line 69 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::PixelType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType
template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer
template<class TInputImage, class TOutputImage, class TFunction>
typedef OutputImageType::RegionType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 67 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef TOutputImage itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Superclass typedefs.

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

Definition at line 65 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
typedef SmartPointer< Self > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Pointer
template<class TInputImage, class TOutputImage, class TFunction>
typedef NaryFunctorImageFilter itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Self
template<class TInputImage, class TOutputImage, class TFunction>
typedef InPlaceImageFilter< TInputImage, TOutputImage > itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryFunctorImageFilter ( )
protected

End concept checking

template<class TInputImage, class TOutputImage, class TFunction>
virtual itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::~NaryFunctorImageFilter ( )
inlineprotectedvirtual

Definition at line 111 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::NaryFunctorImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunction>
virtual::itk::LightObject::Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const
virtual

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

Reimplemented in itk::NaryMaximumImageFilter< TInputImage, TOutputImage >, and itk::NaryAddImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType& itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( )
inline

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer).

Definition at line 75 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
virtual const char* itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TOutputImage, class TFunction>
static Pointer itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::NaryMaximumImageFilter< TInputImage, TOutputImage >, and itk::NaryAddImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self )
private

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

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

Reimplemented in itk::NaryMaximumImageFilter< TInputImage, TOutputImage >, and itk::NaryAddImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::SetFunctor ( FunctorType functor)
inline

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 83 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
void itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

NaryFunctorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::typedef ( Concept::SameDimension< InputImageDimension, OutputImageDimension )

Begin concept checking This class requires SameDimensionCheck in the form of ( Concept::SameDimension< InputImageDimension, OutputImageDimension > )

template<class TInputImage, class TOutputImage, class TFunction>
itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::typedef ( Concept::HasZero< OutputImagePixelType )

This class requires OutputHasZeroCheck in the form of ( Concept::HasZero< OutputImagePixelType > )


Member Data Documentation

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

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

Definition at line 95 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::m_Functor
private

Definition at line 130 of file itkNaryFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunction>
const unsigned int itk::NaryFunctorImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

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

Definition at line 97 of file itkNaryFunctorImageFilter.h.


The documentation for this class was generated from the following file: