Public Member Functions | Protected Attributes | List of all members
vgl_fit_plane_3d< T > Class Template Reference

#include <vgl_algo_fwd.h>

Public Member Functions

 vgl_fit_plane_3d ()=default
 
 vgl_fit_plane_3d (std::vector< vgl_homg_point_3d< T > > points)
 
 ~vgl_fit_plane_3d ()=default
 
void add_point (vgl_homg_point_3d< T > const &p)
 add a point to point set. More...
 
void add_point (const T x, const T y, const T z)
 
void clear ()
 clear internal data. More...
 
bool fit (const T error_marg, std::ostream *outstream=nullptr)
 fits a plane to the stored points. More...
 
fit (std::ostream *outstream=nullptr)
 fits a plane returning the smallest singular value. More...
 
std::vector< vgl_homg_point_3d< T > > & get_points ()
 
vgl_homg_plane_3d< T > & get_plane ()
 first fit() should be called to get the plane computed. More...
 

Protected Attributes

std::vector< vgl_homg_point_3d< T > > points_
 
vgl_homg_plane_3d< T > plane_
 

Detailed Description

template<class T>
class vgl_fit_plane_3d< T >

Definition at line 6 of file vgl_algo_fwd.h.

Constructor & Destructor Documentation

◆ vgl_fit_plane_3d() [1/2]

template<class T >
vgl_fit_plane_3d< T >::vgl_fit_plane_3d ( )
default

◆ vgl_fit_plane_3d() [2/2]

template<class T >
vgl_fit_plane_3d< T >::vgl_fit_plane_3d ( std::vector< vgl_homg_point_3d< T > >  points)

Definition at line 18 of file vgl_fit_plane_3d.hxx.

◆ ~vgl_fit_plane_3d()

template<class T >
vgl_fit_plane_3d< T >::~vgl_fit_plane_3d ( )
default

Member Function Documentation

◆ add_point() [1/2]

template<class T >
void vgl_fit_plane_3d< T >::add_point ( vgl_homg_point_3d< T > const &  p)

add a point to point set.

Definition at line 24 of file vgl_fit_plane_3d.hxx.

◆ add_point() [2/2]

template<class T >
void vgl_fit_plane_3d< T >::add_point ( const T  x,
const T  y,
const T  z 
)

Definition at line 30 of file vgl_fit_plane_3d.hxx.

◆ clear()

template<class T >
void vgl_fit_plane_3d< T >::clear ( )

clear internal data.

Definition at line 36 of file vgl_fit_plane_3d.hxx.

◆ fit() [1/2]

template<class T >
bool vgl_fit_plane_3d< T >::fit ( const T  error_marg,
std::ostream *  outstream = nullptr 
)

fits a plane to the stored points.

report issues over an ostream if declared

Definition at line 42 of file vgl_fit_plane_3d.hxx.

◆ fit() [2/2]

template<class T >
T vgl_fit_plane_3d< T >::fit ( std::ostream *  outstream = nullptr)

fits a plane returning the smallest singular value.

of the data scatter matrix decomposition, a measure.of variance in the direction of the plane normal.

Definition at line 55 of file vgl_fit_plane_3d.hxx.

◆ get_plane()

template<class T >
vgl_homg_plane_3d<T>& vgl_fit_plane_3d< T >::get_plane ( )
inline

first fit() should be called to get the plane computed.

Definition at line 69 of file vgl_fit_plane_3d.h.

◆ get_points()

template<class T >
std::vector<vgl_homg_point_3d<T> >& vgl_fit_plane_3d< T >::get_points ( )
inline

Definition at line 66 of file vgl_fit_plane_3d.h.

Member Data Documentation

◆ plane_

template<class T >
vgl_homg_plane_3d<T> vgl_fit_plane_3d< T >::plane_
protected

Definition at line 32 of file vgl_fit_plane_3d.h.

◆ points_

template<class T >
std::vector<vgl_homg_point_3d<T> > vgl_fit_plane_3d< T >::points_
protected

Definition at line 31 of file vgl_fit_plane_3d.h.


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