ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage > Class Template Reference

#include <itkSpatialObjectToImageFilter.h>

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

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.

Wiki Examples:
Examples:
Examples/Filtering/SpatialObjectToImage1.cxx, Examples/Filtering/SpatialObjectToImage2.cxx, Examples/Filtering/SpatialObjectToImage3.cxx, Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, Examples/RegistrationITKv3/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/SpatialObjects/MeshSpatialObject.cxx, WikiExamples/Registration/ImageRegistrationMethod.cxx, WikiExamples/Registration/ImageRegistrationMethodAffine.cxx, WikiExamples/Registration/ImageRegistrationMethodBSpline.cxx, WikiExamples/Registration/MutualInformation.cxx, WikiExamples/Registration/MutualInformationAffine.cxx, WikiExamples/SpatialObjects/EllipseSpatialObject.cxx, WikiExamples/SpatialObjects/LineSpatialObject.cxx, and WikiExamples/SpatialObjects/SpatialObjectToImageFilter.cxx.

Definition at line 40 of file itkSpatialObjectToImageFilter.h.

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
 
virtual const DirectionTypeGetDirection () const
 
const InputSpatialObjectTypeGetInput ()
 
const InputSpatialObjectTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
virtual const double * GetOrigin () const
 
virtual const double * GetSpacing () const
 
virtual void SetDirection (const DirectionType &direction)
 
virtual void SetInput (const InputSpatialObjectType *object)
 
virtual void SetInput (unsigned int, const InputSpatialObjectType *object)
 
virtual void SetOrigin (const PointType &origin)
 
virtual void SetOrigin (const double *origin)
 
virtual void SetOrigin (const float *origin)
 
virtual void SetSpacing (const SpacingType &spacing)
 
virtual void SetSpacing (const double *spacing)
 
virtual void SetSpacing (const float *spacing)
 
virtual void SetInsideValue (ValueType _arg)
 
virtual ValueType GetInsideValue () const
 
virtual void SetOutsideValue (ValueType _arg)
 
virtual ValueType GetOutsideValue () 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
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
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 ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
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 flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 noexceptoverride
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- 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
 

Protected Member Functions

void GenerateData () override
 
void GenerateOutputInformation () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialObjectToImageFilter ()
 
 ~SpatialObjectToImageFilter () 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 &outputRegionForThread, 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)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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 ()
 

Protected Attributes

unsigned int m_ChildrenDepth
 
DirectionType m_Direction
 
ValueType m_InsideValue
 
double m_Origin [OutputImageDimension]
 
ValueType m_OutsideValue
 
SizeType m_Size
 
double m_Spacing [OutputImageDimension]
 
bool m_UseObjectValue
 
- 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
 

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)
 

Member Typedef Documentation

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

Definition at line 72 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 49 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 57 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 71 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 70 of file itkSpatialObjectToImageFilter.h.

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

Some convenient type alias.

Definition at line 69 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 54 of file itkSpatialObjectToImageFilter.h.

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

Superclass type alias.

Definition at line 66 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 51 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 48 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 53 of file itkSpatialObjectToImageFilter.h.

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

Standard class type aliases.

Definition at line 46 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 52 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 56 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 47 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 55 of file itkSpatialObjectToImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputSpatialObject , typename TOutputImage >
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SpatialObjectToImageFilter ( )
protected
template<typename TInputSpatialObject , typename TOutputImage >
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::~SpatialObjectToImageFilter ( )
overrideprotecteddefault

Member Function Documentation

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.

template<typename TInputSpatialObject , typename TOutputImage >
void itk::SpatialObjectToImageFilter< TInputSpatialObject, 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 >.

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

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.

Definition at line 162 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
virtual unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetChildrenDepth ( ) const
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.

template<typename TInputSpatialObject , typename TOutputImage >
virtual const DirectionType& itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetDirection ( ) const
virtual
template<typename TInputSpatialObject , typename TOutputImage >
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput ( )
template<typename TInputSpatialObject , typename TOutputImage >
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput ( unsigned int  idx)
template<typename TInputSpatialObject , typename TOutputImage >
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInsideValue ( ) const
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.

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

template<typename TInputSpatialObject , typename TOutputImage >
virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOrigin ( ) const
virtual
template<typename TInputSpatialObject , typename TOutputImage >
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOutsideValue ( ) const
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.

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

Set/Get Size

template<typename TInputSpatialObject , typename TOutputImage >
virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSpacing ( ) const
virtual
template<typename TInputSpatialObject , typename TOutputImage >
virtual bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetUseObjectValue ( ) const
virtual

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

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

Method for creation through the object factory.

template<typename TInputSpatialObject , typename TOutputImage >
void itk::SpatialObjectToImageFilter< TInputSpatialObject, 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 >.

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.

template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetDirection ( const DirectionType direction)
virtual

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

template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( const InputSpatialObjectType object)
virtual
template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( unsigned  int,
const InputSpatialObjectType object 
)
virtual
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.

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()
template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const double *  origin)
virtual
template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const float *  origin)
virtual
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.

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

Set/Get Size

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()
template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const double *  spacing)
virtual
template<typename TInputSpatialObject , typename TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const float *  spacing)
virtual
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()

Member Data Documentation

template<typename TInputSpatialObject , typename TOutputImage >
unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_ChildrenDepth
protected

Definition at line 170 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
DirectionType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Direction
protected

Definition at line 168 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_InsideValue
protected

Definition at line 172 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 167 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_OutsideValue
protected

Definition at line 173 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Size
protected

Definition at line 165 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 166 of file itkSpatialObjectToImageFilter.h.

template<typename TInputSpatialObject , typename TOutputImage >
bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_UseObjectValue
protected

Definition at line 175 of file itkSpatialObjectToImageFilter.h.

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

ImageDimension constants

Definition at line 75 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 77 of file itkSpatialObjectToImageFilter.h.


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