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:

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 43 of file sitkGaussianImageSource.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = GaussianImageSource
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute ()
	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 (double value)
Self &	SetMean (std::vector< double > Mean)
Self &	SetNormalized (bool Normalized)
Self &	SetOrigin (std::vector< double > Origin)
Self &	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
Self &	SetScale (double Scale)
Self &	SetSigma (double value)
Self &	SetSigma (std::vector< double > Sigma)
Self &	SetSize (std::vector< unsigned int > Size)
Self &	SetSpacing (std::vector< double > Spacing)
std::string	ToString () const
virtual	~GaussianImageSource ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( )

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

Private Attributes
std::vector< double >	m_Direction {std::vector<double>()}
std::vector< double >	m_Mean {std::vector<double>(3, 32.0)}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_Normalized {false}
std::vector< double >	m_Origin {std::vector<double>(3, 0.0)}
PixelIDValueEnum	m_OutputPixelType {itk::simple::sitkFloat32}
double	m_Scale {255}
std::vector< double >	m_Sigma {std::vector<double>(3, 16.0)}
std::vector< unsigned int >	m_Size {std::vector<unsigned int>(3, 64)}
std::vector< double >	m_Spacing {std::vector<double>(3, 1.0)}

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 double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
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) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
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 TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType>
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

MemberFunctionType

using itk::simple::GaussianImageSource::MemberFunctionType = Image (Self::*)( )

private

Setup for member function dispatching

Definition at line 167 of file sitkGaussianImageSource.h.

PixelIDTypeList

using itk::simple::GaussianImageSource::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 55 of file sitkGaussianImageSource.h.

Self

using itk::simple::GaussianImageSource::Self = GaussianImageSource

Definition at line 45 of file sitkGaussianImageSource.h.

Constructor & Destructor Documentation

~GaussianImageSource()

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

virtual

Destructor

GaussianImageSource()

itk::simple::GaussianImageSource::GaussianImageSource

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::GaussianImageSource::Execute

(

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetDirection()

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

inline

Definition at line 135 of file sitkGaussianImageSource.h.

References m_Direction.

GetMean()

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

inline

Set/Get the mean in each direction.

Definition at line 101 of file sitkGaussianImageSource.h.

References m_Mean.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 152 of file sitkGaussianImageSource.h.

GetNormalized()

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

inline

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

Definition at line 149 of file sitkGaussianImageSource.h.

References m_Normalized.

GetOrigin()

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

inline

Definition at line 119 of file sitkGaussianImageSource.h.

References m_Origin.

GetOutputPixelType()

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

inline

Definition at line 67 of file sitkGaussianImageSource.h.

References m_OutputPixelType.

GetScale()

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 111 of file sitkGaussianImageSource.h.

References m_Scale.

GetSigma()

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

inline

Set/Get the standard deviation in each direction.

Definition at line 88 of file sitkGaussianImageSource.h.

References m_Sigma.

GetSize()

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

inline

Definition at line 75 of file sitkGaussianImageSource.h.

References m_Size.

GetSpacing()

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

inline

Definition at line 127 of file sitkGaussianImageSource.h.

References m_Spacing.

NormalizedOff()

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

inline

Definition at line 144 of file sitkGaussianImageSource.h.

References SetNormalized().

NormalizedOn()

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

inline

Set the value of Normalized to true or false respectfully.

Definition at line 143 of file sitkGaussianImageSource.h.

References SetNormalized().

SetDirection()

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

inline

Definition at line 131 of file sitkGaussianImageSource.h.

References m_Direction.

SetMean() [1/2]

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

inline

Set the values of the Mean vector all to value

Definition at line 96 of file sitkGaussianImageSource.h.

References m_Mean.

SetMean() [2/2]

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

inline

Set/Get the mean in each direction.

Definition at line 93 of file sitkGaussianImageSource.h.

References m_Mean, and itk::simple::Mean().

SetNormalized()

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

inline

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

Definition at line 140 of file sitkGaussianImageSource.h.

References m_Normalized.

Referenced by NormalizedOff(), and NormalizedOn().

SetOrigin()

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

inline

Definition at line 115 of file sitkGaussianImageSource.h.

References m_Origin.

SetOutputPixelType()

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

inline

Definition at line 63 of file sitkGaussianImageSource.h.

References m_OutputPixelType.

SetScale()

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 106 of file sitkGaussianImageSource.h.

References m_Scale.

SetSigma() [1/2]

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

inline

Set the values of the Sigma vector all to value

Definition at line 83 of file sitkGaussianImageSource.h.

References m_Sigma.

SetSigma() [2/2]

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

inline

Set/Get the standard deviation in each direction.

Definition at line 80 of file sitkGaussianImageSource.h.

References m_Sigma.

SetSize()

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

inline

Definition at line 71 of file sitkGaussianImageSource.h.

References m_Size.

SetSpacing()

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

inline

Definition at line 123 of file sitkGaussianImageSource.h.

References m_Spacing.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 168 of file sitkGaussianImageSource.h.

References ExecuteInternal().

Member Data Documentation

m_Direction

std::vector<double> itk::simple::GaussianImageSource::m_Direction {std::vector<double>()}

private

Definition at line 191 of file sitkGaussianImageSource.h.

Referenced by GetDirection(), and SetDirection().

m_Mean

std::vector<double> itk::simple::GaussianImageSource::m_Mean {std::vector<double>(3, 32.0)}

private

Definition at line 182 of file sitkGaussianImageSource.h.

Referenced by GetMean(), SetMean(), and SetMean().

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::GaussianImageSource::m_MemberFactory

private

Definition at line 173 of file sitkGaussianImageSource.h.

m_Normalized

bool itk::simple::GaussianImageSource::m_Normalized {false}

private

Definition at line 193 of file sitkGaussianImageSource.h.

Referenced by GetNormalized(), and SetNormalized().

m_Origin

std::vector<double> itk::simple::GaussianImageSource::m_Origin {std::vector<double>(3, 0.0)}

private

Definition at line 186 of file sitkGaussianImageSource.h.

Referenced by GetOrigin(), and SetOrigin().

m_OutputPixelType

PixelIDValueEnum itk::simple::GaussianImageSource::m_OutputPixelType {itk::simple::sitkFloat32}

private

Definition at line 176 of file sitkGaussianImageSource.h.

Referenced by GetOutputPixelType(), and SetOutputPixelType().

m_Scale

double itk::simple::GaussianImageSource::m_Scale {255}

private

Definition at line 184 of file sitkGaussianImageSource.h.

Referenced by GetScale(), and SetScale().

m_Sigma

std::vector<double> itk::simple::GaussianImageSource::m_Sigma {std::vector<double>(3, 16.0)}

private

Definition at line 180 of file sitkGaussianImageSource.h.

Referenced by GetSigma(), SetSigma(), and SetSigma().

m_Size

std::vector<unsigned int> itk::simple::GaussianImageSource::m_Size {std::vector<unsigned int>(3, 64)}

private

Definition at line 178 of file sitkGaussianImageSource.h.

Referenced by GetSize(), and SetSize().

m_Spacing

std::vector<double> itk::simple::GaussianImageSource::m_Spacing {std::vector<double>(3, 1.0)}

private

Definition at line 188 of file sitkGaussianImageSource.h.

Referenced by GetSpacing(), and SetSpacing().

---

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

• sitkGaussianImageSource.h