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

#include <itkLineSpatialObjectPoint.h>

Detailed Description

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

Point used for a line definition.

This class contains all the functions necessary to define a point that can be used to build lines. This Class derives from SpatialObjectPoint. A LineSpatialObjectPoint has VDimension-1 normals.

ITK Sphinx Examples:

Definition at line 43 of file itkLineSpatialObjectPoint.h.

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

Public Types

using CovariantVectorType = CovariantVector< double, TPointDimension >
 
using NormalArrayType = FixedArray< CovariantVectorType, TPointDimension - 1 >
 
using PointType = Point< double, TPointDimension >
 
using Self = LineSpatialObjectPoint
 
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

const CovariantVectorTypeGetNormalInObjectSpace (unsigned int index) const
 
 LineSpatialObjectPoint ()
 
 LineSpatialObjectPoint (const LineSpatialObjectPoint &other)
 
Selfoperator= (const LineSpatialObjectPoint &rhs)
 
void SetNormalInObjectSpace (CovariantVectorType &normal, unsigned int index)
 
 ~LineSpatialObjectPoint () 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

NormalArrayType m_NormalArrayInObjectSpace {}
 
- 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::LineSpatialObjectPoint< TPointDimension >::CovariantVectorType = CovariantVector<double, TPointDimension>

Definition at line 49 of file itkLineSpatialObjectPoint.h.

◆ NormalArrayType

template<unsigned int TPointDimension = 3>
using itk::LineSpatialObjectPoint< TPointDimension >::NormalArrayType = FixedArray<CovariantVectorType, TPointDimension - 1>

Definition at line 50 of file itkLineSpatialObjectPoint.h.

◆ PointType

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

Definition at line 48 of file itkLineSpatialObjectPoint.h.

◆ Self

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

Definition at line 46 of file itkLineSpatialObjectPoint.h.

◆ Superclass

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

Definition at line 47 of file itkLineSpatialObjectPoint.h.

Constructor & Destructor Documentation

◆ LineSpatialObjectPoint() [1/2]

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

Constructor

◆ LineSpatialObjectPoint() [2/2]

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

Copy Constructor

◆ ~LineSpatialObjectPoint()

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

Destructor

Member Function Documentation

◆ GetNormalInObjectSpace()

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

Get the normal.

◆ operator=()

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

Copy one LineSpatialObjectPoint to another

◆ PrintSelf()

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

Method to print the object.

Reimplemented from itk::SpatialObjectPoint< TPointDimension >.

◆ SetNormalInObjectSpace()

template<unsigned int TPointDimension = 3>
void itk::LineSpatialObjectPoint< TPointDimension >::SetNormalInObjectSpace ( CovariantVectorType normal,
unsigned int  index 
)

Set the normal.

Member Data Documentation

◆ m_NormalArrayInObjectSpace

template<unsigned int TPointDimension = 3>
NormalArrayType itk::LineSpatialObjectPoint< TPointDimension >::m_NormalArrayInObjectSpace {}
protected

Definition at line 74 of file itkLineSpatialObjectPoint.h.


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