itk::ParametricImageSource< TOutputImage > Class Template Reference

Base class for all parametric image sources. More...

#include <itkParametricImageSource.h>

Inheritance diagram for itk::ParametricImageSource< TOutputImage >:

Collaboration diagram for itk::ParametricImageSource< TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef TOutputImage	OutputImageType
typedef Array < ParametersValueType >	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef ParametricImageSource	Self
typedef GenerateImageSource < TOutputImage >	Superclass
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters () const =0
virtual ParametersType	GetParameters () const =0
virtual void	SetParameters (const ParametersType &parameters)=0
Static Public Attributes
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Member Functions
	ParametricImageSource ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~ParametricImageSource ()
Private Member Functions
void	operator= (const Self &)
	ParametricImageSource (const Self &)

---

Detailed Description

template<class TOutputImage>
class itk::ParametricImageSource< TOutputImage >

Base class for all parametric image sources.

This abstract class specifies an interface than enables parameters to be set through a vector of values using the SetParameters() method. This interface makes it easier to include parameterized image sources within ITK's optimization/registration framework.

Concrete subclasses must impelement the methods SetParameters(), GetParameters() and GetNumberOfParameters().

Definition at line 44 of file itkParametricImageSource.h.

---

Member Typedef Documentation

template<class TOutputImage >

typedef SmartPointer<const Self> itk::ParametricImageSource< TOutputImage >::ConstPointer

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 52 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef DataObject::Pointer itk::ParametricImageSource< TOutputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 55 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef OutputImageType::PixelType itk::ParametricImageSource< TOutputImage >::OutputImagePixelType

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 60 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef OutputImageType::Pointer itk::ParametricImageSource< TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 59 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef TOutputImage itk::ParametricImageSource< TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Definition at line 58 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef Array< ParametersValueType > itk::ParametricImageSource< TOutputImage >::ParametersType

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 63 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef double itk::ParametricImageSource< TOutputImage >::ParametersValueType

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 62 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef SmartPointer<Self> itk::ParametricImageSource< TOutputImage >::Pointer

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 51 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef ParametricImageSource itk::ParametricImageSource< TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 49 of file itkParametricImageSource.h.

template<class TOutputImage >

typedef GenerateImageSource<TOutputImage> itk::ParametricImageSource< TOutputImage >::Superclass

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

Definition at line 50 of file itkParametricImageSource.h.

---

Constructor & Destructor Documentation

template<class TOutputImage >

itk::ParametricImageSource< TOutputImage >::ParametricImageSource

(

)

[inline, protected]

Definition at line 87 of file itkParametricImageSource.h.

template<class TOutputImage >

virtual itk::ParametricImageSource< TOutputImage >::~ParametricImageSource

(

)

[inline, protected, virtual]

Definition at line 88 of file itkParametricImageSource.h.

template<class TOutputImage >

itk::ParametricImageSource< TOutputImage >::ParametricImageSource

(

const Self &

)

[private]

---

Member Function Documentation

template<class TOutputImage >

virtual const char* itk::ParametricImageSource< TOutputImage >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >

virtual unsigned int itk::ParametricImageSource< TOutputImage >::GetNumberOfParameters

(

)

const [pure virtual]

Get the number of parameters.

Implemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >

virtual ParametersType itk::ParametricImageSource< TOutputImage >::GetParameters

(

)

const [pure virtual]

Get the parameters for this source.

Implemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >

void itk::ParametricImageSource< TOutputImage >::operator=

(

const Self &

)

[private]

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage >

void itk::ParametricImageSource< TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

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::GenerateImageSource< TOutputImage >.

Reimplemented in itk::GaussianImageSource< TOutputImage >.

template<class TOutputImage >

virtual void itk::ParametricImageSource< TOutputImage >::SetParameters

(

const ParametersType &

parameters

)

[pure virtual]

Set the parameters for this source. Setting the parameters does not mark the image source as modified; subclasses should override this method to forward parameters through setters that call Modified().

---

Member Data Documentation

template<class TOutputImage >

const unsigned int itk::ParametricImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constant

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 68 of file itkParametricImageSource.h.

---

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

• itkParametricImageSource.h