irtkGenericHistogramSimilarityMetric Class Reference

#include <irtkGenericHistogramSimilarityMetric.h>

Inheritance diagram for irtkGenericHistogramSimilarityMetric:

[legend]

Collaboration diagram for irtkGenericHistogramSimilarityMetric:

[legend]

List of all members.

---

Detailed Description

Generic class for histogram-based voxel similarity measures.

This class implements various voxel similarity measures, including sums-of-squared differences, cross-correlation, correlation ratio, mutual information and normalised mutual information.

Definition at line 26 of file irtkGenericHistogramSimilarityMetric.h.

Public Member Functions
	irtkGenericHistogramSimilarityMetric (irtkSimilarityMeasure=MI, int=64, int=64)
	Constructor.
virtual void	Reset ()
	Resets the metric.
virtual void	Reset (irtkGenericHistogramSimilarityMetric &metric)
	Resets the metric.
virtual void	PutMin (double targetMin, double sourceMin)
	Puts the min for the metric.
virtual void	GetMin (double *targetMin, double *sourceMin) const
	Gets the min for the metric.
virtual void	PutMax (double targetMax, double sourceMax)
	Puts the max for the metric.
virtual void	GetMax (double *targetMax, double *sourceMax) const
	Gets the max for the metric.
virtual void	Add (int targetBin, int sourceBin, int count=1)
	Adds to a bin for a particular time.
virtual void	Delete (int targetBin, int sourceBin, int count=1)
	Deletes from a bin for a particular time.
virtual int	GetNumberOfBinsX () const
	Returns number of bins in histogram.
virtual int	GetNumberOfBinsY () const
	Returns number of bins in histogram.
virtual int	NumberOfSamples () const
	Returns number of samples in histogram.
virtual void	SetMeasure (irtkSimilarityMeasure measure)
	Sets the similarity measure.
virtual irtkSimilarityMeasure	GetMeasure () const
	Gets the similarity measure.
virtual double	Evaluate ()
	Evaluate similarity measure.

---

Member Function Documentation

void irtkGenericHistogramSimilarityMetric::Reset

(

irtkGenericHistogramSimilarityMetric &

metric

)

[inline, virtual]

Resets the metric.

Parameters:

metric

To metric to reset with.

Definition at line 107 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::Reset().

void irtkGenericHistogramSimilarityMetric::PutMin	(	double	targetMin,
		double	sourceMin
	)			[inline, virtual]

Puts the min for the metric.

Parameters:

	targetMin	The target min.
	sourceMin	The source min.

Definition at line 112 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::PutMin().

void irtkGenericHistogramSimilarityMetric::GetMin	(	double *	targetMin,
		double *	sourceMin
	)			const [inline, virtual]

Gets the min for the metric.

Parameters:

	targetMin	The target min.
	sourceMin	The source min.

Definition at line 117 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::GetMin().

void irtkGenericHistogramSimilarityMetric::PutMax	(	double	targetMax,
		double	sourceMax
	)			[inline, virtual]

Puts the max for the metric.

Parameters:

	targetMax	The target max.
	sourceMax	The source max.

Definition at line 122 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::PutMax().

void irtkGenericHistogramSimilarityMetric::GetMax	(	double *	targetMax,
		double *	sourceMax
	)			const [inline, virtual]

Gets the max for the metric.

Parameters:

	targetMax	The target max.
	sourceMax	The source max.

Definition at line 127 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::GetMax().

void irtkGenericHistogramSimilarityMetric::Add	(	int	targetBin,
		int	sourceBin,
		int	count = 1
	)			[inline, virtual]

Adds to a bin for a particular time.

Parameters:

	targetBin	Index to target bin.
	sourceBin	Index to source bin.
	count	The number to add.

Definition at line 157 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::Add().

void irtkGenericHistogramSimilarityMetric::Delete	(	int	targetBin,
		int	sourceBin,
		int	count = 1
	)			[inline, virtual]

Deletes from a bin for a particular time.

Parameters:

	targetBin	Index to target bin.
	sourceBin	Index to source bin.
	count	The number to delete.

Definition at line 162 of file irtkGenericHistogramSimilarityMetric.h.

References irtkHistogramSimilarityMetric::_histogram, and irtkHistogram_2D::Delete().

void irtkGenericHistogramSimilarityMetric::SetMeasure

(

irtkSimilarityMeasure

measure

)

[inline, virtual]

Sets the similarity measure.

Parameters:

measure

The similarity measure.

Definition at line 132 of file irtkGenericHistogramSimilarityMetric.h.

irtkSimilarityMeasure irtkGenericHistogramSimilarityMetric::GetMeasure

(

)

const [inline, virtual]

Gets the similarity measure.

Definition at line 137 of file irtkGenericHistogramSimilarityMetric.h.

---

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

• /vol/vipdata/irtk/packages/registration/include/irtkGenericHistogramSimilarityMetric.h

Generated on Mon Mar 23 16:56:04 2009 for IRTK by Doxygen 1.5.4