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

#include <itkSpatialObjectPoint.h>

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

Public Types

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

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
 
 itkTypeMacroNoParent (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
 

Static Public Attributes

static constexpr PointDimensionType PointDimension = TPointDimension
 

Protected Member Functions

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

Protected Attributes

ColorType m_Color
 
int m_Id
 
PointType m_PositionInObjectSpace
 
std::map< std::string, double > m_ScalarDictionary
 
WeakPointer< SpatialObjectTypem_SpatialObject
 

Detailed Description

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

Point used for spatial objects.

This class contains all the functions necessary to define a point

See also
TubeSpatialObjectPoint SurfaceSpatialObjectPoint

Definition at line 44 of file itkSpatialObjectPoint.h.

Member Typedef Documentation

◆ ColorType

template<unsigned int TPointDimension = 3>
using itk::SpatialObjectPoint< TPointDimension >::ColorType = RGBAPixel<double>

Definition at line 69 of file itkSpatialObjectPoint.h.

◆ PointDimensionType

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

Definition at line 47 of file itkSpatialObjectPoint.h.

◆ PointType

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

Definition at line 67 of file itkSpatialObjectPoint.h.

◆ Self

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

Definition at line 63 of file itkSpatialObjectPoint.h.

◆ SpatialObjectType

template<unsigned int TPointDimension = 3>
using itk::SpatialObjectPoint< TPointDimension >::SpatialObjectType = SpatialObject<TPointDimension>

Definition at line 65 of file itkSpatialObjectPoint.h.

◆ VectorType

template<unsigned int TPointDimension = 3>
using itk::SpatialObjectPoint< TPointDimension >::VectorType = vnl_vector<double>

Definition at line 68 of file itkSpatialObjectPoint.h.

Constructor & Destructor Documentation

◆ SpatialObjectPoint() [1/2]

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

Constructor.

◆ SpatialObjectPoint() [2/2]

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

Copy Constructor.

◆ ~SpatialObjectPoint()

template<unsigned int TPointDimension = 3>
virtual itk::SpatialObjectPoint< TPointDimension >::~SpatialObjectPoint ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ GetAlpha()

template<unsigned int TPointDimension = 3>
double itk::SpatialObjectPoint< TPointDimension >::GetAlpha ( ) const
inline

Definition at line 199 of file itkSpatialObjectPoint.h.

◆ GetBlue()

template<unsigned int TPointDimension = 3>
double itk::SpatialObjectPoint< TPointDimension >::GetBlue ( ) const
inline

Definition at line 186 of file itkSpatialObjectPoint.h.

◆ GetColor()

template<unsigned int TPointDimension = 3>
ColorType itk::SpatialObjectPoint< TPointDimension >::GetColor ( ) const
inline

Definition at line 143 of file itkSpatialObjectPoint.h.

◆ GetGreen()

template<unsigned int TPointDimension = 3>
double itk::SpatialObjectPoint< TPointDimension >::GetGreen ( ) const
inline

Definition at line 173 of file itkSpatialObjectPoint.h.

◆ GetId()

template<unsigned int TPointDimension = 3>
int itk::SpatialObjectPoint< TPointDimension >::GetId ( ) const
inline

Get the SpatialObjectPoint Id.

Definition at line 80 of file itkSpatialObjectPoint.h.

◆ GetPositionInObjectSpace()

template<unsigned int TPointDimension = 3>
const PointType& itk::SpatialObjectPoint< TPointDimension >::GetPositionInObjectSpace ( ) const
inline

Return a pointer to the point object.

Definition at line 104 of file itkSpatialObjectPoint.h.

◆ GetPositionInWorldSpace()

template<unsigned int TPointDimension = 3>
PointType itk::SpatialObjectPoint< TPointDimension >::GetPositionInWorldSpace ( ) const

Returns the position in world coordinates, using the spatialObject's objectToWorld transform

◆ GetRed()

template<unsigned int TPointDimension = 3>
double itk::SpatialObjectPoint< TPointDimension >::GetRed ( ) const
inline

Definition at line 160 of file itkSpatialObjectPoint.h.

◆ GetSpatialObject()

template<unsigned int TPointDimension = 3>
SpatialObjectType* itk::SpatialObjectPoint< TPointDimension >::GetSpatialObject ( ) const
inline

Definition at line 116 of file itkSpatialObjectPoint.h.

◆ GetTagScalarDictionary() [1/2]

template<unsigned int TPointDimension = 3>
std::map<std::string, double>& itk::SpatialObjectPoint< TPointDimension >::GetTagScalarDictionary ( )

◆ GetTagScalarDictionary() [2/2]

template<unsigned int TPointDimension = 3>
const std::map<std::string, double>& itk::SpatialObjectPoint< TPointDimension >::GetTagScalarDictionary ( ) const

◆ GetTagScalarValue() [1/2]

template<unsigned int TPointDimension = 3>
double itk::SpatialObjectPoint< TPointDimension >::GetTagScalarValue ( const std::string &  tag) const

◆ GetTagScalarValue() [2/2]

template<unsigned int TPointDimension = 3>
bool itk::SpatialObjectPoint< TPointDimension >::GetTagScalarValue ( const std::string &  tag,
double &  value 
) const

◆ itkTypeMacroNoParent()

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

Runtime information support.

◆ operator=()

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

Copy one SpatialObjectPoint to another

◆ Print()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::Print ( std::ostream &  os) const
inline

PrintSelf method

Definition at line 224 of file itkSpatialObjectPoint.h.

◆ PrintSelf()

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

◆ SetAlpha()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetAlpha ( double  a)
inline

Set/Get alpha value of the point

Definition at line 193 of file itkSpatialObjectPoint.h.

◆ SetBlue()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetBlue ( double  b)
inline

Set/Get blue color of the point

Definition at line 180 of file itkSpatialObjectPoint.h.

◆ SetColor() [1/2]

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetColor ( ColorType  color)
inline

Set/Get color of the point

Definition at line 137 of file itkSpatialObjectPoint.h.

◆ SetColor() [2/2]

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetColor ( double  r,
double  g,
double  b,
double  a = 1 
)

Set the color of the point.

◆ SetGreen()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetGreen ( double  g)
inline

Set/Get Green color of the point

Definition at line 167 of file itkSpatialObjectPoint.h.

◆ SetId()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetId ( int  id)
inline

Set the SpatialObjectPoint Id.

Definition at line 73 of file itkSpatialObjectPoint.h.

◆ SetPositionInObjectSpace() [1/2]

template<unsigned int TPointDimension = 3>
template<typename... TCoordinate>
void itk::SpatialObjectPoint< TPointDimension >::SetPositionInObjectSpace ( const double  firstCoordinate,
const TCoordinate...  otherCoordinate 
)
inline

Definition at line 94 of file itkSpatialObjectPoint.h.

◆ SetPositionInObjectSpace() [2/2]

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetPositionInObjectSpace ( const PointType newPositionInObjectSpace)
inline

Set the point object.

Definition at line 87 of file itkSpatialObjectPoint.h.

◆ SetPositionInWorldSpace()

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

Set the position in world coordinates, using the spatialObject's objectToWorld transform, inverse

◆ SetRed()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetRed ( double  r)
inline

Set/Get red color of the point.

Definition at line 154 of file itkSpatialObjectPoint.h.

◆ SetSpatialObject()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetSpatialObject ( SpatialObjectType so)
inline

Definition at line 110 of file itkSpatialObjectPoint.h.

◆ SetTagScalarDictionary()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetTagScalarDictionary ( const std::map< std::string, double > &  dict)

◆ SetTagScalarValue()

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::SetTagScalarValue ( const std::string &  tag,
double  value 
)

Member Data Documentation

◆ m_Color

template<unsigned int TPointDimension = 3>
ColorType itk::SpatialObjectPoint< TPointDimension >::m_Color
protected

Color of the point

Definition at line 241 of file itkSpatialObjectPoint.h.

◆ m_Id

template<unsigned int TPointDimension = 3>
int itk::SpatialObjectPoint< TPointDimension >::m_Id
protected

A unique ID assigned to this SpatialObjectPoint

Definition at line 235 of file itkSpatialObjectPoint.h.

◆ m_PositionInObjectSpace

template<unsigned int TPointDimension = 3>
PointType itk::SpatialObjectPoint< TPointDimension >::m_PositionInObjectSpace
protected

Position of the point

Definition at line 238 of file itkSpatialObjectPoint.h.

◆ m_ScalarDictionary

template<unsigned int TPointDimension = 3>
std::map<std::string, double> itk::SpatialObjectPoint< TPointDimension >::m_ScalarDictionary
protected

Additional scalar properties of the point

Definition at line 244 of file itkSpatialObjectPoint.h.

◆ m_SpatialObject

template<unsigned int TPointDimension = 3>
WeakPointer<SpatialObjectType> itk::SpatialObjectPoint< TPointDimension >::m_SpatialObject
protected

Definition at line 250 of file itkSpatialObjectPoint.h.

◆ PointDimension

template<unsigned int TPointDimension = 3>
constexpr PointDimensionType itk::SpatialObjectPoint< TPointDimension >::PointDimension = TPointDimension
staticconstexpr

Definition at line 49 of file itkSpatialObjectPoint.h.


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