MeVisLab Toolbox Reference
Public Member Functions | Public Attributes | List of all members
ml::StatisticalClusterInfo Struct Reference

Small helper container managing some information about a cluster. More...

#include <mlPCLStatisticalClusterInfo.h>

Public Member Functions

 StatisticalClusterInfo ()
 Constructor defaulting everything to an empty cluster.
 
void clear ()
 Setting default values corresponding to an empty cluster.
 
void insert (int index, double magnitude, double phase)
 Inserting a new magnitude,phase pair updating statistics.
 
void finalize (const MLPointCloudXYZINormal &inputPointCloud, const Vector3 &planeNormal, const Vector3 &planePoint, const std::string &magnitudeFloatMemberName, const std::string &phaseFloatMemberName)
 To be called after last insert to finalise cluster calculations.
 

Public Attributes

MLint numPoints
 Number of points in the cluster.
 
std::vector< int > indices
 List of point indices of the cluster.
 
double magnitudeSum
 The sum of all point magnitudes in the cluster.
 
double magnitudeSumAbsolute
 The sum of all absolute point magnitudes in the cluster.
 
double magnitudeAverage
 The average of all point magnitudes in the cluster.
 
double magnitudeAverageAbsolute
 The average of all point magnitudes in the cluster.
 
double magnitudeMedian
 The median of all point magnitudes in the cluster.
 
double phaseSum
 The sum of all point phases in the cluster.
 
double phaseSumAbsolute
 The sum of all absolute point phases in the cluster.
 
double phaseAverage
 The average of all point phases in the cluster.
 
double phaseAverageAbsolute
 The average of all point phases in the cluster.
 
double phaseMedian
 The median of all point phases in the cluster.
 
Vector3 centreOfGravity
 Centre of gravity of the cluster.
 
Vector3 eigenValues
 Eigenvalues of the cluster.
 
Vector3 eigenVectors [3]
 Eigenvectors of the cluster.
 
Vector3 orientedExtentsMin
 Minimum extents according to the eigen vectors.
 
Vector3 orientedExtentsMax
 Minimum extents according to the eigen vectors.
 
Vector3 planeIntersection
 Intersection of main axes of cluster with user plane.
 
bool planeIntersectionOk
 True if intersection of main axes of cluster with user plane is valid, otherwise false.
 

Detailed Description

Small helper container managing some information about a cluster.

Definition at line 33 of file mlPCLStatisticalClusterInfo.h.

Constructor & Destructor Documentation

◆ StatisticalClusterInfo()

ml::StatisticalClusterInfo::StatisticalClusterInfo ( )
inline

Constructor defaulting everything to an empty cluster.

Definition at line 35 of file mlPCLStatisticalClusterInfo.h.

Member Function Documentation

◆ clear()

void ml::StatisticalClusterInfo::clear ( )
inline

Setting default values corresponding to an empty cluster.

Definition at line 40 of file mlPCLStatisticalClusterInfo.h.

◆ finalize()

void ml::StatisticalClusterInfo::finalize ( const MLPointCloudXYZINormal & inputPointCloud,
const Vector3 & planeNormal,
const Vector3 & planePoint,
const std::string & magnitudeFloatMemberName,
const std::string & phaseFloatMemberName )
inline

To be called after last insert to finalise cluster calculations.

Definition at line 85 of file mlPCLStatisticalClusterInfo.h.

References ml::Plane::intersect(), ml::PCLSupportTools::PointCloudStatistics::median, and ml::PCLMakeLocalNonDeletingSharedConstPtr().

◆ insert()

void ml::StatisticalClusterInfo::insert ( int index,
double magnitude,
double phase )
inline

Inserting a new magnitude,phase pair updating statistics.

Definition at line 71 of file mlPCLStatisticalClusterInfo.h.

Member Data Documentation

◆ centreOfGravity

Vector3 ml::StatisticalClusterInfo::centreOfGravity

Centre of gravity of the cluster.

Definition at line 195 of file mlPCLStatisticalClusterInfo.h.

◆ eigenValues

Vector3 ml::StatisticalClusterInfo::eigenValues

Eigenvalues of the cluster.

Definition at line 198 of file mlPCLStatisticalClusterInfo.h.

◆ eigenVectors

Vector3 ml::StatisticalClusterInfo::eigenVectors[3]

Eigenvectors of the cluster.

Definition at line 201 of file mlPCLStatisticalClusterInfo.h.

◆ indices

std::vector<int> ml::StatisticalClusterInfo::indices

List of point indices of the cluster.

Definition at line 158 of file mlPCLStatisticalClusterInfo.h.

◆ magnitudeAverage

double ml::StatisticalClusterInfo::magnitudeAverage

The average of all point magnitudes in the cluster.

Definition at line 168 of file mlPCLStatisticalClusterInfo.h.

◆ magnitudeAverageAbsolute

double ml::StatisticalClusterInfo::magnitudeAverageAbsolute

The average of all point magnitudes in the cluster.

Definition at line 171 of file mlPCLStatisticalClusterInfo.h.

◆ magnitudeMedian

double ml::StatisticalClusterInfo::magnitudeMedian

The median of all point magnitudes in the cluster.

Definition at line 174 of file mlPCLStatisticalClusterInfo.h.

◆ magnitudeSum

double ml::StatisticalClusterInfo::magnitudeSum

The sum of all point magnitudes in the cluster.

Definition at line 162 of file mlPCLStatisticalClusterInfo.h.

◆ magnitudeSumAbsolute

double ml::StatisticalClusterInfo::magnitudeSumAbsolute

The sum of all absolute point magnitudes in the cluster.

Definition at line 165 of file mlPCLStatisticalClusterInfo.h.

◆ numPoints

MLint ml::StatisticalClusterInfo::numPoints

Number of points in the cluster.

Definition at line 155 of file mlPCLStatisticalClusterInfo.h.

◆ orientedExtentsMax

Vector3 ml::StatisticalClusterInfo::orientedExtentsMax

Minimum extents according to the eigen vectors.

Definition at line 207 of file mlPCLStatisticalClusterInfo.h.

◆ orientedExtentsMin

Vector3 ml::StatisticalClusterInfo::orientedExtentsMin

Minimum extents according to the eigen vectors.

Definition at line 204 of file mlPCLStatisticalClusterInfo.h.

◆ phaseAverage

double ml::StatisticalClusterInfo::phaseAverage

The average of all point phases in the cluster.

Definition at line 185 of file mlPCLStatisticalClusterInfo.h.

◆ phaseAverageAbsolute

double ml::StatisticalClusterInfo::phaseAverageAbsolute

The average of all point phases in the cluster.

Definition at line 188 of file mlPCLStatisticalClusterInfo.h.

◆ phaseMedian

double ml::StatisticalClusterInfo::phaseMedian

The median of all point phases in the cluster.

Definition at line 191 of file mlPCLStatisticalClusterInfo.h.

◆ phaseSum

double ml::StatisticalClusterInfo::phaseSum

The sum of all point phases in the cluster.

Definition at line 179 of file mlPCLStatisticalClusterInfo.h.

◆ phaseSumAbsolute

double ml::StatisticalClusterInfo::phaseSumAbsolute

The sum of all absolute point phases in the cluster.

Definition at line 182 of file mlPCLStatisticalClusterInfo.h.

◆ planeIntersection

Vector3 ml::StatisticalClusterInfo::planeIntersection

Intersection of main axes of cluster with user plane.

Definition at line 210 of file mlPCLStatisticalClusterInfo.h.

◆ planeIntersectionOk

bool ml::StatisticalClusterInfo::planeIntersectionOk

True if intersection of main axes of cluster with user plane is valid, otherwise false.

Definition at line 213 of file mlPCLStatisticalClusterInfo.h.

The documentation for this struct was generated from the following file: