#include <mat_tools.h>

Public Member Functions
	CSG_Histogram (void)

virtual	~CSG_Histogram (void)

bool	Destroy (void)

	CSG_Histogram (const CSG_Histogram &Histogram)

bool	Create (const CSG_Histogram &Histogram)

	CSG_Histogram (size_t nClasses, double Minimum, double Maximum)

bool	Create (size_t nClasses, double Minimum, double Maximum)

	CSG_Histogram (size_t nClasses, double Minimum, double Maximum, const CSG_Vector &Values, size_t maxSamples=0)

bool	Create (size_t nClasses, double Minimum, double Maximum, const CSG_Vector &Values, size_t maxSamples=0)

	CSG_Histogram (size_t nClasses, double Minimum, double Maximum, class CSG_Table *pTable, int Field, size_t maxSamples=0)

bool	Create (size_t nClasses, double Minimum, double Maximum, class CSG_Table *pTable, int Field, size_t maxSamples=0)

	CSG_Histogram (size_t nClasses, double Minimum, double Maximum, class CSG_Grid *pGrid, size_t maxSamples=0)

bool	Create (size_t nClasses, double Minimum, double Maximum, class CSG_Grid *pGrid, size_t maxSamples=0)

	CSG_Histogram (size_t nClasses, double Minimum, double Maximum, class CSG_Grids *pGrids, size_t maxSamples=0)

bool	Create (size_t nClasses, double Minimum, double Maximum, class CSG_Grids *pGrids, size_t maxSamples=0)

void	Add_Value (double Value)

bool	Scale_Element_Count (double Scale)

bool	Update (void)

size_t	Get_Class_Count (void) const

size_t	Get_Element_Count (void) const

size_t	Get_Element_Maximum (void) const

size_t	Get_Elements (int i) const

size_t	Get_Elements (size_t i) const

size_t	Get_Cumulative (int i) const

size_t	Get_Cumulative (size_t i) const

double	Get_Value (double i) const

double	Get_Break (int i) const

double	Get_Break (size_t i) const

double	Get_Center (int i) const

double	Get_Center (size_t i) const

CSG_Histogram &	operator= (const CSG_Histogram &Histogram)

void	operator+= (double Value)

size_t	operator[] (int i) const

size_t	operator[] (size_t i) const

double	Get_Quantile (double Quantile) const

double	Get_Quantile_Value (double Value) const

double	Get_Percentile (double Percentile) const

double	Get_Percentile_Value (double Value) const

const CSG_Simple_Statistics &	Get_Statistics (void) const

Detailed Description

Definition at line 1010 of file mat_tools.h.

Constructor & Destructor Documentation

◆ CSG_Histogram() [1/7]

CSG_Histogram::CSG_Histogram ( void )

Definition at line 1215 of file mat_tools.cpp.

◆ ~CSG_Histogram()

CSG_Histogram::~CSG_Histogram ( void )

virtual

Definition at line 1269 of file mat_tools.cpp.

References Destroy().

◆ CSG_Histogram() [2/7]

CSG_Histogram::CSG_Histogram ( const CSG_Histogram & Histogram )

Definition at line 1221 of file mat_tools.cpp.

References Create().

◆ CSG_Histogram() [3/7]

CSG_Histogram::CSG_Histogram	(	size_t	nClasses,
		double	Minimum,
		double	Maximum
	)

Definition at line 1229 of file mat_tools.cpp.

References Create().

◆ CSG_Histogram() [4/7]

CSG_Histogram::CSG_Histogram	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		const CSG_Vector &	Values,
		size_t	maxSamples = `0`
	)

Definition at line 1237 of file mat_tools.cpp.

References Create().

◆ CSG_Histogram() [5/7]

CSG_Histogram::CSG_Histogram	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Table *	pTable,
		int	Field,
		size_t	maxSamples = `0`
	)

Definition at line 1245 of file mat_tools.cpp.

References Create().

◆ CSG_Histogram() [6/7]

CSG_Histogram::CSG_Histogram	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Grid *	pGrid,
		size_t	maxSamples = `0`
	)

Definition at line 1253 of file mat_tools.cpp.

References Create().

◆ CSG_Histogram() [7/7]

CSG_Histogram::CSG_Histogram	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Grids *	pGrids,
		size_t	maxSamples = `0`
	)

Definition at line 1261 of file mat_tools.cpp.

References Create().

Member Function Documentation

◆ Add_Value()

void CSG_Histogram::Add_Value ( double Value )

Definition at line 1330 of file mat_tools.cpp.

Referenced by Create().

◆ Create() [1/6]

bool CSG_Histogram::Create ( const CSG_Histogram & Histogram )

Definition at line 1498 of file mat_tools.cpp.

Referenced by CSG_Natural_Breaks::Create(), CSG_Histogram(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), and operator=().

◆ Create() [2/6]

bool CSG_Histogram::Create	(	size_t	nClasses,
		double	Minimum,
		double	Maximum
	)

Definition at line 1519 of file mat_tools.cpp.

◆ Create() [3/6]

bool CSG_Histogram::Create	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Grid *	pGrid,
		size_t	maxSamples = `0`
	)

Definition at line 1609 of file mat_tools.cpp.

References Add_Value(), CSG_Grid::asDouble(), CSG_Simple_Statistics::Get_Count(), CSG_Grid::Get_NCells(), CSG_Grid::is_NoData(), CSG_Data_Object::is_NoData_Value(), and Update().

◆ Create() [4/6]

bool CSG_Histogram::Create	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Grids *	pGrids,
		size_t	maxSamples = `0`
	)

Definition at line 1651 of file mat_tools.cpp.

References Add_Value(), CSG_Grids::asDouble(), CSG_Simple_Statistics::Get_Count(), CSG_Grids::Get_NCells(), CSG_Grids::is_NoData(), CSG_Data_Object::is_NoData_Value(), and Update().

◆ Create() [5/6]

bool CSG_Histogram::Create	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		class CSG_Table *	pTable,
		int	Field,
		size_t	maxSamples = `0`
	)

Definition at line 1565 of file mat_tools.cpp.

References Add_Value(), CSG_Table_Record::asDouble(), CSG_Simple_Statistics::Get_Count(), CSG_Table::Get_Count(), CSG_Table::Get_Field_Count(), CSG_Table::Get_Record(), CSG_Data_Object::is_NoData_Value(), and Update().

◆ Create() [6/6]

bool CSG_Histogram::Create	(	size_t	nClasses,
		double	Minimum,
		double	Maximum,
		const CSG_Vector &	Values,
		size_t	maxSamples = `0`
	)

Definition at line 1525 of file mat_tools.cpp.

References Add_Value(), CSG_Simple_Statistics::Get_Count(), CSG_Simple_Statistics::Get_Maximum(), CSG_Simple_Statistics::Get_Minimum(), CSG_Vector::Get_N(), and Update().

◆ Destroy()

bool CSG_Histogram::Destroy ( void )

Definition at line 1275 of file mat_tools.cpp.

References CSG_Simple_Statistics::Create(), and SG_FREE_SAFE.

Referenced by CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), CSG_Grid::On_Update(), CSG_Grids::On_Update(), and ~CSG_Histogram().

◆ Get_Break() [1/2]

double CSG_Histogram::Get_Break ( int i ) const

inline

Definition at line 1056 of file mat_tools.h.

Referenced by Get_Quantile(), and Get_Quantile_Value().

◆ Get_Break() [2/2]

double CSG_Histogram::Get_Break ( size_t i ) const

inline

Definition at line 1057 of file mat_tools.h.

◆ Get_Center() [1/2]

double CSG_Histogram::Get_Center ( int i ) const

inline

Definition at line 1059 of file mat_tools.h.

Referenced by Get_Quantile().

◆ Get_Center() [2/2]

double CSG_Histogram::Get_Center ( size_t i ) const

inline

Definition at line 1060 of file mat_tools.h.

◆ Get_Class_Count()

size_t CSG_Histogram::Get_Class_Count ( void ) const

inline

Definition at line 1043 of file mat_tools.h.

Referenced by CSG_Grid::Get_Histogram(), and CSG_Grids::Get_Histogram().

◆ Get_Cumulative() [1/2]

size_t CSG_Histogram::Get_Cumulative ( int i ) const

inline

Definition at line 1051 of file mat_tools.h.

References Get_Cumulative().

Referenced by Get_Cumulative().

◆ Get_Cumulative() [2/2]

size_t CSG_Histogram::Get_Cumulative ( size_t i ) const

inline

Definition at line 1052 of file mat_tools.h.

◆ Get_Element_Count()

size_t CSG_Histogram::Get_Element_Count ( void ) const

inline

Definition at line 1045 of file mat_tools.h.

Referenced by Get_Quantile(), Get_Quantile_Value(), Scale_Element_Count(), and Update().

◆ Get_Element_Maximum()

size_t CSG_Histogram::Get_Element_Maximum ( void ) const

inline

Definition at line 1046 of file mat_tools.h.

◆ Get_Elements() [1/2]

size_t CSG_Histogram::Get_Elements ( int i ) const

inline

Definition at line 1048 of file mat_tools.h.

References Get_Elements().

Referenced by Get_Elements().

◆ Get_Elements() [2/2]

size_t CSG_Histogram::Get_Elements ( size_t i ) const

inline

Definition at line 1049 of file mat_tools.h.

◆ Get_Percentile()

double CSG_Histogram::Get_Percentile ( double Percentile ) const

Returns the correspondent value for the requested percentile.

Definition at line 1447 of file mat_tools.cpp.

References Get_Quantile().

◆ Get_Percentile_Value()

double CSG_Histogram::Get_Percentile_Value ( double Value ) const

Returns the correspondent percentile for the requested value.

Definition at line 1487 of file mat_tools.cpp.

References Get_Quantile_Value().

◆ Get_Quantile()

double CSG_Histogram::Get_Quantile ( double Quantile ) const

Returns the correspondent value for the requested quantile.

Definition at line 1412 of file mat_tools.cpp.

References Get_Break(), Get_Center(), and Get_Element_Count().

Referenced by Get_Percentile().

◆ Get_Quantile_Value()

double CSG_Histogram::Get_Quantile_Value ( double Value ) const

Returns the correspondent quantile for the requested value.

Definition at line 1456 of file mat_tools.cpp.

References Get_Break(), and Get_Element_Count().

Referenced by Get_Percentile_Value().

◆ Get_Statistics()

const CSG_Simple_Statistics& CSG_Histogram::Get_Statistics ( void ) const

inline

Definition at line 1076 of file mat_tools.h.

Referenced by CSG_Grid::Get_Histogram(), and CSG_Grids::Get_Histogram().

◆ Get_Value()

double CSG_Histogram::Get_Value ( double i ) const

inline

Definition at line 1054 of file mat_tools.h.

◆ operator+=()

void CSG_Histogram::operator+= ( double Value )

inline

Definition at line 1065 of file mat_tools.h.

◆ operator=()

CSG_Histogram & CSG_Histogram::operator= ( const CSG_Histogram & Histogram )

Definition at line 1698 of file mat_tools.cpp.

References Create().

◆ operator[]() [1/2]

size_t CSG_Histogram::operator[] ( int i ) const

inline

Definition at line 1067 of file mat_tools.h.

◆ operator[]() [2/2]

size_t CSG_Histogram::operator[] ( size_t i ) const

inline

Definition at line 1068 of file mat_tools.h.

◆ Scale_Element_Count()

bool CSG_Histogram::Scale_Element_Count ( double Scale )

Definition at line 1348 of file mat_tools.cpp.

References Get_Element_Count(), CSG_Simple_Statistics::Set_Count(), and Update().

◆ Update()

bool CSG_Histogram::Update ( void )

Definition at line 1366 of file mat_tools.cpp.

References Get_Element_Count(), and CSG_Simple_Statistics::Get_Mean().

Referenced by Create(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), and Scale_Element_Count().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CSG_Histogram() [1/7]

◆ ~CSG_Histogram()

◆ CSG_Histogram() [2/7]

◆ CSG_Histogram() [3/7]

◆ CSG_Histogram() [4/7]

◆ CSG_Histogram() [5/7]

◆ CSG_Histogram() [6/7]

◆ CSG_Histogram() [7/7]

Member Function Documentation

◆ Add_Value()

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

◆ Create() [4/6]

◆ Create() [5/6]

◆ Create() [6/6]

◆ Destroy()

◆ Get_Break() [1/2]

◆ Get_Break() [2/2]

◆ Get_Center() [1/2]

◆ Get_Center() [2/2]

◆ Get_Class_Count()

◆ Get_Cumulative() [1/2]

◆ Get_Cumulative() [2/2]

◆ Get_Element_Count()

◆ Get_Element_Maximum()

◆ Get_Elements() [1/2]

◆ Get_Elements() [2/2]

◆ Get_Percentile()

◆ Get_Percentile_Value()

◆ Get_Quantile()

◆ Get_Quantile_Value()

◆ Get_Statistics()

◆ Get_Value()

◆ operator+=()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Scale_Element_Count()

◆ Update()