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

#include <itkMultiplyImageFilter.h>

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

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

List of all members.

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

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::MultiplyOperator< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType >) Input1Input2OutputMultiplyOperatorCheck
Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >
virtual const Input1ImagePixelType &	GetConstant1 () const
virtual const Input2ImagePixelType &	GetConstant2 () const
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
virtual void	SetConstant1 (const Input1ImagePixelType &input1)
	typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(InputImage2Dimension) >) SameDimensionCheck1
	typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(OutputImageDimension) >) SameDimensionCheck2
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
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 (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage1 *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Protected Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >
	BinaryFunctorImageFilter ()
virtual void	GenerateOutputInformation ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~BinaryFunctorImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) 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)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()
	MultiplyImageFilter ()
virtual	~MultiplyImageFilter ()
	MultiplyImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Static Public Attributes inherited from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >
static const unsigned int	InputImage1Dimension
static const unsigned int	InputImage2Dimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage1, TOutputImage >
static const unsigned int	InputImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage1, TOutputImage >
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

---

Detailed Description

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>
class itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >

Pixel-wise multiplication of two images.

This class is templated over the types of the two input images and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.

Wiki Examples:

• All Examples

• Multiply two images together

• Multiply every pixel in an image by a constant

Definition at line 70 of file itkMultiplyImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef SmartPointer< const Self > itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::ConstPointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 88 of file itkMultiplyImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef SmartPointer< Self > itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 87 of file itkMultiplyImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef MultiplyImageFilter itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 80 of file itkMultiplyImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

typedef BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > > itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

Definition at line 86 of file itkMultiplyImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

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

inlineprotected

End concept checking

Definition at line 107 of file itkMultiplyImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::~MultiplyImageFilter ( )

inlineprotectedvirtual

End concept checking

Definition at line 108 of file itkMultiplyImageFilter.h.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::MultiplyImageFilter ( const Self &  )

private

End concept checking

---

Member Function Documentation

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual::itk::LightObject::Pointer itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

virtual const char* itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

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

static

Method for creation through the object factory.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

Reimplemented in itk::MultiplyByConstantImageFilter< TInputImage, TConstant, TOutputImage >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

void itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::operator= ( const Self &  )

private

End concept checking

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::Mult< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >.

template<class TInputImage1, class TInputImage2 = TInputImage1, class TOutputImage = TInputImage1>

itk::MultiplyImageFilter< TInputImage1, TInputImage2, TOutputImage >::typedef

(

Concept::MultiplyOperator< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType >

)

Begin concept checking This class requires Input1Input2OutputMultiplyOperatorCheck in the form of ( Concept::MultiplyOperator< typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType > )

---

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

• itkMultiplyImageFilter.h