ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::RegularSphereMeshSource< TOutputMesh > Class Template Reference

#include <itkRegularSphereMeshSource.h>

+ Inheritance diagram for itk::RegularSphereMeshSource< TOutputMesh >:
+ Collaboration diagram for itk::RegularSphereMeshSource< TOutputMesh >:

Public Types

using CellAutoPointer = typename TriCellType::CellAutoPointer
 
using CellInterfaceType = itk::CellInterface< PixelType, CellTraits >
 
using CellTraits = typename OutputMeshType::CellTraits
 
using ConstPointer = itk::SmartPointer< const Self >
 
using IndexPairType = std::pair< IdentifierType, IdentifierType >
 
using MeshTraits = typename OutputMeshType::MeshTraits
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using PixelType = typename MeshTraits::PixelType
 
using Pointer = itk::SmartPointer< Self >
 
using PointMapType = itk::MapContainer< IndexPairType, IdentifierType >
 
using PointsContainer = typename OutputMeshType::PointsContainer
 
using PointsContainerPointer = typename OutputMeshType::PointsContainerPointer
 
using PointType = typename OutputMeshType::PointType
 
using Self = RegularSphereMeshSource
 
using Superclass = itk::MeshSource< TOutputMesh >
 
using TriCellAutoPointer = typename TriCellType::SelfAutoPointer
 
using TriCellType = itk::TriangleCell< CellInterfaceType >
 
using VectorType = typename PointType::VectorType
 
- Public Types inherited from itk::MeshSource< TOutputMesh >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using OutputMeshPointer = typename OutputMeshType::Pointer
 
using OutputMeshType = TOutputMesh
 
using Pointer = SmartPointer< Self >
 
using Self = MeshSource
 
using Superclass = ProcessObject
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
- 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 char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
void SetOutput (TOutputMesh *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) 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 DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
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 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
 
MultiThreaderTypeGetMultiThreader () 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
 
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 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
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::MeshSource< TOutputMesh >
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 ()
 
PointType m_Center
 
unsigned int m_Resolution
 
VectorType m_Scale
 
virtual void SetResolution (unsigned int _arg)
 
virtual unsigned int GetResolution () const
 
virtual void SetCenter (PointType _arg)
 
virtual PointType GetCenter () const
 
virtual void SetScale (VectorType _arg)
 
virtual VectorType GetScale () const
 
 RegularSphereMeshSource ()
 
 ~RegularSphereMeshSource () override=default
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateData () override
 
PointType Divide (const PointType &p1, const PointType &p2) const
 
void AddCell (OutputMeshType *mesh, const typename OutputMeshType::PointIdentifier *pointIds, IdentifierType idx)
 

Additional Inherited Members

- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
 MeshSource ()
 
 ~MeshSource () override=default
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, 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)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
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 &time)
 
- 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::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- 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 TOutputMesh>
class itk::RegularSphereMeshSource< TOutputMesh >

Inputs are the center of the mesh, the scale (radius in each dimension) of the mesh and a resolution parameter, which corresponds to the recursion depth while creating a spherical triangle mesh.

Don't use recursion depths larger than 5, because mesh generation gets very slow.

Author
Thomas Boettger. Division Medical and Biological Informatics, German Cancer Research Center, Heidelberg.
Examples
SphinxExamples/src/Core/Mesh/CalculateAreaAndVolumeOfSimplexMesh/Code.cxx, and SphinxExamples/src/Core/Mesh/WorkingWithPointAndCellData/Code.cxx.

Definition at line 41 of file itkRegularSphereMeshSource.h.

Member Typedef Documentation

◆ CellAutoPointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::CellAutoPointer = typename TriCellType::CellAutoPointer

Definition at line 75 of file itkRegularSphereMeshSource.h.

◆ CellInterfaceType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::CellInterfaceType = itk::CellInterface<PixelType, CellTraits>

Define the triangular cell types which form the surface

Definition at line 72 of file itkRegularSphereMeshSource.h.

◆ CellTraits

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::CellTraits = typename OutputMeshType::CellTraits

Definition at line 67 of file itkRegularSphereMeshSource.h.

◆ ConstPointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 50 of file itkRegularSphereMeshSource.h.

◆ IndexPairType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::IndexPairType = std::pair<IdentifierType, IdentifierType>

Definition at line 77 of file itkRegularSphereMeshSource.h.

◆ MeshTraits

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::MeshTraits = typename OutputMeshType::MeshTraits

Definition at line 60 of file itkRegularSphereMeshSource.h.

◆ OutputMeshPointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::OutputMeshPointer = typename OutputMeshType::Pointer

Some convenient type alias.

Definition at line 66 of file itkRegularSphereMeshSource.h.

◆ OutputMeshType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::OutputMeshType = TOutputMesh

Hold on to the type information specified by the template parameters.

Definition at line 59 of file itkRegularSphereMeshSource.h.

◆ PixelType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::PixelType = typename MeshTraits::PixelType

Definition at line 62 of file itkRegularSphereMeshSource.h.

◆ Pointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::Pointer = itk::SmartPointer<Self>

Definition at line 49 of file itkRegularSphereMeshSource.h.

◆ PointMapType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::PointMapType = itk::MapContainer<IndexPairType, IdentifierType>

Definition at line 78 of file itkRegularSphereMeshSource.h.

◆ PointsContainer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::PointsContainer = typename OutputMeshType::PointsContainer

Definition at line 69 of file itkRegularSphereMeshSource.h.

◆ PointsContainerPointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::PointsContainerPointer = typename OutputMeshType::PointsContainerPointer

Definition at line 68 of file itkRegularSphereMeshSource.h.

◆ PointType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::PointType = typename OutputMeshType::PointType

Definition at line 61 of file itkRegularSphereMeshSource.h.

◆ Self

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::Self = RegularSphereMeshSource

Standard "Self" type alias.

Definition at line 47 of file itkRegularSphereMeshSource.h.

◆ Superclass

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::Superclass = itk::MeshSource<TOutputMesh>

Definition at line 48 of file itkRegularSphereMeshSource.h.

◆ TriCellAutoPointer

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::TriCellAutoPointer = typename TriCellType::SelfAutoPointer

Definition at line 74 of file itkRegularSphereMeshSource.h.

◆ TriCellType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::TriCellType = itk::TriangleCell<CellInterfaceType>

Definition at line 73 of file itkRegularSphereMeshSource.h.

◆ VectorType

template<typename TOutputMesh >
using itk::RegularSphereMeshSource< TOutputMesh >::VectorType = typename PointType::VectorType

Definition at line 63 of file itkRegularSphereMeshSource.h.

Constructor & Destructor Documentation

◆ RegularSphereMeshSource()

template<typename TOutputMesh >
itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource ( )
protected

model center

◆ ~RegularSphereMeshSource()

template<typename TOutputMesh >
itk::RegularSphereMeshSource< TOutputMesh >::~RegularSphereMeshSource ( )
overrideprotecteddefault

model center

Member Function Documentation

◆ AddCell()

template<typename TOutputMesh >
void itk::RegularSphereMeshSource< TOutputMesh >::AddCell ( OutputMeshType mesh,
const typename OutputMeshType::PointIdentifier *  pointIds,
IdentifierType  idx 
)
protected

model center

◆ CreateAnother()

template<typename TOutputMesh >
virtual::itk::LightObject::Pointer itk::RegularSphereMeshSource< TOutputMesh >::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::MeshSource< TOutputMesh >.

◆ Divide()

template<typename TOutputMesh >
PointType itk::RegularSphereMeshSource< TOutputMesh >::Divide ( const PointType p1,
const PointType p2 
) const
protected

model center

◆ GenerateData()

template<typename TOutputMesh >
void itk::RegularSphereMeshSource< TOutputMesh >::GenerateData ( )
overrideprotectedvirtual

model center

Reimplemented from itk::ProcessObject.

◆ GetCenter()

template<typename TOutputMesh >
virtual PointType itk::RegularSphereMeshSource< TOutputMesh >::GetCenter ( ) const
virtual

model center

◆ GetNameOfClass()

template<typename TOutputMesh >
virtual const char* itk::RegularSphereMeshSource< TOutputMesh >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::MeshSource< TOutputMesh >.

◆ GetResolution()

template<typename TOutputMesh >
virtual unsigned int itk::RegularSphereMeshSource< TOutputMesh >::GetResolution ( ) const
virtual

model center

◆ GetScale()

template<typename TOutputMesh >
virtual VectorType itk::RegularSphereMeshSource< TOutputMesh >::GetScale ( ) const
virtual

model center

◆ New()

template<typename TOutputMesh >
static Pointer itk::RegularSphereMeshSource< TOutputMesh >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputMesh >
void itk::RegularSphereMeshSource< TOutputMesh >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

model center

Reimplemented from itk::MeshSource< TOutputMesh >.

◆ SetCenter()

template<typename TOutputMesh >
virtual void itk::RegularSphereMeshSource< TOutputMesh >::SetCenter ( PointType  _arg)
virtual

Set/Get Coordinates of the Sphere center.

◆ SetResolution()

template<typename TOutputMesh >
virtual void itk::RegularSphereMeshSource< TOutputMesh >::SetResolution ( unsigned int  _arg)
virtual

Set the resolution level to be used for generating cells in the Sphere. High values of this parameter will produce sphere with more triangles.

◆ SetScale()

template<typename TOutputMesh >
virtual void itk::RegularSphereMeshSource< TOutputMesh >::SetScale ( VectorType  _arg)
virtual

Set/Get scales of the Sphere. This is a vector of values that can actually be used for generating ellipsoids aligned with the coordinate axis.

Member Data Documentation

◆ m_Center

template<typename TOutputMesh >
PointType itk::RegularSphereMeshSource< TOutputMesh >::m_Center
protected

model center

Definition at line 114 of file itkRegularSphereMeshSource.h.

◆ m_Resolution

template<typename TOutputMesh >
unsigned int itk::RegularSphereMeshSource< TOutputMesh >::m_Resolution
protected

models resolution

Definition at line 117 of file itkRegularSphereMeshSource.h.

◆ m_Scale

template<typename TOutputMesh >
VectorType itk::RegularSphereMeshSource< TOutputMesh >::m_Scale
protected

model scales

Definition at line 120 of file itkRegularSphereMeshSource.h.


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