#include <mat_tools.h>

Public Types
enum	EInterval { LINEAR = 0 , INCREASING , DECREASING , EQUALIZE }
typedef enum CSG_Scaler::EInterval	TMode

Public Member Functions
	CSG_Scaler (void)
	CSG_Scaler (const CSG_Scaler &Scaler)
bool	Create (const CSG_Scaler &Scaler)
	CSG_Scaler (double Minimum, double Maximum, int Mode=0, double LogScale=1.)
bool	Create (double Minimum, double Maximum, int Mode=0, double LogScale=1.)
CSG_Scaler &	operator= (const CSG_Scaler &Scaler)
bool	Set_Range (double Minimum, double Maximum)
double	Get_Range (void) const
double	Get_Minimum (void) const
double	Get_Maximum (void) const
bool	Set_Mode (int Mode)
TMode	Get_Mode (void) const
bool	Set_LogScale (double LogScale)
double	Get_LogScale (void) const
bool	Set_Linear (CSG_Table *pTable, int Field, double Minimum, double Maximum, int Mode=0, double LogScale=1.)
bool	Set_StdDev (CSG_Table *pTable, int Field, double StdDev, bool bKeepInRange, int Mode=0, double LogScale=1.)
bool	Set_Percentile (CSG_Table *pTable, int Field, double Minimum, double Maximum, int Mode=0, double LogScale=1.)
bool	Set_Linear (CSG_Data_Object *pObject, double Minimum, double Maximum, int Mode=0, double LogScale=1.)
bool	Set_StdDev (CSG_Data_Object *pObject, double StdDev, bool bKeepInRange, int Mode=0, double LogScale=1.)
bool	Set_Percentile (CSG_Data_Object *pObject, double Minimum, double Maximum, int Mode=0, double LogScale=1.)
bool	Set_Histogram (CSG_Table *pTable, int Field, int Normalize=-1, double Scale=1.)
bool	Set_Histogram (CSG_Data_Object *pObject)
double	to_Relative (double Value) const
double	from_Relative (double Value) const

Protected Member Functions
bool	_Update (CSG_Table *pTable, int Field, double Minimum, double Maximum, int Mode, double LogScale)
bool	_Update (CSG_Data_Object *pObject, double Minimum, double Maximum, int Mode, double LogScale)

Protected Attributes
TMode	m_Mode = LINEAR
CSG_Histogram	m_Histogram
double	m_Minimum = 0.
double	m_Range = 0.
double	m_LogScale [3] = { 1., 10., 2.302585093 }

Detailed Description

Definition at line 1110 of file mat_tools.h.

Member Typedef Documentation

◆ TMode

typedef enum CSG_Scaler::EInterval CSG_Scaler::TMode

Member Enumeration Documentation

◆ EInterval

enum CSG_Scaler::EInterval

Enumerator
LINEAR
INCREASING
DECREASING
EQUALIZE

Definition at line 1113 of file mat_tools.h.

Constructor & Destructor Documentation

◆ CSG_Scaler() [1/3]

CSG_Scaler::CSG_Scaler ( void )

Definition at line 1750 of file mat_tools.cpp.

References Create().

Referenced by Create(), CSG_Scaler(), and operator=().

◆ CSG_Scaler() [2/3]

CSG_Scaler::CSG_Scaler ( const CSG_Scaler & Scaler )

Definition at line 1756 of file mat_tools.cpp.

References Create(), and CSG_Scaler().

◆ CSG_Scaler() [3/3]

CSG_Scaler::CSG_Scaler	(	double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1762 of file mat_tools.cpp.

References Create(), Maximum, and Minimum.

Member Function Documentation

◆ _Update() [1/2]

bool CSG_Scaler::_Update	(	CSG_Data_Object *	pObject,
		double	Minimum,
		double	Maximum,
		int	Mode,
		double	LogScale )

protected

Definition at line 1940 of file mat_tools.cpp.

References CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), Create(), EQUALIZE, CSG_Data_Object::Get_Max_Samples(), m_Histogram, Maximum, and Minimum.

◆ _Update() [2/2]

bool CSG_Scaler::_Update	(	CSG_Table *	pTable,
		int	Field,
		double	Minimum,
		double	Maximum,
		int	Mode,
		double	LogScale )

protected

Definition at line 1929 of file mat_tools.cpp.

References Create(), EQUALIZE, CSG_Data_Object::Get_Max_Samples(), m_Histogram, Maximum, and Minimum.

Referenced by Set_Linear(), Set_Linear(), Set_Percentile(), Set_Percentile(), Set_StdDev(), and Set_StdDev().

◆ Create() [1/2]

bool CSG_Scaler::Create ( const CSG_Scaler & Scaler )

Definition at line 1774 of file mat_tools.cpp.

References Create(), CSG_Scaler(), Get_LogScale(), Get_Maximum(), Get_Minimum(), and Get_Mode().

Referenced by _Update(), _Update(), Create(), CSG_Scaler(), CSG_Scaler(), CSG_Scaler(), and operator=().

◆ Create() [2/2]

bool CSG_Scaler::Create	(	double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1768 of file mat_tools.cpp.

References Maximum, Minimum, Set_LogScale(), Set_Mode(), and Set_Range().

◆ from_Relative()

double CSG_Scaler::from_Relative ( double Value ) const

inline

Definition at line 1172 of file mat_tools.h.

References DECREASING, EQUALIZE, INCREASING, m_Histogram, m_LogScale, m_Minimum, m_Mode, and m_Range.

◆ Get_LogScale()

double CSG_Scaler::Get_LogScale ( void ) const

inline

Definition at line 1140 of file mat_tools.h.

References m_LogScale.

Referenced by Create().

◆ Get_Maximum()

double CSG_Scaler::Get_Maximum ( void ) const

inline

Definition at line 1134 of file mat_tools.h.

References m_Minimum, and m_Range.

Referenced by Create(), Set_Histogram(), and Set_Histogram().

◆ Get_Minimum()

double CSG_Scaler::Get_Minimum ( void ) const

inline

Definition at line 1133 of file mat_tools.h.

References m_Minimum.

Referenced by Create(), Set_Histogram(), Set_Histogram(), and Set_StdDev().

◆ Get_Mode()

TMode CSG_Scaler::Get_Mode ( void ) const

inline

Definition at line 1137 of file mat_tools.h.

References m_Mode.

Referenced by Create().

◆ Get_Range()

double CSG_Scaler::Get_Range ( void ) const

inline

Definition at line 1132 of file mat_tools.h.

References m_Range.

◆ operator=()

CSG_Scaler & CSG_Scaler::operator= ( const CSG_Scaler & Scaler )

Definition at line 1780 of file mat_tools.cpp.

References Create(), and CSG_Scaler().

◆ Set_Histogram() [1/2]

bool CSG_Scaler::Set_Histogram ( CSG_Data_Object * pObject )

Definition at line 1920 of file mat_tools.cpp.

References CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), EQUALIZE, CSG_Data_Object::Get_Max_Samples(), Get_Maximum(), Get_Minimum(), m_Histogram, and m_Mode.

◆ Set_Histogram() [2/2]

bool CSG_Scaler::Set_Histogram	(	CSG_Table *	pTable,
		int	Field,
		int	Normalize = -1,
		double	Scale = 1. )

Definition at line 1915 of file mat_tools.cpp.

References EQUALIZE, CSG_Data_Object::Get_Max_Samples(), Get_Maximum(), Get_Minimum(), m_Histogram, and m_Mode.

◆ Set_Linear() [1/2]

bool CSG_Scaler::Set_Linear	(	CSG_Data_Object *	pObject,
		double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1851 of file mat_tools.cpp.

References _Update(), CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), CSG_Grid::Get_Min(), CSG_Grids::Get_Min(), CSG_Grid::Get_Range(), CSG_Grids::Get_Range(), Maximum, and Minimum.

◆ Set_Linear() [2/2]

bool CSG_Scaler::Set_Linear	(	CSG_Table *	pTable,
		int	Field,
		double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1826 of file mat_tools.cpp.

References _Update(), CSG_Table::Get_Minimum(), CSG_Table::Get_Range(), Maximum, and Minimum.

◆ Set_LogScale()

bool CSG_Scaler::Set_LogScale ( double LogScale )

Definition at line 1797 of file mat_tools.cpp.

References m_LogScale.

Referenced by Create().

◆ Set_Mode()

bool CSG_Scaler::Set_Mode ( int Mode )

Definition at line 1812 of file mat_tools.cpp.

References DECREASING, EQUALIZE, INCREASING, LINEAR, and m_Mode.

Referenced by Create().

◆ Set_Percentile() [1/2]

bool CSG_Scaler::Set_Percentile	(	CSG_Data_Object *	pObject,
		double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1893 of file mat_tools.cpp.

References _Update(), CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), CSG_Grid::Get_Percentile(), CSG_Grids::Get_Percentile(), Maximum, and Minimum.

◆ Set_Percentile() [2/2]

bool CSG_Scaler::Set_Percentile	(	CSG_Table *	pTable,
		int	Field,
		double	Minimum,
		double	Maximum,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1842 of file mat_tools.cpp.

References _Update(), CSG_Table::Get_Histogram(), CSG_Histogram::Get_Percentile(), Maximum, and Minimum.

◆ Set_Range()

bool CSG_Scaler::Set_Range	(	double	Minimum,
		double	Maximum )

Definition at line 1788 of file mat_tools.cpp.

References m_Minimum, m_Range, Maximum, and Minimum.

Referenced by Create().

◆ Set_StdDev() [1/2]

bool CSG_Scaler::Set_StdDev	(	CSG_Data_Object *	pObject,
		double	StdDev,
		bool	bKeepInRange,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1872 of file mat_tools.cpp.

References _Update(), CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), CSG_Grid::Get_Max(), CSG_Grids::Get_Max(), CSG_Grid::Get_Mean(), CSG_Grids::Get_Mean(), CSG_Grid::Get_Min(), CSG_Grids::Get_Min(), CSG_Grid::Get_StdDev(), CSG_Grids::Get_StdDev(), Maximum, and Minimum.

◆ Set_StdDev() [2/2]

bool CSG_Scaler::Set_StdDev	(	CSG_Table *	pTable,
		int	Field,
		double	StdDev,
		bool	bKeepInRange,
		int	Mode = 0,
		double	LogScale = 1. )

Definition at line 1834 of file mat_tools.cpp.

References _Update(), CSG_Table::Get_Maximum(), CSG_Table::Get_Mean(), Get_Minimum(), CSG_Table::Get_Minimum(), CSG_Table::Get_StdDev(), Maximum, and Minimum.

◆ to_Relative()

double CSG_Scaler::to_Relative ( double Value ) const

inline

Definition at line 1155 of file mat_tools.h.

References DECREASING, EQUALIZE, INCREASING, m_Histogram, m_LogScale, m_Minimum, m_Mode, and m_Range.

Member Data Documentation

◆ m_Histogram

CSG_Histogram CSG_Scaler::m_Histogram

protected

Definition at line 1195 of file mat_tools.h.

Referenced by _Update(), _Update(), from_Relative(), Set_Histogram(), Set_Histogram(), and to_Relative().

◆ m_LogScale

double CSG_Scaler::m_LogScale[3] = { 1., 10., 2.302585093 }

protected

Definition at line 1197 of file mat_tools.h.

Referenced by from_Relative(), Get_LogScale(), Set_LogScale(), and to_Relative().

◆ m_Minimum

double CSG_Scaler::m_Minimum = 0.

protected

Definition at line 1197 of file mat_tools.h.

Referenced by from_Relative(), Get_Maximum(), Get_Minimum(), Set_Range(), and to_Relative().

◆ m_Mode

TMode CSG_Scaler::m_Mode = LINEAR

protected

Definition at line 1193 of file mat_tools.h.

Referenced by from_Relative(), Get_Mode(), Set_Histogram(), Set_Histogram(), Set_Mode(), and to_Relative().

◆ m_Range

double CSG_Scaler::m_Range = 0.

protected

Definition at line 1197 of file mat_tools.h.

Referenced by from_Relative(), Get_Maximum(), Get_Range(), Set_Range(), and to_Relative().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TMode

Member Enumeration Documentation

◆ EInterval

Constructor & Destructor Documentation

◆ CSG_Scaler() [1/3]

◆ CSG_Scaler() [2/3]

◆ CSG_Scaler() [3/3]

Member Function Documentation

◆ _Update() [1/2]

◆ _Update() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ from_Relative()

◆ Get_LogScale()

◆ Get_Maximum()

◆ Get_Minimum()

◆ Get_Mode()

◆ Get_Range()

◆ operator=()

◆ Set_Histogram() [1/2]

◆ Set_Histogram() [2/2]

◆ Set_Linear() [1/2]

◆ Set_Linear() [2/2]

◆ Set_LogScale()

◆ Set_Mode()

◆ Set_Percentile() [1/2]

◆ Set_Percentile() [2/2]

◆ Set_Range()

◆ Set_StdDev() [1/2]

◆ Set_StdDev() [2/2]

◆ to_Relative()

Member Data Documentation

◆ m_Histogram

◆ m_LogScale

◆ m_Minimum

◆ m_Mode

◆ m_Range