itk::MammogramPectoralisFitMetric< TInputImage > Class Template Reference

A metric to compute the similarity between an image and a pectoral shape model. More...

Inheritance diagram for itk::MammogramPectoralisFitMetric< TInputImage >:

Collaboration diagram for itk::MammogramPectoralisFitMetric< TInputImage >:

Public Types
typedef MammogramPectoralisFitMetric	Self
typedef SingleValuedCostFunction	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::SpacingType	InputImageSpacingType
typedef InputImageType::PointType	InputImagePointType
typedef InputImageType::IndexType	InputImageIndexType
typedef InputImageType::SizeType	InputImageSizeType
typedef itk::ImageRegionIterator < TInputImage >	IteratorType
typedef itk::ImageRegionIteratorWithIndex < TInputImage >	IteratorWithIndexType
typedef itk::ImageRegionConstIterator < TInputImage >	IteratorConstType
typedef itk::ImageRegionConstIteratorWithIndex < TInputImage >	IteratorWithIndexConstType
typedef float	TemplatePixelType
typedef itk::Image < TemplatePixelType, ImageDimension >	TemplateImageType
typedef TemplateImageType::Pointer	TemplateImagePointer
typedef TemplateImageType::ConstPointer	TemplateImageConstPointer
typedef TemplateImageType::RegionType	TemplateImageRegionType
typedef TemplateImageType::PixelType	TemplateImagePixelType
typedef TemplateImageType::SpacingType	TemplateImageSpacingType
typedef TemplateImageType::PointType	TemplateImagePointType
typedef TemplateImageType::IndexType	TemplateImageIndexType
typedef TemplateImageType::SizeType	TemplateImageSizeType
typedef itk::ImageRegionIterator < TemplateImageType >	TemplateIteratorType
typedef itk::ImageRegionIteratorWithIndex < TemplateImageType >	TemplateIteratorWithIndexType
typedef unsigned char	MaskPixelType
typedef itk::Image < MaskPixelType, ImageDimension >	MaskImageType
typedef MaskImageType::ConstPointer	MaskImageConstPointer
typedef MaskImageType::Pointer	MaskImagePointer
typedef MaskImageType::RegionType	MaskImageRegionType
typedef MaskImageType::SizeType	MaskImageSizeType
typedef MaskImageType::IndexType	MaskImageIndexType
typedef MaskImageType::SpacingType	MaskImageSpacingType
typedef itk::ImageRegionConstIterator < MaskImageType >	MaskIteratorType
typedef itk::ImageLinearConstIteratorWithIndex < MaskImageType >	MaskLineIteratorType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::MeasureType	MeasureType

Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
void	SetInputImage (const InputImageType *imInput)
void	SetMask (const MaskImageType *imMask)
	Set the optional mask image. More...
void	SetSSD (bool flag)
	Optimise SSD rather than normalised cross-correlation. More...
void	SetMinimumPectoralArea (double minPecArea)
	Set the minuimum pectoral area in mm^2. More...
virtual TemplateImageType *	GetImTemplate ()
	itkStaticConstMacro (ParametricSpaceDimension, unsigned int, 8)
unsigned int	GetNumberOfParameters (void) const override
void	GetParameters (const InputImagePointType &pecInterceptInMM, ParametersType &parameters)
void	GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const override
MeasureType	GetValueAtPecIntercept (const InputImagePointType &pecInterceptInMM)
MeasureType	GetValue (const ParametersType &parameters) const override
MeasureType	GetValueNCC (const ParametersType &parameters) const
MeasureType	GetValueSSD (const ParametersType &parameters) const
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
TemplateImagePointer	GetTemplate (void)
void	ClearTemplate (void)
void	GenerateTemplate (const ParametersType &parameters, double &tMean, double &tStdDev, double &nInside, double &nPixels, TemplateImageRegionType &templateRegion)

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	MammogramPectoralisFitMetric ()
virtual	~MammogramPectoralisFitMetric ()
	MammogramPectoralisFitMetric (const Self &)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const override
double	GradientAtMidpoint (const ParametersType &parameters) const

Protected Attributes
bool	m_flgOptimiseSSD
double	m_MinimumPectoralArea
double	m_TemplatePixelAreaInMM
InputImageRegionType	m_ImRegion
InputImageSpacingType	m_ImSpacing
InputImagePointType	m_ImOrigin
InputImageSizeType	m_ImSize
InputImagePointType	m_ImSizeInMM
InputImageConstPointer	m_InputImage
TemplateImagePointer	m_ImTemplate
MaskImageRegionType	m_MaskRegion
MaskImageConstPointer	m_Mask

Detailed Description

template<class TInputImage>
class itk::MammogramPectoralisFitMetric< TInputImage >

A metric to compute the similarity between an image and a pectoral shape model.

Caveats

• The mammogram is assumed to be have the chest wall of the left-hand edge so right mammograms should be flipped first.

Member Typedef Documentation

template<class TInputImage>

typedef SmartPointer< const Self > itk::MammogramPectoralisFitMetric< TInputImage >::ConstPointer

template<class TInputImage>

typedef Superclass::DerivativeType itk::MammogramPectoralisFitMetric< TInputImage >::DerivativeType

template<class TInputImage>

typedef InputImageType::ConstPointer itk::MammogramPectoralisFitMetric< TInputImage >::InputImageConstPointer

template<class TInputImage>

typedef InputImageType::IndexType itk::MammogramPectoralisFitMetric< TInputImage >::InputImageIndexType

template<class TInputImage>

typedef InputImageType::PixelType itk::MammogramPectoralisFitMetric< TInputImage >::InputImagePixelType

template<class TInputImage>

typedef InputImageType::Pointer itk::MammogramPectoralisFitMetric< TInputImage >::InputImagePointer

template<class TInputImage>

typedef InputImageType::PointType itk::MammogramPectoralisFitMetric< TInputImage >::InputImagePointType

template<class TInputImage>

typedef InputImageType::RegionType itk::MammogramPectoralisFitMetric< TInputImage >::InputImageRegionType

template<class TInputImage>

typedef InputImageType::SizeType itk::MammogramPectoralisFitMetric< TInputImage >::InputImageSizeType

template<class TInputImage>

typedef InputImageType::SpacingType itk::MammogramPectoralisFitMetric< TInputImage >::InputImageSpacingType

template<class TInputImage>

typedef TInputImage itk::MammogramPectoralisFitMetric< TInputImage >::InputImageType

Type of the input image

template<class TInputImage>

typedef itk::ImageRegionConstIterator< TInputImage > itk::MammogramPectoralisFitMetric< TInputImage >::IteratorConstType

template<class TInputImage>

typedef itk::ImageRegionIterator< TInputImage > itk::MammogramPectoralisFitMetric< TInputImage >::IteratorType

template<class TInputImage>

typedef itk::ImageRegionConstIteratorWithIndex< TInputImage > itk::MammogramPectoralisFitMetric< TInputImage >::IteratorWithIndexConstType

template<class TInputImage>

typedef itk::ImageRegionIteratorWithIndex< TInputImage > itk::MammogramPectoralisFitMetric< TInputImage >::IteratorWithIndexType

template<class TInputImage>

typedef MaskImageType::ConstPointer itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageConstPointer

template<class TInputImage>

typedef MaskImageType::IndexType itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageIndexType

template<class TInputImage>

typedef MaskImageType::Pointer itk::MammogramPectoralisFitMetric< TInputImage >::MaskImagePointer

template<class TInputImage>

typedef MaskImageType::RegionType itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageRegionType

template<class TInputImage>

typedef MaskImageType::SizeType itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageSizeType

template<class TInputImage>

typedef MaskImageType::SpacingType itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageSpacingType

template<class TInputImage>

typedef itk::Image<MaskPixelType, ImageDimension> itk::MammogramPectoralisFitMetric< TInputImage >::MaskImageType

template<class TInputImage>

typedef itk::ImageRegionConstIterator< MaskImageType > itk::MammogramPectoralisFitMetric< TInputImage >::MaskIteratorType

template<class TInputImage>

typedef itk::ImageLinearConstIteratorWithIndex< MaskImageType > itk::MammogramPectoralisFitMetric< TInputImage >::MaskLineIteratorType

template<class TInputImage>

typedef unsigned char itk::MammogramPectoralisFitMetric< TInputImage >::MaskPixelType

Optional mask image

template<class TInputImage>

typedef Superclass::MeasureType itk::MammogramPectoralisFitMetric< TInputImage >::MeasureType

template<class TInputImage>

typedef Superclass::ParametersType itk::MammogramPectoralisFitMetric< TInputImage >::ParametersType

template<class TInputImage>

typedef SmartPointer< Self > itk::MammogramPectoralisFitMetric< TInputImage >::Pointer

template<class TInputImage>

typedef MammogramPectoralisFitMetric itk::MammogramPectoralisFitMetric< TInputImage >::Self

template<class TInputImage>

typedef SingleValuedCostFunction itk::MammogramPectoralisFitMetric< TInputImage >::Superclass

template<class TInputImage>

typedef TemplateImageType::ConstPointer itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageConstPointer

template<class TInputImage>

typedef TemplateImageType::IndexType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageIndexType

template<class TInputImage>

typedef TemplateImageType::PixelType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImagePixelType

template<class TInputImage>

typedef TemplateImageType::Pointer itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImagePointer

template<class TInputImage>

typedef TemplateImageType::PointType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImagePointType

template<class TInputImage>

typedef TemplateImageType::RegionType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageRegionType

template<class TInputImage>

typedef TemplateImageType::SizeType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageSizeType

template<class TInputImage>

typedef TemplateImageType::SpacingType itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageSpacingType

template<class TInputImage>

typedef itk::Image<TemplatePixelType, ImageDimension> itk::MammogramPectoralisFitMetric< TInputImage >::TemplateImageType

template<class TInputImage>

typedef itk::ImageRegionIterator< TemplateImageType > itk::MammogramPectoralisFitMetric< TInputImage >::TemplateIteratorType

template<class TInputImage>

typedef itk::ImageRegionIteratorWithIndex< TemplateImageType > itk::MammogramPectoralisFitMetric< TInputImage >::TemplateIteratorWithIndexType

template<class TInputImage>

typedef float itk::MammogramPectoralisFitMetric< TInputImage >::TemplatePixelType

Type of the template image

Constructor & Destructor Documentation

template<class TInputImage>

itk::MammogramPectoralisFitMetric< TInputImage >::MammogramPectoralisFitMetric ( )

protected

template<class TInputImage>

virtual itk::MammogramPectoralisFitMetric< TInputImage >::~MammogramPectoralisFitMetric ( )

protectedvirtual

template<class TInputImage>

itk::MammogramPectoralisFitMetric< TInputImage >::MammogramPectoralisFitMetric ( const Self &  )

inlineprotected

Member Function Documentation

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::ClearTemplate

(

void

)

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::GenerateTemplate	(	const ParametersType &	parameters,
		double &	tMean,
		double &	tStdDev,
		double &	nInside,
		double &	nPixels,
		TemplateImageRegionType &	templateRegion
	)

template<class TInputImage>

virtual const char* itk::MammogramPectoralisFitMetric< TInputImage >::GetClassName ( ) const

virtual

Run-time type information (and related methods).

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::GetDerivative ( const ParametersType &  parameters, DerivativeType &  Derivative  ) const

inlineoverride

template<class TInputImage>

virtual TemplateImageType* itk::MammogramPectoralisFitMetric< TInputImage >::GetImTemplate ( )

virtual

Get the template image.

template<class TInputImage>

unsigned int itk::MammogramPectoralisFitMetric< TInputImage >::GetNumberOfParameters ( void  ) const

inlineoverride

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::GetParameters	(	const InputImagePointType &	pecInterceptInMM,
		ParametersType &	parameters
	)

template<class TInputImage>

TemplateImagePointer itk::MammogramPectoralisFitMetric< TInputImage >::GetTemplate ( void  )

inline

template<class TInputImage>

MeasureType itk::MammogramPectoralisFitMetric< TInputImage >::GetValue ( const ParametersType &  parameters ) const

override

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::GetValueAndDerivative ( const ParametersType &  parameters, MeasureType &  Value, DerivativeType &  Derivative  ) const

inlineoverride

template<class TInputImage>

MeasureType itk::MammogramPectoralisFitMetric< TInputImage >::GetValueAtPecIntercept

(

const InputImagePointType &

pecInterceptInMM

)

template<class TInputImage>

MeasureType itk::MammogramPectoralisFitMetric< TInputImage >::GetValueNCC

(

const ParametersType &

parameters

)

const

template<class TInputImage>

MeasureType itk::MammogramPectoralisFitMetric< TInputImage >::GetValueSSD

(

const ParametersType &

parameters

)

const

template<class TInputImage>

double itk::MammogramPectoralisFitMetric< TInputImage >::GradientAtMidpoint ( const ParametersType &  parameters ) const

protected

template<class TInputImage>

itk::MammogramPectoralisFitMetric< TInputImage >::itkStaticConstMacro	(	ImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)

Image dimension.

template<class TInputImage>

itk::MammogramPectoralisFitMetric< TInputImage >::itkStaticConstMacro	(	ParametricSpaceDimension	,
		unsigned	int,
		8
	)

template<class TInputImage>

static Pointer itk::MammogramPectoralisFitMetric< TInputImage >::New ( )

static

Method for creation through the object factory.

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::operator= ( const Self &  )

inlineprotected

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::SetInputImage

(

const InputImageType *

imInput

)

Connect the input image.

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::SetMask

(

const MaskImageType *

imMask

)

Set the optional mask image.

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::SetMinimumPectoralArea ( double  minPecArea )

inline

Set the minuimum pectoral area in mm^2.

template<class TInputImage>

void itk::MammogramPectoralisFitMetric< TInputImage >::SetSSD ( bool  flag )

inline

Optimise SSD rather than normalised cross-correlation.

Member Data Documentation

template<class TInputImage>

bool itk::MammogramPectoralisFitMetric< TInputImage >::m_flgOptimiseSSD

protected

template<class TInputImage>

InputImagePointType itk::MammogramPectoralisFitMetric< TInputImage >::m_ImOrigin

protected

template<class TInputImage>

InputImageRegionType itk::MammogramPectoralisFitMetric< TInputImage >::m_ImRegion

protected

template<class TInputImage>

InputImageSizeType itk::MammogramPectoralisFitMetric< TInputImage >::m_ImSize

protected

template<class TInputImage>

InputImagePointType itk::MammogramPectoralisFitMetric< TInputImage >::m_ImSizeInMM

protected

template<class TInputImage>

InputImageSpacingType itk::MammogramPectoralisFitMetric< TInputImage >::m_ImSpacing

protected

template<class TInputImage>

TemplateImagePointer itk::MammogramPectoralisFitMetric< TInputImage >::m_ImTemplate

protected

template<class TInputImage>

InputImageConstPointer itk::MammogramPectoralisFitMetric< TInputImage >::m_InputImage

protected

template<class TInputImage>

MaskImageConstPointer itk::MammogramPectoralisFitMetric< TInputImage >::m_Mask

protected

template<class TInputImage>

MaskImageRegionType itk::MammogramPectoralisFitMetric< TInputImage >::m_MaskRegion

protected

template<class TInputImage>

double itk::MammogramPectoralisFitMetric< TInputImage >::m_MinimumPectoralArea

protected

template<class TInputImage>

double itk::MammogramPectoralisFitMetric< TInputImage >::m_TemplatePixelAreaInMM

protected

---

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

• itkMammogramPectoralisFitMetric.h