Point cloud class. More...

#include <point_cloud.hpp>

Detailed Description

template<uint8_t dim>
class bem::PointCloud< dim >

Point cloud class.

Template Parameters

dim	- The dimension of the point cloud (1, 2 or 3).

Examples: /examples/ex01_start_here.cpp, and /examples/ex02_assemblers.cpp.

Definition at line 39 of file point_cloud.hpp.

Constructor & Destructor Documentation

◆ PointCloud() [1/2]

template<uint8_t dim>

bem::PointCloud< dim >::PointCloud ( )

inline

Constructs an empty PointCloud.

Definition at line 49 of file point_cloud.hpp.

◆ PointCloud() [2/2]

template<uint8_t dim>

bem::PointCloud< dim >::PointCloud ( ConstEigRef< EigMatNX< Float, dim > > points )

inline

Constructs a PointCloud with given point data.

Parameters

[in] points - Coordinates of the points in the cloud.

Definition at line 56 of file point_cloud.hpp.

Member Function Documentation

◆ set_line_data()

template<uint8_t dim>

void bem::PointCloud< dim >::set_line_data	(	ConstEigRef< EigColVecN< Float, dim > >	start,
		ConstEigRef< EigColVecN< Float, dim > >	stop,
		const Index	num_pts
	)

Sets PointCloud data as points along a straight line.

Parameters

[in]	start	- Starting point coordinates.
[in]	stop	- Ending point coordinates.
[in]	num_pts	- Number of points in the cloud.

Definition at line 30 of file point_cloud.cpp.

◆ set_block_data()

template<uint8_t dim>

void bem::PointCloud< dim >::set_block_data	(	ConstEigRef< EigColVecN< Float, dim > >	start,
		ConstEigRef< EigColVecN< Float, dim > >	stop,
		ConstEigRef< EigColVecN< Index, dim > >	num_pts
	)

Sets PointCloud data as a block of points.

Parameters

[in]	start	- Coordinates of the minimum-value corner of the block.
[in]	stop	- Coordinates of the maximum-value corner of the block.
[in]	num_pts	- Number of points in the block along each dimension.

Definition at line 44 of file point_cloud.cpp.

◆ set_polar_data()

template<uint8_t dim>

void bem::PointCloud< dim >::set_polar_data	(	ConstEigRef< EigColVecN< Float, dim > >	start,
		ConstEigRef< EigColVecN< Float, dim > >	stop,
		ConstEigRef< EigColVecN< Float, dim > >	center,
		ConstEigRef< EigColVecN< Index, dim > >	num_pts
	)

Sets PointCloud data as points of a polar grid.

Parameters

[in]	start	- Starting point coordinates (radius, azimuth, elevation).
[in]	stop	- Ending point coordinates (radius, azimuth, elevation).
[in]	center	- Center point coordinates (x, y, z).
[in]	num_pts	- Number of points in the polar grid along each dimension.

Examples: /examples/ex01_start_here.cpp, and /examples/ex02_assemblers.cpp.

Definition at line 83 of file point_cloud.cpp.

◆ set_data()

template<uint8_t dim>

void bem::PointCloud< dim >::set_data ( ConstEigRef< EigMatNX< Float, dim > > points )

Sets the point cloud data.

Parameters

[in] points - Coordinates of the points in the cloud.

Definition at line 97 of file point_cloud.cpp.

◆ clear_data()

template<uint8_t dim>

void bem::PointCloud< dim >::clear_data ( )

Clears the point cloud data.

Definition at line 105 of file point_cloud.cpp.

◆ points() [1/2]

template<uint8_t dim>

const EigMatNX< Float, dim > & bem::PointCloud< dim >::points ( ) const

inline

Returns the coordinates of the points in the cloud.

Returns: Point coordinates.

Definition at line 126 of file point_cloud.hpp.

◆ points() [2/2]

template<uint8_t dim>

EigColVecN< Float, dim > bem::PointCloud< dim >::points ( Index idx ) const

inline

Returns the coordinates of the point at a specific index in the cloud.

Parameters

[in] idx - Index of the point.

Returns: Coordinates of the specified point.

Definition at line 135 of file point_cloud.hpp.

◆ num_points()

template<uint8_t dim>

Index bem::PointCloud< dim >::num_points ( ) const

inline

Returns the number of points in the cloud.

Returns: Number of points.

Definition at line 143 of file point_cloud.hpp.

Member Data Documentation

◆ points_

template<uint8_t dim>

EigMatNX<Float, dim> bem::PointCloud< dim >::points_

protected

Definition at line 149 of file point_cloud.hpp.

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

source/geometry/point_cloud.hpp
source/geometry/point_cloud.cpp