#include <itkParametricImageSource.h>

Detailed Description

template<typename 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 implement the methods SetParameters(), GetParameters() and GetNumberOfParameters().

Definition at line 45 of file itkParametricImageSource.h.

Inheritance diagram for itk::ParametricImageSource< TOutputImage >:

Collaboration diagram for itk::ParametricImageSource< TOutputImage >:

Public Types
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

virtual unsigned int	GetNumberOfParameters () const =0

virtual ParametersType	GetParameters () const =0


virtual void	SetParameters (const ParametersType &parameters)=0

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 *)

unsigned long	AddObserver (const EventObject &event, Command *) 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)

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 Attributes
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
	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)

void	GenerateData () override

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 () ITKv5_CONST

virtual void	VerifyPreconditions () ITKv5_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 ()

Additional Inherited Members
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 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
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

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

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

◆ ConstPointer

template<typename TOutputImage >

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

Definition at line 54 of file itkParametricImageSource.h.

◆ DataObjectPointer

template<typename TOutputImage >

using itk::ParametricImageSource< TOutputImage >::DataObjectPointer = DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 57 of file itkParametricImageSource.h.

◆ OutputImagePixelType

template<typename TOutputImage >

using itk::ParametricImageSource< TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 62 of file itkParametricImageSource.h.

◆ OutputImagePointer

template<typename TOutputImage >

using itk::ParametricImageSource< TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 61 of file itkParametricImageSource.h.

◆ OutputImageType

template<typename TOutputImage >

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

Some convenient type alias.

Definition at line 60 of file itkParametricImageSource.h.

◆ ParametersType

template<typename TOutputImage >

using itk::ParametricImageSource< TOutputImage >::ParametersType = Array<ParametersValueType>

Definition at line 65 of file itkParametricImageSource.h.

◆ ParametersValueType

template<typename TOutputImage >

using itk::ParametricImageSource< TOutputImage >::ParametersValueType = double

Definition at line 64 of file itkParametricImageSource.h.

◆ Pointer

template<typename TOutputImage >

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

Definition at line 53 of file itkParametricImageSource.h.

◆ Self

template<typename TOutputImage >

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

Standard class type aliases.

Definition at line 51 of file itkParametricImageSource.h.

◆ Superclass

template<typename TOutputImage >

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

Definition at line 52 of file itkParametricImageSource.h.

Constructor & Destructor Documentation

◆ ParametricImageSource()

template<typename TOutputImage >

itk::ParametricImageSource< TOutputImage >::ParametricImageSource ( )

protecteddefault

◆ ~ParametricImageSource()

template<typename TOutputImage >

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

overrideprotecteddefault

Member Function Documentation

◆ GetNameOfClass()

template<typename TOutputImage >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::GenerateImageSource< TOutputImage >.

◆ GetNumberOfParameters()

template<typename TOutputImage >

virtual unsigned int itk::ParametricImageSource< TOutputImage >::GetNumberOfParameters ( ) const

pure virtual

Get the number of parameters.

Implemented in itk::GaussianImageSource< TOutputImage >.

◆ GetParameters()

template<typename TOutputImage >

virtual ParametersType itk::ParametricImageSource< TOutputImage >::GetParameters ( ) const

pure virtual

Get the parameters for this source.

Implemented in itk::GaussianImageSource< TOutputImage >.

◆ PrintSelf()

template<typename TOutputImage >

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

◆ SetParameters()

template<typename 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().

Implemented in itk::GaussianImageSource< TOutputImage >.

Member Data Documentation

◆ OutputImageDimension

template<typename TOutputImage >

constexpr unsigned int itk::ParametricImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

ImageDimension constant

Definition at line 68 of file itkParametricImageSource.h.

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

itkParametricImageSource.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DataObjectPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageType

◆ ParametersType

◆ ParametersValueType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ParametricImageSource()

◆ ~ParametricImageSource()

Member Function Documentation

◆ GetNameOfClass()

◆ GetNumberOfParameters()

◆ GetParameters()

◆ PrintSelf()

◆ SetParameters()

Member Data Documentation

◆ OutputImageDimension

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