#include <itkGenerateImageSource.h>

Detailed Description

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

a Base class for image sources which need to have image size, and other meta-data set.

This class adds the ability for the user to set the Image's size, spacing, origin, and direction cosines. It is designed to be a base class for other image sources which generate an image, while there is no image input to the source.

Definition at line 41 of file itkGenerateImageSource.h.

Inheritance diagram for itk::GenerateImageSource< TOutputImage >:

Collaboration diagram for itk::GenerateImageSource< TOutputImage >:

Public Types
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
virtual const char *	GetNameOfClass () const

virtual bool	GetUseReferenceImage () const

	itkGetInputMacro (ReferenceImage, ReferenceImageBaseType)

	itkSetInputMacro (ReferenceImage, ReferenceImageBaseType)

void	SetOutputParametersFromImage (const ReferenceImageBaseType *image)

virtual void	SetUseReferenceImage (bool _arg)

virtual void	UseReferenceImageOff ()

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)

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

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

virtual void	GraftOutput (DataObject *graft)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

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

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

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

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

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

void	GenerateOutputInformation () override

void	PrintSelf (std::ostream &os, Indent indent) const 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 ()

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

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

virtual void	DynamicMultiThreadingOff ()

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

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

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

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
DirectionType	m_Direction {}

PointType	m_Origin {}

SizeType	m_Size {}

SpacingType	m_Spacing {}

IndexType	m_StartIndex {}

bool	m_UseReferenceImage { false }

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

◆ ConstPointer

template<typename TOutputImage>

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

Definition at line 49 of file itkGenerateImageSource.h.

◆ DirectionType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::DirectionType = typename OutputImageType::DirectionType

Definition at line 58 of file itkGenerateImageSource.h.

◆ IndexType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 59 of file itkGenerateImageSource.h.

◆ OutputImagePointer

template<typename TOutputImage>

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

Definition at line 53 of file itkGenerateImageSource.h.

◆ OutputImageType

template<typename TOutputImage>

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

Output image type alias

Definition at line 52 of file itkGenerateImageSource.h.

◆ PixelType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::PixelType = typename OutputImageType::PixelType

Definition at line 54 of file itkGenerateImageSource.h.

◆ Pointer

template<typename TOutputImage>

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

Definition at line 48 of file itkGenerateImageSource.h.

◆ PointType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::PointType = typename OutputImageType::PointType

Definition at line 57 of file itkGenerateImageSource.h.

◆ ReferenceImageBaseType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::ReferenceImageBaseType = ImageBase<TOutputImage::ImageDimension>

Typedef the reference image type to be the ImageBase of the OutputImageType

Definition at line 62 of file itkGenerateImageSource.h.

◆ RegionType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::RegionType = typename OutputImageType::RegionType

Definition at line 55 of file itkGenerateImageSource.h.

◆ Self

template<typename TOutputImage>

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

Definition at line 46 of file itkGenerateImageSource.h.

◆ SizeType

template<typename TOutputImage>

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

Definition at line 64 of file itkGenerateImageSource.h.

◆ SizeValueType

template<typename TOutputImage>

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

Definition at line 65 of file itkGenerateImageSource.h.

◆ SpacingType

template<typename TOutputImage>

using itk::GenerateImageSource< TOutputImage >::SpacingType = typename OutputImageType::SpacingType

Definition at line 56 of file itkGenerateImageSource.h.

◆ Superclass

template<typename TOutputImage>

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

Definition at line 47 of file itkGenerateImageSource.h.

Constructor & Destructor Documentation

◆ GenerateImageSource()

template<typename TOutputImage>

itk::GenerateImageSource< TOutputImage >::GenerateImageSource ( )

protected

Referenced by GetNameOfClass().

◆ ~GenerateImageSource()

template<typename TOutputImage>

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

overrideprotecteddefault

Member Function Documentation

◆ GenerateOutputInformation()

template<typename TOutputImage>

void itk::GenerateImageSource< TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::PhysicalPointImageSource< TOutputImage >.

◆ GetDirection()

template<typename TOutputImage>

virtual const DirectionType & itk::GenerateImageSource< TOutputImage >::GetDirection ( ) const

virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

◆ GetNameOfClass()

template<typename TOutputImage>

virtual const char * itk::GenerateImageSource< TOutputImage >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::GaborImageSource< TOutputImage >, itk::GaussianImageSource< TOutputImage >, itk::GridImageSource< TOutputImage >, itk::ParametricImageSource< TOutputImage >, and itk::PhysicalPointImageSource< TOutputImage >.

References GenerateImageSource().

◆ GetOrigin()

template<typename TOutputImage>

virtual const PointType & itk::GenerateImageSource< TOutputImage >::GetOrigin ( ) const

virtual

Set/Get the output image origin. This parameter defaults to all zeros.

◆ GetSize()

template<typename TOutputImage>

virtual const SizeType & itk::GenerateImageSource< TOutputImage >::GetSize ( ) const

virtual

Set/Get the size of the output image

◆ GetSpacing()

template<typename TOutputImage>

virtual const SpacingType & itk::GenerateImageSource< TOutputImage >::GetSpacing ( ) const

virtual

Set/Get the output image spacing. This parameter defaults to all ones.

◆ GetStartIndex()

template<typename TOutputImage>

virtual const IndexType & itk::GenerateImageSource< TOutputImage >::GetStartIndex ( ) const

virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

◆ GetUseReferenceImage()

template<typename TOutputImage>

virtual bool itk::GenerateImageSource< TOutputImage >::GetUseReferenceImage ( ) const

virtual

◆ itkGetInputMacro()

template<typename TOutputImage>

itk::GenerateImageSource< TOutputImage >::itkGetInputMacro	(	ReferenceImage	,
		ReferenceImageBaseType	)

Get the reference image that is defining the output information.

◆ itkSetInputMacro()

template<typename TOutputImage>

itk::GenerateImageSource< TOutputImage >::itkSetInputMacro	(	ReferenceImage	,
		ReferenceImageBaseType	)

Set a reference image to use to define the output information. By default, output information is specified through the SetOutputSpacing, Origin, and Direction methods. Alternatively, this method can be used to specify an image from which to copy the information. UseReferenceImageOn must be set to utilize the reference image.

◆ PrintSelf()

template<typename TOutputImage>

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

Reimplemented in itk::GridImageSource< TOutputImage >, and itk::ParametricImageSource< TOutputImage >.

◆ SetDirection()

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetDirection ( DirectionType _arg )

virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

◆ SetOrigin() [1/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetOrigin ( const float data[] )

virtual

Set/Get the output image origin. This parameter defaults to all zeros.

References NDimensions.

◆ SetOrigin() [2/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetOrigin ( PointType _arg )

virtual

Set/Get the output image origin. This parameter defaults to all zeros.

◆ SetOutputParametersFromImage()

template<typename TOutputImage>

void itk::GenerateImageSource< TOutputImage >::SetOutputParametersFromImage ( const ReferenceImageBaseType * image )

Helper method to set the output parameters based on an image.

◆ SetSize() [1/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetSize ( SizeType _arg )

virtual

Set/Get the size of the output image

◆ SetSize() [2/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetSize ( SizeValueType data[] )

virtual

Set/Get the size of the output image

References NDimensions.

◆ SetSpacing() [1/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetSpacing ( const float data[] )

virtual

Set/Get the output image spacing. This parameter defaults to all ones.

References NDimensions.

◆ SetSpacing() [2/2]

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetSpacing ( SpacingType _arg )

virtual

Set/Get the output image spacing. This parameter defaults to all ones.

◆ SetStartIndex()

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetStartIndex ( IndexType _arg )

virtual

Set/Get the output image direction cosine. This parameter defaults to the identity matrix.

◆ SetUseReferenceImage()

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::SetUseReferenceImage ( bool _arg )

virtual

◆ UseReferenceImageOff()

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::UseReferenceImageOff ( )

virtual

◆ UseReferenceImageOn()

template<typename TOutputImage>

virtual void itk::GenerateImageSource< TOutputImage >::UseReferenceImageOn ( )

virtual

Member Data Documentation

◆ m_Direction

template<typename TOutputImage>

DirectionType itk::GenerateImageSource< TOutputImage >::m_Direction {}

private

Definition at line 146 of file itkGenerateImageSource.h.

◆ m_Origin

template<typename TOutputImage>

PointType itk::GenerateImageSource< TOutputImage >::m_Origin {}

private

Definition at line 145 of file itkGenerateImageSource.h.

◆ m_Size

template<typename TOutputImage>

SizeType itk::GenerateImageSource< TOutputImage >::m_Size {}

private

Definition at line 143 of file itkGenerateImageSource.h.

◆ m_Spacing

template<typename TOutputImage>

SpacingType itk::GenerateImageSource< TOutputImage >::m_Spacing {}

private

Definition at line 144 of file itkGenerateImageSource.h.

◆ m_StartIndex

template<typename TOutputImage>

IndexType itk::GenerateImageSource< TOutputImage >::m_StartIndex {}

private

Definition at line 147 of file itkGenerateImageSource.h.

◆ m_UseReferenceImage

template<typename TOutputImage>

bool itk::GenerateImageSource< TOutputImage >::m_UseReferenceImage { false }

private

Definition at line 148 of file itkGenerateImageSource.h.

◆ NDimensions

template<typename TOutputImage>

unsigned int itk::GenerateImageSource< TOutputImage >::NDimensions = TOutputImage::ImageDimension

staticconstexpr

Dimensionality of the output image

Definition at line 68 of file itkGenerateImageSource.h.

Referenced by SetOrigin(), SetSize(), and SetSpacing().

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

itkGenerateImageSource.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DirectionType

◆ IndexType

◆ OutputImagePointer

◆ OutputImageType

◆ PixelType

◆ Pointer

◆ PointType

◆ ReferenceImageBaseType

◆ RegionType

◆ Self

◆ SizeType

◆ SizeValueType

◆ SpacingType

◆ Superclass

Constructor & Destructor Documentation

◆ GenerateImageSource()

◆ ~GenerateImageSource()

Member Function Documentation

◆ GenerateOutputInformation()

◆ GetDirection()

◆ GetNameOfClass()

◆ GetOrigin()

◆ GetSize()

◆ GetSpacing()

◆ GetStartIndex()

◆ GetUseReferenceImage()

◆ itkGetInputMacro()

◆ itkSetInputMacro()

◆ PrintSelf()

◆ SetDirection()

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetOutputParametersFromImage()

◆ SetSize() [1/2]

◆ SetSize() [2/2]

◆ SetSpacing() [1/2]

◆ SetSpacing() [2/2]

◆ SetStartIndex()

◆ SetUseReferenceImage()

◆ UseReferenceImageOff()

◆ UseReferenceImageOn()

Member Data Documentation

◆ m_Direction

◆ m_Origin

◆ m_Size

◆ m_Spacing

◆ m_StartIndex

◆ m_UseReferenceImage

◆ NDimensions