#include <itkSimilarityIndexImageFilter.h>

Inheritance diagram for itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >:

Collaboration diagram for itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >:

Detailed Description

template<typename TInputImage1, typename TInputImage2>
class itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >

Measures the similarity between the set of non-zero pixels of two images.

SimilarityIndexImageFilter measures the similarity between the set non-zero pixels of two images using the following formula:

$S = \frac{2 | A \cap B |}{|A| + |B|}$

where $A$ and $B$ are respectively the set of non-zero pixels in the first and second input images. Operator $|\cdot|$ represents the size of a set and $\cap$ represents the intersection of two sets.

The measure is derived from a reliability measure known as the kappa statistic. $S$ is sensitive to both differences in size and in location and have been in the literature for comparing two segmentation masks. For more information see: "Morphometric Analysis of White Matter Lesions in MR Images: Method and Validation", A. P. Zijdenbos, B. M. Dawant, R. A. Margolin and A. C. Palmer, IEEE Trans. on Medical Imaging, 13(4) pp 716-724,1994

This filter requires the largest possible region of the first image and the same corresponding region in the second image. It behaves as filter with two input and one output. Thus it can be inserted in a pipeline with other filters. The filter passes the first input through unmodified.

This filter is templated over the two input image type. It assume both image have the same number of dimensions.

Definition at line 60 of file itkSimilarityIndexImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef TInputImage1::IndexType	IndexType

typedef TInputImage1::ConstPointer	InputImage1ConstPointer

typedef TInputImage1::PixelType	InputImage1PixelType

typedef TInputImage1::Pointer	InputImage1Pointer

typedef TInputImage1	InputImage1Type

typedef TInputImage2::ConstPointer	InputImage2ConstPointer

typedef TInputImage2::PixelType	InputImage2PixelType

typedef TInputImage2::Pointer	InputImage2Pointer

typedef TInputImage2	InputImage2Type

typedef SmartPointer< Self >	Pointer

typedef NumericTraits < InputImage1PixelType > ::RealType	RealType

typedef TInputImage1::RegionType	RegionType

typedef SimilarityIndexImageFilter	Self

typedef TInputImage1::SizeType	SizeType

typedef ImageToImageFilter < TInputImage1, TInputImage1 >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage1	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TInputImage1 >	Superclass

Public Types inherited from itk::ImageSource< TInputImage1 >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TInputImage1	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef MultiThreader	MultiThreaderType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

const InputImage1Type *	GetInput1 (void)

const InputImage2Type *	GetInput2 ()

virtual const char *	GetNameOfClass () const

virtual RealType	GetSimilarityIndex () const

void	SetInput1 (const InputImage1Type *image)

void	SetInput2 (const InputImage2Type *image)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage1 *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TInputImage1 >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

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

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () 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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage1::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage1 >
static const unsigned int	OutputImageDimension

Protected Member Functions
void	AfterThreadedGenerateData () override

void	AllocateOutputs () override

void	BeforeThreadedGenerateData () override

void	EnlargeOutputRequestedRegion (DataObject *data) override

void	GenerateInputRequestedRegion () override

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

	SimilarityIndexImageFilter ()

void	ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType threadId) override

	~SimilarityIndexImageFilter () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

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

	ImageToImageFilter ()

virtual void	VerifyInputInformation () override

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TInputImage1 >
virtual void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

virtual	~ImageSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

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

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions ()

	~ProcessObject () override

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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 () 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
Array< SizeValueType >	m_CountOfImage1

Array< SizeValueType >	m_CountOfImage2

Array< SizeValueType >	m_CountOfIntersection

RealType	m_SimilarityIndex

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TInputImage1 >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage1 , typename TInputImage2 >

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

Definition at line 68 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::IndexType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::IndexType

Definition at line 86 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::ConstPointer itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1ConstPointer

Definition at line 81 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::PixelType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1PixelType

Definition at line 88 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::Pointer itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1Pointer

Definition at line 79 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1 itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1Type

Image related typedefs.

Definition at line 74 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage2::ConstPointer itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2ConstPointer

Definition at line 82 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage2::PixelType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2PixelType

Definition at line 89 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage2::Pointer itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2Pointer

Definition at line 80 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage2 itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2Type

Definition at line 78 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef SmartPointer< Self > itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Pointer

Definition at line 67 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef NumericTraits< InputImage1PixelType >::RealType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::RealType

Type to use form computations.

Definition at line 96 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::RegionType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::RegionType

Definition at line 84 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef SimilarityIndexImageFilter itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Self

Standard Self typedef

Definition at line 65 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef TInputImage1::SizeType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SizeType

Definition at line 85 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

typedef ImageToImageFilter< TInputImage1, TInputImage1 > itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Superclass

Definition at line 66 of file itkSimilarityIndexImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage1 , typename TInputImage2 >

itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SimilarityIndexImageFilter ( )

protected

template<typename TInputImage1 , typename TInputImage2 >

itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::~SimilarityIndexImageFilter ( )

inlineoverrideprotected

Definition at line 126 of file itkSimilarityIndexImageFilter.h.

Member Function Documentation

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::AfterThreadedGenerateData ( )

overrideprotectedvirtual

Do final mean and variance computation from data accumulated in threads.

Reimplemented from itk::ImageSource< TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::AllocateOutputs ( )

overrideprotectedvirtual

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Reimplemented from itk::ImageSource< TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

virtual::itk::LightObject::Pointer itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::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.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GenerateInputRequestedRegion ( void )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage1, TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

const InputImage1Type* itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GetInput1 ( void )

inline

Get the first input.

Definition at line 106 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

const InputImage2Type* itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GetInput2 ( )

Get the secong input.

template<typename TInputImage1 , typename TInputImage2 >

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

virtual

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TInputImage1, TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

virtual RealType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GetSimilarityIndex ( ) const

virtual

Return the computed similarity index.

template<typename TInputImage1 , typename TInputImage2 >

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

static

Method for creation through the object factory.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< TInputImage1, TInputImage1 >.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SetInput1 ( const InputImage1Type * image )

inline

Set the first input.

Definition at line 99 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SetInput2 ( const InputImage2Type * image )

Set the second input.

template<typename TInputImage1 , typename TInputImage2 >

void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::ThreadedGenerateData	(	const RegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

overrideprotected

Multi-thread version GenerateData.

Member Data Documentation

template<typename TInputImage1 , typename TInputImage2 >

const unsigned int itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::ImageDimension = TInputImage1::ImageDimension

static

Image related typedefs.

Definition at line 93 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

Array< SizeValueType > itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfImage1

private

Definition at line 156 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

Array< SizeValueType > itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfImage2

private

Definition at line 157 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

Array< SizeValueType > itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfIntersection

private

Definition at line 158 of file itkSimilarityIndexImageFilter.h.

template<typename TInputImage1 , typename TInputImage2 >

RealType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_SimilarityIndex

private

Definition at line 152 of file itkSimilarityIndexImageFilter.h.

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

itkSimilarityIndexImageFilter.h

Detailed Description

template<typename TInputImage1, typename TInputImage2> class itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TInputImage1, typename TInputImage2>
class itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >