ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::CastSpatialObjectFilter< ObjectDimension > Class Template Reference
Group Core » Module ITKSpatialObjects

#include <itkCastSpatialObjectFilter.h>

Detailed Description

template<unsigned int ObjectDimension>
class itk::CastSpatialObjectFilter< ObjectDimension >

This filter casts one spatialobject to another, when the class hierarchy supports it (e.g., Tube to PointBased). Particularly useful in Python where casting objects without public constructors (e.g., objects managed by smartpointers) is problematic.

Definition at line 54 of file itkCastSpatialObjectFilter.h.

+ Inheritance diagram for itk::CastSpatialObjectFilter< ObjectDimension >:
+ Collaboration diagram for itk::CastSpatialObjectFilter< ObjectDimension >:

Public Types

using ArrowPointer = typename itk::ArrowSpatialObject< ObjectDimension >::Pointer
 
using BlobPointer = typename itk::BlobSpatialObject< ObjectDimension >::Pointer
 
using BoxPointer = typename itk::BoxSpatialObject< ObjectDimension >::Pointer
 
using ConstPointer = SmartPointer< const Self >
 
using ContourPointer = typename itk::ContourSpatialObject< ObjectDimension >::Pointer
 
using EllipsePointer = typename itk::EllipseSpatialObject< ObjectDimension >::Pointer
 
using GaussianPointer = typename itk::GaussianSpatialObject< ObjectDimension >::Pointer
 
using GroupPointer = typename itk::GroupSpatialObject< ObjectDimension >::Pointer
 
using ImageMaskPointer = typename itk::ImageMaskSpatialObject< ObjectDimension >::Pointer
 
using ImagePointer = typename itk::ImageSpatialObject< ObjectDimension >::Pointer
 
using InputChildrenListType = typename InputSpatialObjectType::ChildrenListType
 
using InputSpatialObjectType = SpatialObject< ObjectDimension >
 
using LandmarkPointer = typename itk::LandmarkSpatialObject< ObjectDimension >::Pointer
 
using LinePointer = typename itk::LineSpatialObject< ObjectDimension >::Pointer
 
using PointBasedPointer = typename itk::PointBasedSpatialObject< ObjectDimension >::Pointer
 
using Pointer = SmartPointer< Self >
 
using PolygonPointer = typename itk::PolygonSpatialObject< ObjectDimension >::Pointer
 
using Self = CastSpatialObjectFilter
 
using SpatialObjectPointer = typename itk::SpatialObject< ObjectDimension >::Pointer
 
using Superclass = Object
 
using SurfacePointer = typename itk::SurfaceSpatialObject< ObjectDimension >::Pointer
 
using TubePointer = typename itk::TubeSpatialObject< ObjectDimension >::Pointer
 
- 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

std::list< ArrowPointer > * GetArrows () const
 
std::list< BlobPointer > * GetBlobs () const
 
std::list< BoxPointer > * GetBoxes () const
 
std::list< ContourPointer > * GetContours () const
 
std::list< EllipsePointer > * GetEllipses () const
 
std::list< GaussianPointer > * GetGaussians () const
 
std::list< GroupPointer > * GetGroups () const
 
std::list< ImageMaskPointer > * GetImageMasks () const
 
std::list< ImagePointer > * GetImages () const
 
virtual const InputSpatialObjectType * GetInput () const
 
std::list< LandmarkPointer > * GetLandmarks () const
 
std::list< LinePointer > * GetLines () const
 
const char * GetNameOfClass () const override
 
template<class OutputSpatialObjectT >
std::list< typename OutputSpatialObjectT::Pointer > * GetOutput () const
 
std::list< PointBasedPointer > * GetPointBased () const
 
std::list< PolygonPointer > * GetPolygons () const
 
std::list< SpatialObjectPointer > * GetSpatialObjects () const
 
std::list< SurfacePointer > * GetSurfaces () const
 
std::list< TubePointer > * GetTubes () const
 
virtual void SetInput (InputSpatialObjectType *_arg)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

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

Protected Member Functions

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

InputSpatialObjectType::Pointer m_Input {}
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ArrowPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::ArrowPointer = typename itk::ArrowSpatialObject<ObjectDimension>::Pointer

Definition at line 111 of file itkCastSpatialObjectFilter.h.

◆ BlobPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::BlobPointer = typename itk::BlobSpatialObject<ObjectDimension>::Pointer

Definition at line 118 of file itkCastSpatialObjectFilter.h.

◆ BoxPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::BoxPointer = typename itk::BoxSpatialObject<ObjectDimension>::Pointer

Definition at line 125 of file itkCastSpatialObjectFilter.h.

◆ ConstPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkCastSpatialObjectFilter.h.

◆ ContourPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::ContourPointer = typename itk::ContourSpatialObject<ObjectDimension>::Pointer

Definition at line 132 of file itkCastSpatialObjectFilter.h.

◆ EllipsePointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::EllipsePointer = typename itk::EllipseSpatialObject<ObjectDimension>::Pointer

Definition at line 139 of file itkCastSpatialObjectFilter.h.

◆ GaussianPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::GaussianPointer = typename itk::GaussianSpatialObject<ObjectDimension>::Pointer

Definition at line 146 of file itkCastSpatialObjectFilter.h.

◆ GroupPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::GroupPointer = typename itk::GroupSpatialObject<ObjectDimension>::Pointer

Definition at line 153 of file itkCastSpatialObjectFilter.h.

◆ ImageMaskPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::ImageMaskPointer = typename itk::ImageMaskSpatialObject<ObjectDimension>::Pointer

Definition at line 160 of file itkCastSpatialObjectFilter.h.

◆ ImagePointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::ImagePointer = typename itk::ImageSpatialObject<ObjectDimension>::Pointer

Definition at line 167 of file itkCastSpatialObjectFilter.h.

◆ InputChildrenListType

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::InputChildrenListType = typename InputSpatialObjectType::ChildrenListType

Definition at line 71 of file itkCastSpatialObjectFilter.h.

◆ InputSpatialObjectType

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::InputSpatialObjectType = SpatialObject<ObjectDimension>

Definition at line 69 of file itkCastSpatialObjectFilter.h.

◆ LandmarkPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::LandmarkPointer = typename itk::LandmarkSpatialObject<ObjectDimension>::Pointer

Definition at line 174 of file itkCastSpatialObjectFilter.h.

◆ LinePointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::LinePointer = typename itk::LineSpatialObject<ObjectDimension>::Pointer

Definition at line 181 of file itkCastSpatialObjectFilter.h.

◆ PointBasedPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::PointBasedPointer = typename itk::PointBasedSpatialObject<ObjectDimension>::Pointer

Definition at line 188 of file itkCastSpatialObjectFilter.h.

◆ Pointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkCastSpatialObjectFilter.h.

◆ PolygonPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::PolygonPointer = typename itk::PolygonSpatialObject<ObjectDimension>::Pointer

Definition at line 195 of file itkCastSpatialObjectFilter.h.

◆ Self

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::Self = CastSpatialObjectFilter

Standard class typedefs.

Definition at line 60 of file itkCastSpatialObjectFilter.h.

◆ SpatialObjectPointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::SpatialObjectPointer = typename itk::SpatialObject<ObjectDimension>::Pointer

Definition at line 202 of file itkCastSpatialObjectFilter.h.

◆ Superclass

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::Superclass = Object

Definition at line 61 of file itkCastSpatialObjectFilter.h.

◆ SurfacePointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::SurfacePointer = typename itk::SurfaceSpatialObject<ObjectDimension>::Pointer

Definition at line 209 of file itkCastSpatialObjectFilter.h.

◆ TubePointer

template<unsigned int ObjectDimension>
using itk::CastSpatialObjectFilter< ObjectDimension >::TubePointer = typename itk::TubeSpatialObject<ObjectDimension>::Pointer

Definition at line 216 of file itkCastSpatialObjectFilter.h.

Constructor & Destructor Documentation

◆ CastSpatialObjectFilter()

template<unsigned int ObjectDimension>
itk::CastSpatialObjectFilter< ObjectDimension >::CastSpatialObjectFilter ( )
protected

◆ ~CastSpatialObjectFilter()

template<unsigned int ObjectDimension>
itk::CastSpatialObjectFilter< ObjectDimension >::~CastSpatialObjectFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GetArrows()

template<unsigned int ObjectDimension>
std::list<ArrowPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetArrows ( ) const
inline

Definition at line 113 of file itkCastSpatialObjectFilter.h.

◆ GetBlobs()

template<unsigned int ObjectDimension>
std::list<BlobPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetBlobs ( ) const
inline

Definition at line 120 of file itkCastSpatialObjectFilter.h.

◆ GetBoxes()

template<unsigned int ObjectDimension>
std::list<BoxPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetBoxes ( ) const
inline

Definition at line 127 of file itkCastSpatialObjectFilter.h.

◆ GetContours()

template<unsigned int ObjectDimension>
std::list<ContourPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetContours ( ) const
inline

Definition at line 134 of file itkCastSpatialObjectFilter.h.

◆ GetEllipses()

template<unsigned int ObjectDimension>
std::list<EllipsePointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetEllipses ( ) const
inline

Definition at line 141 of file itkCastSpatialObjectFilter.h.

◆ GetGaussians()

template<unsigned int ObjectDimension>
std::list<GaussianPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetGaussians ( ) const
inline

Definition at line 148 of file itkCastSpatialObjectFilter.h.

◆ GetGroups()

template<unsigned int ObjectDimension>
std::list<GroupPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetGroups ( ) const
inline

Definition at line 155 of file itkCastSpatialObjectFilter.h.

◆ GetImageMasks()

template<unsigned int ObjectDimension>
std::list<ImageMaskPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetImageMasks ( ) const
inline

Definition at line 162 of file itkCastSpatialObjectFilter.h.

◆ GetImages()

template<unsigned int ObjectDimension>
std::list<ImagePointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetImages ( ) const
inline

Definition at line 169 of file itkCastSpatialObjectFilter.h.

◆ GetInput()

template<unsigned int ObjectDimension>
virtual const InputSpatialObjectType* itk::CastSpatialObjectFilter< ObjectDimension >::GetInput ( ) const
virtual

◆ GetLandmarks()

template<unsigned int ObjectDimension>
std::list<LandmarkPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetLandmarks ( ) const
inline

Definition at line 176 of file itkCastSpatialObjectFilter.h.

◆ GetLines()

template<unsigned int ObjectDimension>
std::list<LinePointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetLines ( ) const
inline

Definition at line 183 of file itkCastSpatialObjectFilter.h.

◆ GetNameOfClass()

template<unsigned int ObjectDimension>
const char* itk::CastSpatialObjectFilter< ObjectDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetOutput()

template<unsigned int ObjectDimension>
template<class OutputSpatialObjectT >
std::list<typename OutputSpatialObjectT::Pointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetOutput ( ) const
inline

Definition at line 78 of file itkCastSpatialObjectFilter.h.

References New().

◆ GetPointBased()

template<unsigned int ObjectDimension>
std::list<PointBasedPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetPointBased ( ) const
inline

Definition at line 190 of file itkCastSpatialObjectFilter.h.

◆ GetPolygons()

template<unsigned int ObjectDimension>
std::list<PolygonPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetPolygons ( ) const
inline

Definition at line 197 of file itkCastSpatialObjectFilter.h.

◆ GetSpatialObjects()

template<unsigned int ObjectDimension>
std::list<SpatialObjectPointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetSpatialObjects ( ) const
inline

Definition at line 204 of file itkCastSpatialObjectFilter.h.

◆ GetSurfaces()

template<unsigned int ObjectDimension>
std::list<SurfacePointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetSurfaces ( ) const
inline

Definition at line 211 of file itkCastSpatialObjectFilter.h.

◆ GetTubes()

template<unsigned int ObjectDimension>
std::list<TubePointer>* itk::CastSpatialObjectFilter< ObjectDimension >::GetTubes ( ) const
inline

Definition at line 218 of file itkCastSpatialObjectFilter.h.

◆ New()

template<unsigned int ObjectDimension>
static Pointer itk::CastSpatialObjectFilter< ObjectDimension >::New ( )
static

◆ PrintSelf()

template<unsigned int ObjectDimension>
void itk::CastSpatialObjectFilter< ObjectDimension >::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::Object.

◆ SetInput()

template<unsigned int ObjectDimension>
virtual void itk::CastSpatialObjectFilter< ObjectDimension >::SetInput ( InputSpatialObjectType *  _arg)
virtual

Member Data Documentation

◆ m_Input

template<unsigned int ObjectDimension>
InputSpatialObjectType::Pointer itk::CastSpatialObjectFilter< ObjectDimension >::m_Input {}
private

Definition at line 232 of file itkCastSpatialObjectFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16