ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction > Class Template Reference
Data Processing Objects » Filters » Image Filters » Intensity Image FiltersMultiThreading Support » | MultiThreaded FiltersGroup Filtering » | Module ITKImageFilterBase

#include <itkBinaryFunctorImageFilter.h>

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
BinaryGeneratorImagFilter
UnaryFunctorImageFilter TernaryFunctorImageFilter
ITK Sphinx Examples:
Examples
SphinxExamples/src/Filtering/ImageFilterBase/CustomOperationToCorrespondingPixelsInTwoImages/Code.cxx, and SphinxExamples/src/Filtering/ImageFilterBase/PredefinedOperationToCorrespondingPixelsInTwoImages/Code.cxx.

Definition at line 53 of file itkBinaryFunctorImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DecoratedInput1ImagePixelType = SimpleDataObjectDecorator< Input1ImagePixelType >
 
using DecoratedInput2ImagePixelType = SimpleDataObjectDecorator< Input2ImagePixelType >
 
using FunctorType = TFunction
 
using Input1ImagePixelType = typename Input1ImageType::PixelType
 
using Input1ImagePointer = typename Input1ImageType::ConstPointer
 
using Input1ImageRegionType = typename Input1ImageType::RegionType
 
using Input1ImageType = TInputImage1
 
using Input2ImagePixelType = typename Input2ImageType::PixelType
 
using Input2ImagePointer = typename Input2ImageType::ConstPointer
 
using Input2ImageRegionType = typename Input2ImageType::RegionType
 
using Input2ImageType = TInputImage2
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = BinaryFunctorImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage1, TOutputImage >
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage1
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TInputImage1, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage1
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const Input1ImagePixelType & GetConstant1 () const
 
virtual const Input2ImagePixelType & GetConstant2 () const
 
FunctorType & GetFunctor ()
 
const FunctorType & GetFunctor () const
 
const char * GetNameOfClass () const override
 
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 Input2ImagePixelType & GetConstant () const
 
void SetFunctor (const FunctorType &functor)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
virtual bool CanRunInPlace () const
 
const char * GetNameOfClass () const override
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
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 >
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

 BinaryFunctorImageFilter ()
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
 
void GenerateOutputInformation () override
 
 ~BinaryFunctorImageFilter () override=default
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () 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)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void VerifyInputInformation () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- 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)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (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
 
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 PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 62 of file itkBinaryFunctorImageFilter.h.

◆ DecoratedInput1ImagePixelType

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

Definition at line 76 of file itkBinaryFunctorImageFilter.h.

◆ DecoratedInput2ImagePixelType

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

Definition at line 82 of file itkBinaryFunctorImageFilter.h.

◆ FunctorType

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

Some convenient type alias.

Definition at line 71 of file itkBinaryFunctorImageFilter.h.

◆ Input1ImagePixelType

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

Definition at line 75 of file itkBinaryFunctorImageFilter.h.

◆ Input1ImagePointer

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

Definition at line 73 of file itkBinaryFunctorImageFilter.h.

◆ Input1ImageRegionType

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

Definition at line 74 of file itkBinaryFunctorImageFilter.h.

◆ Input1ImageType

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

Definition at line 72 of file itkBinaryFunctorImageFilter.h.

◆ Input2ImagePixelType

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

Definition at line 81 of file itkBinaryFunctorImageFilter.h.

◆ Input2ImagePointer

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

Definition at line 79 of file itkBinaryFunctorImageFilter.h.

◆ Input2ImageRegionType

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

Definition at line 80 of file itkBinaryFunctorImageFilter.h.

◆ Input2ImageType

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

Definition at line 78 of file itkBinaryFunctorImageFilter.h.

◆ OutputImagePixelType

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

Definition at line 87 of file itkBinaryFunctorImageFilter.h.

◆ OutputImagePointer

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

Definition at line 85 of file itkBinaryFunctorImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 86 of file itkBinaryFunctorImageFilter.h.

◆ OutputImageType

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

Definition at line 84 of file itkBinaryFunctorImageFilter.h.

◆ Pointer

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

Definition at line 61 of file itkBinaryFunctorImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 59 of file itkBinaryFunctorImageFilter.h.

◆ Superclass

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

Definition at line 60 of file itkBinaryFunctorImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryFunctorImageFilter()

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

◆ ~BinaryFunctorImageFilter()

template<typename TInputImage1 , typename TInputImage2 , typename TOutputImage , typename TFunction >
itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::~BinaryFunctorImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ DynamicThreadedGenerateData()

template<typename TInputImage1 , typename TInputImage2 , typename TOutputImage , typename TFunction >
void itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread)
overrideprotectedvirtual

BinaryFunctorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData 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 >.

◆ GenerateOutputInformation()

template<typename TInputImage1 , typename TInputImage2 , typename TOutputImage , typename TFunction >
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.

◆ GetConstant()

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 125 of file itkBinaryFunctorImageFilter.h.

◆ GetConstant1()

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.

◆ GetConstant2()

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.

◆ GetFunctor() [1/2]

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 141 of file itkBinaryFunctorImageFilter.h.

◆ GetFunctor() [2/2]

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 151 of file itkBinaryFunctorImageFilter.h.

◆ GetNameOfClass()

template<typename TInputImage1 , typename TInputImage2 , typename TOutputImage , typename TFunction >
const char* itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, TFunction >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ New()

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.

◆ SetConstant()

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 120 of file itkBinaryFunctorImageFilter.h.

◆ SetConstant1()

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.

◆ SetConstant2()

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.

◆ SetFunctor()

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 163 of file itkBinaryFunctorImageFilter.h.

◆ SetInput1() [1/3]

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.

◆ SetInput1() [2/3]

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.

◆ SetInput1() [3/3]

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.

◆ SetInput2() [1/3]

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.

◆ SetInput2() [2/3]

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.

◆ SetInput2() [3/3]

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.

Member Data Documentation

◆ InputImage1Dimension

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

ImageDimension constants

Definition at line 174 of file itkBinaryFunctorImageFilter.h.

◆ InputImage2Dimension

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

Definition at line 175 of file itkBinaryFunctorImageFilter.h.

◆ m_Functor

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

Definition at line 211 of file itkBinaryFunctorImageFilter.h.

◆ OutputImageDimension

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

Definition at line 176 of file itkBinaryFunctorImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16