Formula Student Autonomous Systems
The code for the main driverless system
Loading...
Searching...
No Matches
ZScoreValidator Class Reference

The ZScoreValidator class is responsible for validating cones based on the approximation of z-score of when compared with some thresholds. More...

#include <z_score_validator.hpp>

Inheritance diagram for ZScoreValidator:
Inheritance graph
Collaboration diagram for ZScoreValidator:
Collaboration graph

Public Member Functions

 ZScoreValidator (double min_z_score_x, double max_z_score_x, double min_z_score_y, double max_z_score_y)
 Construct a new ZScoreValidator object with the specific thresholds.
 
std::vector< double > coneValidator (Cluster *cluster, Plane &plane) const override
 Validates the cluster based on the z-score distribution.
 
virtual ~ZScoreValidator ()=default
 Virtual destructor for ZScoreValidator.
 

Private Attributes

double _min_z_score_x_
 Min z-score on x-axis *‍/.
 
double _max_z_score_x_
 Max z-score on x-axis *‍/.
 
double _min_z_score_y_
 Min z-score on y-axis *‍/.
 
double _max_z_score_y_
 Max z-score on y-axis *‍/.
 

Detailed Description

The ZScoreValidator class is responsible for validating cones based on the approximation of z-score of when compared with some thresholds.

A z-score is used to determine how unusual or typical a particular value is within a set of data. It helps in comparing values from different distributions by standardizing them, allowing for meaningful comparisons.

The z-score references the normal distribution, where most values cluster around the mean. Values with z-scores close to zero are near the mean, while values with higher positive or negative z-scores are further from the mean, indicating they are more unusual or extreme. This makes z-scores useful in identifying outliers and understanding data spread.

Definition at line 19 of file z_score_validator.hpp.

Constructor & Destructor Documentation

◆ ZScoreValidator()

ZScoreValidator::ZScoreValidator ( double  min_z_score_x,
double  max_z_score_x,
double  min_z_score_y,
double  max_z_score_y 
)

Construct a new ZScoreValidator object with the specific thresholds.

Parameters
min_z_score_xMin z-score on x-axis
max_z_score_xMax z-score on x-axis
min_z_score_yMin z-score on y-axis
max_z_score_yMax z-score on y-axis

Definition at line 3 of file z_score_validator.cpp.

◆ ~ZScoreValidator()

virtual ZScoreValidator::~ZScoreValidator ( )
virtualdefault

Virtual destructor for ZScoreValidator.

Member Function Documentation

◆ coneValidator()

std::vector< double > ZScoreValidator::coneValidator ( Cluster cluster,
Plane plane 
) const
overridevirtual

Validates the cluster based on the z-score distribution.

Parameters
clusterCluster to be validated
Returns
true if the cluster is valid, false otherwise

Implements ConeValidator.

Definition at line 10 of file z_score_validator.cpp.

Member Data Documentation

◆ _max_z_score_x_

double ZScoreValidator::_max_z_score_x_
private

Max z-score on x-axis *‍/.

Definition at line 47 of file z_score_validator.hpp.

◆ _max_z_score_y_

double ZScoreValidator::_max_z_score_y_
private

Max z-score on y-axis *‍/.

Definition at line 49 of file z_score_validator.hpp.

◆ _min_z_score_x_

double ZScoreValidator::_min_z_score_x_
private

Min z-score on x-axis *‍/.

Definition at line 46 of file z_score_validator.hpp.

◆ _min_z_score_y_

double ZScoreValidator::_min_z_score_y_
private

Min z-score on y-axis *‍/.

Definition at line 48 of file z_score_validator.hpp.


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