![]() |
ITK
5.4.0
Insight Toolkit
|
#include <itkPointSet.h>
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.
Definition at line 82 of file itkPointSet.h.
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static bool | GetGlobalReleaseDataFlag () |
static void | GlobalReleaseDataFlagOff () |
static void | GlobalReleaseDataFlagOn () |
static Pointer | New () |
static void | SetGlobalReleaseDataFlag (bool val) |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static constexpr unsigned int | PointDimension = TMeshTraits::PointDimension |
Protected Member Functions | |
PointSet ()=default | |
~PointSet () override=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
![]() | |
DataObject () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | PropagateResetPipeline () |
~DataObject () override | |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
![]() | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Protected Attributes | |
RegionType | m_BufferedRegion { -1 } |
RegionType | m_MaximumNumberOfRegions { 1 } |
RegionType | m_NumberOfRegions { 1 } |
PointDataContainerPointer | m_PointDataContainer {} |
PointsContainerPointer | m_PointsContainer {} |
RegionType | m_RequestedNumberOfRegions {} |
RegionType | m_RequestedRegion { -1 } |
![]() | |
std::atomic< int > | m_ReferenceCount {} |
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::ConstPointer = SmartPointer<const Self> |
Definition at line 91 of file itkPointSet.h.
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.
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.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PixelType = typename MeshTraits::PixelType |
Definition at line 101 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainer = typename MeshTraits::PointDataContainer |
Definition at line 108 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerConstPointer = typename PointDataContainer::ConstPointer |
Definition at line 121 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerIterator = typename PointDataContainer::ConstIterator |
Definition at line 126 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerPointer = typename PointDataContainer::Pointer |
Definition at line 120 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Pointer = SmartPointer<Self> |
Definition at line 90 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointIdentifier = typename MeshTraits::PointIdentifier |
Definition at line 105 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainer = typename MeshTraits::PointsContainer |
Definition at line 107 of file itkPointSet.h.
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.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerConstPointer = typename PointsContainer::ConstPointer |
Definition at line 119 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerIterator = typename PointsContainer::Iterator |
Definition at line 125 of file itkPointSet.h.
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.
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.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsVectorContainerPointer = typename PointsVectorContainer::Pointer |
Definition at line 112 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointType = typename MeshTraits::PointType |
Definition at line 106 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::RegionType = long |
Type used to define Regions
Definition at line 129 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Self = PointSet |
Standard class type aliases.
Definition at line 88 of file itkPointSet.h.
using itk::PointSet< TPixelType, VDimension, TMeshTraits >::Superclass = DataObject |
Definition at line 89 of file itkPointSet.h.
|
protecteddefault |
Constructor for use by New() method.
|
overrideprotecteddefault |
Constructor for use by New() method.
|
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< TPixel, VDimension, QuadEdgeMeshTraits< TPixel, VDimension, bool, bool > >, itk::Mesh< TPixelType, 3, DefaultStaticMeshTraits< TPixelType, 3, 3, TPixelType, TPixelType, TPixelType > >, and itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.
|
virtual |
|
virtual |
Get the maximum number of regions that this data can be separated into.
|
overridevirtual |
Reimplemented from itk::DataObject.
Reimplemented in itk::Mesh< TPixel, VDimension, QuadEdgeMeshTraits< TPixel, VDimension, bool, bool > >, itk::Mesh< TPixelType, 3, DefaultStaticMeshTraits< TPixelType, 3, 3, TPixelType, TPixelType, TPixelType > >, and itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.
PointIdentifier itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetNumberOfPoints | ( | ) | const |
Get the number of points in the points container.
PointType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoint | ( | PointIdentifier | ) | const |
Get the point for the given point identifier.
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.
PointDataContainer * itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData | ( | ) |
Get the point data container.
const PointDataContainer * itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData | ( | ) | const |
Get the point data container.
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.
PointsContainer * itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints | ( | ) |
Get the points container.
const PointsContainer * itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints | ( | ) | const |
Get the points container.
|
virtual |
|
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< TPixel, VDimension, QuadEdgeMeshTraits< TPixel, VDimension, bool, bool > >, itk::Mesh< TPixelType, 3, DefaultStaticMeshTraits< TPixelType, 3, 3, TPixelType, TPixelType, TPixelType > >, and itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.
|
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< TPixel, VDimension, QuadEdgeMeshTraits< TPixel, VDimension, bool, bool > >, itk::Mesh< TPixelType, 3, DefaultStaticMeshTraits< TPixelType, 3, 3, TPixelType, TPixelType, TPixelType > >, and itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.
|
static |
Method for creation through the object factory.
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.
|
overrideprotectedvirtual |
Constructor for use by New() method.
Reimplemented from itk::DataObject.
Reimplemented in itk::Mesh< TPixel, VDimension, QuadEdgeMeshTraits< TPixel, VDimension, bool, bool > >, itk::Mesh< TPixelType, 3, DefaultStaticMeshTraits< TPixelType, 3, 3, TPixelType, TPixelType, TPixelType > >, and itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >.
|
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.
|
virtual |
Set/Get the Buffered region
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.
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPointData | ( | PointDataContainer * | ) |
Set the point data container.
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.
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoints | ( | PointsContainer * | ) |
Set the points container.
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoints | ( | PointsVectorContainer * | ) |
Set the points container using a 1D vector.
|
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.
|
virtual |
Set/Get the Requested region
|
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.
|
overridevirtual |
Methods to manage streaming.
Reimplemented from itk::DataObject.
|
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.
|
protected |
Definition at line 282 of file itkPointSet.h.
|
protected |
Definition at line 279 of file itkPointSet.h.
|
protected |
Definition at line 280 of file itkPointSet.h.
|
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.
|
protected |
An object containing points used by the mesh. Individual points are accessed through point identifiers.
Definition at line 138 of file itkPointSet.h.
|
protected |
Definition at line 281 of file itkPointSet.h.
|
protected |
Definition at line 283 of file itkPointSet.h.
|
staticconstexpr |
Convenient type alias obtained from TMeshTraits template parameter.
Definition at line 115 of file itkPointSet.h.