CGAL::Shape_detection::Plane< Traits > Class Template Reference

#include <CGAL/Shape_detection/Efficient_RANSAC/Plane.h>

Inherits CGAL::Shape_detection::Shape_base< Traits >.

Definition

template<class Traits>
class CGAL::Shape_detection::Plane< Traits >

Plane implements Shape_base. The plane is represented by the normal vector and the distance to the origin.

Template Parameters

Traits

must be a model of EfficientRANSACTraits with the additional requirement for planes (see EfficientRANSACTraits documentation).

Examples

Shape_detection/efficient_RANSAC_and_plane_regularization.cpp, Shape_detection/efficient_RANSAC_basic.cpp, Shape_detection/efficient_RANSAC_with_callback.cpp, Shape_detection/efficient_RANSAC_with_parameters.cpp, and Shape_detection/efficient_RANSAC_with_point_access.cpp.

Public Types
typedef Traits::Plane_3	Plane_3
	Plane type for the conversion operator.
Public Types inherited from CGAL::Shape_detection::Shape_base< Traits >
typedef Traits::FT	FT
	Number type.
typedef Traits::Point_3	Point_3
	Point type.
typedef Traits::Vector_3	Vector_3
	Vector type.

Public Member Functions
	operator Plane_3 () const
	Conversion operator to Plane_3 type.
Vector_3	plane_normal () const
	Normal vector of the plane.
FT	d () const
	Signed distance from the origin.
Public Member Functions inherited from CGAL::Shape_detection::Shape_base< Traits >
const std::vector< std::size_t > &	indices_of_assigned_points () const
	Returns the indices of the points in the input range assigned to this shape.
virtual std::string	info () const
	Returns a string containing the shape type and the numerical parameters.
virtual FT	squared_distance (const Point_3 &p) const =0
	Computes the squared Euclidean distance from the query point p to the shape.

Additional Inherited Members
Protected Member Functions inherited from CGAL::Shape_detection::Shape_base< Traits >
virtual void	create_shape (const std::vector< std::size_t > &indices)=0
	Constructs the shape based on a minimal set of samples from the input data.
virtual std::size_t	connected_component (std::vector< std::size_t > &indices, FT cluster_epsilon)
	Determines the largest cluster of inlier points. More...
std::size_t	connected_component_kdTree (std::vector< std::size_t > &indices, FT cluster_epsilon)
	Determines the largest cluster with a point-to-point distance not larger than cluster_epsilon. More...
virtual void	squared_distance (const std::vector< std::size_t > &indices, std::vector< FT > &distances) const =0
	Computes the squared Euclidean distance from a set of points to the shape. More...
virtual void	cos_to_normal (const std::vector< std::size_t > &indices, std::vector< FT > &angles) const =0
	Computes the deviation of the point normal from the surface normal at the projected point in form of the dot product and writes the result into the provided angles vector.
virtual std::size_t	minimum_sample_size () const =0
	Returns minimal number of sample points required for construction.
boost::property_traits< typename Traits::Point_map >::reference	point (std::size_t i) const
	Retrieves the point location from its index.
boost::property_traits< typename Traits::Normal_map >::reference	normal (std::size_t i) const
	Retrieves the normal vector from its index.
const Traits &	traits () const
	Retrieves the traits class.