ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 > Class Template Reference

#include <itkSimilarityIndexImageFilter.h>

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 61 of file itkSimilarityIndexImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage1::IndexType
 
using InputImage1ConstPointer = typename TInputImage1::ConstPointer
 
using InputImage1PixelType = typename TInputImage1::PixelType
 
using InputImage1Pointer = typename TInputImage1::Pointer
 
using InputImage1Type = TInputImage1
 
using InputImage2ConstPointer = typename TInputImage2::ConstPointer
 
using InputImage2PixelType = typename TInputImage2::PixelType
 
using InputImage2Pointer = typename TInputImage2::Pointer
 
using InputImage2Type = TInputImage2
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< InputImage1PixelType >::RealType
 
using RegionType = typename TInputImage1::RegionType
 
using Self = SimilarityIndexImageFilter
 
using SizeType = typename TInputImage1::SizeType
 
using Superclass = ImageToImageFilter< TInputImage1, TInputImage1 >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage1
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TInputImage1 >
 
- Public Types inherited from itk::ImageSource< TInputImage1 >
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 = TInputImage1
 
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

const InputImage1TypeGetInput1 ()
 
const InputImage2TypeGetInput2 ()
 
const char * GetNameOfClass () const override
 
virtual RealType GetSimilarityIndex () const
 
void SetInput1 (const InputImage1Type *image)
 
void SetInput2 (const InputImage2Type *image)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
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< TInputImage1 >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

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

Static Public Attributes

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

Protected Member Functions

void AfterThreadedGenerateData () override
 
void AllocateOutputs () override
 
void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const RegionType &) 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=default
 
- 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)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TInputImage1 >
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void 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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

Array< SizeValueTypem_CountOfImage1 {}
 
Array< SizeValueTypem_CountOfImage2 {}
 
Array< SizeValueTypem_CountOfIntersection {}
 
RealType m_SimilarityIndex {}
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage1, TInputImage1 >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TInputImage1 >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
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< TInputImage1 >
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

◆ ConstPointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::ConstPointer = SmartPointer<const Self>

Definition at line 70 of file itkSimilarityIndexImageFilter.h.

◆ IndexType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::IndexType = typename TInputImage1::IndexType

Definition at line 88 of file itkSimilarityIndexImageFilter.h.

◆ InputImage1ConstPointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1ConstPointer = typename TInputImage1::ConstPointer

Definition at line 83 of file itkSimilarityIndexImageFilter.h.

◆ InputImage1PixelType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1PixelType = typename TInputImage1::PixelType

Definition at line 90 of file itkSimilarityIndexImageFilter.h.

◆ InputImage1Pointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1Pointer = typename TInputImage1::Pointer

Definition at line 81 of file itkSimilarityIndexImageFilter.h.

◆ InputImage1Type

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage1Type = TInputImage1

Image related type alias.

Definition at line 79 of file itkSimilarityIndexImageFilter.h.

◆ InputImage2ConstPointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2ConstPointer = typename TInputImage2::ConstPointer

Definition at line 84 of file itkSimilarityIndexImageFilter.h.

◆ InputImage2PixelType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2PixelType = typename TInputImage2::PixelType

Definition at line 91 of file itkSimilarityIndexImageFilter.h.

◆ InputImage2Pointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2Pointer = typename TInputImage2::Pointer

Definition at line 82 of file itkSimilarityIndexImageFilter.h.

◆ InputImage2Type

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::InputImage2Type = TInputImage2

Definition at line 80 of file itkSimilarityIndexImageFilter.h.

◆ Pointer

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Pointer = SmartPointer<Self>

Definition at line 69 of file itkSimilarityIndexImageFilter.h.

◆ RealType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::RealType = typename NumericTraits<InputImage1PixelType>::RealType

Type to use form computations.

Definition at line 97 of file itkSimilarityIndexImageFilter.h.

◆ RegionType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::RegionType = typename TInputImage1::RegionType

Definition at line 86 of file itkSimilarityIndexImageFilter.h.

◆ Self

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Self = SimilarityIndexImageFilter

Standard Self type alias

Definition at line 67 of file itkSimilarityIndexImageFilter.h.

◆ SizeType

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SizeType = typename TInputImage1::SizeType

Definition at line 87 of file itkSimilarityIndexImageFilter.h.

◆ Superclass

template<typename TInputImage1 , typename TInputImage2 >
using itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::Superclass = ImageToImageFilter<TInputImage1, TInputImage1>

Definition at line 68 of file itkSimilarityIndexImageFilter.h.

Constructor & Destructor Documentation

◆ SimilarityIndexImageFilter()

template<typename TInputImage1 , typename TInputImage2 >
itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SimilarityIndexImageFilter ( )
protected

◆ ~SimilarityIndexImageFilter()

template<typename TInputImage1 , typename TInputImage2 >
itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::~SimilarityIndexImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

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

◆ AllocateOutputs()

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

◆ BeforeThreadedGenerateData()

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

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TInputImage1 >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage1 , typename TInputImage2 >
void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::DynamicThreadedGenerateData ( const RegionType )
inlineoverrideprotected

Definition at line 156 of file itkSimilarityIndexImageFilter.h.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage1 , typename TInputImage2 >
void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::EnlargeOutputRequestedRegion ( DataObject )
overrideprotectedvirtual

Give the process object a chance to indicate 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.

◆ GenerateInputRequestedRegion()

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

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

Reimplemented from itk::ProcessObject.

◆ GetInput1()

template<typename TInputImage1 , typename TInputImage2 >
const InputImage1Type* itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GetInput1 ( )
inline

Get the first input.

Definition at line 112 of file itkSimilarityIndexImageFilter.h.

◆ GetInput2()

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

Get the second input.

◆ GetNameOfClass()

template<typename TInputImage1 , typename TInputImage2 >
const char* itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::GetNameOfClass ( ) const
overridevirtual

◆ GetSimilarityIndex()

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

Return the computed similarity index.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

◆ SetInput1()

template<typename TInputImage1 , typename TInputImage2 >
void itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::SetInput1 ( const InputImage1Type image)
inline

Set the first input.

Definition at line 101 of file itkSimilarityIndexImageFilter.h.

◆ SetInput2()

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

Set the second input.

◆ ThreadedGenerateData()

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

Multi-thread version GenerateData.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage1 , typename TInputImage2 >
constexpr unsigned int itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::ImageDimension = TInputImage1::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 94 of file itkSimilarityIndexImageFilter.h.

◆ m_CountOfImage1

template<typename TInputImage1 , typename TInputImage2 >
Array<SizeValueType> itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfImage1 {}
private

Definition at line 172 of file itkSimilarityIndexImageFilter.h.

◆ m_CountOfImage2

template<typename TInputImage1 , typename TInputImage2 >
Array<SizeValueType> itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfImage2 {}
private

Definition at line 173 of file itkSimilarityIndexImageFilter.h.

◆ m_CountOfIntersection

template<typename TInputImage1 , typename TInputImage2 >
Array<SizeValueType> itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_CountOfIntersection {}
private

Definition at line 174 of file itkSimilarityIndexImageFilter.h.

◆ m_SimilarityIndex

template<typename TInputImage1 , typename TInputImage2 >
RealType itk::SimilarityIndexImageFilter< TInputImage1, TInputImage2 >::m_SimilarityIndex {}
private

Definition at line 170 of file itkSimilarityIndexImageFilter.h.


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