ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction > Class Template Reference

#include <itkBinaryFunctorImageFilter.h>

+ Inheritance diagram for itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >:
+ Collaboration diagram for itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >:

Detailed Description

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
class itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >

Implements pixel-wise generic operation of two images, or of an image and a constant.

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

The constant must be of the same type than the pixel type of the corresponding image. It is wrapped in a SimpleDataObjectDecorator so it can be updated through the pipeline. The SetConstant() and GetConstant() methods are provided as shortcuts to set or get the constant value without manipulating the decorator.

See Also
UnaryFunctorImageFilter TernaryFunctorImageFilter
Wiki Examples:
Examples:
WikiExamples/ImageProcessing/BinaryFunctorImageFilter.cxx, and WikiExamples/ImageProcessing/BinaryFunctorImageFilterCustom.cxx.

Definition at line 51 of file itkBinaryFunctorImageFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
SimpleDataObjectDecorator
< Input1ImagePixelType
DecoratedInput1ImagePixelType
 
typedef
SimpleDataObjectDecorator
< Input2ImagePixelType
DecoratedInput2ImagePixelType
 
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 OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef BinaryFunctorImageFilter Self
 
typedef InPlaceImageFilter
< TInputImage1, TOutputImage > 
Superclass
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage1 InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImagePointer 
OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef InPlaceImageFilter Self
 
typedef ImageToImageFilter
< TInputImage1, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage1 InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef MultiThreader MultiThreaderType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const
Input1ImagePixelType
GetConstant1 () const
 
virtual const
Input2ImagePixelType
GetConstant2 () const
 
FunctorTypeGetFunctor ()
 
const FunctorTypeGetFunctor () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetConstant1 (const Input1ImagePixelType &input1)
 
virtual void SetInput1 (const TInputImage1 *image1)
 
virtual void SetInput1 (const DecoratedInput1ImagePixelType *input1)
 
virtual void SetInput1 (const Input1ImagePixelType &input1)
 
virtual void SetInput2 (const TInputImage2 *image2)
 
virtual void SetInput2 (const DecoratedInput2ImagePixelType *input2)
 
virtual void SetInput2 (const Input2ImagePixelType &input2)
 
virtual void SetConstant2 (const Input2ImagePixelType &input2)
 
void SetConstant (Input2ImagePixelType ct)
 
const Input2ImagePixelTypeGetConstant () const
 
void SetFunctor (const FunctorType &functor)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, 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< TInputImage1, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage1 *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

 BinaryFunctorImageFilter ()
 
virtual void GenerateOutputInformation () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 
virtual ~BinaryFunctorImageFilter () override
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
virtual void AllocateOutputs () override
 
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ReleaseInputs () override
 
 ~InPlaceImageFilter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateData () override
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual ~ImageSource () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) 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 () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) 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 () override
 
- 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 Attributes

FunctorType m_Functor
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef SmartPointer< const Self > itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::ConstPointer

Definition at line 59 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef SimpleDataObjectDecorator<Input1ImagePixelType> itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::DecoratedInput1ImagePixelType

Definition at line 74 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef SimpleDataObjectDecorator<Input2ImagePixelType> itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::DecoratedInput2ImagePixelType

Definition at line 81 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef TFunction itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::FunctorType

Some convenient typedefs.

Definition at line 65 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input1ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePixelType

Definition at line 72 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input1ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImagePointer

Definition at line 70 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input1ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageRegionType

Definition at line 71 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef TInputImage1 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input1ImageType

Definition at line 69 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input2ImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePixelType

Definition at line 79 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input2ImageType::ConstPointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImagePointer

Definition at line 77 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef Input2ImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageRegionType

Definition at line 78 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef TInputImage2 itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Input2ImageType

Definition at line 76 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef OutputImageType::PixelType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePixelType

Definition at line 86 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef OutputImageType::Pointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImagePointer

Definition at line 84 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef OutputImageType::RegionType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageRegionType

Definition at line 85 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef TOutputImage itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageType

Definition at line 83 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef SmartPointer< Self > itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Pointer

Definition at line 58 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef BinaryFunctorImageFilter itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 56 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
typedef InPlaceImageFilter< TInputImage1, TOutputImage > itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::Superclass

Definition at line 57 of file itkBinaryFunctorImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::BinaryFunctorImageFilter ( )
protected
template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::~BinaryFunctorImageFilter ( )
inlineoverrideprotectedvirtual

Definition at line 176 of file itkBinaryFunctorImageFilter.h.

Member Function Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual::itk::LightObject::Pointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::CreateAnother ( ) 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::AddImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::SubtractImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::DivideImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, and itk::MultiplyImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GenerateOutputInformation ( )
overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

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

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
const Input2ImagePixelType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetConstant ( ) const
inline

Set the second operand as a constant.

Definition at line 113 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual const Input1ImagePixelType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetConstant1 ( ) const
virtual

Get the constant value of the first operand. An exception is sent if the first operand is not a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual const Input2ImagePixelType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetConstant2 ( ) const
virtual

Get the constant value of the second operand. An exception is sent if the second operand is not a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
FunctorType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, 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 127 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
const FunctorType& itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetFunctor ( ) const
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 133 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual const char* itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

Reimplemented in itk::JoinImageFilter< TInputImage1, TInputImage2 >, itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueAdditionImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MagnitudeAndPhaseToComplexImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::PowImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AbsoluteValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SquaredDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AddImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SubtractImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::XorImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::OrImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AndImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ModulusImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MultiplyImageFilter< TInputImage, Image< TConstant, TInputImage::ImageDimension >, TOutputImage >, itk::SubtractConstantFromImageFilter< TInputImage, TConstant, TOutputImage >, itk::DivideByConstantImageFilter< TInputImage, TConstant, TOutputImage >, itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >, and itk::AddConstantToImageFilter< TInputImage, TConstant, TOutputImage >.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
static Pointer itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetConstant ( Input2ImagePixelType  ct)
inline

Set the second operand as a constant.

Definition at line 109 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetConstant1 ( const Input1ImagePixelType input1)
virtual

Set the first operand as a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetConstant2 ( const Input2ImagePixelType input2)
virtual

Set the second operand as a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetFunctor ( const 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 144 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput1 ( const TInputImage1 *  image1)
virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput1 ( const DecoratedInput1ImagePixelType input1)
virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput1 ( const Input1ImagePixelType input1)
virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput2 ( const TInputImage2 *  image2)
virtual

Connect the second operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput2 ( const DecoratedInput2ImagePixelType input2)
virtual

Connect the second operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
virtual void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::SetInput2 ( const Input2ImagePixelType input2)
virtual

Connect the second operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotectedvirtual

BinaryFunctorImageFilter 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 >.

Member Data Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
const unsigned int itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::InputImage1Dimension = TInputImage1::ImageDimension
static

ImageDimension constants

Definition at line 156 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
const unsigned int itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::InputImage2Dimension = TInputImage2::ImageDimension
static

ImageDimension constants

Definition at line 158 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
FunctorType itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::m_Functor
private

Definition at line 196 of file itkBinaryFunctorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage, typename TFunction>
const unsigned int itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension
static

ImageDimension constants

Definition at line 160 of file itkBinaryFunctorImageFilter.h.


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