ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
itk::PointSet< TPixelType, VDimension, TMeshTraits > Class Template Reference

#include <itkPointSet.h>

+ Inheritance diagram for itk::PointSet< TPixelType, VDimension, TMeshTraits >:
+ Collaboration diagram for itk::PointSet< TPixelType, VDimension, TMeshTraits >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename MeshTraits::CoordRepType
 
using MeshTraits = TMeshTraits
 
using PixelType = typename MeshTraits::PixelType
 
using PointDataContainer = typename MeshTraits::PointDataContainer
 
using PointDataContainerConstPointer = typename PointDataContainer::ConstPointer
 
using PointDataContainerIterator = typename PointDataContainer::ConstIterator
 
using PointDataContainerPointer = typename PointDataContainer::Pointer
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename MeshTraits::PointIdentifier
 
using PointsContainer = typename MeshTraits::PointsContainer
 
using PointsContainerConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainerConstPointer = typename PointsContainer::ConstPointer
 
using PointsContainerIterator = typename PointsContainer::Iterator
 
using PointsContainerPointer = typename PointsContainer::Pointer
 
using PointsVectorContainer = typename itk::VectorContainer< PointIdentifier, CoordRepType >
 
using PointsVectorContainerPointer = typename PointsVectorContainer::Pointer
 
using PointType = typename MeshTraits::PointType
 
using RegionType = long
 
using Self = PointSet
 
using Superclass = DataObject
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
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

void CopyInformation (const DataObject *data) override
 
virtual RegionType GetBufferedRegion () const
 
virtual RegionType GetMaximumNumberOfRegions () const
 
virtual const char * GetNameOfClass () const
 
PointIdentifier GetNumberOfPoints () const
 
PointType GetPoint (PointIdentifier) const
 
bool GetPoint (PointIdentifier, PointType *) const
 
PointDataContainerGetPointData ()
 
const PointDataContainerGetPointData () const
 
bool GetPointData (PointIdentifier, PixelType *) const
 
PointsContainerGetPoints ()
 
const PointsContainerGetPoints () const
 
virtual RegionType GetRequestedRegion () const
 
void Graft (const DataObject *data) override
 
void Initialize () override
 
void PassStructure (Self *inputPointSet)
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetPoint (PointIdentifier, PointType)
 
void SetPointData (PointDataContainer *)
 
void SetPointData (PointIdentifier, PixelType)
 
void SetPoints (PointsContainer *)
 
void SetPoints (PointsVectorContainer *)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegionToLargestPossibleRegion () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- 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
 
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
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::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 PointDimension = TMeshTraits::PointDimension
 

Protected Member Functions

 PointSet ()
 
 ~PointSet () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- 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 ()
 

Protected Attributes

RegionType m_BufferedRegion
 
RegionType m_MaximumNumberOfRegions
 
RegionType m_NumberOfRegions
 
PointDataContainerPointer m_PointDataContainer
 
PointsContainerPointer m_PointsContainer
 
RegionType m_RequestedNumberOfRegions
 
RegionType m_RequestedRegion
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
class itk::PointSet< TPixelType, VDimension, TMeshTraits >

A superclass of the N-dimensional mesh structure; supports point (geometric coordinate and attribute) definition.

PointSet is a superclass of the N-dimensional mesh structure (itk::Mesh). It provides the portion of the mesh definition for geometric coordinates (and associated attribute or pixel information). The defined API provides operations on points but does not tie down the underlying implementation and storage. A "MeshTraits" structure is used to define the container and identifier to access the points. See DefaultStaticMeshTraits for the set of type definitions needed. All types that are defined in the "MeshTraits" structure will have duplicate type alias in the resulting mesh itself.

PointSet has two template parameters. The first is the pixel type, or the type of data stored (optionally) with the points. The second is the "MeshTraits" structure controlling type information characterizing the point set. Most users will be happy with the defaults, and will not have to worry about this second argument.

Template parameters for PointSet:

TPixelType = The type stored as data for the point.

TMeshTraits = Type information structure for the point set.

ITK Sphinx Examples:
Examples
Examples/DataRepresentation/Mesh/ImageToPointSet.cxx, Examples/DataRepresentation/Mesh/PointSet1.cxx, Examples/DataRepresentation/Mesh/PointSet2.cxx, Examples/DataRepresentation/Mesh/PointSet3.cxx, Examples/DataRepresentation/Mesh/PointSetWithCovariantVectors.cxx, Examples/DataRepresentation/Mesh/PointSetWithVectors.cxx, Examples/DataRepresentation/Mesh/RGBPointSet.cxx, Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, Examples/RegistrationITKv4/IterativeClosestPoint3.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/Statistics/PointSetToAdaptor.cxx, Examples/Statistics/PointSetToListSampleAdaptor.cxx, SphinxExamples/src/Core/Common/BoundingBoxOfAPointSet/Code.cxx, SphinxExamples/src/Core/Common/CreateAPointSet/Code.cxx, SphinxExamples/src/Core/Common/WriteAPointSet/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/FitSplineIntoPointSet/Code.cxx, and SphinxExamples/src/Registration/Metricsv4/RegisterTwoPointSets/Code.cxx.

Definition at line 82 of file itkPointSet.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::ConstPointer = SmartPointer<const Self>

Definition at line 91 of file itkPointSet.h.

◆ CoordRepType

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::CoordRepType = typename MeshTraits::CoordRepType

Convenient type alias obtained from TMeshTraits template parameter.

Definition at line 104 of file itkPointSet.h.

◆ MeshTraits

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::MeshTraits = TMeshTraits

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

Definition at line 100 of file itkPointSet.h.

◆ PixelType

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PixelType = typename MeshTraits::PixelType

Definition at line 101 of file itkPointSet.h.

◆ PointDataContainer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainer = typename MeshTraits::PointDataContainer

Definition at line 108 of file itkPointSet.h.

◆ PointDataContainerConstPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerConstPointer = typename PointDataContainer::ConstPointer

Definition at line 121 of file itkPointSet.h.

◆ PointDataContainerIterator

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerIterator = typename PointDataContainer::ConstIterator

Definition at line 126 of file itkPointSet.h.

◆ PointDataContainerPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerPointer = typename PointDataContainer::Pointer

Definition at line 120 of file itkPointSet.h.

◆ Pointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Pointer = SmartPointer<Self>

Definition at line 90 of file itkPointSet.h.

◆ PointIdentifier

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointIdentifier = typename MeshTraits::PointIdentifier

Definition at line 105 of file itkPointSet.h.

◆ PointsContainer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainer = typename MeshTraits::PointsContainer

Definition at line 107 of file itkPointSet.h.

◆ PointsContainerConstIterator

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerConstIterator = typename PointsContainer::ConstIterator

Create types that are iterators for each of the container types.

Definition at line 124 of file itkPointSet.h.

◆ PointsContainerConstPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerConstPointer = typename PointsContainer::ConstPointer

Definition at line 119 of file itkPointSet.h.

◆ PointsContainerIterator

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerIterator = typename PointsContainer::Iterator

Definition at line 125 of file itkPointSet.h.

◆ PointsContainerPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerPointer = typename PointsContainer::Pointer

Create types that are pointers to each of the container types.

Definition at line 118 of file itkPointSet.h.

◆ PointsVectorContainer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsVectorContainer = typename itk::VectorContainer<PointIdentifier, CoordRepType>

For improving Python support for PointSet and Meshes

Definition at line 111 of file itkPointSet.h.

◆ PointsVectorContainerPointer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsVectorContainerPointer = typename PointsVectorContainer::Pointer

Definition at line 112 of file itkPointSet.h.

◆ PointType

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointType = typename MeshTraits::PointType

Definition at line 106 of file itkPointSet.h.

◆ RegionType

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::RegionType = long

Type used to define Regions

Definition at line 129 of file itkPointSet.h.

◆ Self

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Self = PointSet

Standard class type aliases.

Definition at line 88 of file itkPointSet.h.

◆ Superclass

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Superclass = DataObject

Definition at line 89 of file itkPointSet.h.

Constructor & Destructor Documentation

◆ PointSet()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointSet ( )
protected

Constructor for use by New() method.

◆ ~PointSet()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
itk::PointSet< TPixelType, VDimension, TMeshTraits >::~PointSet ( )
overrideprotecteddefault

Constructor for use by New() method.

Member Function Documentation

◆ CopyInformation()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::CopyInformation ( const DataObject )
overridevirtual

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Reimplemented from itk::DataObject.

Reimplemented in itk::Mesh< TPixelType, VDimension, TMeshTraits >, itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::Mesh< TPixel, VDimension, TTraits >, and itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >.

◆ GetBufferedRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetBufferedRegion ( ) const
virtual

◆ GetMaximumNumberOfRegions()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetMaximumNumberOfRegions ( ) const
virtual

Get the maximum number of regions that this data can be separated into.

◆ GetNameOfClass()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual const char* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetNameOfClass ( ) const
virtual

◆ GetNumberOfPoints()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointIdentifier itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetNumberOfPoints ( ) const

Get the number of points in the points container.

◆ GetPoint() [1/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoint ( PointIdentifier  ) const

Get the point for the given point identifier.

◆ GetPoint() [2/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoint ( PointIdentifier  ,
PointType  
) const

Check if a point exists for a given point identifier. If a spot for the point identifier exists, the point is set, and true is returned. Otherwise, false is returned, and the point is not modified. If the point is nullptr, then it is never set, but the existence of the point is still returned.

◆ GetPointData() [1/3]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointDataContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData ( )

Get the point data container.

◆ GetPointData() [2/3]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
const PointDataContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData ( ) const

Get the point data container.

◆ GetPointData() [3/3]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData ( PointIdentifier  ,
PixelType  
) const

Check if point data exists for a given point identifier. If a spot for the point identifier exists, "data" is set, and true is returned. Otherwise, false is returned, and "data" is not modified. If "data" is nullptr, then it is never set, but the existence of the point data is still returned.

◆ GetPoints() [1/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointsContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints ( )

Get the points container.

◆ GetPoints() [2/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
const PointsContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints ( ) const

Get the points container.

◆ GetRequestedRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetRequestedRegion ( ) const
virtual

◆ Graft()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::Graft ( const DataObject )
overridevirtual

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::DataObject.

Reimplemented in itk::Mesh< TPixelType, VDimension, TMeshTraits >, itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, and itk::Mesh< TPixel, VDimension, TTraits >.

◆ Initialize()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::Initialize ( )
overridevirtual

Restore the PointSet to its initial state. Useful for data pipeline updates without memory re-allocation.

Reimplemented from itk::DataObject.

Reimplemented in itk::Mesh< TPixelType, VDimension, TMeshTraits >, itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, and itk::Mesh< TPixel, VDimension, TTraits >.

◆ New()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
static Pointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::New ( )
static

Method for creation through the object factory.

◆ PassStructure()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::PassStructure ( Self inputPointSet)

Copy the geometric and topological structure of the given input pointSet. The copying is done via reference counting.

◆ PrintSelf()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

◆ SetBufferedRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetBufferedRegion ( const RegionType region)
virtual

Set/Get the Buffered region

◆ SetPoint()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoint ( PointIdentifier  ,
PointType   
)

Assign a point to a point identifier. If a spot for the point identifier does not exist, it will be created automatically.

◆ SetPointData() [1/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPointData ( PointDataContainer )

Set the point data container.

◆ SetPointData() [2/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPointData ( PointIdentifier  ,
PixelType   
)

Assign data to a point identifier. If a spot for the point identifier does not exist, it will be created automatically. There is no check if a point with the same identifier exists.

◆ SetPoints() [1/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoints ( PointsContainer )

Set the points container.

◆ SetPoints() [2/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoints ( PointsVectorContainer )

Set the points container using a 1D vector.

◆ SetRequestedRegion() [1/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetRequestedRegion ( const DataObject data)
overridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to a PointSet.

Reimplemented from itk::DataObject.

◆ SetRequestedRegion() [2/2]

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
virtual void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetRequestedRegion ( const RegionType region)
virtual

Set/Get the Requested region

◆ SetRequestedRegionToLargestPossibleRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::DataObject.

◆ UpdateOutputInformation()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::UpdateOutputInformation ( )
overridevirtual

Methods to manage streaming.

Reimplemented from itk::DataObject.

◆ VerifyRequestedRegion()

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::VerifyRequestedRegion ( )
overridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion.

If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Default implementation simply returns true in order to support DataObjects that do not need regions (for instance itk::EquivalencyTable).

Reimplemented from itk::DataObject.

Member Data Documentation

◆ m_BufferedRegion

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_BufferedRegion
protected

Definition at line 282 of file itkPointSet.h.

◆ m_MaximumNumberOfRegions

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_MaximumNumberOfRegions
protected

Definition at line 279 of file itkPointSet.h.

◆ m_NumberOfRegions

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_NumberOfRegions
protected

Definition at line 280 of file itkPointSet.h.

◆ m_PointDataContainer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointDataContainerPointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_PointDataContainer
protected

An object containing data associated with the mesh's points. Optionally, this can be nullptr, indicating that no data are associated with the points. The data for a point can be accessed through its point identifier.

Definition at line 144 of file itkPointSet.h.

◆ m_PointsContainer

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
PointsContainerPointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_PointsContainer
protected

An object containing points used by the mesh. Individual points are accessed through point identifiers.

Definition at line 138 of file itkPointSet.h.

◆ m_RequestedNumberOfRegions

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_RequestedNumberOfRegions
protected

Definition at line 281 of file itkPointSet.h.

◆ m_RequestedRegion

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
RegionType itk::PointSet< TPixelType, VDimension, TMeshTraits >::m_RequestedRegion
protected

Definition at line 283 of file itkPointSet.h.

◆ PointDimension

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
constexpr unsigned int itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDimension = TMeshTraits::PointDimension
staticconstexpr

Convenient type alias obtained from TMeshTraits template parameter.

Definition at line 115 of file itkPointSet.h.


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