Implementation of a plane clipper in 3D. More...

#include <pcl/filters/plane_clipper3D.h>

Inheritance diagram for pcl::PlaneClipper3D< PointT >:

Public Types
using	Ptr = shared_ptr< PlaneClipper3D<PointT> >
using	ConstPtr = shared_ptr< const PlaneClipper3D<PointT> >
Public Types inherited from pcl::Clipper3D< PointT >
using	Ptr = shared_ptr<Clipper3D<PointT> >
using	ConstPtr = shared_ptr<const Clipper3D<PointT> >

Public Member Functions
PCL_MAKE_ALIGNED_OPERATOR_NEW	PlaneClipper3D (const Eigen::Vector4f &plane_params)
	Constructor taking the homogeneous representation of the plane as a Eigen::Vector4f.
virtual	~PlaneClipper3D () noexcept=default
void	setPlaneParameters (const Eigen::Vector4f &plane_params)
	Set new plane parameters.
const Eigen::Vector4f &	getPlaneParameters () const
	return the current plane parameters
virtual bool	clipPoint3D (const PointT &point) const
	interface to clip a single point
virtual bool	clipLineSegment3D (PointT &from, PointT &to) const
virtual void	clipPlanarPolygon3D (std::vector< PointT, Eigen::aligned_allocator< PointT > > &polygon) const
virtual void	clipPlanarPolygon3D (const std::vector< PointT, Eigen::aligned_allocator< PointT > > &polygon, std::vector< PointT, Eigen::aligned_allocator< PointT > > &clipped_polygon) const
virtual void	clipPointCloud3D (const pcl::PointCloud< PointT > &cloud_in, Indices &clipped, const Indices &indices=Indices()) const
	interface to clip a point cloud
virtual Clipper3D< PointT > *	clone () const
	polymorphic method to clone the underlying clipper with its parameters.
Public Member Functions inherited from pcl::Clipper3D< PointT >
virtual	~Clipper3D () noexcept=default
	virtual destructor.

Protected Member Functions
float	getDistance (const PointT &point) const

Detailed Description

template<typename PointT>
class pcl::PlaneClipper3D< PointT >

Implementation of a plane clipper in 3D.

Author: Suat Gedikli gedik.nosp@m.li@w.nosp@m.illow.nosp@m.gara.nosp@m.ge.co.nosp@m.m

Definition at line 50 of file plane_clipper3D.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PointT>

using pcl::PlaneClipper3D< PointT >::ConstPtr = shared_ptr< const PlaneClipper3D<PointT> >

Definition at line 55 of file plane_clipper3D.h.

◆ Ptr

template<typename PointT>

using pcl::PlaneClipper3D< PointT >::Ptr = shared_ptr< PlaneClipper3D<PointT> >

Definition at line 54 of file plane_clipper3D.h.

Constructor & Destructor Documentation

◆ PlaneClipper3D()

template<typename PointT>

pcl::PlaneClipper3D< PointT >::PlaneClipper3D ( const Eigen::Vector4f & plane_params )

Constructor taking the homogeneous representation of the plane as a Eigen::Vector4f.

Author: Suat Gedikli gedik.nosp@m.li@w.nosp@m.illow.nosp@m.gara.nosp@m.ge.co.nosp@m.m

Parameters

[in] plane_params plane parameters, need not necessarily be normalized

Definition at line 41 of file plane_clipper3D.hpp.

Referenced by clone().

◆ ~PlaneClipper3D()

template<typename PointT>

virtual pcl::PlaneClipper3D< PointT >::~PlaneClipper3D ( )

virtualdefaultnoexcept

References clipLineSegment3D(), clipPlanarPolygon3D(), clipPoint3D(), clipPointCloud3D(), clone(), getDistance(), getPlaneParameters(), and setPlaneParameters().

Member Function Documentation

◆ clipLineSegment3D()

template<typename PointT>

bool pcl::PlaneClipper3D< PointT >::clipLineSegment3D	(	PointT &	point1,
		PointT &	point2 ) const

virtual

Attention: untested code

Implements pcl::Clipper3D< PointT >.

Definition at line 80 of file plane_clipper3D.hpp.

References getDistance().

Referenced by clipPlanarPolygon3D(), and ~PlaneClipper3D().

◆ clipPlanarPolygon3D() [1/2]

template<typename PointT>

void pcl::PlaneClipper3D< PointT >::clipPlanarPolygon3D	(	const std::vector< PointT, Eigen::aligned_allocator< PointT > > &	polygon,
		std::vector< PointT, Eigen::aligned_allocator< PointT > > &	clipped_polygon ) const

virtual

Attention: untested code

Implements pcl::Clipper3D< PointT >.

Definition at line 109 of file plane_clipper3D.hpp.

References clipLineSegment3D(), clipPoint3D(), and getDistance().

◆ clipPlanarPolygon3D() [2/2]

template<typename PointT>

void pcl::PlaneClipper3D< PointT >::clipPlanarPolygon3D ( std::vector< PointT, Eigen::aligned_allocator< PointT > > & polygon ) const

virtual

Attention: untested code

Implements pcl::Clipper3D< PointT >.

Definition at line 166 of file plane_clipper3D.hpp.

References clipPlanarPolygon3D().

Referenced by clipPlanarPolygon3D(), and ~PlaneClipper3D().

◆ clipPoint3D()

template<typename PointT>

bool pcl::PlaneClipper3D< PointT >::clipPoint3D ( const PointT & point ) const

virtual

interface to clip a single point

Parameters

[in] point the point to check against

Returns: true, it point still exists, false if its clipped

Implements pcl::Clipper3D< PointT >.

Definition at line 71 of file plane_clipper3D.hpp.

Referenced by clipPlanarPolygon3D(), clipPointCloud3D(), and ~PlaneClipper3D().

◆ clipPointCloud3D()

template<typename PointT>

void pcl::PlaneClipper3D< PointT >::clipPointCloud3D	(	const pcl::PointCloud< PointT > &	cloud_in,
		Indices &	clipped,
		const Indices &	indices = Indices() ) const

virtual

interface to clip a point cloud

Parameters

[in]	cloud_in	input point cloud
[out]	clipped	indices of points that remain after clipping the input cloud
[in]	indices	the indices of points in the point cloud to be clipped.