#include <itkBinaryGeneratorImageFilter.h>

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

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

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 char *	GetNameOfClass () const

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual bool	CanRunInPlace () const

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

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 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 void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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 constexpr unsigned int	InputImage1Dimension = TInputImage1::ImageDimension

static constexpr unsigned int	InputImage2Dimension = TInputImage2::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

std::function< void(const OutputImageRegionType &)>	m_DynamicThreadedGenerateDataFunction

virtual void	SetInput1 (const TInputImage1 *image1)

virtual void	SetInput1 (const DecoratedInput1ImagePixelType *input1)

virtual void	SetInput1 (const Input1ImagePixelType &input1)

virtual void	SetConstant1 (const Input1ImagePixelType &input1)

virtual const Input1ImagePixelType &	GetConstant1 () const

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

virtual const Input2ImagePixelType &	GetConstant2 () const

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)

	BinaryGeneratorImageFilter ()

	~BinaryGeneratorImageFilter () override=default

template<typename TFunctor >
void	DynamicThreadedGenerateDataWithFunctor (const TFunctor &, const OutputImageRegionType &outputRegionForThread)

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	GenerateOutputInformation () override

Additional Inherited Members
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 Types inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
	InPlaceImageFilter ()=default

	~InPlaceImageFilter () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

void	AllocateOutputs () override

void	ReleaseInputs () override

virtual bool	GetRunningInPlace () const

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

	ImageToImageFilter ()

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

void	GenerateInputRequestedRegion () override

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
	ImageSource ()

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	PropagateResetPipeline ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

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
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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 ways:

traditional ITK "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 56 of file itkBinaryGeneratorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 65 of file itkBinaryGeneratorImageFilter.h.

◆ ConstRefFunctionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 93 of file itkBinaryGeneratorImageFilter.h.

◆ DecoratedInput1ImagePixelType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 78 of file itkBinaryGeneratorImageFilter.h.

◆ DecoratedInput2ImagePixelType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 84 of file itkBinaryGeneratorImageFilter.h.

◆ FunctionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 91 of file itkBinaryGeneratorImageFilter.h.

◆ Input1ImagePixelType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 77 of file itkBinaryGeneratorImageFilter.h.

◆ Input1ImagePointer

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 75 of file itkBinaryGeneratorImageFilter.h.

◆ Input1ImageRegionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 76 of file itkBinaryGeneratorImageFilter.h.

◆ Input1ImageType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Some convenient type alias.

Definition at line 74 of file itkBinaryGeneratorImageFilter.h.

◆ Input2ImagePixelType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 83 of file itkBinaryGeneratorImageFilter.h.

◆ Input2ImagePointer

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 81 of file itkBinaryGeneratorImageFilter.h.

◆ Input2ImageRegionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 82 of file itkBinaryGeneratorImageFilter.h.

◆ Input2ImageType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 80 of file itkBinaryGeneratorImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 89 of file itkBinaryGeneratorImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 87 of file itkBinaryGeneratorImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 88 of file itkBinaryGeneratorImageFilter.h.

◆ OutputImageType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 86 of file itkBinaryGeneratorImageFilter.h.

◆ Pointer

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 64 of file itkBinaryGeneratorImageFilter.h.

◆ Self

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Standard class type aliases.

Definition at line 62 of file itkBinaryGeneratorImageFilter.h.

◆ Superclass

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 63 of file itkBinaryGeneratorImageFilter.h.

◆ ValueFunctionType

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

Definition at line 94 of file itkBinaryGeneratorImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryGeneratorImageFilter()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

protected

ImageDimension constants

◆ ~BinaryGeneratorImageFilter()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

overrideprotecteddefault

ImageDimension constants

Member Function Documentation

◆ CreateAnother()

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.

◆ DynamicThreadedGenerateData()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

overrideprotectedvirtual

ImageDimension constants

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateDataWithFunctor()

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

◆ GenerateOutputInformation()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

overrideprotectedvirtual

ImageDimension constants

Reimplemented from itk::ProcessObject.

◆ GetConstant()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

inline

ImageDimension constants

Definition at line 133 of file itkBinaryGeneratorImageFilter.h.

◆ GetConstant1()

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 thrown if the first operand is not a constant.

◆ GetConstant2()

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 thrown if the second operand is not a constant.

◆ GetNameOfClass()

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

◆ New()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

static

Method for creation through the object factory.

◆ SetConstant()

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

inline

ImageDimension constants

Definition at line 128 of file itkBinaryGeneratorImageFilter.h.

◆ SetConstant1()

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.

◆ SetConstant2()

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.

◆ SetFunctor() [1/5]

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 150 of file itkBinaryGeneratorImageFilter.h.

◆ SetFunctor() [2/5]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

inline

ImageDimension constants

Definition at line 161 of file itkBinaryGeneratorImageFilter.h.

◆ SetFunctor() [3/5]

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 206 of file itkBinaryGeneratorImageFilter.h.

◆ SetFunctor() [4/5]

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 176 of file itkBinaryGeneratorImageFilter.h.

◆ SetFunctor() [5/5]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

inline

ImageDimension constants

Definition at line 186 of file itkBinaryGeneratorImageFilter.h.

◆ SetInput1() [1/3]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

virtual

ImageDimension constants

◆ SetInput1() [2/3]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

virtual

ImageDimension constants

◆ SetInput1() [3/3]

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.

◆ SetInput2() [1/3]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

virtual

ImageDimension constants

◆ SetInput2() [2/3]

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

virtual

ImageDimension constants

◆ SetInput2() [3/3]

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.

Member Data Documentation

◆ InputImage1Dimension

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

staticconstexpr

ImageDimension constants

Definition at line 220 of file itkBinaryGeneratorImageFilter.h.

◆ InputImage2Dimension

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

staticconstexpr

ImageDimension constants

Definition at line 221 of file itkBinaryGeneratorImageFilter.h.

◆ m_DynamicThreadedGenerateDataFunction

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

private

ImageDimension constants

Definition at line 262 of file itkBinaryGeneratorImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage1, typename TInputImage2, typename TOutputImage>

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

staticconstexpr

ImageDimension constants

Definition at line 222 of file itkBinaryGeneratorImageFilter.h.

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

itkBinaryGeneratorImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ ConstRefFunctionType

◆ DecoratedInput1ImagePixelType

◆ DecoratedInput2ImagePixelType

◆ FunctionType

◆ Input1ImagePixelType

◆ Input1ImagePointer

◆ Input1ImageRegionType

◆ Input1ImageType

◆ Input2ImagePixelType

◆ Input2ImagePointer

◆ Input2ImageRegionType

◆ Input2ImageType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

◆ ValueFunctionType

Constructor & Destructor Documentation

◆ BinaryGeneratorImageFilter()

◆ ~BinaryGeneratorImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ DynamicThreadedGenerateDataWithFunctor()

◆ GenerateOutputInformation()

◆ GetConstant()

◆ GetConstant1()

◆ GetConstant2()

◆ GetNameOfClass()

◆ New()

◆ SetConstant()

◆ SetConstant1()

◆ SetConstant2()

◆ SetFunctor() [1/5]

◆ SetFunctor() [2/5]

◆ SetFunctor() [3/5]

◆ SetFunctor() [4/5]

◆ SetFunctor() [5/5]

◆ SetInput1() [1/3]

◆ SetInput1() [2/3]

◆ SetInput1() [3/3]

◆ SetInput2() [1/3]

◆ SetInput2() [2/3]

◆ SetInput2() [3/3]

Member Data Documentation

◆ InputImage1Dimension

◆ InputImage2Dimension

◆ m_DynamicThreadedGenerateDataFunction

◆ OutputImageDimension

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