ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ContourSpatialObjectPoint< TPointDimension > Class Template Reference

#include <itkContourSpatialObjectPoint.h>

Detailed Description

template<unsigned int TPointDimension = 3>
class itk::ContourSpatialObjectPoint< TPointDimension >

Point used for a Contour definition.

This class contains all the functions necessary to define a point that can be used to build surfaces. A surface point has a position and only one normal.

See also
SpatialObjectPoint

Definition at line 38 of file itkContourSpatialObjectPoint.h.

+ Inheritance diagram for itk::ContourSpatialObjectPoint< TPointDimension >:
+ Collaboration diagram for itk::ContourSpatialObjectPoint< TPointDimension >:

Public Types

using CovariantVectorType = CovariantVector< double, TPointDimension >
 
using PointType = Point< double, TPointDimension >
 
using Self = ContourSpatialObjectPoint
 
using Superclass = SpatialObjectPoint< TPointDimension >
 
- Public Types inherited from itk::SpatialObjectPoint< TPointDimension >
using ColorType = RGBAPixel< double >
 
using PointDimensionType = unsigned int
 
using PointType = Point< double, TPointDimension >
 
using Self = SpatialObjectPoint
 
using SpatialObjectType = SpatialObject< TPointDimension >
 
using VectorType = vnl_vector< double >
 

Public Member Functions

 ContourSpatialObjectPoint ()
 
 ContourSpatialObjectPoint (const ContourSpatialObjectPoint &other)
 
const CovariantVectorTypeGetNormalInObjectSpace () const
 
const PointTypeGetPickedPointInObjectSpace () const
 
Selfoperator= (const ContourSpatialObjectPoint &rhs)
 
void SetNormalInObjectSpace (const CovariantVectorType &normal)
 
void SetPickedPointInObjectSpace (const PointType &point)
 
 ~ContourSpatialObjectPoint () override=default
 
- Public Member Functions inherited from itk::SpatialObjectPoint< TPointDimension >
double GetAlpha () const
 
double GetBlue () const
 
ColorType GetColor () const
 
double GetGreen () const
 
int GetId () const
 
const PointTypeGetPositionInObjectSpace () const
 
PointType GetPositionInWorldSpace () const
 
double GetRed () const
 
SpatialObjectTypeGetSpatialObject () const
 
std::map< std::string, double > & GetTagScalarDictionary ()
 
const std::map< std::string, double > & GetTagScalarDictionary () const
 
double GetTagScalarValue (const std::string &tag) const
 
bool GetTagScalarValue (const std::string &tag, double &value) const
 
 itkVirtualGetNameOfClassMacro (SpatialObjectPoint)
 
Selfoperator= (const SpatialObjectPoint &rhs)
 
void Print (std::ostream &os) const
 
void SetAlpha (double a)
 
void SetBlue (double b)
 
void SetColor (ColorType color)
 
void SetColor (double r, double g, double b, double a=1)
 
void SetGreen (double g)
 
void SetId (int id)
 
template<typename... TCoordinate>
void SetPositionInObjectSpace (const double firstCoordinate, const TCoordinate... otherCoordinate)
 
void SetPositionInObjectSpace (const PointType &newPositionInObjectSpace)
 
void SetPositionInWorldSpace (const PointType &point)
 
void SetRed (double r)
 
void SetSpatialObject (SpatialObjectType *so)
 
void SetTagScalarDictionary (const std::map< std::string, double > &dict)
 
void SetTagScalarValue (const std::string &tag, double value)
 
 SpatialObjectPoint ()
 
 SpatialObjectPoint (const SpatialObjectPoint &other)
 
virtual ~SpatialObjectPoint ()=default
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 

Private Attributes

CovariantVectorType m_NormalInObjectSpace {}
 
PointType m_PickedPointInObjectSpace {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialObjectPoint< TPointDimension >
static constexpr PointDimensionType PointDimension = TPointDimension
 
- Protected Attributes inherited from itk::SpatialObjectPoint< TPointDimension >
ColorType m_Color {}
 
int m_Id {}
 
PointType m_PositionInObjectSpace {}
 
std::map< std::string, double > m_ScalarDictionary {}
 
WeakPointer< SpatialObjectTypem_SpatialObject {}
 

Member Typedef Documentation

◆ CovariantVectorType

template<unsigned int TPointDimension = 3>
using itk::ContourSpatialObjectPoint< TPointDimension >::CovariantVectorType = CovariantVector<double, TPointDimension>

Definition at line 44 of file itkContourSpatialObjectPoint.h.

◆ PointType

template<unsigned int TPointDimension = 3>
using itk::ContourSpatialObjectPoint< TPointDimension >::PointType = Point<double, TPointDimension>

Definition at line 43 of file itkContourSpatialObjectPoint.h.

◆ Self

template<unsigned int TPointDimension = 3>
using itk::ContourSpatialObjectPoint< TPointDimension >::Self = ContourSpatialObjectPoint

Definition at line 41 of file itkContourSpatialObjectPoint.h.

◆ Superclass

template<unsigned int TPointDimension = 3>
using itk::ContourSpatialObjectPoint< TPointDimension >::Superclass = SpatialObjectPoint<TPointDimension>

Definition at line 42 of file itkContourSpatialObjectPoint.h.

Constructor & Destructor Documentation

◆ ContourSpatialObjectPoint() [1/2]

template<unsigned int TPointDimension = 3>
itk::ContourSpatialObjectPoint< TPointDimension >::ContourSpatialObjectPoint ( )

Constructor. This one defines the number of dimensions in the ContourSpatialObjectPoint

◆ ContourSpatialObjectPoint() [2/2]

template<unsigned int TPointDimension = 3>
itk::ContourSpatialObjectPoint< TPointDimension >::ContourSpatialObjectPoint ( const ContourSpatialObjectPoint< TPointDimension > &  other)

Copy Constructor

◆ ~ContourSpatialObjectPoint()

template<unsigned int TPointDimension = 3>
itk::ContourSpatialObjectPoint< TPointDimension >::~ContourSpatialObjectPoint ( )
overridedefault

Default destructor.

Member Function Documentation

◆ GetNormalInObjectSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType& itk::ContourSpatialObjectPoint< TPointDimension >::GetNormalInObjectSpace ( ) const

Get the normal.

◆ GetPickedPointInObjectSpace()

template<unsigned int TPointDimension = 3>
const PointType& itk::ContourSpatialObjectPoint< TPointDimension >::GetPickedPointInObjectSpace ( ) const

Get the picked point.

◆ operator=()

template<unsigned int TPointDimension = 3>
Self& itk::ContourSpatialObjectPoint< TPointDimension >::operator= ( const ContourSpatialObjectPoint< TPointDimension > &  rhs)

Copy a surface point to another.

◆ PrintSelf()

template<unsigned int TPointDimension = 3>
void itk::ContourSpatialObjectPoint< TPointDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

PrintSelf method

Reimplemented from itk::SpatialObjectPoint< TPointDimension >.

◆ SetNormalInObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::ContourSpatialObjectPoint< TPointDimension >::SetNormalInObjectSpace ( const CovariantVectorType normal)

Set the normal : N-D case.

◆ SetPickedPointInObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::ContourSpatialObjectPoint< TPointDimension >::SetPickedPointInObjectSpace ( const PointType point)

Set the picked point : N-D case.

Member Data Documentation

◆ m_NormalInObjectSpace

template<unsigned int TPointDimension = 3>
CovariantVectorType itk::ContourSpatialObjectPoint< TPointDimension >::m_NormalInObjectSpace {}
private

Definition at line 81 of file itkContourSpatialObjectPoint.h.

◆ m_PickedPointInObjectSpace

template<unsigned int TPointDimension = 3>
PointType itk::ContourSpatialObjectPoint< TPointDimension >::m_PickedPointInObjectSpace {}
private

Definition at line 82 of file itkContourSpatialObjectPoint.h.


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