CGAL 5.2.2 - Classification
CGAL::Classification::Label Class Reference

#include <CGAL/Classification/Label.h>

Definition

Classification label (for example: vegetation, ground, etc.).

Note
Labels should always be constructed from a CGAL::Classification::Label_set object.

Access

const std::string & name () const
 returns the name of the classification label (e.g. More...
 
std::size_t index () const
 returns the index of the classification label in the label set. More...
 
std::size_t standard_index () const
 returns the standard index of the classification label (e.g. More...
 
const CGAL::Colorcolor () const
 returns the color used to represent the label. More...
 

Modification

void set_name (const std::string &name)
 
void set_standard_index (std::size_t idx)
 
void set_color (const Color &color)
 

Member Function Documentation

◆ color()

const CGAL::Color& CGAL::Classification::Label::color ( ) const

returns the color used to represent the label.

Note
The color is purely user-oriented and is not used by the classification algorithms. It is not to be confused with a color attribute embedded in a data set which can be used (see Color_channel).

◆ index()

std::size_t CGAL::Classification::Label::index ( ) const

returns the index of the classification label in the label set.

Note
This index cannot be changed by the user and is handled directly by the label set.

◆ name()

const std::string& CGAL::Classification::Label::name ( ) const

returns the name of the classification label (e.g.

vegetation).

◆ standard_index()

std::size_t CGAL::Classification::Label::standard_index ( ) const

returns the standard index of the classification label (e.g.

index in the ASPRS standard).

Note
This index is purely user-oriented and is not used by the classification algorithms.