PointXYZI Class Reference

#include <peak_icv/types/geometry/peak_icv_point_xyzi.hpp>

Inheritance diagram for PointXYZI:

Public Member Functions
constexpr	PointXYZI ()=default
constexpr	PointXYZI (float x, float y, float z, uint16_t intensity)
	Point constructor from x, y and z.
constexpr uint16_t	GetIntensity () const
	Returns the intensity meta data.
constexpr bool	operator== (const PointXYZI &rhs) const
float	GetZ () const
	Returns the z coordinate.
constexpr float	GetX () const
	Returns the x-coordinate (first component).
constexpr float	GetY () const
	Returns the y-coordinate (second component).
constexpr bool	operator== (const PointXd< H, d > &rhs) const
	Equality operator for comparing integral coordinates.
constexpr bool	operator!= (const PointXd< H, d > &rhs) const
	Inequality operator for comparing coordinates.
constexpr std::array< float, dimension >	GetCoordinates () const
	Returns the coordinates of the point as an array.

Detailed Description

A point consists of x, y, z coordinates and intensity meta data.

Since

ids_peak_icv 1.1

Definition at line 31 of file peak_icv_point_xyzi.hpp.

Constructor & Destructor Documentation

PointXYZI() [1/2]

PointXYZI ( )

constexprdefault

PointXYZI() [2/2]

PointXYZI ( float x, float y, float z, uint16_t intensity )

inlineconstexpr

Point constructor from x, y and z.

Parameters

x	x coordinate
y	y coordinate
z	z coordinate
intensity	intensity meta data

Since

ids_peak_icv 1.1

Definition at line 47 of file peak_icv_point_xyzi.hpp.

Member Function Documentation

GetCoordinates()

std::array< float, dimension > GetCoordinates ( ) const

inlineconstexprinherited

Returns the coordinates of the point as an array.

Returns

A copy of the internal coordinate array.

Since

ids_peak_common 1.0

Definition at line 170 of file peak_common_point.hpp.

GetIntensity()

uint16_t GetIntensity ( ) const

inlineconstexpr

Returns the intensity meta data.

Since

ids_peak_icv 1.1

Definition at line 57 of file peak_icv_point_xyzi.hpp.

GetX()

float GetX ( ) const

inlineconstexprinherited

Returns the x-coordinate (first component).

Returns

The value of the first coordinate.

Since

ids_peak_common 1.0

Definition at line 74 of file peak_common_point.hpp.

GetY()

float GetY ( ) const

inlineconstexprinherited

Returns the y-coordinate (second component).

Returns

The value of the second coordinate.

Since

ids_peak_common 1.0

Definition at line 86 of file peak_common_point.hpp.

GetZ()

float GetZ ( ) const

inlineinherited

Returns the z coordinate.

Since

ids_peak_icv 1.1

Definition at line 62 of file peak_icv_point_xyz.hpp.

operator!=()

bool operator!= ( const PointXd< H, d > & rhs ) const

inlineconstexprinherited

Inequality operator for comparing coordinates.

Returns true if any coordinates of this point are not equal to the corresponding coordinates of the other point.

Template Parameters

H	The type of the other point's coordinates.
d	The dimensionality of the point.

Since

ids_peak_common 1.0

Definition at line 126 of file peak_common_point.hpp.

operator==() [1/2]

bool operator== ( const PointXd< H, d > & rhs ) const

inlineconstexprinherited

Equality operator for comparing integral coordinates.

Returns true if all coordinates of this point are exactly equal to the corresponding coordinates of the other point. This overload is used for integral coordinate types.

Template Parameters

H	The type of the other point's coordinates.
d	The dimensionality of the point.

Since

ids_peak_common 1.0

Definition at line 109 of file peak_common_point.hpp.

operator==() [2/2]

bool operator== ( const PointXYZI & rhs ) const

inlineconstexpr

PointXYZI equality operator

Since

ids_peak_icv 1.1

Definition at line 67 of file peak_icv_point_xyzi.hpp.