SAGA API Version 9.14
Loading...
Searching...
No Matches
CSG_Map_Symbology Class Reference

#include <map_symbology.h>

Public Types

enum  {
  SINGLE = 0 , CLASSIFIED , DISCRETE , GRADUATED ,
  COMPOSITE , RGB
}
enum  {
  LUT_COLOR = 0 , LUT_TITLE , LUT_DESCRIPTION , LUT_MIN ,
  LUT_MAX
}
enum  {
  SHADE_MODE_DSC_GREY = 0 , SHADE_MODE_ASC_GREY , SHADE_MODE_DSC_CYAN , SHADE_MODE_ASC_CYAN ,
  SHADE_MODE_DSC_MAGENTA , SHADE_MODE_ASC_MAGENTA , SHADE_MODE_DSC_YELLOW , SHADE_MODE_ASC_YELLOW
}

Public Member Functions

 CSG_Map_Symbology (class CSG_Map_Layer *pLayer)
virtual ~CSG_Map_Symbology (void)
bool Update (void)
bool Set_Mode (int Mode)
int Get_Mode (void) const
bool Set_NoData_Color (int Color)
int Get_NoData_Color (void) const
bool Set_Single_Color (int Color)
int Get_Single_Color (void) const
bool Set_Class_Count (int Count)
int Get_Class_Count (void) const
int Get_Class (double Value)
int Get_Class (const CSG_String &Value)
double Get_Class_Value_Minimum (int Class)
double Get_Class_Value_Center (int Class)
double Get_Class_Value_Maximum (int Class)
wxString Get_Class_Name (int Class)
wxString Get_Class_Name_byValue (double Value)
wxString Get_Class_Name_byValue (const wxString &Value)
CSG_Colors Get_Class_Colors (void) const
bool Get_Class_Color (int Class, int &Color) const
int Get_Class_Color (int Class) const
bool Get_Class_Color_byValue (double Value, int &Color) const
bool Get_Class_Color_byValue (const CSG_String &Value, int &Color) const
int Get_Class_Color_byValue (double Value) const
int Get_Class_Color_byValue (const CSG_String &Value) const
CSG_Colors & Get_Colors (void)
const CSG_Colors & Get_Colors (void) const
CSG_Scaler & Get_Stretch (void)
const CSG_Scaler & Get_Stretch (void) const
bool Set_Stretch (double Minimum, double Maximum, int Mode=0, double LogScale=1.)
double Get_Stretch_Minimum (void) const
double Get_Stretch_Maximum (void) const
double Get_Stretch_Range (void) const
int Get_Stretch_Mode (void) const
double Get_Stretch_LogScale (void) const
double Get_Stretch_to_Relative (double Value) const
double Get_Stretch_from_Relative (double Value) const
bool Histogram_Update (void)
const CSG_Histogram & Histogram_Get (void) const
const CSG_Simple_Statistics & Statistics_Get (void) const

Protected Member Functions

int _LUT_Cmp_Class (double Value, int Class) const
int _LUT_Get_Class (double Value) const
int _LUT_Cmp_Class (const CSG_String &Value, int Class) const
int _LUT_Get_Class (const CSG_String &Value) const
int _METRIC_Get_Class (double Value) const
bool _Histogram_Update (CSG_Data_Object *pObject)
bool _Histogram_Update (CSG_Table *pTable, int Field, int Normalize=-1, double Scale=1.)

Protected Attributes

int m_Mode
int m_Count
int m_Single_Color
int m_NoData_Color
CSG_Scaler m_Stretch
CSG_Histogram m_Histogram
CSG_Simple_Statistics m_Statistics
CSG_Colors * m_pColors = NULL
CSG_Table * m_pLUT = NULL
class CSG_Map_Layer * m_pLayer = NULL

Detailed Description

Definition at line 71 of file map_symbology.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SHADE_MODE_DSC_GREY 
SHADE_MODE_ASC_GREY 
SHADE_MODE_DSC_CYAN 
SHADE_MODE_ASC_CYAN 
SHADE_MODE_DSC_MAGENTA 
SHADE_MODE_ASC_MAGENTA 
SHADE_MODE_DSC_YELLOW 
SHADE_MODE_ASC_YELLOW 

Definition at line 111 of file map_symbology.h.

◆ anonymous enum

anonymous enum
Enumerator
SINGLE 
CLASSIFIED 
DISCRETE 
GRADUATED 
COMPOSITE 
RGB 

Definition at line 90 of file map_symbology.h.

◆ anonymous enum

anonymous enum
Enumerator
LUT_COLOR 
LUT_TITLE 
LUT_DESCRIPTION 
LUT_MIN 
LUT_MAX 

Definition at line 101 of file map_symbology.h.

Constructor & Destructor Documentation

◆ CSG_Map_Symbology()

CSG_Map_Symbology::CSG_Map_Symbology ( class CSG_Map_Layer * pLayer)

Definition at line 62 of file map_symbology.cpp.

References m_Count, m_Mode, m_NoData_Color, m_pColors, m_pLayer, m_pLUT, m_Single_Color, SG_Color_Get_Random(), SG_COLOR_GREY_LIGHT, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_TIN, and SINGLE.

◆ ~CSG_Map_Symbology()

CSG_Map_Symbology::~CSG_Map_Symbology ( void )
virtual

Definition at line 78 of file map_symbology.cpp.

Member Function Documentation

◆ _Histogram_Update() [1/2]

bool CSG_Map_Symbology::_Histogram_Update ( CSG_Data_Object * pObject)
protected

Definition at line 505 of file map_symbology.cpp.

References asDouble, CSG_Data_Object::asGrid(), CSG_Data_Object::asGrids(), Get_Class(), CSG_Data_Object::Get_Max_Samples(), CSG_Grid::Get_NCells(), CSG_Grids::Get_NCells(), CSG_Grid::Get_Statistics(), CSG_Grids::Get_Statistics(), isNoData, m_Histogram, m_Statistics, and SG_UI_Process_Set_Progress().

Referenced by Histogram_Update().

◆ _Histogram_Update() [2/2]

bool CSG_Map_Symbology::_Histogram_Update ( CSG_Table * pTable,
int Field,
int Normalize = -1,
double Scale = 1. )
protected

Definition at line 553 of file map_symbology.cpp.

References CLASSIFIED, Get_Class(), CSG_Table::Get_Count(), CSG_Table::Get_Field_Count(), CSG_Data_Object::Get_Max_Samples(), CSG_Table::Get_Value(), LUT_MIN, m_Histogram, m_Mode, m_pLUT, m_Statistics, SG_Data_Type_is_Numeric(), and SG_UI_Process_Set_Progress().

◆ _LUT_Cmp_Class() [1/2]

int CSG_Map_Symbology::_LUT_Cmp_Class ( const CSG_String & Value,
int Class ) const
inlineprotected

Definition at line 383 of file map_symbology.cpp.

References CSG_Table_Record::asString(), CSG_String::Cmp(), LUT_MAX, LUT_MIN, and m_pLUT.

◆ _LUT_Cmp_Class() [2/2]

int CSG_Map_Symbology::_LUT_Cmp_Class ( double Value,
int Class ) const
inlineprotected

Definition at line 321 of file map_symbology.cpp.

References CSG_Table_Record::asDouble(), LUT_MAX, LUT_MIN, and m_pLUT.

Referenced by _LUT_Get_Class(), and _LUT_Get_Class().

◆ _LUT_Get_Class() [1/2]

int CSG_Map_Symbology::_LUT_Get_Class ( const CSG_String & Value) const
protected

Definition at line 403 of file map_symbology.cpp.

References _LUT_Cmp_Class(), LUT_MIN, m_pLUT, and TABLE_INDEX_Ascending.

◆ _LUT_Get_Class() [2/2]

int CSG_Map_Symbology::_LUT_Get_Class ( double Value) const
protected

Definition at line 339 of file map_symbology.cpp.

References _LUT_Cmp_Class(), LUT_MIN, m_pLUT, and TABLE_INDEX_Ascending.

Referenced by Get_Class(), Get_Class(), Get_Class_Color_byValue(), and Get_Class_Color_byValue().

◆ _METRIC_Get_Class()

int CSG_Map_Symbology::_METRIC_Get_Class ( double Value) const
inlineprotected

Definition at line 352 of file map_symbology.h.

References Get_Class_Count(), and m_Stretch.

Referenced by Get_Class(), and Get_Class_Color_byValue().

◆ Get_Class() [1/2]

int CSG_Map_Symbology::Get_Class ( const CSG_String & Value)
inline

Definition at line 166 of file map_symbology.h.

References _LUT_Get_Class(), CSG_String::asDouble(), CLASSIFIED, Get_Class(), and m_Mode.

◆ Get_Class() [2/2]

int CSG_Map_Symbology::Get_Class ( double Value)
inline

Definition at line 149 of file map_symbology.h.

References _LUT_Get_Class(), _METRIC_Get_Class(), CLASSIFIED, COMPOSITE, DISCRETE, GRADUATED, m_Mode, and SINGLE.

Referenced by _Histogram_Update(), _Histogram_Update(), Get_Class(), Get_Class_Name_byValue(), and Get_Class_Name_byValue().

◆ Get_Class_Color() [1/2]

int CSG_Map_Symbology::Get_Class_Color ( int Class) const
inline

Definition at line 225 of file map_symbology.h.

References Get_Class_Color().

◆ Get_Class_Color() [2/2]

bool CSG_Map_Symbology::Get_Class_Color ( int Class,
int & Color ) const
inline

Definition at line 191 of file map_symbology.h.

References CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Color_byValue(), GRADUATED, LUT_COLOR, m_Count, m_Mode, m_NoData_Color, m_pColors, m_pLUT, m_Single_Color, m_Stretch, and SINGLE.

Referenced by Get_Class_Color(), Get_Class_Color_byValue(), Get_Class_Color_byValue(), and Get_Class_Colors().

◆ Get_Class_Color_byValue() [1/4]

int CSG_Map_Symbology::Get_Class_Color_byValue ( const CSG_String & Value) const
inline

Definition at line 291 of file map_symbology.h.

References Get_Class_Color_byValue().

◆ Get_Class_Color_byValue() [2/4]

bool CSG_Map_Symbology::Get_Class_Color_byValue ( const CSG_String & Value,
int & Color ) const
inline

Definition at line 275 of file map_symbology.h.

References _LUT_Get_Class(), CSG_String::asDouble(), CLASSIFIED, Get_Class_Color(), Get_Class_Color_byValue(), and m_Mode.

◆ Get_Class_Color_byValue() [3/4]

int CSG_Map_Symbology::Get_Class_Color_byValue ( double Value) const
inline

Definition at line 286 of file map_symbology.h.

References Get_Class_Color_byValue().

◆ Get_Class_Color_byValue() [4/4]

bool CSG_Map_Symbology::Get_Class_Color_byValue ( double Value,
int & Color ) const
inline

Definition at line 231 of file map_symbology.h.

References _LUT_Get_Class(), _METRIC_Get_Class(), CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Color(), GRADUATED, m_Mode, m_pColors, m_Stretch, RGB, SG_GET_RGB, and SINGLE.

Referenced by Get_Class_Color(), Get_Class_Color_byValue(), Get_Class_Color_byValue(), and Get_Class_Color_byValue().

◆ Get_Class_Colors()

CSG_Colors CSG_Map_Symbology::Get_Class_Colors ( void ) const

Definition at line 303 of file map_symbology.cpp.

References Get_Class_Color(), and Get_Class_Count().

◆ Get_Class_Count()

int CSG_Map_Symbology::Get_Class_Count ( void ) const
inline

Definition at line 129 of file map_symbology.h.

References CLASSIFIED, COMPOSITE, DISCRETE, GRADUATED, m_Count, m_Mode, m_pColors, m_pLUT, and SINGLE.

Referenced by _METRIC_Get_Class(), Get_Class_Colors(), Get_Class_Value_Center(), Get_Class_Value_Maximum(), Get_Class_Value_Minimum(), and Histogram_Update().

◆ Get_Class_Name()

wxString CSG_Map_Symbology::Get_Class_Name ( int Class)

Definition at line 215 of file map_symbology.cpp.

References CSG_String::c_str(), CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Value_Maximum(), Get_Class_Value_Minimum(), GRADUATED, LUT_TITLE, m_Mode, m_pLUT, CSG_String::Printf(), SG_Get_String(), and SG_T.

Referenced by Get_Class_Name_byValue(), and Get_Class_Name_byValue().

◆ Get_Class_Name_byValue() [1/2]

wxString CSG_Map_Symbology::Get_Class_Name_byValue ( const wxString & Value)

Definition at line 247 of file map_symbology.cpp.

References asDouble, Get_Class(), Get_Class_Name(), LUT_MIN, m_pLUT, and SG_Data_Type_is_Numeric().

◆ Get_Class_Name_byValue() [2/2]

wxString CSG_Map_Symbology::Get_Class_Name_byValue ( double Value)

Definition at line 242 of file map_symbology.cpp.

References Get_Class(), and Get_Class_Name().

◆ Get_Class_Value_Center()

double CSG_Map_Symbology::Get_Class_Value_Center ( int Class)

Definition at line 188 of file map_symbology.cpp.

References CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Count(), GRADUATED, LUT_MAX, LUT_MIN, m_Mode, m_pLUT, and m_Stretch.

◆ Get_Class_Value_Maximum()

double CSG_Map_Symbology::Get_Class_Value_Maximum ( int Class)

Definition at line 162 of file map_symbology.cpp.

References CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Count(), GRADUATED, LUT_MAX, m_Mode, m_pLUT, and m_Stretch.

Referenced by Get_Class_Name().

◆ Get_Class_Value_Minimum()

double CSG_Map_Symbology::Get_Class_Value_Minimum ( int Class)

Definition at line 136 of file map_symbology.cpp.

References CLASSIFIED, COMPOSITE, DISCRETE, Get_Class_Count(), GRADUATED, LUT_MIN, m_Mode, m_pLUT, and m_Stretch.

Referenced by Get_Class_Name().

◆ Get_Colors() [1/2]

CSG_Colors & CSG_Map_Symbology::Get_Colors ( void )
inline

Definition at line 300 of file map_symbology.h.

References m_pColors.

◆ Get_Colors() [2/2]

const CSG_Colors & CSG_Map_Symbology::Get_Colors ( void ) const
inline

Definition at line 301 of file map_symbology.h.

References m_pColors.

◆ Get_Mode()

int CSG_Map_Symbology::Get_Mode ( void ) const
inline

Definition at line 80 of file map_symbology.h.

References m_Mode.

◆ Get_NoData_Color()

int CSG_Map_Symbology::Get_NoData_Color ( void ) const
inline

Definition at line 83 of file map_symbology.h.

References m_NoData_Color.

◆ Get_Single_Color()

int CSG_Map_Symbology::Get_Single_Color ( void ) const
inline

Definition at line 86 of file map_symbology.h.

References m_Single_Color.

◆ Get_Stretch() [1/2]

CSG_Scaler & CSG_Map_Symbology::Get_Stretch ( void )
inline

Definition at line 303 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch() [2/2]

const CSG_Scaler & CSG_Map_Symbology::Get_Stretch ( void ) const
inline

Definition at line 304 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_from_Relative()

double CSG_Map_Symbology::Get_Stretch_from_Relative ( double Value) const
inline

Definition at line 315 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_LogScale()

double CSG_Map_Symbology::Get_Stretch_LogScale ( void ) const
inline

Definition at line 312 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_Maximum()

double CSG_Map_Symbology::Get_Stretch_Maximum ( void ) const
inline

Definition at line 309 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_Minimum()

double CSG_Map_Symbology::Get_Stretch_Minimum ( void ) const
inline

Definition at line 308 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_Mode()

int CSG_Map_Symbology::Get_Stretch_Mode ( void ) const
inline

Definition at line 311 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_Range()

double CSG_Map_Symbology::Get_Stretch_Range ( void ) const
inline

Definition at line 310 of file map_symbology.h.

References m_Stretch.

◆ Get_Stretch_to_Relative()

double CSG_Map_Symbology::Get_Stretch_to_Relative ( double Value) const
inline

Definition at line 314 of file map_symbology.h.

References m_Stretch.

◆ Histogram_Get()

const CSG_Histogram & CSG_Map_Symbology::Histogram_Get ( void ) const
inline

Definition at line 323 of file map_symbology.h.

References m_Histogram.

◆ Histogram_Update()

bool CSG_Map_Symbology::Histogram_Update ( void )

Definition at line 452 of file map_symbology.cpp.

References _Histogram_Update(), _TL, COMPOSITE, Get_Class_Count(), HISTOGRAM_UPDATE, m_Histogram, m_Mode, m_pLayer, m_Statistics, SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_TIN, SG_UI_Process_Set_Ready(), and SG_UI_Process_Set_Text().

Referenced by Set_Class_Count().

◆ Set_Class_Count()

bool CSG_Map_Symbology::Set_Class_Count ( int Count)

Definition at line 290 of file map_symbology.cpp.

References Histogram_Update(), and m_Count.

◆ Set_Mode()

bool CSG_Map_Symbology::Set_Mode ( int Mode)

Definition at line 261 of file map_symbology.cpp.

References m_Mode.

◆ Set_NoData_Color()

bool CSG_Map_Symbology::Set_NoData_Color ( int Color)

Definition at line 269 of file map_symbology.cpp.

References m_NoData_Color.

◆ Set_Single_Color()

bool CSG_Map_Symbology::Set_Single_Color ( int Color)

Definition at line 277 of file map_symbology.cpp.

References m_Single_Color.

◆ Set_Stretch()

bool CSG_Map_Symbology::Set_Stretch ( double Minimum,
double Maximum,
int Mode = 0,
double LogScale = 1. )
inline

Definition at line 306 of file map_symbology.h.

References m_Stretch, Maximum, and Minimum.

◆ Statistics_Get()

const CSG_Simple_Statistics & CSG_Map_Symbology::Statistics_Get ( void ) const
inline

Definition at line 325 of file map_symbology.h.

References m_Statistics.

◆ Update()

bool CSG_Map_Symbology::Update ( void )

Definition at line 87 of file map_symbology.cpp.

References COMPOSITE, HISTOGRAM_UPDATE, LUT_MIN, m_Mode, m_pColors, m_pLayer, m_pLUT, m_Stretch, SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_TIN, and TABLE_INDEX_Ascending.

Member Data Documentation

◆ m_Count

int CSG_Map_Symbology::m_Count
protected

Definition at line 330 of file map_symbology.h.

Referenced by CSG_Map_Symbology(), Get_Class_Color(), Get_Class_Count(), and Set_Class_Count().

◆ m_Histogram

CSG_Histogram CSG_Map_Symbology::m_Histogram
protected

Definition at line 334 of file map_symbology.h.

Referenced by _Histogram_Update(), _Histogram_Update(), Histogram_Get(), and Histogram_Update().

◆ m_Mode

int CSG_Map_Symbology::m_Mode
protected

Definition at line 330 of file map_symbology.h.

Referenced by _Histogram_Update(), CSG_Map_Symbology(), Get_Class(), Get_Class(), Get_Class_Color(), Get_Class_Color_byValue(), Get_Class_Color_byValue(), Get_Class_Count(), Get_Class_Name(), Get_Class_Value_Center(), Get_Class_Value_Maximum(), Get_Class_Value_Minimum(), Get_Mode(), Histogram_Update(), Set_Mode(), and Update().

◆ m_NoData_Color

int CSG_Map_Symbology::m_NoData_Color
protected

Definition at line 330 of file map_symbology.h.

Referenced by CSG_Map_Symbology(), Get_Class_Color(), Get_NoData_Color(), and Set_NoData_Color().

◆ m_pColors

CSG_Colors* CSG_Map_Symbology::m_pColors = NULL
protected

Definition at line 338 of file map_symbology.h.

Referenced by CSG_Map_Symbology(), Get_Class_Color(), Get_Class_Color_byValue(), Get_Class_Count(), Get_Colors(), Get_Colors(), and Update().

◆ m_pLayer

class CSG_Map_Layer* CSG_Map_Symbology::m_pLayer = NULL
protected

Definition at line 342 of file map_symbology.h.

Referenced by CSG_Map_Symbology(), Histogram_Update(), and Update().

◆ m_pLUT

CSG_Table* CSG_Map_Symbology::m_pLUT = NULL
protected

Definition at line 340 of file map_symbology.h.

Referenced by _Histogram_Update(), _LUT_Cmp_Class(), _LUT_Cmp_Class(), _LUT_Get_Class(), _LUT_Get_Class(), CSG_Map_Symbology(), Get_Class_Color(), Get_Class_Count(), Get_Class_Name(), Get_Class_Name_byValue(), Get_Class_Value_Center(), Get_Class_Value_Maximum(), Get_Class_Value_Minimum(), and Update().

◆ m_Single_Color

int CSG_Map_Symbology::m_Single_Color
protected

Definition at line 330 of file map_symbology.h.

Referenced by CSG_Map_Symbology(), Get_Class_Color(), Get_Single_Color(), and Set_Single_Color().

◆ m_Statistics

CSG_Simple_Statistics CSG_Map_Symbology::m_Statistics
protected

Definition at line 336 of file map_symbology.h.

Referenced by _Histogram_Update(), _Histogram_Update(), Histogram_Update(), and Statistics_Get().

◆ m_Stretch

CSG_Scaler CSG_Map_Symbology::m_Stretch
protected

Definition at line 332 of file map_symbology.h.

Referenced by _METRIC_Get_Class(), Get_Class_Color(), Get_Class_Color_byValue(), Get_Class_Value_Center(), Get_Class_Value_Maximum(), Get_Class_Value_Minimum(), Get_Stretch(), Get_Stretch(), Get_Stretch_from_Relative(), Get_Stretch_LogScale(), Get_Stretch_Maximum(), Get_Stretch_Minimum(), Get_Stretch_Mode(), Get_Stretch_Range(), Get_Stretch_to_Relative(), Set_Stretch(), and Update().

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