ITK
4.6.0
Insight Segmentation and Registration 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 typedefs 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 84 of file itkPointSet.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef MeshTraits::CoordRepType | CoordRepType |
typedef TMeshTraits | MeshTraits |
typedef MeshTraits::PixelType | PixelType |
typedef MeshTraits::PointDataContainer | PointDataContainer |
typedef PointDataContainer::ConstPointer | PointDataContainerConstPointer |
typedef PointDataContainer::ConstIterator | PointDataContainerIterator |
typedef PointDataContainer::Pointer | PointDataContainerPointer |
typedef SmartPointer< Self > | Pointer |
typedef MeshTraits::PointIdentifier | PointIdentifier |
typedef MeshTraits::PointsContainer | PointsContainer |
typedef PointsContainer::ConstIterator | PointsContainerConstIterator |
typedef PointsContainer::ConstPointer | PointsContainerConstPointer |
typedef PointsContainer::Iterator | PointsContainerIterator |
typedef PointsContainer::Pointer | PointsContainerPointer |
typedef MeshTraits::PointType | PointType |
typedef long | RegionType |
typedef PointSet | Self |
typedef DataObject | Superclass |
Public Types inherited from itk::DataObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef std::string | DataObjectIdentifierType |
typedef std::vector< Pointer > ::size_type | DataObjectPointerArraySizeType |
typedef SmartPointer< Self > | Pointer |
typedef DataObject | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual void | CopyInformation (const DataObject *data) ITK_OVERRIDE |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual RegionType | GetBufferedRegion () const |
virtual RegionType | GetMaximumNumberOfRegions () const |
virtual const char * | GetNameOfClass () const |
PointIdentifier | GetNumberOfPoints (void) const |
PointDataContainer * | GetPointData (void) |
const PointDataContainer * | GetPointData (void) const |
PointsContainer * | GetPoints (void) |
const PointsContainer * | GetPoints (void) const |
virtual RegionType | GetRequestedRegion () const |
virtual void | Graft (const DataObject *data) ITK_OVERRIDE |
virtual void | Initialize (void) ITK_OVERRIDE |
void | PassStructure (Self *inputPointSet) |
virtual bool | RequestedRegionIsOutsideOfTheBufferedRegion () ITK_OVERRIDE |
virtual void | SetBufferedRegion (const RegionType ®ion) |
void | SetPointData (PointDataContainer *) |
void | SetPoints (PointsContainer *) |
virtual void | SetRequestedRegion (const DataObject *data) ITK_OVERRIDE |
virtual void | SetRequestedRegion (const RegionType ®ion) |
virtual void | SetRequestedRegionToLargestPossibleRegion () ITK_OVERRIDE |
virtual void | UpdateOutputInformation () ITK_OVERRIDE |
virtual bool | VerifyRequestedRegion () ITK_OVERRIDE |
void | SetPoint (PointIdentifier, PointType) |
bool | GetPoint (PointIdentifier, PointType *) const |
PointType | GetPoint (PointIdentifier) const |
void | SetPointData (PointIdentifier, PixelType) |
bool | GetPointData (PointIdentifier, PixelType *) const |
Public Member Functions inherited from itk::DataObject | |
virtual void | DataHasBeenGenerated () |
void | DisconnectPipeline () |
bool | GetDataReleased () const |
virtual const bool & | GetReleaseDataFlag () const |
SmartPointerForwardReference < ProcessObject > | GetSource () const |
DataObjectPointerArraySizeType | GetSourceOutputIndex () const |
const DataObjectIdentifierType & | GetSourceOutputName () const |
virtual ModifiedTimeType | GetUpdateMTime () const |
virtual void | PrepareForNewData () |
virtual void | PropagateRequestedRegion () |
void | ReleaseData () |
virtual void | ReleaseDataFlagOff () |
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 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 *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) 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 |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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::DataObject | |
static bool | GetGlobalReleaseDataFlag () |
static void | GlobalReleaseDataFlagOff () |
static void | GlobalReleaseDataFlagOn () |
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 flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static const unsigned int | PointDimension = TMeshTraits::PointDimension |
Protected Member Functions | |
PointSet () | |
~PointSet () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
Protected Member Functions inherited from itk::DataObject | |
DataObject () | |
virtual void | PropagateResetPipeline () |
~DataObject () | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
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 Member Functions | |
void | operator= (const Self &) |
PointSet (const Self &) | |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
typedef SmartPointer< const Self > itk::PointSet< TPixelType, VDimension, TMeshTraits >::ConstPointer |
Definition at line 91 of file itkPointSet.h.
typedef MeshTraits::CoordRepType itk::PointSet< TPixelType, VDimension, TMeshTraits >::CoordRepType |
Convenient typedefs obtained from TMeshTraits template parameter.
Definition at line 104 of file itkPointSet.h.
typedef TMeshTraits itk::PointSet< TPixelType, VDimension, TMeshTraits >::MeshTraits |
Hold on to the type information specified by the template parameters.
Definition at line 97 of file itkPointSet.h.
typedef MeshTraits::PixelType itk::PointSet< TPixelType, VDimension, TMeshTraits >::PixelType |
Definition at line 101 of file itkPointSet.h.
typedef MeshTraits::PointDataContainer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainer |
Definition at line 108 of file itkPointSet.h.
typedef PointDataContainer::ConstPointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerConstPointer |
Definition at line 118 of file itkPointSet.h.
typedef PointDataContainer::ConstIterator itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerIterator |
Definition at line 123 of file itkPointSet.h.
typedef PointDataContainer::Pointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointDataContainerPointer |
Definition at line 117 of file itkPointSet.h.
typedef SmartPointer< Self > itk::PointSet< TPixelType, VDimension, TMeshTraits >::Pointer |
Definition at line 90 of file itkPointSet.h.
typedef MeshTraits::PointIdentifier itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointIdentifier |
Definition at line 105 of file itkPointSet.h.
typedef MeshTraits::PointsContainer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainer |
Definition at line 107 of file itkPointSet.h.
typedef PointsContainer::ConstIterator itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerConstIterator |
Create types that are iterators for each of the container types.
Definition at line 121 of file itkPointSet.h.
typedef PointsContainer::ConstPointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerConstPointer |
Definition at line 116 of file itkPointSet.h.
typedef PointsContainer::Iterator itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerIterator |
Definition at line 122 of file itkPointSet.h.
typedef PointsContainer::Pointer itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointsContainerPointer |
Create types that are pointers to each of the container types.
Definition at line 115 of file itkPointSet.h.
typedef MeshTraits::PointType itk::PointSet< TPixelType, VDimension, TMeshTraits >::PointType |
Definition at line 106 of file itkPointSet.h.
typedef long itk::PointSet< TPixelType, VDimension, TMeshTraits >::RegionType |
Type used to define Regions
Definition at line 126 of file itkPointSet.h.
typedef PointSet itk::PointSet< TPixelType, VDimension, TMeshTraits >::Self |
Standard class typedefs.
Definition at line 88 of file itkPointSet.h.
typedef DataObject itk::PointSet< TPixelType, VDimension, TMeshTraits >::Superclass |
Definition at line 89 of file itkPointSet.h.
|
protected |
Constructor for use by New() method.
|
inlineprotected |
Constructor for use by New() method.
Definition at line 211 of file itkPointSet.h.
|
private |
|
virtual |
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 >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, and itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >.
|
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::Object.
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 >.
|
virtual |
|
virtual |
Get the maximum number of regions that this data can be separated into.
|
virtual |
Standard part of every itk Object.
Reimplemented from itk::DataObject.
Reimplemented in itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::Mesh< TPixelType, VDimension, TMeshTraits >, itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::Mesh< TPixel, VDimension, TTraits >, itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >, and itk::VoronoiDiagram2D< TCoordType >.
PointIdentifier itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetNumberOfPoints | ( | void | ) | const |
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoint | ( | PointIdentifier | , |
PointType * | |||
) | const |
Access routines to fill the Points container, and get information from it.
Referenced by itk::QuadEdgeMesh< TPixel, VDimension, TTraits >::GetPoint().
PointType itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoint | ( | PointIdentifier | ) | const |
Access routines to fill the Points container, and get information from it.
PointDataContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData | ( | void | ) |
const PointDataContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData | ( | void | ) | const |
bool itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPointData | ( | PointIdentifier | , |
PixelType * | |||
) | const |
Access routines to fill the PointData container, and get information from it.
PointsContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints | ( | void | ) |
const PointsContainer* itk::PointSet< TPixelType, VDimension, TMeshTraits >::GetPoints | ( | void | ) | const |
|
virtual |
|
virtual |
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 > >, itk::Mesh< TPixel, VDimension, TTraits >, and itk::QuadEdgeMesh< TPixel, VDimension, TTraits >.
|
virtual |
Restore the data object to its initial state. This means releasing memory.
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::QuadEdgeMesh< TPixel, VDimension, TTraits >.
|
static |
Method for creation through the object factory.
|
private |
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::PassStructure | ( | Self * | inputPointSet | ) |
PointSet-level operation interface.
|
protectedvirtual |
Constructor for use by New() method.
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 >, itk::SimplexMesh< TPixelType, VDimension, TMeshTraits >, and itk::VoronoiDiagram2D< TCoordType >.
|
virtual |
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.
Reimplemented in itk::QuadEdgeMesh< TPixel, VDimension, TTraits >.
|
virtual |
Set/Get the Buffered region
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoint | ( | PointIdentifier | , |
PointType | |||
) |
Access routines to fill the Points container, and get information from it.
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPointData | ( | PointDataContainer * | ) |
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPointData | ( | PointIdentifier | , |
PixelType | |||
) |
Access routines to fill the PointData container, and get information from it.
void itk::PointSet< TPixelType, VDimension, TMeshTraits >::SetPoints | ( | PointsContainer * | ) |
Define Set/Get access routines for each internal container. Methods also exist to add points, cells, etc. one at a time rather than through an entire container.
|
virtual |
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
|
virtual |
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.
|
virtual |
Methods to manage streaming.
Reimplemented from itk::DataObject.
|
virtual |
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 228 of file itkPointSet.h.
|
protected |
Definition at line 225 of file itkPointSet.h.
|
protected |
Definition at line 226 of file itkPointSet.h.
|
protected |
An object containing data associated with the mesh's points. Optionally, this can be NULL, indicating that no data are associated with the points. The data for a point can be accessed through its point identifier.
Definition at line 141 of file itkPointSet.h.
|
protected |
An object containing points used by the mesh. Individual points are accessed through point identifiers.
Definition at line 130 of file itkPointSet.h.
|
protected |
Definition at line 227 of file itkPointSet.h.
|
protected |
Definition at line 229 of file itkPointSet.h.
|
static |
Convenient typedefs obtained from TMeshTraits template parameter.
Definition at line 112 of file itkPointSet.h.