itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage > Class Template Reference

#include <itkSpatialObjectToImageFilter.h>

Inheritance diagram for itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >:

Collaboration diagram for itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >:

Public Types
using	ChildrenListType = typename TInputSpatialObject::ChildrenListType
using	ConstPointer = SmartPointer< const Self >
using	DirectionType = typename OutputImageType::DirectionType
using	InputSpatialObjectConstPointer = typename InputSpatialObjectType::ConstPointer
using	InputSpatialObjectPointer = typename InputSpatialObjectType::Pointer
using	InputSpatialObjectType = TInputSpatialObject
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType = typename Superclass::OutputImageRegionType
using	OutputImageType = TOutputImage
using	Pointer = SmartPointer< Self >
using	PointType = typename OutputImageType::PointType
using	Self = SpatialObjectToImageFilter
using	SizeType = typename OutputImageType::SizeType
using	SpacingType = typename OutputImageType::SpacingType
using	Superclass = ImageSource< TOutputImage >
using	ValueType = typename OutputImageType::ValueType
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 ::itk::LightObject::Pointer	CreateAnother () const
const InputSpatialObjectType *	GetInput ()
const InputSpatialObjectType *	GetInput (unsigned int idx)
virtual const char *	GetNameOfClass () const
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputSpatialObjectType *input)
virtual void	SetInput (unsigned int, const InputSpatialObjectType *object)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
OutputImageType *	GetOutput (unsigned int idx)
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	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
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	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
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
MultiThreaderType *	GetMultiThreader () const
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	PrepareOutputs ()
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
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 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	ObjectDimension = InputSpatialObjectType::ObjectDimension
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension
SizeType	m_Size
double	m_Spacing [OutputImageDimension]
double	m_Origin [OutputImageDimension]
DirectionType	m_Direction
unsigned int	m_ChildrenDepth
ValueType	m_InsideValue
ValueType	m_OutsideValue
bool	m_UseObjectValue
template<class TReferenceImage >
void	SetReferenceImage (TReferenceImage *refImage)
virtual void	SetSpacing (const SpacingType &spacing)
virtual void	SetSpacing (const double *spacing)
virtual void	SetSpacing (const float *spacing)
virtual const double *	GetSpacing () const
virtual void	SetDirection (const DirectionType &dir)
virtual const DirectionType &	GetDirection () const
virtual void	SetInsideValue (ValueType _arg)
virtual ValueType	GetInsideValue () const
virtual void	SetOutsideValue (ValueType _arg)
virtual ValueType	GetOutsideValue () const
virtual void	SetOrigin (const PointType &origin)
virtual void	SetOrigin (const double *origin)
virtual void	SetOrigin (const float *origin)
virtual const double *	GetOrigin () const
virtual void	SetChildrenDepth (unsigned int _arg)
virtual unsigned int	GetChildrenDepth () const
virtual void	SetSize (SizeType _arg)
virtual SizeType	GetSize () const
virtual void	SetUseObjectValue (bool _arg)
virtual bool	GetUseObjectValue () const
virtual void	UseObjectValueOn ()
virtual void	UseObjectValueOff ()
	SpatialObjectToImageFilter ()
	~SpatialObjectToImageFilter () override=default
void	GenerateOutputInformation () override
void	GenerateData () override
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
	ImageSource ()
	~ImageSource () override=default
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	AfterThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
Protected Member Functions inherited from itk::ProcessObject
	ProcessObject ()
	~ProcessObject () override
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
virtual void	SetPrimaryInput (DataObject *object)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
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
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	SetPrimaryOutput (DataObject *object)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
virtual void	VerifyPreconditions () ITKv5_CONST
virtual void	VerifyInputInformation () ITKv5_CONST
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	RestoreInputReleaseDataFlags ()
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	ThreaderUpdateProgressOff ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
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
bool	m_Updating
TimeStamp	m_OutputInformationMTime
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TInputSpatialObject, typename TOutputImage>
class itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >

Base class for filters that take a SpatialObject as input and produce an image as output. By default, if the user does not specify the size of the output image, the maximum size of the object's bounding box is used. The spacing of the image is given by the spacing of the input Spatial object.

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Convert Spatial Object To Image

Examples

Examples/Filtering/SpatialObjectToImage1.cxx, Examples/Filtering/SpatialObjectToImage2.cxx, Examples/Filtering/SpatialObjectToImage3.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/SpatialObjects/MeshSpatialObject.cxx, SphinxExamples/src/Core/SpatialObjects/ContourSpatialObject/Code.cxx, SphinxExamples/src/Core/SpatialObjects/ConvertSpatialObjectToImage/Code.cxx, SphinxExamples/src/Core/SpatialObjects/CreateALineSpatialObject/Code.cxx, SphinxExamples/src/Core/SpatialObjects/Ellipse/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesAffine/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesBSpline/Code.cxx, and SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx.

Definition at line 41 of file itkSpatialObjectToImageFilter.h.

Member Typedef Documentation

ChildrenListType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ChildrenListType = typename TInputSpatialObject::ChildrenListType

Definition at line 73 of file itkSpatialObjectToImageFilter.h.

ConstPointer

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkSpatialObjectToImageFilter.h.

DirectionType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::DirectionType = typename OutputImageType::DirectionType

Definition at line 58 of file itkSpatialObjectToImageFilter.h.

InputSpatialObjectConstPointer

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectConstPointer = typename InputSpatialObjectType::ConstPointer

Definition at line 72 of file itkSpatialObjectToImageFilter.h.

InputSpatialObjectPointer

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectPointer = typename InputSpatialObjectType::Pointer

Definition at line 71 of file itkSpatialObjectToImageFilter.h.

InputSpatialObjectType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectType = TInputSpatialObject

Some convenient type alias.

Definition at line 70 of file itkSpatialObjectToImageFilter.h.

OutputImagePointer

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 55 of file itkSpatialObjectToImageFilter.h.

OutputImageRegionType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Superclass type alias.

Definition at line 67 of file itkSpatialObjectToImageFilter.h.

OutputImageType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageType = TOutputImage

Definition at line 52 of file itkSpatialObjectToImageFilter.h.

Pointer

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkSpatialObjectToImageFilter.h.

PointType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::PointType = typename OutputImageType::PointType

Definition at line 54 of file itkSpatialObjectToImageFilter.h.

Self

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Self = SpatialObjectToImageFilter

Standard class type aliases.

Definition at line 47 of file itkSpatialObjectToImageFilter.h.

SizeType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 53 of file itkSpatialObjectToImageFilter.h.

SpacingType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SpacingType = typename OutputImageType::SpacingType

Definition at line 57 of file itkSpatialObjectToImageFilter.h.

Superclass

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Superclass = ImageSource<TOutputImage>

Definition at line 48 of file itkSpatialObjectToImageFilter.h.

ValueType

template<typename TInputSpatialObject , typename TOutputImage >

using itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ValueType = typename OutputImageType::ValueType

Definition at line 56 of file itkSpatialObjectToImageFilter.h.

Constructor & Destructor Documentation

SpatialObjectToImageFilter()

template<typename TInputSpatialObject , typename TOutputImage >

itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SpatialObjectToImageFilter ( )

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

~SpatialObjectToImageFilter()

template<typename TInputSpatialObject , typename TOutputImage >

itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::~SpatialObjectToImageFilter ( )

overrideprotecteddefault

Generate an output image that matches the origin, size, direction, and spacing of this image.

Member Function Documentation

CreateAnother()

template<typename TInputSpatialObject , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

GenerateData()

template<typename TInputSpatialObject , typename TOutputImage >

void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

Reimplemented from itk::ImageSource< TOutputImage >.

GenerateOutputInformation()

template<typename TInputSpatialObject , typename TOutputImage >

void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GenerateOutputInformation ( )

inlineoverrideprotectedvirtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

Reimplemented from itk::ProcessObject.

Definition at line 192 of file itkSpatialObjectToImageFilter.h.

GetChildrenDepth()

template<typename TInputSpatialObject , typename TOutputImage >

virtual unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetChildrenDepth ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetDirection()

template<typename TInputSpatialObject , typename TOutputImage >

virtual const DirectionType& itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetDirection ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetInput() [1/2]

template<typename TInputSpatialObject , typename TOutputImage >

const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput

(

)

GetInput() [2/2]

template<typename TInputSpatialObject , typename TOutputImage >

const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput

(

unsigned int

idx

)

GetInsideValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInsideValue ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetNameOfClass()

template<typename TInputSpatialObject , typename TOutputImage >

virtual const char* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

GetOrigin()

template<typename TInputSpatialObject , typename TOutputImage >

virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOrigin ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetOutsideValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOutsideValue ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetSize()

template<typename TInputSpatialObject , typename TOutputImage >

virtual SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSize ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetSpacing()

template<typename TInputSpatialObject , typename TOutputImage >

virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSpacing ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

GetUseObjectValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetUseObjectValue ( ) const

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

New()

template<typename TInputSpatialObject , typename TOutputImage >

static Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputSpatialObject , typename TOutputImage >

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

overrideprotectedvirtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

Reimplemented from itk::ImageSource< TOutputImage >.

SetChildrenDepth()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetChildrenDepth ( unsigned int  _arg )

virtual

The spatial object being transformed can be part of a hierarchy. How deep in the hierarchy should we descend in generating the image? A ChildrenDepth of 0 means to only include the object itself.

SetDirection()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetDirection ( const DirectionType &  dir )

virtual

Directions of the output image. The direction is for oriented images.

SetInput() [1/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::ProcessObject::SetInput

Set/Get the image input of this process object.

SetInput() [2/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( const InputSpatialObjectType *  input )

virtual

SetInput() [3/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( unsigned int  , const InputSpatialObjectType *  object  )

virtual

SetInsideValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInsideValue ( ValueType  _arg )

virtual

Set/Get the value for pixels inside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

SetOrigin() [1/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const double *  origin )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

SetOrigin() [2/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const float *  origin )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

SetOrigin() [3/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const PointType &  origin )

virtual

The origin of the output image. The origin is the geometric coordinates of the index (0,0,...,0). It is stored internally as double but may be set from float.

See also

GetOrigin()

SetOutsideValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOutsideValue ( ValueType  _arg )

virtual

Set/Get the value for pixels outside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

SetReferenceImage()

template<typename TInputSpatialObject , typename TOutputImage >

template<class TReferenceImage >

void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetReferenceImage ( TReferenceImage *  refImage )

inline

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 98 of file itkSpatialObjectToImageFilter.h.

SetSize()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSize ( SizeType  _arg )

virtual

Set/Get Size

SetSpacing() [1/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const double *  spacing )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

SetSpacing() [2/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const float *  spacing )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

SetSpacing() [3/3]

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const SpacingType &  spacing )

virtual

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also

GetSpacing()

SetUseObjectValue()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetUseObjectValue ( bool  _arg )

virtual

If UseObjectValue is set to true, then the filter uses the ValueAtInWorldSpace() function instead of IsInsideInWorldSpace()

UseObjectValueOff()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::UseObjectValueOff ( )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

UseObjectValueOn()

template<typename TInputSpatialObject , typename TOutputImage >

virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::UseObjectValueOn ( )

virtual

Generate an output image that matches the origin, size, direction, and spacing of this image.

Member Data Documentation

m_ChildrenDepth

template<typename TInputSpatialObject , typename TOutputImage >

unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_ChildrenDepth

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 202 of file itkSpatialObjectToImageFilter.h.

m_Direction

template<typename TInputSpatialObject , typename TOutputImage >

DirectionType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Direction

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 200 of file itkSpatialObjectToImageFilter.h.

m_InsideValue

template<typename TInputSpatialObject , typename TOutputImage >

ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_InsideValue

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 204 of file itkSpatialObjectToImageFilter.h.

m_Origin

template<typename TInputSpatialObject , typename TOutputImage >

double itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Origin[OutputImageDimension]

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 199 of file itkSpatialObjectToImageFilter.h.

m_OutsideValue

template<typename TInputSpatialObject , typename TOutputImage >

ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_OutsideValue

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 205 of file itkSpatialObjectToImageFilter.h.

m_Size

template<typename TInputSpatialObject , typename TOutputImage >

SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Size

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 197 of file itkSpatialObjectToImageFilter.h.

m_Spacing

template<typename TInputSpatialObject , typename TOutputImage >

double itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Spacing[OutputImageDimension]

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 198 of file itkSpatialObjectToImageFilter.h.

m_UseObjectValue

template<typename TInputSpatialObject , typename TOutputImage >

bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_UseObjectValue

protected

Generate an output image that matches the origin, size, direction, and spacing of this image.

Definition at line 207 of file itkSpatialObjectToImageFilter.h.

ObjectDimension

template<typename TInputSpatialObject , typename TOutputImage >

constexpr unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ObjectDimension = InputSpatialObjectType::ObjectDimension

staticconstexpr

ImageDimension constants

Definition at line 76 of file itkSpatialObjectToImageFilter.h.

OutputImageDimension

template<typename TInputSpatialObject , typename TOutputImage >

constexpr unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 78 of file itkSpatialObjectToImageFilter.h.

---

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

• itkSpatialObjectToImageFilter.h