ITK
6.0.0
Insight Toolkit
|
#include <itkPointSetBase.h>
A superclass of PointSet supports point (geometric coordinate and attribute) definition.
PointSetBase is a superclass of PointSet. It provides the portion of the point set definition for geometric coordinates (and region information). The defined API provides operations on points but does not tie down the underlying implementation and storage.
TPointsContainer | Type of the container of points. Typically either an itk::VectorContainer<PointType> or an itk::MapContainer<PointType> .). |
Definition at line 56 of file itkPointSetBase.h.
Public Member Functions | |
void | CopyInformation (const DataObject *data) override |
virtual RegionType | GetBufferedRegion () const |
virtual RegionType | GetMaximumNumberOfRegions () const |
const char * | GetNameOfClass () const override |
PointIdentifier | GetNumberOfPoints () const |
PointType | GetPoint (PointIdentifier) const |
bool | GetPoint (PointIdentifier, PointType *) const |
PointsContainer * | GetPoints () |
const PointsContainer * | GetPoints () const |
virtual RegionType | GetRequestedRegion () const |
void | Initialize () override |
itkCloneMacro (Self) | |
void | PassStructure (Self *inputPointSet) |
bool | RequestedRegionIsOutsideOfTheBufferedRegion () override |
virtual void | SetBufferedRegion (const RegionType ®ion) |
void | SetPoint (PointIdentifier, PointType) |
void | SetPoints (PointsContainer *) |
void | SetPoints (PointsVectorContainer *) |
void | SetPointsByCoordinates (const std::vector< CoordRepType > &coordinates) |
void | SetRequestedRegion (const DataObject *data) override |
virtual void | SetRequestedRegion (const RegionType ®ion) |
void | SetRequestedRegionToLargestPossibleRegion () override |
void | UpdateOutputInformation () override |
bool | VerifyRequestedRegion () override |
Public Member Functions inherited from itk::DataObject | |
virtual void | CopyInformation (const DataObject *) |
virtual void | DataHasBeenGenerated () |
void | DisconnectPipeline () |
bool | GetDataReleased () const |
const char * | GetNameOfClass () const override |
virtual const bool & | GetReleaseDataFlag () const |
SmartPointer< ProcessObject > | GetSource () const |
DataObjectPointerArraySizeType | GetSourceOutputIndex () const |
const DataObjectIdentifierType & | GetSourceOutputName () const |
virtual ModifiedTimeType | GetUpdateMTime () const |
virtual void | Graft (const DataObject *) |
virtual void | Initialize () |
virtual void | PrepareForNewData () |
virtual void | PropagateRequestedRegion () |
void | ReleaseData () |
virtual void | ReleaseDataFlagOn () |
virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () |
virtual void | ResetPipeline () |
void | SetReleaseDataFlag (bool flag) |
virtual void | SetRequestedRegion (const DataObject *) |
virtual void | SetRequestedRegionToLargestPossibleRegion () |
bool | ShouldIReleaseData () const |
virtual void | Update () |
virtual void | UpdateOutputData () |
virtual void | UpdateOutputInformation () |
void | UpdateSource () const |
virtual bool | VerifyRequestedRegion () |
void | SetPipelineMTime (ModifiedTimeType time) |
virtual const ModifiedTimeType & | GetPipelineMTime () const |
virtual void | SetRealTimeStamp (RealTimeStamp _arg) |
virtual const RealTimeStamp & | GetRealTimeStamp () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) 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 |
const char * | GetNameOfClass () const override |
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) const |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Attributes | |
static constexpr unsigned int | PointDimension = PointType::PointDimension |
Protected Member Functions | |
LightObject::Pointer | InternalClone () const override |
PointSetBase ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~PointSetBase () override=0 | |
Protected Member Functions inherited from itk::DataObject | |
DataObject () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | PropagateResetPipeline () |
~DataObject () override | |
Protected Member Functions inherited from itk::Object | |
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 | |
Protected Member Functions inherited from itk::LightObject | |
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 } |
PointsContainerPointer | m_PointsContainer {} |
RegionType | m_RequestedNumberOfRegions {} |
RegionType | m_RequestedRegion { -1 } |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
Additional Inherited Members | |
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 () |
using itk::PointSetBase< TPointsContainer >::ConstPointer = SmartPointer<const Self> |
Definition at line 65 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::CoordRepType = typename PointType::CoordRepType |
Definition at line 74 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::Pointer = SmartPointer<Self> |
Definition at line 64 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointIdentifier = typename TPointsContainer::ElementIdentifier |
Definition at line 75 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsContainer = TPointsContainer |
Definition at line 76 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsContainerConstIterator = typename PointsContainer::ConstIterator |
Create types that are iterators for each of the container types.
Definition at line 90 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsContainerConstPointer = typename PointsContainer::ConstPointer |
Definition at line 87 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsContainerIterator = typename PointsContainer::Iterator |
Definition at line 91 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsContainerPointer = typename PointsContainer::Pointer |
Create types that are pointers to each of the container types.
Definition at line 86 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsVectorContainer = typename itk::VectorContainer<PointIdentifier, CoordRepType> |
For improving Python support for PointSetBase and Meshes
Definition at line 79 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointsVectorContainerPointer = typename PointsVectorContainer::Pointer |
Definition at line 80 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::PointType = typename TPointsContainer::Element |
Convenient type alias obtained from TPointsContainer template parameter.
Definition at line 73 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::RegionType = long |
Type used to define Regions
Definition at line 94 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::Self = PointSetBase |
Standard class type aliases.
Definition at line 62 of file itkPointSetBase.h.
using itk::PointSetBase< TPointsContainer >::Superclass = DataObject |
Definition at line 63 of file itkPointSetBase.h.
|
protecteddefault |
Default-constructor, to be used by derived classes.
|
overrideprotectedpure virtual |
Pure virtual destructor, to be used by derived classes.
|
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::PointSetBase< TPointsContainer >::GetNumberOfPoints | ( | ) | const |
Get the number of points in the points container.
PointType itk::PointSetBase< TPointsContainer >::GetPoint | ( | PointIdentifier | ) | const |
Get the point for the given point identifier.
bool itk::PointSetBase< TPointsContainer >::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.
PointsContainer * itk::PointSetBase< TPointsContainer >::GetPoints | ( | ) |
Get the points container.
const PointsContainer * itk::PointSetBase< TPointsContainer >::GetPoints | ( | ) | const |
Get the points container.
|
virtual |
|
overridevirtual |
Restore the PointSetBase 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 > >.
|
overrideprotectedvirtual |
Actual implementation of the clone method. This method should be reimplemented in subclasses to clone the extra required parameters.
Reimplemented from itk::LightObject.
itk::PointSetBase< TPointsContainer >::itkCloneMacro | ( | Self | ) |
void itk::PointSetBase< TPointsContainer >::PassStructure | ( | Self * | inputPointSet | ) |
Copy the geometric and topological structure of the given input pointSet. The copying is done via reference counting.
|
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::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::PointSetBase< TPointsContainer >::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::PointSetBase< TPointsContainer >::SetPoints | ( | PointsContainer * | ) |
Set the points container.
void itk::PointSetBase< TPointsContainer >::SetPoints | ( | PointsVectorContainer * | ) |
Set the points container using a 1D vector.
void itk::PointSetBase< TPointsContainer >::SetPointsByCoordinates | ( | const std::vector< CoordRepType > & | coordinates | ) |
Sets the points by specifying its coordinates.
|
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 PointSetBase.
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 221 of file itkPointSetBase.h.
|
protected |
Definition at line 218 of file itkPointSetBase.h.
|
protected |
Definition at line 219 of file itkPointSetBase.h.
|
protected |
An object containing points used by the mesh. Individual points are accessed through point identifiers.
Definition at line 103 of file itkPointSetBase.h.
|
protected |
Definition at line 220 of file itkPointSetBase.h.
|
protected |
Definition at line 222 of file itkPointSetBase.h.
|
staticconstexpr |
Convenient constant, indirectly obtained from TPointsContainer template parameter.
Definition at line 83 of file itkPointSetBase.h.