#include <map_classify.h>

Public Types
enum class	Classifier { Unique = 0 , Equal , Defined , Quantile , Geometric , Natural , StdDev , NotSet }
enum class	LUT_Fields { Color = 0 , Name , Description , Minimum , Maximum }

Public Member Functions
	CSG_Map_Classify (void)
virtual	~CSG_Map_Classify (void)
	CSG_Map_Classify (CSG_Data_Object *pObject)
bool	Create (CSG_Data_Object *pObject)
	CSG_Map_Classify (CSG_Table *pTable, int Field, int Normalize=-1, bool bPercent=false)
bool	Create (CSG_Table *pTable, int Field, int Normalize=-1, bool bPercent=false)
bool	Destroy (void)
const CSG_String &	Get_Name (Classifier Classifier) const
bool	is_Okay (void) const
bool	is_Classified (void) const
Classifier	Get_Classifier (void) const
bool	Set_LUT (CSG_Table &LUT, CSG_Colors Colors, int Labeling, int NumPrecision=-2) const
bool	Classify_Unique (int maxCount=1024)
bool	Classify_Equal (int Count, double Minimum, double Maximum)
bool	Classify_Equal (int Count)
bool	Classify_Defined (double Interval, double Offset)
bool	Classify_Defined (double Interval)
bool	Classify_Quantile (int Count, bool bHistogram=true)
bool	Classify_Geometric (int Count, bool bIncreasing=true)
bool	Classify_Natural (int Count)
bool	Classify_StdDev (double StdDev, double StdDev_Max=4.)

Public Attributes
bool	m_Show_Progress = false

Detailed Description

Definition at line 71 of file map_classify.h.

Member Enumeration Documentation

◆ Classifier

enum class CSG_Map_Classify::Classifier

strong

Enumerator
Unique
Equal
Defined
Quantile
Geometric
Natural
StdDev
NotSet

Definition at line 75 of file map_classify.h.

◆ LUT_Fields

enum class CSG_Map_Classify::LUT_Fields

strong

Enumerator
Color
Name
Description
Minimum
Maximum

Definition at line 80 of file map_classify.h.

Constructor & Destructor Documentation

◆ CSG_Map_Classify() [1/3]

CSG_Map_Classify::CSG_Map_Classify ( void )

Definition at line 62 of file map_classify.cpp.

◆ ~CSG_Map_Classify()

CSG_Map_Classify::~CSG_Map_Classify ( void )

virtual

Definition at line 80 of file map_classify.cpp.

References Destroy().

◆ CSG_Map_Classify() [2/3]

CSG_Map_Classify::CSG_Map_Classify ( CSG_Data_Object * pObject )

Definition at line 68 of file map_classify.cpp.

References Create().

◆ CSG_Map_Classify() [3/3]

CSG_Map_Classify::CSG_Map_Classify	(	CSG_Table *	pTable,
		int	Field,
		int	Normalize = -1,
		bool	bPercent = false )

Definition at line 74 of file map_classify.cpp.

References Create().

Member Function Documentation

◆ Classify_Defined() [1/2]

bool CSG_Map_Classify::Classify_Defined ( double Interval )

Definition at line 561 of file map_classify.cpp.

References Classify_Defined(), and CSG_Simple_Statistics::Get_Minimum().

◆ Classify_Defined() [2/2]

bool CSG_Map_Classify::Classify_Defined	(	double	Interval,
		double	Offset )

Definition at line 528 of file map_classify.cpp.

References Defined, CSG_Simple_Statistics::Get_Maximum(), Maximum, Minimum, and CSG_Table_Record::Set_Value().

Referenced by Classify_Defined().

◆ Classify_Equal() [1/2]

bool CSG_Map_Classify::Classify_Equal ( int Count )

Definition at line 515 of file map_classify.cpp.

References Classify_Equal(), CSG_Simple_Statistics::Get_Maximum(), and CSG_Simple_Statistics::Get_Minimum().

◆ Classify_Equal() [2/2]

bool CSG_Map_Classify::Classify_Equal	(	int	Count,
		double	Minimum,
		double	Maximum )

Definition at line 487 of file map_classify.cpp.

References Equal, Maximum, Minimum, and CSG_Table_Record::Set_Value().

Referenced by Classify_Equal(), and Classify_StdDev().

◆ Classify_Geometric()

bool CSG_Map_Classify::Classify_Geometric	(	int	Count,
		bool	bIncreasing = true )

Definition at line 653 of file map_classify.cpp.

References Geometric, CSG_Simple_Statistics::Get_Maximum(), CSG_Simple_Statistics::Get_Minimum(), CSG_Simple_Statistics::Get_Range(), Maximum, Minimum, and CSG_Table_Record::Set_Value().

◆ Classify_Natural()

bool CSG_Map_Classify::Classify_Natural ( int Count )

Definition at line 692 of file map_classify.cpp.

References CSG_Natural_Breaks::Create(), CSG_Natural_Breaks::Get_Count(), is_Okay(), Natural, and CSG_Table_Record::Set_Value().

◆ Classify_Quantile()

bool CSG_Map_Classify::Classify_Quantile	(	int	Count,
		bool	bHistogram = true )

Definition at line 574 of file map_classify.cpp.

References CSG_Simple_Statistics::Get_Minimum(), CSG_Histogram::Get_Quantile(), CSG_Histogram::Get_Statistics(), is_Okay(), Maximum, Minimum, Quantile, and CSG_Table_Record::Set_Value().

◆ Classify_StdDev()

bool CSG_Map_Classify::Classify_StdDev	(	double	StdDev,
		double	StdDev_Max = 4. )

Definition at line 745 of file map_classify.cpp.

References Classify_Equal(), CSG_Simple_Statistics::Get_Maximum(), CSG_Simple_Statistics::Get_Mean(), CSG_Simple_Statistics::Get_Minimum(), CSG_Simple_Statistics::Get_StdDev(), Maximum, Minimum, and StdDev.

◆ Classify_Unique()

bool CSG_Map_Classify::Classify_Unique ( int maxCount = 1024 )

Definition at line 426 of file map_classify.cpp.

References CSG_Unique_Value_Statistics::Get_Count(), CSG_Unique_Number_Statistics::Get_Value(), CSG_Unique_String_Statistics::Get_Value(), is_Okay(), CSG_Table_Record::Set_Value(), and Unique.

◆ Create() [1/2]

bool CSG_Map_Classify::Create ( CSG_Data_Object * pObject )

Definition at line 101 of file map_classify.cpp.

References CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), Destroy(), CSG_Grid::Get_NCells(), CSG_Grids::Get_NCells(), and is_Okay().

Referenced by CSG_Map_Classify(), and CSG_Map_Classify().

◆ Create() [2/2]

bool CSG_Map_Classify::Create	(	CSG_Table *	pTable,
		int	Field,
		int	Normalize = -1,
		bool	bPercent = false )

Definition at line 130 of file map_classify.cpp.

References Destroy(), CSG_Table::Get_Count(), CSG_Table::Get_Value(), is_Okay(), and SG_DATATYPE_Double.

◆ Destroy()

bool CSG_Map_Classify::Destroy ( void )

Definition at line 86 of file map_classify.cpp.

References NotSet.

Referenced by Create(), Create(), and ~CSG_Map_Classify().

◆ Get_Classifier()

Classifier CSG_Map_Classify::Get_Classifier ( void ) const

inline

Definition at line 102 of file map_classify.h.

◆ Get_Name()

const CSG_String & CSG_Map_Classify::Get_Name ( Classifier Classifier ) const

Definition at line 176 of file map_classify.cpp.

References _TL.

◆ is_Classified()

bool CSG_Map_Classify::is_Classified ( void ) const

inline

Definition at line 101 of file map_classify.h.

References NotSet.

◆ is_Okay()

bool CSG_Map_Classify::is_Okay ( void ) const

inline

Definition at line 100 of file map_classify.h.

Referenced by Classify_Natural(), Classify_Quantile(), Classify_Unique(), Create(), Create(), and Set_LUT().

◆ Set_LUT()

bool CSG_Map_Classify::Set_LUT	(	CSG_Table &	LUT,
		CSG_Colors	Colors,
		int	Labeling,
		int	NumPrecision = -2 ) const

Definition at line 199 of file map_classify.cpp.

References CSG_Table::Add_Record(), Color, CSG_Table::Del_Records(), Description, CSG_Table::Get_Count(), is_Okay(), Maximum, Minimum, Name, CSG_Colors::Set_Count(), CSG_Table::Set_Field_Type(), CSG_Table::Set_Value(), CSG_Table_Record::Set_Value(), SG_DATATYPE_Double, SG_DATATYPE_String, Unique, and VALUE2STRING.

Member Data Documentation

◆ m_Show_Progress

bool CSG_Map_Classify::m_Show_Progress = false

Definition at line 116 of file map_classify.h.

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Classifier

◆ LUT_Fields

Constructor & Destructor Documentation

◆ CSG_Map_Classify() [1/3]

◆ ~CSG_Map_Classify()

◆ CSG_Map_Classify() [2/3]

◆ CSG_Map_Classify() [3/3]

Member Function Documentation

◆ Classify_Defined() [1/2]

◆ Classify_Defined() [2/2]

◆ Classify_Equal() [1/2]

◆ Classify_Equal() [2/2]

◆ Classify_Geometric()

◆ Classify_Natural()

◆ Classify_Quantile()

◆ Classify_StdDev()

◆ Classify_Unique()

◆ Create() [1/2]

◆ Create() [2/2]

◆ Destroy()

◆ Get_Classifier()

◆ Get_Name()

◆ is_Classified()

◆ is_Okay()

◆ Set_LUT()

Member Data Documentation

◆ m_Show_Progress