itk::simple::GaussianImageSource Class Reference

Generate an n-dimensional image of a Gaussian. More...

#include <sitkGaussianImageSource.h>

Inheritance diagram for itk::simple::GaussianImageSource:

Collaboration diagram for itk::simple::GaussianImageSource:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef GaussianImageSource	Self
Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute ()
Image	Execute (PixelIDValueEnum outputPixelType, const std::vector< unsigned int > &size, const std::vector< double > &sigma, const std::vector< double > &mean, double scale, const std::vector< double > &origin, const std::vector< double > &spacing, std::vector< double > direction, bool normalized)
	GaussianImageSource ()
std::vector< double >	GetDirection () const
std::vector< double >	GetMean () const
std::string	GetName () const
bool	GetNormalized () const
std::vector< double >	GetOrigin () const
PixelIDValueEnum	GetOutputPixelType () const
double	GetScale () const
std::vector< double >	GetSigma () const
std::vector< unsigned int >	GetSize () const
std::vector< double >	GetSpacing () const
Self &	NormalizedOff ()
Self &	NormalizedOn ()
Self &	SetDirection (std::vector< double > Direction)
Self &	SetMean (const std::vector< double > &Mean)
Self &	SetMean (double value)
Self &	SetNormalized (bool Normalized)
Self &	SetOrigin (const std::vector< double > &Origin)
Self &	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
Self &	SetScale (double Scale)
Self &	SetSigma (const std::vector< double > &Sigma)
Self &	SetSigma (double value)
Self &	SetSize (const std::vector< unsigned int > &Size)
Self &	SetSpacing (const std::vector< double > &Spacing)
std::string	ToString () const
virtual	~GaussianImageSource ()
Public Member Functions inherited from itk::simple::ImageFilter< 0 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) ()

Private Member Functions
template<class TImageType >
Image	ExecuteInternal ()

Private Attributes
std::vector< double >	m_Direction
std::vector< double >	m_Mean
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_Normalized
std::vector< double >	m_Origin
PixelIDValueEnum	m_OutputPixelType
double	m_Scale
std::vector< double >	m_Sigma
std::vector< unsigned int >	m_Size
std::vector< double >	m_Spacing

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TImageType >
static Image	CastITKToImage (TImageType *img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Generate an n-dimensional image of a Gaussian.

GaussianImageSource generates an image of a Gaussian. m_Normalized determines whether or not the Gaussian is normalized (whether or not the sum over infinite space is 1.0) When creating an image, it is preferable to not normalize the Gaussian m_Scale scales the output of the Gaussian to span a range larger than 0->1, and is typically set to the maximum value of the output data type (for instance, 255 for uchars)

The output image may be of any dimension.

See also

itk::simple::GaussianSource for the procedural interface

itk::GaussianImageSource for the Doxygen on the original ITK class.

Definition at line 44 of file sitkGaussianImageSource.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GaussianImageSource::MemberFunctionType) ()

private

Setup for member function dispatching

Definition at line 172 of file sitkGaussianImageSource.h.

typedef BasicPixelIDTypeList itk::simple::GaussianImageSource::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkGaussianImageSource.h.

typedef GaussianImageSource itk::simple::GaussianImageSource::Self

Definition at line 46 of file sitkGaussianImageSource.h.

Constructor & Destructor Documentation

virtual itk::simple::GaussianImageSource::~GaussianImageSource ( )

virtual

Destructor

itk::simple::GaussianImageSource::GaussianImageSource

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::GaussianImageSource::Execute

(

)

Execute the filter on the input image

Image itk::simple::GaussianImageSource::Execute	(	PixelIDValueEnum	outputPixelType,
		const std::vector< unsigned int > &	size,
		const std::vector< double > &	sigma,
		const std::vector< double > &	mean,
		double	scale,
		const std::vector< double > &	origin,
		const std::vector< double > &	spacing,
		std::vector< double >	direction,
		bool	normalized
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::GaussianImageSource::ExecuteInternal ( )

private

std::vector<double> itk::simple::GaussianImageSource::GetDirection ( ) const

inline

Definition at line 138 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::GetMean ( ) const

inline

Set/Get the mean in each direction.

Definition at line 104 of file sitkGaussianImageSource.h.

std::string itk::simple::GaussianImageSource::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 154 of file sitkGaussianImageSource.h.

bool itk::simple::GaussianImageSource::GetNormalized ( ) const

inline

Set/Get whether or not to normalize the Gaussian. Default is false.

Definition at line 152 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::GetOrigin ( ) const

inline

Definition at line 122 of file sitkGaussianImageSource.h.

PixelIDValueEnum itk::simple::GaussianImageSource::GetOutputPixelType ( ) const

inline

Definition at line 68 of file sitkGaussianImageSource.h.

double itk::simple::GaussianImageSource::GetScale ( ) const

inline

Gets and sets for Gaussian parameters Set/Get the scale factor to multiply the true value of the Gaussian.

Definition at line 114 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::GetSigma ( ) const

inline

Set/Get the standard deviation in each direction.

Definition at line 90 of file sitkGaussianImageSource.h.

std::vector<unsigned int> itk::simple::GaussianImageSource::GetSize ( ) const

inline

Definition at line 76 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::GetSpacing ( ) const

inline

Definition at line 130 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::NormalizedOff ( )

inline

Definition at line 147 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::NormalizedOn ( )

inline

Set the value of Normalized to true or false respectfully.

Definition at line 146 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetDirection ( std::vector< double >  Direction )

inline

Definition at line 134 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetMean ( const std::vector< double > &  Mean )

inline

Set/Get the mean in each direction.

Definition at line 95 of file sitkGaussianImageSource.h.

References itk::simple::Mean().

Self& itk::simple::GaussianImageSource::SetMean ( double  value )

inline

Set the values of the Mean vector all to value

Definition at line 98 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetNormalized ( bool  Normalized )

inline

Set/Get whether or not to normalize the Gaussian. Default is false.

Definition at line 143 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetOrigin ( const std::vector< double > &  Origin )

inline

Definition at line 118 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetOutputPixelType ( PixelIDValueEnum  OutputPixelType )

inline

Definition at line 64 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetScale ( double  Scale )

inline

Gets and sets for Gaussian parameters Set/Get the scale factor to multiply the true value of the Gaussian.

Definition at line 109 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetSigma ( const std::vector< double > &  Sigma )

inline

Set/Get the standard deviation in each direction.

Definition at line 81 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetSigma ( double  value )

inline

Set the values of the Sigma vector all to value

Definition at line 84 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetSize ( const std::vector< unsigned int > &  Size )

inline

Definition at line 72 of file sitkGaussianImageSource.h.

Self& itk::simple::GaussianImageSource::SetSpacing ( const std::vector< double > &  Spacing )

inline

Definition at line 126 of file sitkGaussianImageSource.h.

std::string itk::simple::GaussianImageSource::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 176 of file sitkGaussianImageSource.h.

Member Data Documentation

std::vector<double> itk::simple::GaussianImageSource::m_Direction

private

Definition at line 189 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::m_Mean

private

Definition at line 184 of file sitkGaussianImageSource.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GaussianImageSource::m_MemberFactory

private

Definition at line 178 of file sitkGaussianImageSource.h.

bool itk::simple::GaussianImageSource::m_Normalized

private

Definition at line 190 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::m_Origin

private

Definition at line 186 of file sitkGaussianImageSource.h.

PixelIDValueEnum itk::simple::GaussianImageSource::m_OutputPixelType

private

Definition at line 181 of file sitkGaussianImageSource.h.

double itk::simple::GaussianImageSource::m_Scale

private

Definition at line 185 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::m_Sigma

private

Definition at line 183 of file sitkGaussianImageSource.h.

std::vector<unsigned int> itk::simple::GaussianImageSource::m_Size

private

Definition at line 182 of file sitkGaussianImageSource.h.

std::vector<double> itk::simple::GaussianImageSource::m_Spacing

private

Definition at line 187 of file sitkGaussianImageSource.h.

---

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

• sitkGaussianImageSource.h