itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage > Class Template Reference

#include <itkBinaryGeneratorImageFilter.h>

Inheritance diagram for itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Collaboration diagram for itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >:

Detailed Description

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>
class itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >

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.

This filter allows per-pixel operations to be specified in several way:

• ITK traditional "Functor", with operator()
• C++11 lambda functions, with closures
• C++ std::function
• C-style function pointers

The constant must be of the same type as 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

UnaryGeneratorImageFilter

BinaryFunctorImageFilter

Definition at line 57 of file itkBinaryGeneratorImageFilter.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ConstRefFunctionType = OutputImagePixelType(const Input1ImagePixelType &, const Input2ImagePixelType &)
using	DecoratedInput1ImagePixelType = SimpleDataObjectDecorator< Input1ImagePixelType >
using	DecoratedInput2ImagePixelType = SimpleDataObjectDecorator< Input2ImagePixelType >
using	FunctionType = OutputImagePixelType(*)(const Input1ImagePixelType &, const Input2ImagePixelType &)
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 = BinaryGeneratorImageFilter
using	Superclass = InPlaceImageFilter< TInputImage1, TOutputImage >
using	ValueFunctionType = OutputImagePixelType(Input1ImagePixelType, Input2ImagePixelType)
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	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImagePointer = typename Superclass::OutputImagePointer
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	OutputImageType = typename Superclass::OutputImageType
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	OutputImagePixelType = typename Superclass::OutputImagePixelType
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
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 ::itk::LightObject::Pointer	CreateAnother () const
virtual const Input1ImagePixelType &	GetConstant1 () const
virtual const Input2ImagePixelType &	GetConstant2 () const
virtual const char *	GetNameOfClass () const
virtual void	SetConstant1 (const Input1ImagePixelType &input1)
void	SetFunctor (const std::function< ConstRefFunctionType > &f)
void	SetFunctor (const std::function< ValueFunctionType > &f)
void	SetFunctor (ConstRefFunctionType *funcPointer)
void	SetFunctor (ValueFunctionType *funcPointer)
template<typename TFunctor >
void	SetFunctor (const TFunctor &functor)
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
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 InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
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 >
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
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 ()
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 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)
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 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	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () 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
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)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
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
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 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
	BinaryGeneratorImageFilter ()
void	GenerateOutputInformation () override
	~BinaryGeneratorImageFilter () override=default
template<typename TFunctor >
void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
void	AllocateOutputs () override
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ReleaseInputs () override
	~InPlaceImageFilter () override=default
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 () ITKv5_CONST 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 ()
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 &outputRegionForThread, ThreadIdType threadId)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
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	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 () ITKv5_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 idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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
std::function< void(const OutputImageRegionType &)>	m_DynamicThreadedGenerateDataFunction

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)
Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading
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

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer = SmartPointer< const Self >

Definition at line 67 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstRefFunctionType = OutputImagePixelType (const Input1ImagePixelType &, const Input2ImagePixelType &)

Definition at line 97 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::DecoratedInput1ImagePixelType = SimpleDataObjectDecorator<Input1ImagePixelType>

Definition at line 80 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::DecoratedInput2ImagePixelType = SimpleDataObjectDecorator<Input2ImagePixelType>

Definition at line 86 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::FunctionType = OutputImagePixelType (*)(const Input1ImagePixelType &, const Input2ImagePixelType &)

Definition at line 94 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input1ImagePixelType = typename Input1ImageType::PixelType

Definition at line 79 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input1ImagePointer = typename Input1ImageType::ConstPointer

Definition at line 77 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input1ImageRegionType = typename Input1ImageType::RegionType

Definition at line 78 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input1ImageType = TInputImage1

Some convenient type alias.

Definition at line 76 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input2ImagePixelType = typename Input2ImageType::PixelType

Definition at line 85 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input2ImagePointer = typename Input2ImageType::ConstPointer

Definition at line 83 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input2ImageRegionType = typename Input2ImageType::RegionType

Definition at line 84 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Input2ImageType = TInputImage2

Definition at line 82 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 91 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 89 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 90 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::OutputImageType = TOutputImage

Definition at line 88 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer = SmartPointer< Self >

Definition at line 66 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self = BinaryGeneratorImageFilter

Standard class type aliases.

Definition at line 64 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass = InPlaceImageFilter< TInputImage1, TOutputImage >

Definition at line 65 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

using itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::ValueFunctionType = OutputImagePixelType (Input1ImagePixelType, Input2ImagePixelType)

Definition at line 99 of file itkBinaryGeneratorImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::BinaryGeneratorImageFilter ( )

protected

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::~BinaryGeneratorImageFilter ( )

overrideprotecteddefault

Member Function Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::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::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueAdditionImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::PowImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MagnitudeAndPhaseToComplexImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AbsoluteValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SquaredDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::XorImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AndImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::OrImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ModulusImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread )

overrideprotectedvirtual

BinaryGeneratorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread.

The template method is instantiated by the SetFunctor method, and the generated code is run during the update.

See Also

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

template<typename TFunctor >

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::DynamicThreadedGenerateDataWithFunctor ( const TFunctor &  , const OutputImageRegionType &  outputRegionForThread  )

protected

BinaryGeneratorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread.

The template method is instantiated by the SetFunctor method, and the generated code is run during the update.

See Also

ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::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.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

const Input2ImagePixelType& itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::GetConstant ( ) const

inline

Set the second operand as a constant.

Definition at line 127 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual const Input1ImagePixelType& itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::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>

virtual const Input2ImagePixelType& itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::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>

virtual const char* itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::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::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >, itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueAdditionImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::PowImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MagnitudeAndPhaseToComplexImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ConstrainedValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AbsoluteValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SquaredDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AddImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >, itk::DivideImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::XorImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::AndImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::OrImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::ModulusImageFilter< TInputImage1, TInputImage2, TOutputImage >, itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >, and itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

static Pointer itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetConstant ( Input2ImagePixelType  ct )

inline

Set the second operand as a constant.

Definition at line 123 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetConstant1 ( const Input1ImagePixelType &  input1 )

virtual

Set the first operand as a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetConstant2 ( const Input2ImagePixelType &  input2 )

virtual

Set the second operand as a constant.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetFunctor ( const std::function< ConstRefFunctionType > &  f )

inline

Set the pixel functor

The functor defines an operation done per pixel.

Definition at line 142 of file itkBinaryGeneratorImageFilter.h.

Referenced by itk::AbsoluteValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >::AbsoluteValueDifferenceImageFilter(), itk::AndImageFilter< TInputImage1, TInputImage2, TOutputImage >::AndImageFilter(), itk::Atan2ImageFilter< TInputImage1, TInputImage2, TOutputImage >::Atan2ImageFilter(), itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >::BeforeThreadedGenerateData(), itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::BeforeThreadedGenerateData(), itk::BinaryMagnitudeImageFilter< TInputImage1, TInputImage2, TOutputImage >::BinaryMagnitudeImageFilter(), itk::ConstrainedValueAdditionImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstrainedValueAdditionImageFilter(), itk::ConstrainedValueDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstrainedValueDifferenceImageFilter(), itk::JoinImageFilter< TInputImage1, TInputImage2 >::JoinImageFilter(), itk::MagnitudeAndPhaseToComplexImageFilter< TInputImage1, TInputImage2, TOutputImage >::MagnitudeAndPhaseToComplexImageFilter(), itk::MaximumImageFilter< TInputImage1, TInputImage2, TOutputImage >::MaximumImageFilter(), itk::MinimumImageFilter< TInputImage1, TInputImage2, TOutputImage >::MinimumImageFilter(), itk::OrImageFilter< TInputImage1, TInputImage2, TOutputImage >::OrImageFilter(), itk::PowImageFilter< TInputImage1, TInputImage2, TOutputImage >::PowImageFilter(), itk::SquaredDifferenceImageFilter< TInputImage1, TInputImage2, TOutputImage >::SquaredDifferenceImageFilter(), itk::SubtractImageFilter< TInputImage1, TInputImage2, TOutputImage >::SubtractImageFilter(), and itk::XorImageFilter< TInputImage1, TInputImage2, TOutputImage >::XorImageFilter().

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetFunctor ( const std::function< ValueFunctionType > &  f )

inline

Definition at line 150 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetFunctor ( ConstRefFunctionType *  funcPointer )

inline

Set the pixel functor by a C function pointer

The functor defines an operation done per pixel.

Definition at line 163 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetFunctor ( ValueFunctionType *  funcPointer )

inline

Definition at line 172 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

template<typename TFunctor >

void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetFunctor ( const TFunctor &  functor )

inline

Set the pixel functor by a "Functor Object"

The functor defines an operation done per pixel. A single copy of the argument is created an used for all threads, so the functor must be concurrent thread-safe. The functor must a have an operator() method which accept arguments of Input1ImagePixelType, Input2ImagePixelType.

Definition at line 190 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput1 ( const TInputImage1 *  image1 )

virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput1 ( const DecoratedInput1ImagePixelType *  input1 )

virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput1 ( const Input1ImagePixelType &  input1 )

virtual

Connect the first operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput2 ( const TInputImage2 *  image2 )

virtual

Connect the second operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput2 ( const DecoratedInput2ImagePixelType *  input2 )

virtual

Connect the second operand for pixel-wise operation.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

virtual void itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetInput2 ( const Input2ImagePixelType &  input2 )

virtual

Connect the second operand for pixel-wise operation.

Member Data Documentation

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

constexpr unsigned int itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::InputImage1Dimension = TInputImage1::ImageDimension

static

ImageDimension constants

Definition at line 203 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

constexpr unsigned int itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::InputImage2Dimension = TInputImage2::ImageDimension

static

ImageDimension constants

Definition at line 205 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

std::function<void(const OutputImageRegionType &)> itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::m_DynamicThreadedGenerateDataFunction

private

Definition at line 244 of file itkBinaryGeneratorImageFilter.h.

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

constexpr unsigned int itk::BinaryGeneratorImageFilter< TInputImage1, TInputImage2, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension constants

Definition at line 207 of file itkBinaryGeneratorImageFilter.h.

---

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

• itkBinaryGeneratorImageFilter.h