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

#include <itkSurfaceSpatialObjectPoint.h>

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

Public Types

using CovariantVectorType = CovariantVector< double, TPointDimension >
 
using PointType = Point< double, TPointDimension >
 
using Self = SurfaceSpatialObjectPoint
 
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 () const
 
const CovariantVectorType GetNormalInWorldSpace () const
 
Selfoperator= (const SurfaceSpatialObjectPoint &rhs)
 
void SetNormalInObjectSpace (const CovariantVectorType &normal)
 
void SetNormalInWorldSpace (const CovariantVectorType &normal)
 
 SurfaceSpatialObjectPoint ()
 
 SurfaceSpatialObjectPoint (const SurfaceSpatialObjectPoint &other)
 
 ~SurfaceSpatialObjectPoint () 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
 
 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
 

Protected Member Functions

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

Protected Attributes

CovariantVectorType m_NormalInObjectSpace {}
 
- 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
 

Detailed Description

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

Point used for a Surface 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 39 of file itkSurfaceSpatialObjectPoint.h.

Member Typedef Documentation

◆ CovariantVectorType

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

Definition at line 46 of file itkSurfaceSpatialObjectPoint.h.

◆ PointType

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

Definition at line 44 of file itkSurfaceSpatialObjectPoint.h.

◆ Self

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

Definition at line 42 of file itkSurfaceSpatialObjectPoint.h.

◆ Superclass

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

Definition at line 43 of file itkSurfaceSpatialObjectPoint.h.

Constructor & Destructor Documentation

◆ SurfaceSpatialObjectPoint() [1/2]

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

Constructor

◆ SurfaceSpatialObjectPoint() [2/2]

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

Copy Constructor

◆ ~SurfaceSpatialObjectPoint()

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

Destructor

Member Function Documentation

◆ GetNormalInObjectSpace()

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

Get the normal in object space.

◆ GetNormalInWorldSpace()

template<unsigned int TPointDimension = 3>
const CovariantVectorType itk::SurfaceSpatialObjectPoint< TPointDimension >::GetNormalInWorldSpace ( ) const

Get the normal in world space.

◆ operator=()

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

Copy one SurfaceSpatialObjectPoint to another.

◆ PrintSelf()

template<unsigned int TPointDimension = 3>
void itk::SurfaceSpatialObjectPoint< 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::SurfaceSpatialObjectPoint< TPointDimension >::SetNormalInObjectSpace ( const CovariantVectorType normal)

Set the normal in object space.

◆ SetNormalInWorldSpace()

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

Set the normal in world space.

Member Data Documentation

◆ m_NormalInObjectSpace

template<unsigned int TPointDimension = 3>
CovariantVectorType itk::SurfaceSpatialObjectPoint< TPointDimension >::m_NormalInObjectSpace {}
protected

Definition at line 78 of file itkSurfaceSpatialObjectPoint.h.


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