#include <itkGaussianImageSource.h>

Detailed Description

template<typename TOutputImage>
class itk::GaussianImageSource< TOutputImage >

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.

Examples: SphinxExamples/src/Core/Common/ObserveAnEvent/Code.cxx, and SphinxExamples/src/Filtering/FFT/FilterImageInFourierDomain/Code.cxx.

Definition at line 45 of file itkGaussianImageSource.h.

Inheritance diagram for itk::GaussianImageSource< TOutputImage >:

Collaboration diagram for itk::GaussianImageSource< TOutputImage >:

Public Types
using	ArrayType = FixedArray< double, Self::NDimensions >

using	ConstPointer = SmartPointer< const Self >

using	DirectionType = typename TOutputImage::DirectionType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	PointType = typename TOutputImage::PointType

using	Self = GaussianImageSource

using	SizeType = typename TOutputImage::SizeType

using	SizeValueType = typename TOutputImage::SizeValueType

using	SpacingType = typename TOutputImage::SpacingType

using	Superclass = ParametricImageSource< TOutputImage >

Public Types inherited from itk::ParametricImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectPointer = DataObject::Pointer

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	ParametersType = Array< ParametersValueType >

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	Self = ParametricImageSource

using	Superclass = GenerateImageSource< TOutputImage >

Public Types inherited from itk::GenerateImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DirectionType = typename OutputImageType::DirectionType

using	IndexType = typename OutputImageType::IndexType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	PixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename OutputImageType::PointType

using	ReferenceImageBaseType = ImageBase< TOutputImage::ImageDimension >

using	RegionType = typename OutputImageType::RegionType

using	Self = GenerateImageSource

using	SizeType = typename TOutputImage::SizeType

using	SizeValueType = typename TOutputImage::SizeValueType

using	SpacingType = typename OutputImageType::SpacingType

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

unsigned int	GetNumberOfParameters () const override


virtual void	SetScale (double _arg)

virtual const double &	GetScale () const


virtual void	SetNormalized (bool _arg)

virtual const bool &	GetNormalized () const

virtual void	NormalizedOn ()


virtual void	SetSigma (ArrayType _arg)

virtual const ArrayType &	GetSigma () const


virtual void	SetMean (ArrayType _arg)

virtual const ArrayType &	GetMean () const


void	SetParameters (const ParametersType &parameters) override

ParametersType	GetParameters () const override

Public Member Functions inherited from itk::ParametricImageSource< TOutputImage >
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::GenerateImageSource< TOutputImage >
virtual const ReferenceImageBaseType *	GetReferenceImage () const

virtual bool	GetUseReferenceImage () const

void	SetOutputParametersFromImage (const ReferenceImageBaseType *image)

virtual void	SetReferenceImage (const ReferenceImageBaseType *input)

virtual void	SetUseReferenceImage (bool _arg)

virtual void	UseReferenceImageOn ()

virtual void	SetSize (SizeType _arg)

virtual const SizeType &	GetSize () const

virtual void	SetSize (SizeValueType data[])

virtual void	SetSpacing (SpacingType _arg)

virtual const SpacingType &	GetSpacing () const

virtual void	SetSpacing (const float data[])

virtual void	SetOrigin (PointType _arg)

virtual const PointType &	GetOrigin () const

virtual void	SetOrigin (const float data[])

virtual void	SetDirection (DirectionType _arg)

virtual const DirectionType &	GetDirection () const

virtual void	SetStartIndex (IndexType _arg)

virtual const IndexType &	GetStartIndex () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	NDimensions = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ParametricImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::GenerateImageSource< TOutputImage >
static constexpr unsigned int	NDimensions = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
	GaussianImageSource ()

void	GenerateData () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~GaussianImageSource () override=default

Protected Member Functions inherited from itk::ParametricImageSource< TOutputImage >
	ParametricImageSource ()=default

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ParametricImageSource () override=default

Protected Member Functions inherited from itk::GenerateImageSource< TOutputImage >
	GenerateImageSource ()

void	GenerateOutputInformation () override

	~GenerateImageSource () override=default

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
ArrayType	m_Mean {}

bool	m_Normalized { false }

double	m_Scale { 255.0 }

ArrayType	m_Sigma {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ArrayType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::ArrayType = FixedArray<double, Self::NDimensions>

Type used to store Gaussian parameters.

Definition at line 81 of file itkGaussianImageSource.h.

◆ ConstPointer

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkGaussianImageSource.h.

◆ DirectionType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::DirectionType = typename TOutputImage::DirectionType

Direction type alias support The direction is the direction cosines of the image.

Definition at line 75 of file itkGaussianImageSource.h.

◆ OutputImagePixelType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::OutputImagePixelType = typename TOutputImage::PixelType

Typedef for the output image PixelType.

Definition at line 60 of file itkGaussianImageSource.h.

◆ OutputImageRegionType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType

Typedef to describe the output image region type.

Definition at line 63 of file itkGaussianImageSource.h.

◆ OutputImageType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::OutputImageType = TOutputImage

Typedef for the output image type.

Definition at line 57 of file itkGaussianImageSource.h.

◆ Pointer

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkGaussianImageSource.h.

◆ PointType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::PointType = typename TOutputImage::PointType

Origin type alias support The origin is the geometric coordinates of the index (0,0).

Definition at line 71 of file itkGaussianImageSource.h.

◆ Self

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::Self = GaussianImageSource

Standard class type aliases.

Definition at line 51 of file itkGaussianImageSource.h.

◆ SizeType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::SizeType = typename TOutputImage::SizeType

Size type matches that used for images

Definition at line 84 of file itkGaussianImageSource.h.

◆ SizeValueType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::SizeValueType = typename TOutputImage::SizeValueType

Definition at line 85 of file itkGaussianImageSource.h.

◆ SpacingType

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::SpacingType = typename TOutputImage::SpacingType

Spacing type alias support Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 67 of file itkGaussianImageSource.h.

◆ Superclass

template<typename TOutputImage >

using itk::GaussianImageSource< TOutputImage >::Superclass = ParametricImageSource<TOutputImage>

Definition at line 52 of file itkGaussianImageSource.h.

Constructor & Destructor Documentation

◆ GaussianImageSource()

template<typename TOutputImage >

itk::GaussianImageSource< TOutputImage >::GaussianImageSource ( )

protected

◆ ~GaussianImageSource()

template<typename TOutputImage >

itk::GaussianImageSource< TOutputImage >::~GaussianImageSource ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TOutputImage >

void itk::GaussianImageSource< TOutputImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetMean()

template<typename TOutputImage >

virtual const ArrayType& itk::GaussianImageSource< TOutputImage >::GetMean ( ) const

virtual

Set/Get the mean in each direction.

◆ GetNameOfClass()

template<typename TOutputImage >

const char* itk::GaussianImageSource< TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetNormalized()

template<typename TOutputImage >

virtual const bool& itk::GaussianImageSource< TOutputImage >::GetNormalized ( ) const

virtual

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

◆ GetNumberOfParameters()

template<typename TOutputImage >

unsigned int itk::GaussianImageSource< TOutputImage >::GetNumberOfParameters ( ) const

overridevirtual

Get the number of parameters for this image source. When this source is templated over an N-dimensional output image type, the number of parameters is 2*N+1.

Implements itk::ParametricImageSource< TOutputImage >.

◆ GetParameters()

template<typename TOutputImage >

ParametersType itk::GaussianImageSource< TOutputImage >::GetParameters ( ) const

overridevirtual

Set/Get the parameters for this source. When this source is templated over an N-dimensional output image type, the first N values in the parameter array are the Sigma parameters in each dimension, the next N values are the Mean parameters in each dimension, and the last value is the Scale.

Implements itk::ParametricImageSource< TOutputImage >.

◆ GetScale()

template<typename TOutputImage >

virtual const double& itk::GaussianImageSource< TOutputImage >::GetScale ( ) const

virtual

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

◆ GetSigma()

template<typename TOutputImage >

virtual const ArrayType& itk::GaussianImageSource< TOutputImage >::GetSigma ( ) const

virtual

Set/Get the standard deviation in each direction.

◆ New()

template<typename TOutputImage >

static Pointer itk::GaussianImageSource< TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ NormalizedOn()

template<typename TOutputImage >

virtual void itk::GaussianImageSource< TOutputImage >::NormalizedOn ( )

virtual

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

◆ PrintSelf()

template<typename TOutputImage >

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

overrideprotectedvirtual

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

◆ SetMean()

template<typename TOutputImage >

virtual void itk::GaussianImageSource< TOutputImage >::SetMean ( ArrayType _arg )

virtual

Set/Get the mean in each direction.

◆ SetNormalized()

template<typename TOutputImage >

virtual void itk::GaussianImageSource< TOutputImage >::SetNormalized ( bool _arg )

virtual

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

◆ SetParameters()

template<typename TOutputImage >

void itk::GaussianImageSource< TOutputImage >::SetParameters ( const ParametersType & parameters )

overridevirtual

Set/Get the parameters for this source. When this source is templated over an N-dimensional output image type, the first N values in the parameter array are the Sigma parameters in each dimension, the next N values are the Mean parameters in each dimension, and the last value is the Scale.

Implements itk::ParametricImageSource< TOutputImage >.

◆ SetScale()

template<typename TOutputImage >

virtual void itk::GaussianImageSource< TOutputImage >::SetScale ( double _arg )

virtual

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

◆ SetSigma()

template<typename TOutputImage >

virtual void itk::GaussianImageSource< TOutputImage >::SetSigma ( ArrayType _arg )

virtual

Set/Get the standard deviation in each direction.

Member Data Documentation

◆ m_Mean

template<typename TOutputImage >

ArrayType itk::GaussianImageSource< TOutputImage >::m_Mean {}

private

Definition at line 149 of file itkGaussianImageSource.h.

◆ m_Normalized

template<typename TOutputImage >

bool itk::GaussianImageSource< TOutputImage >::m_Normalized { false }

private

Definition at line 153 of file itkGaussianImageSource.h.

◆ m_Scale

template<typename TOutputImage >

double itk::GaussianImageSource< TOutputImage >::m_Scale { 255.0 }

private

Definition at line 151 of file itkGaussianImageSource.h.

◆ m_Sigma

template<typename TOutputImage >

ArrayType itk::GaussianImageSource< TOutputImage >::m_Sigma {}

private

Definition at line 147 of file itkGaussianImageSource.h.

◆ NDimensions

template<typename TOutputImage >

constexpr unsigned int itk::GaussianImageSource< TOutputImage >::NDimensions = TOutputImage::ImageDimension

staticconstexpr

Dimensionality of the output image

Definition at line 78 of file itkGaussianImageSource.h.

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

itkGaussianImageSource.h

Detailed Description

template<typename TOutputImage> class itk::GaussianImageSource< TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ArrayType

◆ ConstPointer

◆ DirectionType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ PointType

◆ Self

◆ SizeType

◆ SizeValueType

◆ SpacingType

◆ Superclass

Constructor & Destructor Documentation

◆ GaussianImageSource()

◆ ~GaussianImageSource()

Member Function Documentation

◆ GenerateData()

◆ GetMean()

◆ GetNameOfClass()

◆ GetNormalized()

◆ GetNumberOfParameters()

◆ GetParameters()

◆ GetScale()

◆ GetSigma()

◆ New()

◆ NormalizedOn()

◆ PrintSelf()

◆ SetMean()

◆ SetNormalized()

◆ SetParameters()

◆ SetScale()

◆ SetSigma()

Member Data Documentation

◆ m_Mean

◆ m_Normalized

◆ m_Scale

◆ m_Sigma

◆ NDimensions

template<typename TOutputImage>
class itk::GaussianImageSource< TOutputImage >