Helios++
Helios software for LiDAR simulations
SurfaceInspector::maths::Plane< T > Class Template Reference

Class representing a plane. More...

#include <Plane.hpp>

Inheritance diagram for SurfaceInspector::maths::Plane< T >:
Collaboration diagram for SurfaceInspector::maths::Plane< T >:

Public Member Functions

 Plane ()=default
 Default plane constructor.
 
 Plane (vector< T > centroid, vector< T > orthonormal, T scatter=0, T curvature=0)
 Build a plane with given centroid, orthonormal and scatter. More...
 

Public Attributes

vector< T > centroid
 Coordinates for plane centroid.
 
vector< T > orthonormal
 Plane orthonormal vector.
 
scatter
 When the plane has been obtained through fitting to a sample, scatter will quantify variation with respect to elements in the sample. More...
 
curvature
 When the plane has been obtained through fitting to a sample, curvature is defined by expression: More...
 

Detailed Description

template<typename T>
class SurfaceInspector::maths::Plane< T >

Class representing a plane.

Author
Alberto M. Esmoris Pena
Version
1.0
Template Parameters
TType of number

Constructor & Destructor Documentation

◆ Plane()

template<typename T >
SurfaceInspector::maths::Plane< T >::Plane ( vector< T >  centroid,
vector< T >  orthonormal,
scatter = 0,
curvature = 0 
)
inline

Build a plane with given centroid, orthonormal and scatter.

Parameters
centroidCentroid for the plane
orthonormalOrthonormal for the plane
scatterScatter for the plane
See also
Plane:centroid
Plane::orthonormal
Plane::scatter
Plane::curvature

Member Data Documentation

◆ curvature

template<typename T >
T SurfaceInspector::maths::Plane< T >::curvature

When the plane has been obtained through fitting to a sample, curvature is defined by expression:

\[ \frac{\lambda_{1}}{\sum_{i}^{n}\lambda_{i}} \]

Where \(\lambda_{i}\) is the ith eigen value or ith singular value, depending on used method. So \(\lambda_{1}\) will be the eigen or singular value for the plane which maximizes distance with respect to sample set while \(lambda_{n}\) will be the one which minimizes it

See also
PlaneFitter

◆ scatter

template<typename T >
T SurfaceInspector::maths::Plane< T >::scatter

When the plane has been obtained through fitting to a sample, scatter will quantify variation with respect to elements in the sample.

See also
PlaneFitter

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