#include <grid.h>

Public Member Functions
	CSG_Grid_System (void)

	CSG_Grid_System (const CSG_Grid_System &System, int Precision=-1)

bool	Create (const CSG_Grid_System &System, int Precision=-1)

	CSG_Grid_System (double Cellsize, const CSG_Rect &Extent, int Precision=-1)

bool	Create (double Cellsize, const CSG_Rect &Extent, int Precision=-1)

	CSG_Grid_System (double Cellsize, double xMin, double yMin, double xMax, double yMax, int Precision=-1)

bool	Create (double Cellsize, double xMin, double yMin, double xMax, double yMax, int Precision=-1)

	CSG_Grid_System (double Cellsize, double xMin, double yMin, int NX, int NY, int Precision=-1)

bool	Create (double Cellsize, double xMin, double yMin, int NX, int NY, int Precision=-1)

	CSG_Grid_System (const CSG_String &System, int Precision=-1)

bool	Create (const CSG_String &System, int Precision=-1)

	~CSG_Grid_System (void)

bool	Destroy (void)

bool	Assign (const CSG_Grid_System &System)

bool	Assign (double Cellsize, const CSG_Rect &Extent)

bool	Assign (double Cellsize, double xMin, double yMin, double xMax, double yMax)

bool	Assign (double Cellsize, double xMin, double yMin, int NX, int NY)

bool	is_Valid (void) const

const SG_Char *	Get_Name (bool bShort=true)

const SG_Char *	asString (void)

double	Get_Cellsize (void) const

double	Get_Cellarea (void) const

int	Get_NX (void) const

int	Get_NY (void) const

sLong	Get_NCells (void) const

const CSG_Rect &	Get_Extent (bool bCells=false) const

double	Get_XMin (bool bCells=false) const

double	Get_XMax (bool bCells=false) const

double	Get_XRange (bool bCells=false) const

double	Get_YMin (bool bCells=false) const

double	Get_YMax (bool bCells=false) const

double	Get_YRange (bool bCells=false) const

CSG_Grid_System &	operator= (const CSG_Grid_System &System)

bool	operator== (const CSG_Grid_System *pSystem) const

bool	operator!= (const CSG_Grid_System *pSystem) const

bool	operator== (const CSG_Grid_System &System) const

bool	operator!= (const CSG_Grid_System &System) const

bool	is_Equal (const CSG_Grid_System &System) const

bool	is_Equal (double Cellsize, const TSG_Rect &Extent) const

double	Fit_xto_Grid_System (double x) const
	Aligns the world coordinate x to the rows of the grid system and returns it. More...

double	Fit_yto_Grid_System (double y) const
	Aligns the world coordinate y to the columns of the grid system and returns it. More...

TSG_Point	Fit_to_Grid_System (TSG_Point ptWorld) const
	Aligns the world coordinate ptWorld to the rows and columns of the grid system and returns it. More...

double	Get_xGrid_to_World (int xGrid) const

double	Get_yGrid_to_World (int yGrid) const

TSG_Point	Get_Grid_to_World (int xGrid, int yGrid) const

int	Get_xWorld_to_Grid (double xWorld) const

int	Get_yWorld_to_Grid (double yWorld) const

bool	Get_World_to_Grid (int &xGrid, int &yGrid, double xWorld, double yWorld) const

bool	Get_World_to_Grid (int &xGrid, int &yGrid, TSG_Point ptWorld) const

bool	Get_Neighbor_Pos (int Direction, int x, int y, int &xPos, int &yPos) const

int	Get_xToSave (int Direction, int x) const

int	Get_yToSave (int Direction, int y) const

int	Get_xFromSave (int Direction, int x) const

int	Get_yFromSave (int Direction, int y) const

bool	is_InGrid (int x, int y) const

bool	is_InGrid (int x, int y, int Rand) const

double	Get_Length (int Direction) const

sLong	Get_IndexFromRowCol (int x, int y) const

bool	Get_RowColFromIndex (int &x, int &y, sLong i) const

Static Public Member Functions
static int	Get_xTo (int Direction, int x=0)

static int	Get_yTo (int Direction, int y=0)

static int	Get_xFrom (int Direction, int x=0)

static int	Get_yFrom (int Direction, int y=0)

static double	Get_UnitLength (int Direction)

static int	Set_Precision (int Decimals)

static int	Get_Precision (void)

Detailed Description

CSG_Grid_System is used by the CSG_Grid class to provide information about the number of rows and columns, the cell size and the georeference, which define the grid. It offers various functions, which help when working with grids.

See also: CSG_Grid

Definition at line 199 of file grid.h.

Constructor & Destructor Documentation

◆ CSG_Grid_System() [1/6]

CSG_Grid_System::CSG_Grid_System ( void )

Definition at line 99 of file grid_system.cpp.

References Destroy().

◆ CSG_Grid_System() [2/6]

CSG_Grid_System::CSG_Grid_System	(	const CSG_Grid_System &	System,
		int	Precision = `-1`
	)

Definition at line 105 of file grid_system.cpp.

References Create().

◆ CSG_Grid_System() [3/6]

CSG_Grid_System::CSG_Grid_System	(	double	Cellsize,
		const CSG_Rect &	Extent,
		int	Precision = `-1`
	)

Definition at line 111 of file grid_system.cpp.

References Create().

◆ CSG_Grid_System() [4/6]

CSG_Grid_System::CSG_Grid_System	(	double	Cellsize,
		double	xMin,
		double	yMin,
		double	xMax,
		double	yMax,
		int	Precision = `-1`
	)

Definition at line 117 of file grid_system.cpp.

References Create().

◆ CSG_Grid_System() [5/6]

CSG_Grid_System::CSG_Grid_System	(	double	Cellsize,
		double	xMin,
		double	yMin,
		int	NX,
		int	NY,
		int	Precision = `-1`
	)

Definition at line 123 of file grid_system.cpp.

References Create().

◆ CSG_Grid_System() [6/6]

CSG_Grid_System::CSG_Grid_System	(	const CSG_String &	System,
		int	Precision = `-1`
	)

Definition at line 129 of file grid_system.cpp.

References Create().

◆ ~CSG_Grid_System()

CSG_Grid_System::~CSG_Grid_System ( void )

Definition at line 135 of file grid_system.cpp.

References Destroy().

Member Function Documentation

◆ Assign() [1/4]

bool CSG_Grid_System::Assign ( const CSG_Grid_System & System )

Definition at line 287 of file grid_system.cpp.

References Create().

Referenced by CSG_Parameters::Add_Grid_System(), CSG_Grid_File_Info::Create(), CSG_Parameters_Grid_Target::Get_System(), and CSG_Parameters::Serialize_Compatibility().

◆ Assign() [2/4]

bool CSG_Grid_System::Assign	(	double	Cellsize,
		const CSG_Rect &	Extent
	)

Definition at line 290 of file grid_system.cpp.

References Create().

◆ Assign() [3/4]

bool CSG_Grid_System::Assign	(	double	Cellsize,
		double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)

Definition at line 293 of file grid_system.cpp.

References Create().

◆ Assign() [4/4]

bool CSG_Grid_System::Assign	(	double	Cellsize,
		double	xMin,
		double	yMin,
		int	NX,
		int	NY
	)

Definition at line 296 of file grid_system.cpp.

References Create().

◆ asString()

const SG_Char * CSG_Grid_System::asString ( void )

Definition at line 341 of file grid_system.cpp.

References CSG_String::Printf(), SG_Get_Significant_Decimals(), SSG_Rect::xMin, and SSG_Rect::yMin.

◆ Create() [1/5]

bool CSG_Grid_System::Create	(	const CSG_Grid_System &	System,
		int	Precision = `-1`
	)

Definition at line 146 of file grid_system.cpp.

References Get_Cellsize(), Get_NX(), Get_NY(), Get_XMin(), Get_YMin(), and is_Valid().

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Parameter_Grid_System::_Set_Value(), Assign(), CSG_Grid::Create(), Create(), CSG_Grid_System(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), operator=(), and CSG_Tool_Grid::Set_System().

◆ Create() [2/5]

bool CSG_Grid_System::Create	(	const CSG_String &	System,
		int	Precision = `-1`
	)

Tries to construct a grid system from a string that uses one of the formats provided by the Get_Name() function, i.e. "<double>; <int>x <int>y; <double>x <double>y" or "Cell size: <double>, Number of cells: <int>x/<int>y, Lower left corner: <double>x/<double>y"

Definition at line 235 of file grid_system.cpp.

References Create(), CSG_Strings::Get_Count(), and SG_String_Tokenize().

◆ Create() [3/5]

bool CSG_Grid_System::Create	(	double	Cellsize,
		const CSG_Rect &	Extent,
		int	Precision = `-1`
	)

Definition at line 168 of file grid_system.cpp.

References Create(), Destroy(), CSG_Rect::Get_Center(), CSG_Rect::Get_XMin(), CSG_Rect::Get_XRange(), CSG_Rect::Get_YMin(), CSG_Rect::Get_YRange(), SSG_Point::x, and SSG_Point::y.

◆ Create() [4/5]

bool CSG_Grid_System::Create	(	double	Cellsize,
		double	xMin,
		double	yMin,
		double	xMax,
		double	yMax,
		int	Precision = `-1`
	)

Definition at line 187 of file grid_system.cpp.

References Create().

◆ Create() [5/5]

bool CSG_Grid_System::Create	(	double	Cellsize,
		double	xMin,
		double	yMin,
		int	NX,
		int	NY,
		int	Precision = `-1`
	)

Definition at line 193 of file grid_system.cpp.

References Destroy(), CSG_Rect::Inflate(), SG_Get_Rounded(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Destroy()

bool CSG_Grid_System::Destroy ( void )

Definition at line 270 of file grid_system.cpp.

References CSG_Rect::Create().

Referenced by Create(), CSG_Grid_System(), CSG_Grid::Destroy(), CSG_Parameter_Grid_List::Update_Data(), and ~CSG_Grid_System().

◆ Fit_to_Grid_System()

TSG_Point CSG_Grid_System::Fit_to_Grid_System ( TSG_Point ptWorld ) const

inline

Aligns the world coordinate ptWorld to the rows and columns of the grid system and returns it.

Definition at line 273 of file grid.h.

References SSG_Point::x, and SSG_Point::y.

◆ Fit_xto_Grid_System()

double CSG_Grid_System::Fit_xto_Grid_System ( double x ) const

inline

Aligns the world coordinate x to the rows of the grid system and returns it.

Definition at line 267 of file grid.h.

◆ Fit_yto_Grid_System()

double CSG_Grid_System::Fit_yto_Grid_System ( double y ) const

inline

Aligns the world coordinate y to the columns of the grid system and returns it.

Definition at line 270 of file grid.h.

◆ Get_Cellarea()

double CSG_Grid_System::Get_Cellarea ( void ) const

inline

Definition at line 236 of file grid.h.

◆ Get_Cellsize()

double CSG_Grid_System::Get_Cellsize ( void ) const

inline

Definition at line 235 of file grid.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grids::Create(), Create(), and CSG_Grid_File_Info::Save().

◆ Get_Extent()

const CSG_Rect& CSG_Grid_System::Get_Extent ( bool bCells = false ) const

inline

Definition at line 242 of file grid.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grid::Get_Value(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_Grid_to_World()

TSG_Point CSG_Grid_System::Get_Grid_to_World	(	int	xGrid,
		int	yGrid
	)		const

inline

Definition at line 286 of file grid.h.

References SSG_Point::x, and SSG_Point::y.

◆ Get_IndexFromRowCol()

sLong CSG_Grid_System::Get_IndexFromRowCol	(	int	x,
		int	y
	)		const

inline

Definition at line 363 of file grid.h.

◆ Get_Length()

double CSG_Grid_System::Get_Length ( int Direction ) const

inline

Definition at line 357 of file grid.h.

Referenced by CSG_Grid::Get_Gradient_NeighborDir().

◆ Get_Name()

const SG_Char * CSG_Grid_System::Get_Name ( bool bShort = true )

Definition at line 311 of file grid_system.cpp.

References _TL, is_Valid(), CSG_String::Printf(), SG_Get_Significant_Decimals(), SSG_Rect::xMin, and SSG_Rect::yMin.

Referenced by CSG_Parameter_Grid_System::_Set_String().

◆ Get_NCells()

sLong CSG_Grid_System::Get_NCells ( void ) const

inline

Definition at line 240 of file grid.h.

◆ Get_Neighbor_Pos()

bool CSG_Grid_System::Get_Neighbor_Pos	(	int	Direction,
		int	x,
		int	y,
		int &	xPos,
		int &	yPos
	)		const

inline

Definition at line 313 of file grid.h.

◆ Get_NX()

int CSG_Grid_System::Get_NX ( void ) const

inline

Definition at line 238 of file grid.h.

Referenced by Create(), CSG_Grid::Create(), and CSG_Grid_File_Info::Save().

◆ Get_NY()

int CSG_Grid_System::Get_NY ( void ) const

inline

Definition at line 239 of file grid.h.

Referenced by Create(), CSG_Grid::Create(), CSG_Grid_File_Info::Save(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_Precision()

int CSG_Grid_System::Get_Precision ( void )

static

Get the default precision (number of decimals) used to store coordinates and cell sizes. A negative value indicates that this is ignored.

Definition at line 88 of file grid_system.cpp.

Referenced by CSG_Grid_File_Info::Save().

◆ Get_RowColFromIndex()

bool CSG_Grid_System::Get_RowColFromIndex	(	int &	x,
		int &	y,
		sLong	i
	)		const

inline

Definition at line 373 of file grid.h.

◆ Get_UnitLength()

static double CSG_Grid_System::Get_UnitLength ( int Direction )

inlinestatic

Definition at line 358 of file grid.h.

◆ Get_World_to_Grid() [1/2]

bool CSG_Grid_System::Get_World_to_Grid	(	int &	xGrid,
		int &	yGrid,
		double	xWorld,
		double	yWorld
	)		const

inline

Definition at line 301 of file grid.h.

◆ Get_World_to_Grid() [2/2]

bool CSG_Grid_System::Get_World_to_Grid	(	int &	xGrid,
		int &	yGrid,
		TSG_Point	ptWorld
	)		const

inline

Definition at line 306 of file grid.h.

References SSG_Point::x, and SSG_Point::y.

◆ Get_xFrom()

static int CSG_Grid_System::Get_xFrom	(	int	Direction,
		int	x = `0`
	)

inlinestatic

Definition at line 346 of file grid.h.

Referenced by CSG_Grid::Get_Gradient(), and CSG_Tool_Grid::Get_xFrom().

◆ Get_xFromSave()

int CSG_Grid_System::Get_xFromSave	(	int	Direction,
		int	x
	)		const

inline

Definition at line 351 of file grid.h.

◆ Get_xGrid_to_World()

double CSG_Grid_System::Get_xGrid_to_World ( int xGrid ) const

inline

Definition at line 283 of file grid.h.

◆ Get_XMax()

double CSG_Grid_System::Get_XMax ( bool bCells = false ) const

inline

Definition at line 245 of file grid.h.

◆ Get_XMin()

double CSG_Grid_System::Get_XMin ( bool bCells = false ) const

inline

Definition at line 244 of file grid.h.

Referenced by Create(), CSG_Grid::Create(), and CSG_Grid_File_Info::Save().

◆ Get_XRange()

double CSG_Grid_System::Get_XRange ( bool bCells = false ) const

inline

Definition at line 246 of file grid.h.

◆ Get_xTo()

static int CSG_Grid_System::Get_xTo	(	int	Direction,
		int	x = `0`
	)

inlinestatic

Definition at line 318 of file grid.h.

Referenced by CSG_Grid::Get_Gradient(), CSG_Grid::Get_Gradient_NeighborDir(), and CSG_Tool_Grid::Get_xTo().

◆ Get_xToSave()

int CSG_Grid_System::Get_xToSave	(	int	Direction,
		int	x
	)		const

inline

Definition at line 349 of file grid.h.

◆ Get_xWorld_to_Grid()

int CSG_Grid_System::Get_xWorld_to_Grid ( double xWorld ) const

inline

Definition at line 298 of file grid.h.

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

◆ Get_yFrom()

static int CSG_Grid_System::Get_yFrom	(	int	Direction,
		int	y = `0`
	)

inlinestatic

Definition at line 347 of file grid.h.

Referenced by CSG_Grid::Get_Gradient(), and CSG_Tool_Grid::Get_yFrom().

◆ Get_yFromSave()

int CSG_Grid_System::Get_yFromSave	(	int	Direction,
		int	y
	)		const

inline

Definition at line 352 of file grid.h.

◆ Get_yGrid_to_World()

double CSG_Grid_System::Get_yGrid_to_World ( int yGrid ) const

inline

Definition at line 284 of file grid.h.

◆ Get_YMax()

double CSG_Grid_System::Get_YMax ( bool bCells = false ) const

inline

Definition at line 249 of file grid.h.

◆ Get_YMin()

double CSG_Grid_System::Get_YMin ( bool bCells = false ) const

inline

Definition at line 248 of file grid.h.

Referenced by Create(), CSG_Grid::Create(), and CSG_Grid_File_Info::Save().

◆ Get_YRange()

double CSG_Grid_System::Get_YRange ( bool bCells = false ) const

inline

Definition at line 250 of file grid.h.

◆ Get_yTo()

static int CSG_Grid_System::Get_yTo	(	int	Direction,
		int	y = `0`
	)

inlinestatic

Definition at line 332 of file grid.h.

Referenced by CSG_Grid::Get_Gradient(), CSG_Grid::Get_Gradient_NeighborDir(), and CSG_Tool_Grid::Get_yTo().

◆ Get_yToSave()

int CSG_Grid_System::Get_yToSave	(	int	Direction,
		int	y
	)		const

inline

Definition at line 350 of file grid.h.

◆ Get_yWorld_to_Grid()

int CSG_Grid_System::Get_yWorld_to_Grid ( double yWorld ) const

inline

Definition at line 299 of file grid.h.

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

◆ is_Equal() [1/2]

bool CSG_Grid_System::is_Equal ( const CSG_Grid_System & System ) const

Definition at line 393 of file grid_system.cpp.

References SSG_Rect::xMin, and SSG_Rect::yMin.

Referenced by CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameter::is_Value_Equal(), operator!=(), and operator==().

◆ is_Equal() [2/2]

bool CSG_Grid_System::is_Equal	(	double	Cellsize,
		const TSG_Rect &	Extent
	)		const

Definition at line 404 of file grid_system.cpp.

◆ is_InGrid() [1/2]

bool CSG_Grid_System::is_InGrid	(	int	x,
		int	y
	)		const

inline

Definition at line 354 of file grid.h.

◆ is_InGrid() [2/2]

bool CSG_Grid_System::is_InGrid	(	int	x,
		int	y,
		int	Rand
	)		const

inline

Definition at line 355 of file grid.h.

◆ is_Valid()

bool CSG_Grid_System::is_Valid ( void ) const

Definition at line 305 of file grid_system.cpp.

Referenced by CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), Create(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), Get_Name(), CSG_Grid::is_Valid(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ operator!=() [1/2]

bool CSG_Grid_System::operator!= ( const CSG_Grid_System & System ) const

Definition at line 382 of file grid_system.cpp.

References is_Equal().

◆ operator!=() [2/2]

bool CSG_Grid_System::operator!= ( const CSG_Grid_System * pSystem ) const

Definition at line 371 of file grid_system.cpp.

References is_Equal().

◆ operator=()

CSG_Grid_System & CSG_Grid_System::operator= ( const CSG_Grid_System & System )

Definition at line 358 of file grid_system.cpp.

References Create().

◆ operator==() [1/2]

bool CSG_Grid_System::operator== ( const CSG_Grid_System & System ) const

Definition at line 377 of file grid_system.cpp.

References is_Equal().

◆ operator==() [2/2]

bool CSG_Grid_System::operator== ( const CSG_Grid_System * pSystem ) const

Definition at line 366 of file grid_system.cpp.

References is_Equal().

◆ Set_Precision()

int CSG_Grid_System::Set_Precision ( int Decimals )

static

Set the default precision given as number of decimals used to store coordinates and cell sizes. Ignored if set to a negative value.

Definition at line 75 of file grid_system.cpp.

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CSG_Grid_System() [1/6]

◆ CSG_Grid_System() [2/6]

◆ CSG_Grid_System() [3/6]

◆ CSG_Grid_System() [4/6]

◆ CSG_Grid_System() [5/6]

◆ CSG_Grid_System() [6/6]

◆ ~CSG_Grid_System()

Member Function Documentation

◆ Assign() [1/4]

◆ Assign() [2/4]

◆ Assign() [3/4]

◆ Assign() [4/4]

◆ asString()

◆ Create() [1/5]

◆ Create() [2/5]

◆ Create() [3/5]

◆ Create() [4/5]

◆ Create() [5/5]

◆ Destroy()

◆ Fit_to_Grid_System()

◆ Fit_xto_Grid_System()

◆ Fit_yto_Grid_System()

◆ Get_Cellarea()

◆ Get_Cellsize()

◆ Get_Extent()

◆ Get_Grid_to_World()

◆ Get_IndexFromRowCol()

◆ Get_Length()

◆ Get_Name()

◆ Get_NCells()

◆ Get_Neighbor_Pos()

◆ Get_NX()

◆ Get_NY()

◆ Get_Precision()

◆ Get_RowColFromIndex()

◆ Get_UnitLength()

◆ Get_World_to_Grid() [1/2]

◆ Get_World_to_Grid() [2/2]

◆ Get_xFrom()

◆ Get_xFromSave()

◆ Get_xGrid_to_World()

◆ Get_XMax()

◆ Get_XMin()

◆ Get_XRange()

◆ Get_xTo()

◆ Get_xToSave()

◆ Get_xWorld_to_Grid()

◆ Get_yFrom()

◆ Get_yFromSave()

◆ Get_yGrid_to_World()

◆ Get_YMax()

◆ Get_YMin()

◆ Get_YRange()

◆ Get_yTo()

◆ Get_yToSave()

◆ Get_yWorld_to_Grid()

◆ is_Equal() [1/2]

◆ is_Equal() [2/2]

◆ is_InGrid() [1/2]

◆ is_InGrid() [2/2]

◆ is_Valid()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ Set_Precision()