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

#include <itkTubeSpatialObjectPoint.h>

Detailed Description

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

Point used for a tube definition.

This class contains all the functions necessary to define a point that can be used to build tubes.

See also
TubeSpatialObject

Definition at line 39 of file itkTubeSpatialObjectPoint.h.

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

Public Types

using CovariantVectorType = CovariantVector< double, TPointDimension >
 
using PointType = Point< double, TPointDimension >
 
using Self = TubeSpatialObjectPoint
 
using Superclass = SpatialObjectPoint< TPointDimension >
 
using VectorType = Vector< double, 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

double GetAlpha1 () const
 
double GetAlpha2 () const
 
double GetAlpha3 () const
 
double GetBranchness () const
 
double GetCurvature () const
 
double GetIntensity () const
 
double GetLevelness () const
 
double GetMedialness () const
 
const CovariantVectorTypeGetNormal1InObjectSpace () const
 
const CovariantVectorType GetNormal1InWorldSpace () const
 
const CovariantVectorTypeGetNormal2InObjectSpace () const
 
const CovariantVectorType GetNormal2InWorldSpace () const
 
double GetRadiusInObjectSpace () const
 
double GetRadiusInWorldSpace () const
 
double GetRidgeness () const
 
double GetRoundness () const
 
const VectorTypeGetTangentInObjectSpace () const
 
const VectorType GetTangentInWorldSpace () const
 
Selfoperator= (const TubeSpatialObjectPoint &rhs)
 
void SetAlpha1 (double alpha1)
 
void SetAlpha2 (double alpha2)
 
void SetAlpha3 (double alpha3)
 
void SetBranchness (double branchness)
 
void SetCurvature (double curvature)
 
void SetIntensity (double intensity)
 
void SetLevelness (double levelness)
 
void SetMedialness (double medialness)
 
void SetNormal1InObjectSpace (const CovariantVectorType &newV1)
 
void SetNormal1InWorldSpace (const CovariantVectorType &newV1)
 
void SetNormal2InObjectSpace (const CovariantVectorType &newV2)
 
void SetNormal2InWorldSpace (const CovariantVectorType &newV2)
 
void SetRadiusInObjectSpace (double newR)
 
void SetRadiusInWorldSpace (double newR)
 
void SetRidgeness (double ridgeness)
 
void SetRoundness (double roundness)
 
void SetTangentInObjectSpace (const VectorType &newT)
 
void SetTangentInWorldSpace (const VectorType &newT)
 
 TubeSpatialObjectPoint ()
 
 TubeSpatialObjectPoint (const TubeSpatialObjectPoint &other)
 
 ~TubeSpatialObjectPoint () 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
 

Protected Attributes

double m_Alpha1 {}
 
double m_Alpha2 {}
 
double m_Alpha3 {}
 
double m_Branchness {}
 
double m_Curvature {}
 
double m_Intensity {}
 
double m_Levelness {}
 
double m_Medialness {}
 
CovariantVectorType m_Normal1InObjectSpace {}
 
CovariantVectorType m_Normal2InObjectSpace {}
 
double m_RadiusInObjectSpace {}
 
double m_Ridgeness {}
 
double m_Roundness {}
 
VectorType m_TangentInObjectSpace {}
 
- 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 {}
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialObjectPoint< TPointDimension >
static constexpr PointDimensionType PointDimension = TPointDimension
 

Member Typedef Documentation

◆ CovariantVectorType

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

Definition at line 46 of file itkTubeSpatialObjectPoint.h.

◆ PointType

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

Definition at line 44 of file itkTubeSpatialObjectPoint.h.

◆ Self

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

Definition at line 42 of file itkTubeSpatialObjectPoint.h.

◆ Superclass

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

Definition at line 43 of file itkTubeSpatialObjectPoint.h.

◆ VectorType

template<unsigned int TPointDimension = 3>
using itk::TubeSpatialObjectPoint< TPointDimension >::VectorType = Vector<double, TPointDimension>

Definition at line 45 of file itkTubeSpatialObjectPoint.h.

Constructor & Destructor Documentation

◆ TubeSpatialObjectPoint() [1/2]

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

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

◆ TubeSpatialObjectPoint() [2/2]

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

Copy Constructor

◆ ~TubeSpatialObjectPoint()

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

Default destructor.

Member Function Documentation

◆ GetAlpha1()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetAlpha1 ( ) const
inline

Definition at line 237 of file itkTubeSpatialObjectPoint.h.

◆ GetAlpha2()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetAlpha2 ( ) const
inline

Definition at line 249 of file itkTubeSpatialObjectPoint.h.

◆ GetAlpha3()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetAlpha3 ( ) const
inline

Definition at line 261 of file itkTubeSpatialObjectPoint.h.

◆ GetBranchness()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetBranchness ( ) const
inline

Definition at line 225 of file itkTubeSpatialObjectPoint.h.

◆ GetCurvature()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetCurvature ( ) const
inline

Definition at line 165 of file itkTubeSpatialObjectPoint.h.

◆ GetIntensity()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetIntensity ( ) const
inline

Definition at line 201 of file itkTubeSpatialObjectPoint.h.

◆ GetLevelness()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetLevelness ( ) const
inline

Definition at line 177 of file itkTubeSpatialObjectPoint.h.

◆ GetMedialness()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetMedialness ( ) const
inline

Definition at line 213 of file itkTubeSpatialObjectPoint.h.

◆ GetNormal1InObjectSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType& itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal1InObjectSpace ( ) const
inline

Get V1 in Object space

Definition at line 104 of file itkTubeSpatialObjectPoint.h.

◆ GetNormal1InWorldSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal1InWorldSpace ( ) const

Get V1 in World space

◆ GetNormal2InObjectSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType& itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal2InObjectSpace ( ) const
inline

Get V2

Definition at line 126 of file itkTubeSpatialObjectPoint.h.

◆ GetNormal2InWorldSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal2InWorldSpace ( ) const

Get V2

◆ GetRadiusInObjectSpace()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetRadiusInObjectSpace ( ) const
inline

Get the radius in object space.

Definition at line 60 of file itkTubeSpatialObjectPoint.h.

◆ GetRadiusInWorldSpace()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetRadiusInWorldSpace ( ) const

Get the radius in world space.

◆ GetRidgeness()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetRidgeness ( ) const
inline

Definition at line 153 of file itkTubeSpatialObjectPoint.h.

◆ GetRoundness()

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::GetRoundness ( ) const
inline

Definition at line 189 of file itkTubeSpatialObjectPoint.h.

◆ GetTangentInObjectSpace()

template<unsigned int TPointDimension = 3>
const VectorType& itk::TubeSpatialObjectPoint< TPointDimension >::GetTangentInObjectSpace ( ) const
inline

Get the tangent in object space.

Definition at line 82 of file itkTubeSpatialObjectPoint.h.

◆ GetTangentInWorldSpace()

template<unsigned int TPointDimension = 3>
const VectorType itk::TubeSpatialObjectPoint< TPointDimension >::GetTangentInWorldSpace ( ) const

Get the tangent in world space.

◆ operator=()

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

Copy one TubeSpatialObjectPoint to another

◆ PrintSelf()

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

Print the object

Reimplemented from itk::SpatialObjectPoint< TPointDimension >.

◆ SetAlpha1()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetAlpha1 ( double  alpha1)
inline

Definition at line 231 of file itkTubeSpatialObjectPoint.h.

◆ SetAlpha2()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetAlpha2 ( double  alpha2)
inline

Definition at line 243 of file itkTubeSpatialObjectPoint.h.

◆ SetAlpha3()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetAlpha3 ( double  alpha3)
inline

Definition at line 255 of file itkTubeSpatialObjectPoint.h.

◆ SetBranchness()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetBranchness ( double  branchness)
inline

Definition at line 219 of file itkTubeSpatialObjectPoint.h.

◆ SetCurvature()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetCurvature ( double  curvature)
inline

Definition at line 159 of file itkTubeSpatialObjectPoint.h.

◆ SetIntensity()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetIntensity ( double  intensity)
inline

Definition at line 195 of file itkTubeSpatialObjectPoint.h.

◆ SetLevelness()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetLevelness ( double  levelness)
inline

Definition at line 171 of file itkTubeSpatialObjectPoint.h.

◆ SetMedialness()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetMedialness ( double  medialness)
inline

Definition at line 207 of file itkTubeSpatialObjectPoint.h.

◆ SetNormal1InObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal1InObjectSpace ( const CovariantVectorType newV1)
inline

Set V1

Definition at line 115 of file itkTubeSpatialObjectPoint.h.

◆ SetNormal1InWorldSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal1InWorldSpace ( const CovariantVectorType newV1)

Set V1

◆ SetNormal2InObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal2InObjectSpace ( const CovariantVectorType newV2)
inline

Set V2

Definition at line 137 of file itkTubeSpatialObjectPoint.h.

◆ SetNormal2InWorldSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal2InWorldSpace ( const CovariantVectorType newV2)

Set V2

◆ SetRadiusInObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetRadiusInObjectSpace ( double  newR)
inline

Set the radius in object space.

Definition at line 71 of file itkTubeSpatialObjectPoint.h.

◆ SetRadiusInWorldSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetRadiusInWorldSpace ( double  newR)

Set the radius in world space.

◆ SetRidgeness()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetRidgeness ( double  ridgeness)
inline

Definition at line 147 of file itkTubeSpatialObjectPoint.h.

◆ SetRoundness()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetRoundness ( double  roundness)
inline

Definition at line 183 of file itkTubeSpatialObjectPoint.h.

◆ SetTangentInObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetTangentInObjectSpace ( const VectorType newT)
inline

Set the tangent in object space.

Definition at line 93 of file itkTubeSpatialObjectPoint.h.

◆ SetTangentInWorldSpace()

template<unsigned int TPointDimension = 3>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetTangentInWorldSpace ( const VectorType newT)

Set the tangent in World Space.

Member Data Documentation

◆ m_Alpha1

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Alpha1 {}
protected

Definition at line 282 of file itkTubeSpatialObjectPoint.h.

◆ m_Alpha2

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Alpha2 {}
protected

Definition at line 283 of file itkTubeSpatialObjectPoint.h.

◆ m_Alpha3

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Alpha3 {}
protected

Definition at line 284 of file itkTubeSpatialObjectPoint.h.

◆ m_Branchness

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Branchness {}
protected

Definition at line 275 of file itkTubeSpatialObjectPoint.h.

◆ m_Curvature

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Curvature {}
protected

Definition at line 278 of file itkTubeSpatialObjectPoint.h.

◆ m_Intensity

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Intensity {}
protected

Definition at line 281 of file itkTubeSpatialObjectPoint.h.

◆ m_Levelness

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Levelness {}
protected

Definition at line 279 of file itkTubeSpatialObjectPoint.h.

◆ m_Medialness

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Medialness {}
protected

Definition at line 276 of file itkTubeSpatialObjectPoint.h.

◆ m_Normal1InObjectSpace

template<unsigned int TPointDimension = 3>
CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_Normal1InObjectSpace {}
protected

Definition at line 272 of file itkTubeSpatialObjectPoint.h.

◆ m_Normal2InObjectSpace

template<unsigned int TPointDimension = 3>
CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_Normal2InObjectSpace {}
protected

Definition at line 273 of file itkTubeSpatialObjectPoint.h.

◆ m_RadiusInObjectSpace

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_RadiusInObjectSpace {}
protected

The radius of the tube point

Definition at line 287 of file itkTubeSpatialObjectPoint.h.

◆ m_Ridgeness

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Ridgeness {}
protected

Definition at line 277 of file itkTubeSpatialObjectPoint.h.

◆ m_Roundness

template<unsigned int TPointDimension = 3>
double itk::TubeSpatialObjectPoint< TPointDimension >::m_Roundness {}
protected

Definition at line 280 of file itkTubeSpatialObjectPoint.h.

◆ m_TangentInObjectSpace

template<unsigned int TPointDimension = 3>
VectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_TangentInObjectSpace {}
protected

Definition at line 271 of file itkTubeSpatialObjectPoint.h.


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