#include <grids.h>

Inheritance diagram for CSG_Grids:

Public Member Functions
	CSG_Grids (void)

virtual	~CSG_Grids (void)

	CSG_Grids (const CSG_Grids &Grids)

virtual bool	Create (const CSG_Grids &Grids)

	CSG_Grids (const CSG_Grids *pGrids, bool bCopyData=false)

virtual bool	Create (const CSG_Grids *pGrids, bool bCopyData=false)

	CSG_Grids (const char *FileName, bool bLoadData=true)

virtual bool	Create (const char *FileName, bool bLoadData=true)

	CSG_Grids (const wchar_t *FileName, bool bLoadData=true)

virtual bool	Create (const wchar_t *FileName, bool bLoadData=true)

	CSG_Grids (const CSG_String &FileName, bool bLoadData=true)

virtual bool	Create (const CSG_String &FileName, bool bLoadData=true)

	CSG_Grids (const CSG_Grid_System &System, int NZ=0, double zMin=0., TSG_Data_Type Type=SG_DATATYPE_Undefined)

virtual bool	Create (const CSG_Grid_System &System, int NZ=0, double zMin=0., TSG_Data_Type Type=SG_DATATYPE_Undefined)

	CSG_Grids (const CSG_Grid_System &System, const CSG_Table &Attributes, int zAttribute=0, TSG_Data_Type Type=SG_DATATYPE_Undefined, bool bCreateGrids=false)

virtual bool	Create (const CSG_Grid_System &System, const CSG_Table &Attributes, int zAttribute=0, TSG_Data_Type Type=SG_DATATYPE_Undefined, bool bCreateGrids=false)

	CSG_Grids (int NX, int NY, int NZ=0, double Cellsize=0., double xMin=0., double yMin=0., double zMin=0., TSG_Data_Type Type=SG_DATATYPE_Undefined)

virtual bool	Create (int NX, int NY, int NZ=0, double Cellsize=0., double xMin=0., double yMin=0., double zMin=0., TSG_Data_Type Type=SG_DATATYPE_Undefined)

virtual bool	Destroy (void)

virtual bool	Load (const CSG_String &File, bool bLoadData=true)

virtual bool	Save (const CSG_String &File, int Format=0)

virtual bool	Save (const char *File, int Format=0)

virtual bool	Save (const wchar_t *File, int Format=0)

virtual TSG_Data_Object_Type	Get_ObjectType (void) const

TSG_Data_Type	Get_Type (void) const

int	Get_nValueBytes (void) const

int	Get_nLineBytes (void) const

void	Set_Unit (const CSG_String &Unit)

const SG_Char *	Get_Unit (void) const

const CSG_Grid_System &	Get_System (void) const

virtual const CSG_Rect &	Get_Extent (void)

int	Get_NX (void) const

int	Get_NY (void) const

int	Get_NZ (void) const

sLong	Get_NCells (void) const

sLong	Get_Data_Count (void)

sLong	Get_NoData_Count (void)

double	Get_Cellsize (void) const

double	Get_Cellarea (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

double	Get_ZMin (bool bCells=false) const

double	Get_ZMax (bool bCells=false) const

double	Get_ZRange (bool bCells=false) const

bool	Set_Z_Attribute (int Field)

int	Get_Z_Attribute (void) const

bool	Set_Z_Name_Field (int Field)

int	Get_Z_Name_Field (void) const

bool	Add_Attribute (const char *Name, TSG_Data_Type Type, int Insert=-1)

bool	Add_Attribute (const wchar_t *Name, TSG_Data_Type Type, int Insert=-1)

bool	Add_Attribute (const CSG_String &Name, TSG_Data_Type Type, int Insert=-1)

bool	Del_Attribute (int Field)

const CSG_Table &	Get_Attributes (void) const

CSG_Table *	Get_Attributes_Ptr (void)

CSG_Table_Record &	Get_Attributes (int i) const

bool	Set_Attribute (int i, int Field, const CSG_String &Value)

bool	Set_Attribute (int i, const CSG_String &Field, const CSG_String &Value)

bool	Set_Attribute (int i, const wchar_t Field, const wchar_t Value)

bool	Set_Attribute (int i, const char Field, const char Value)

bool	Set_Attribute (int i, int Field, double Value)

bool	Set_Attribute (int i, const CSG_String &Field, double Value)

bool	Set_Attribute (int i, const wchar_t *Field, double Value)

bool	Set_Attribute (int i, const char *Field, double Value)

bool	Set_Z (int i, double Value)

double	Get_Z (int i) const

bool	Update_Z_Order (void)

bool	Set_Grid_Count (int Count)

int	Get_Grid_Count (void) const

bool	Add_Grid (double Z)

bool	Add_Grid (double Z, CSG_Grid *pGrid, bool bAttach=false)

bool	Add_Grid (CSG_Table_Record &Attributes)

bool	Add_Grid (CSG_Table_Record &Attributes, CSG_Grid *pGrid, bool bAttach=false)

bool	Del_Grid (int i, bool bDetach=false)

bool	Del_Grids (bool bDetach=false)

const CSG_Grid &	Get_Grid (int i) const

CSG_Grid *	Get_Grid_Ptr (int i) const

CSG_String	Get_Grid_Name (int i, int Style=0) const

sLong	Get_Memory_Size (void) const

void	Set_Scaling (double Scale=1., double Offset=0.)

double	Get_Scaling (void) const

double	Get_Offset (void) const

bool	is_Scaled (void) const

double	Get_Mean (void)

double	Get_Min (void)

double	Get_Max (void)

double	Get_Range (void)

double	Get_StdDev (void)

double	Get_Variance (void)

double	Get_Quantile (double Quantile, bool bFromHistogram=true)

double	Get_Percentile (double Percentile, bool bFromHistogram=true)

const CSG_Simple_Statistics &	Get_Statistics (void)

bool	Get_Statistics (const CSG_Rect &rWorld, CSG_Simple_Statistics &Statistics, bool bHoldValues=false) const

const CSG_Histogram &	Get_Histogram (size_t nClasses=0)

bool	Get_Histogram (const CSG_Rect &rWorld, CSG_Histogram &Histogram, size_t nClasses=0) const

virtual bool	Set_Max_Samples (sLong Max_Samples)

virtual bool	is_Valid (void) const

TSG_Intersection	is_Intersecting (const CSG_Rect &Extent) const

TSG_Intersection	is_Intersecting (const TSG_Rect &Extent) const

TSG_Intersection	is_Intersecting (double xMin, double yMin, double xMax, double yMax) const

bool	is_Compatible (CSG_Grid *pGrid) const

bool	is_Compatible (CSG_Grids *pGrids) const

bool	is_Compatible (const CSG_Grid_System &System) const

bool	is_Compatible (int NX, int NY, double Cellsize, double xMin, double yMin) const

bool	is_InGrid (int x, int y, int z, bool bCheckNoData=true) const

bool	is_InGrid_byPos (double x, double y, double z, bool bCheckNoData=true) const

bool	is_InGrid_byPos (const TSG_Point_3D &p, bool bCheckNoData=true) const

virtual void	Set_Modified (bool bModified=true)

virtual bool	is_Modified (void) const

void	Assign_NoData (void)

virtual bool	Assign (double Value=0.)

virtual bool	Assign (CSG_Data_Object *pObject)

virtual bool	Assign (CSG_Grids *pGrids, TSG_Grid_Resampling Interpolation)

virtual CSG_Grids &	operator= (const CSG_Grids &Grids)

virtual CSG_Grids &	operator= (double Value)

virtual CSG_Grids &	operator+= (double Value)

virtual CSG_Grids &	Add (double Value)

virtual CSG_Grids &	operator-= (double Value)

virtual CSG_Grids &	Subtract (double Value)

virtual CSG_Grids &	operator*= (double Value)

virtual CSG_Grids &	Multiply (double Value)

virtual CSG_Grids &	operator/= (double Value)

virtual CSG_Grids &	Divide (double Value)

virtual double	operator() (int x, int y, int z) const

virtual CSG_Grid &	operator[] (int i)

virtual bool	Set_NoData_Value_Range (double loValue, double hiValue)

virtual bool	is_NoData (int x, int y, int z) const

virtual bool	is_NoData (sLong i) const

virtual void	Set_NoData (int x, int y, int z)

virtual void	Set_NoData (sLong i)

double	Get_Value (double x, double y, double z, TSG_Grid_Resampling Resampling=GRID_RESAMPLING_BSpline, TSG_Grid_Resampling ZResampling=GRID_RESAMPLING_Undefined) const

double	Get_Value (const TSG_Point_3D &p, TSG_Grid_Resampling Resampling=GRID_RESAMPLING_BSpline, TSG_Grid_Resampling ZResampling=GRID_RESAMPLING_Undefined) const

bool	Get_Value (double x, double y, double z, double &Value, TSG_Grid_Resampling Resampling=GRID_RESAMPLING_BSpline, TSG_Grid_Resampling ZResampling=GRID_RESAMPLING_Undefined) const

bool	Get_Value (const TSG_Point_3D &p, double &Value, TSG_Grid_Resampling Resampling=GRID_RESAMPLING_BSpline, TSG_Grid_Resampling ZResampling=GRID_RESAMPLING_Undefined) const

virtual BYTE	asByte (int x, int y, int z, bool bScaled=true) const

virtual BYTE	asByte (sLong i, bool bScaled=true) const

virtual char	asChar (int x, int y, int z, bool bScaled=true) const

virtual char	asChar (sLong i, bool bScaled=true) const

virtual short	asShort (int x, int y, int z, bool bScaled=true) const

virtual short	asShort (sLong i, bool bScaled=true) const

virtual int	asInt (int x, int y, int z, bool bScaled=true) const

virtual int	asInt (sLong i, bool bScaled=true) const

virtual sLong	asLong (int x, int y, int z, bool bScaled=true) const

virtual sLong	asLong (sLong i, bool bScaled=true) const

virtual float	asFloat (int x, int y, int z, bool bScaled=true) const

virtual float	asFloat (sLong i, bool bScaled=true) const

virtual double	asDouble (sLong i, bool bScaled=true) const

virtual double	asDouble (int x, int y, int z, bool bScaled=true) const

virtual void	Add_Value (int x, int y, int z, double Value)

virtual void	Add_Value (sLong i, double Value)

virtual void	Mul_Value (int x, int y, int z, double Value)

virtual void	Mul_Value (sLong i, double Value)

virtual void	Set_Value (sLong i, double Value, bool bScaled=true)

virtual void	Set_Value (int x, int y, int z, double Value, bool bScaled=true)

bool	Set_Index (bool bOn=true)

sLong	Get_Sorted (sLong Position, bool bDown=true, bool bCheckNoData=true)

bool	Get_Sorted (sLong Position, sLong &i, bool bDown=true, bool bCheckNoData=true)

bool	Get_Sorted (sLong Position, int &x, int &y, int &z, bool bDown=true, bool bCheckNoData=true)

Public Member Functions inherited from CSG_Data_Object
	CSG_Data_Object (void)

virtual	~CSG_Data_Object (void)

int	Get_RefID (void) const
	Returns the object's reference id (unique). More...

int	Get_Managed (void) const

bool	Reload (void)
	If there is an associated file data can be reloaded with this command. More...

bool	Delete (void)
	Deletes all files associated with this data object if possible. Works only with native SAGA files. Returns true on success. More...

void	Set_File_Name (const CSG_String &FileName)

const SG_Char *	Get_File_Name (bool bNative=true) const

int	Get_File_Type (void) const

bool	is_File_Native (void) const

void	Set_Name (const CSG_String &Name)

void	Set_Name (const char *Name)

void	Set_Name (const wchar_t *Name)

void	Fmt_Name (const char *Format,...)

void	Fmt_Name (const wchar_t *Format,...)

const SG_Char *	Get_Name (void) const

void	Set_Description (const CSG_String &Description)

const SG_Char *	Get_Description (void) const

bool	Update (bool bForce=false)

CSG_Data_Object *	Get_Owner (void) const

void	Set_Owner (CSG_Data_Object *pOwner)

CSG_MetaData &	Get_MetaData (void) const

CSG_MetaData &	Get_MetaData_DB (void) const

CSG_MetaData &	Get_History (void)

const CSG_MetaData &	Get_History (void) const

CSG_Projection &	Get_Projection (void)

const CSG_Projection &	Get_Projection (void) const

class CSG_Table *	asTable (bool bPolymorph=false) const

class CSG_Shapes *	asShapes (bool bPolymorph=false) const

class CSG_TIN *	asTIN (bool bPolymorph=false) const

class CSG_PointCloud *	asPointCloud (bool bPolymorph=false) const

class CSG_Grid *	asGrid (bool bPolymorph=false) const

class CSG_Grids *	asGrids (bool bPolymorph=false) const

virtual bool	Set_NoData_Value (double Value)

double	Get_NoData_Value (bool bUpper=false) const

bool	is_NoData_Value (double Value) const

bool	Save_History_to_Model (const CSG_String &File) const

sLong	Get_Max_Samples (void) const

Protected Member Functions
virtual bool	On_Update (void)

virtual bool	On_Reload (void)

virtual bool	On_Delete (void)

Protected Member Functions inherited from CSG_Data_Object
void	Set_File_Name (const CSG_String &FileName, bool bNative)

void	Set_File_Type (int Type)

bool	Load_MetaData (const CSG_String &FileName)

bool	Load_MetaData (CSG_File &Stream)

bool	Save_MetaData (const CSG_String &FileName)

bool	Save_MetaData (CSG_File &Stream)

void	Set_Update_Flag (bool bOn=true)

bool	Get_Update_Flag (void)

virtual bool	On_NoData_Changed (void)

Additional Inherited Members
Static Public Member Functions inherited from CSG_Data_Object
static void	Track (bool Track=true, bool Offset=false)
	Activate/deactivate lifetime tracking (data object construction/destruction). Needs compiler flag WITH_LIFETIME_TRACKER being defined. More...

Protected Attributes inherited from CSG_Data_Object
CSG_Data_Object *	m_pOwner

Detailed Description

CSG_Grids is the data object created for handling raster collections.

Definition at line 118 of file grids.h.

Constructor & Destructor Documentation

◆ CSG_Grids() [1/9]

CSG_Grids::CSG_Grids ( void )

Default constructor.

Definition at line 132 of file grids.cpp.

◆ ~CSG_Grids()

CSG_Grids::~CSG_Grids ( void )

virtual

The destructor.

Definition at line 141 of file grids.cpp.

References Destroy().

◆ CSG_Grids() [2/9]

CSG_Grids::CSG_Grids ( const CSG_Grids & Grids )

Copy constructor.

Definition at line 153 of file grids.cpp.

References Create().

◆ CSG_Grids() [3/9]

CSG_Grids::CSG_Grids	(	const CSG_Grids *	pGrids,
		bool	bCopyData = `false`
	)

Create a grid collection using the pGrids's grid system, data type, and attribute field definition. If bCopyData is true, it also copies the data. Otherwise it has no initial data.

Definition at line 168 of file grids.cpp.

References Create().

◆ CSG_Grids() [4/9]

CSG_Grids::CSG_Grids	(	const char *	FileName,
		bool	bLoadData = `true`
	)

Create a grid collection from file.

Definition at line 180 of file grids.cpp.

References Create().

◆ CSG_Grids() [5/9]

CSG_Grids::CSG_Grids	(	const wchar_t *	FileName,
		bool	bLoadData = `true`
	)

Definition at line 181 of file grids.cpp.

References Create().

◆ CSG_Grids() [6/9]

CSG_Grids::CSG_Grids	(	const CSG_String &	FileName,
		bool	bLoadData = `true`
	)

Definition at line 182 of file grids.cpp.

References Create().

◆ CSG_Grids() [7/9]

CSG_Grids::CSG_Grids	(	const CSG_Grid_System &	System,
		int	NZ = `0`,
		double	zMin = `0.`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`
	)

Create a grid collection with specified dimensions'.

Definition at line 201 of file grids.cpp.

References Create().

◆ CSG_Grids() [8/9]

CSG_Grids::CSG_Grids	(	const CSG_Grid_System &	System,
		const CSG_Table &	Attributes,
		int	zAttribute = `0`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`,
		bool	bCreateGrids = `false`
	)

Create a grid collection with specified dimensions'.

Definition at line 213 of file grids.cpp.

References Create().

◆ CSG_Grids() [9/9]

CSG_Grids::CSG_Grids	(	int	NX,
		int	NY,
		int	NZ = `0`,
		double	Cellsize = `0.`,
		double	xMin = `0.`,
		double	yMin = `0.`,
		double	zMin = `0.`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`
	)

Create a grid collection with specified dimensions'.

Definition at line 189 of file grids.cpp.

References Create().

Member Function Documentation

◆ Add()

CSG_Grids & CSG_Grids::Add ( double Value )

virtual

Definition at line 1005 of file grids.cpp.

References CSG_Grid::Add(), and Get_Grid_Count().

Referenced by operator+=().

◆ Add_Attribute() [1/3]

bool CSG_Grids::Add_Attribute	(	const char *	Name,
		TSG_Data_Type	Type,
		int	Insert = `-1`
	)

Definition at line 505 of file grids.cpp.

Referenced by Add_Attribute().

◆ Add_Attribute() [2/3]

bool CSG_Grids::Add_Attribute	(	const CSG_String &	Name,
		TSG_Data_Type	Type,
		int	Insert = `-1`
	)

Definition at line 507 of file grids.cpp.

References CSG_Table::Add_Field().

◆ Add_Attribute() [3/3]

bool CSG_Grids::Add_Attribute	(	const wchar_t *	Name,
		TSG_Data_Type	Type,
		int	Insert = `-1`
	)

Definition at line 506 of file grids.cpp.

References Add_Attribute().

◆ Add_Grid() [1/4]

bool CSG_Grids::Add_Grid ( CSG_Table_Record & Attributes )

Definition at line 682 of file grids.cpp.

References CSG_Table::Add_Record(), CSG_Array_Pointer::Get_Array(), Get_NZ(), Get_System(), Get_Type(), is_Valid(), SG_Create_Grid(), SG_FREE_SAFE, and Update_Z_Order().

◆ Add_Grid() [2/4]

bool CSG_Grids::Add_Grid	(	CSG_Table_Record &	Attributes,
		CSG_Grid *	pGrid,
		bool	bAttach = `false`
	)

Definition at line 722 of file grids.cpp.

References CSG_Table::Add_Record(), Create(), CSG_Array_Pointer::Get_Array(), Get_NZ(), CSG_Data_Object::Get_Projection(), is_Compatible(), CSG_Projection::is_Okay(), CSG_Grid::is_Valid(), SG_Create_Grid(), SG_FREE_SAFE, and Update_Z_Order().

◆ Add_Grid() [3/4]

bool CSG_Grids::Add_Grid ( double Z )

Definition at line 658 of file grids.cpp.

References CSG_Table::Add_Record(), and CSG_Table::Set_Value().

Referenced by Add_Grid(), Create(), CSG_Parameters_Grid_Target::Get_Grids(), and Set_Grid_Count().

◆ Add_Grid() [4/4]

bool CSG_Grids::Add_Grid	(	double	Z,
		CSG_Grid *	pGrid,
		bool	bAttach = `false`
	)

Definition at line 670 of file grids.cpp.

References Add_Grid(), CSG_Table::Add_Record(), and CSG_Table::Set_Value().

◆ Add_Value() [1/2]

virtual void CSG_Grids::Add_Value	(	int	x,
		int	y,
		int	z,
		double	Value
	)

inlinevirtual

Definition at line 415 of file grids.h.

◆ Add_Value() [2/2]

virtual void CSG_Grids::Add_Value	(	sLong	i,
		double	Value
	)

inlinevirtual

Definition at line 416 of file grids.h.

◆ asByte() [1/2]

virtual BYTE CSG_Grids::asByte	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 385 of file grids.h.

References SG_ROUND_TO_BYTE.

◆ asByte() [2/2]

virtual BYTE CSG_Grids::asByte	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 386 of file grids.h.

References SG_ROUND_TO_BYTE.

◆ asChar() [1/2]

virtual char CSG_Grids::asChar	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 387 of file grids.h.

References SG_ROUND_TO_CHAR.

◆ asChar() [2/2]

virtual char CSG_Grids::asChar	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 388 of file grids.h.

References SG_ROUND_TO_CHAR.

◆ asDouble() [1/2]

virtual double CSG_Grids::asDouble	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 406 of file grids.h.

◆ asDouble() [2/2]

virtual double CSG_Grids::asDouble	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 399 of file grids.h.

Referenced by CSG_Natural_Breaks::Create(), CSG_Histogram::Create(), Get_Histogram(), Get_Quantile(), Get_Statistics(), and On_Update().

◆ asFloat() [1/2]

virtual float CSG_Grids::asFloat	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 395 of file grids.h.

◆ asFloat() [2/2]

virtual float CSG_Grids::asFloat	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 396 of file grids.h.

◆ asInt() [1/2]

virtual int CSG_Grids::asInt	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 391 of file grids.h.

References SG_ROUND_TO_INT.

◆ asInt() [2/2]

virtual int CSG_Grids::asInt	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 392 of file grids.h.

References SG_ROUND_TO_INT.

◆ asLong() [1/2]

virtual sLong CSG_Grids::asLong	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 393 of file grids.h.

References SG_ROUND_TO_SLONG.

◆ asLong() [2/2]

virtual sLong CSG_Grids::asLong	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 394 of file grids.h.

References SG_ROUND_TO_SLONG.

◆ asShort() [1/2]

virtual short CSG_Grids::asShort	(	int	x,
		int	y,
		int	z,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 389 of file grids.h.

References SG_ROUND_TO_SHORT.

◆ asShort() [2/2]

virtual short CSG_Grids::asShort	(	sLong	i,
		bool	bScaled = `true`
	)		const

inlinevirtual

Definition at line 390 of file grids.h.

References SG_ROUND_TO_SHORT.

◆ Assign() [1/3]

bool CSG_Grids::Assign ( CSG_Data_Object * pObject )

virtual

Reimplemented from CSG_Data_Object.

Definition at line 930 of file grids.cpp.

References Assign(), Get_Grid_Count(), CSG_Data_Object::Get_ObjectType(), SG_DATAOBJECT_TYPE_Grid, and SG_DATAOBJECT_TYPE_Grids.

◆ Assign() [2/3]

bool CSG_Grids::Assign	(	CSG_Grids *	pGrids,
		TSG_Grid_Resampling	Interpolation
	)

virtual

Definition at line 963 of file grids.cpp.

References Assign(), and Get_Grid_Count().

◆ Assign() [3/3]

bool CSG_Grids::Assign ( double Value = 0. )

virtual

Definition at line 919 of file grids.cpp.

References CSG_Grid::Assign(), and Get_Grid_Count().

Referenced by Assign(), and operator=().

◆ Assign_NoData()

void CSG_Grids::Assign_NoData ( void )

Definition at line 910 of file grids.cpp.

References CSG_Grid::Assign_NoData(), and Get_Grid_Count().

◆ Create() [1/8]

bool CSG_Grids::Create	(	const char *	FileName,
		bool	bLoadData = `true`
	)

virtual

Definition at line 307 of file grids.cpp.

References Load().

◆ Create() [2/8]

bool CSG_Grids::Create	(	const CSG_Grid_System &	System,
		const CSG_Table &	Attributes,
		int	zAttribute = `0`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`,
		bool	bCreateGrids = `false`
	)

virtual

Definition at line 335 of file grids.cpp.

References Add_Grid(), CSG_Grid::Create(), CSG_Table::Create(), Destroy(), CSG_Table::Get_Count(), and Set_Z_Attribute().

◆ Create() [3/8]

bool CSG_Grids::Create	(	const CSG_Grid_System &	System,
		int	NZ = `0`,
		double	zMin = `0.`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`
	)

virtual

Definition at line 312 of file grids.cpp.

References Add_Grid(), Create(), Destroy(), CSG_Grid_System::Get_Cellsize(), CSG_Data_Object::Get_NoData_Value(), and Set_NoData_Value_Range().

◆ Create() [4/8]

bool CSG_Grids::Create ( const CSG_Grids & Grids )

virtual

Definition at line 271 of file grids.cpp.

Referenced by Add_Grid(), Create(), CSG_Grids(), CSG_Parameters_Grid_Target::Get_Grids(), On_Reload(), and operator=().

◆ Create() [5/8]

bool CSG_Grids::Create	(	const CSG_Grids *	pGrids,
		bool	bCopyData = `false`
	)

virtual

◆ Create() [6/8]

bool CSG_Grids::Create	(	const CSG_String &	FileName,
		bool	bLoadData = `true`
	)

virtual

Definition at line 309 of file grids.cpp.

References Load().

◆ Create() [7/8]

bool CSG_Grids::Create	(	const wchar_t *	FileName,
		bool	bLoadData = `true`
	)

virtual

Definition at line 308 of file grids.cpp.

References Load().

◆ Create() [8/8]

bool CSG_Grids::Create	(	int	NX,
		int	NY,
		int	NZ = `0`,
		double	Cellsize = `0.`,
		double	xMin = `0.`,
		double	yMin = `0.`,
		double	zMin = `0.`,
		TSG_Data_Type	Type = `SG_DATATYPE_Undefined`
	)

virtual

Definition at line 361 of file grids.cpp.

References Create().

◆ Del_Attribute()

bool CSG_Grids::Del_Attribute ( int Field )

Definition at line 513 of file grids.cpp.

References CSG_Table::Del_Field(), and CSG_Table::Get_Field_Count().

◆ Del_Grid()

bool CSG_Grids::Del_Grid	(	int	i,
		bool	bDetach = `false`
	)

Definition at line 785 of file grids.cpp.

References CSG_Table::Del_Record(), CSG_Array_Pointer::Get_Array(), Get_NZ(), CSG_Data_Object::Set_Owner(), SG_Create_Grid(), and SG_FREE_SAFE.

◆ Del_Grids()

bool CSG_Grids::Del_Grids ( bool bDetach = false )

Definition at line 823 of file grids.cpp.

References CSG_Table::Del_Records(), CSG_Array_Pointer::Get_Array(), CSG_Data_Object::Get_Owner(), CSG_Array_Pointer::Get_uSize(), CSG_Data_Object::Set_Owner(), SG_Create_Grid(), and SG_FREE_SAFE.

Referenced by CSG_Parameters_Grid_Target::Get_Grids(), and Set_Grid_Count().

◆ Destroy()

bool CSG_Grids::Destroy ( void )

virtual

Destroys the data space of the CSG_Grids object.

Reimplemented from CSG_Data_Object.

Definition at line 245 of file grids.cpp.

References CSG_Table::Add_Field(), CSG_Data_Object::Destroy(), CSG_Grid::Destroy(), CSG_Table::Destroy(), CSG_Array_Pointer::Get_Array(), CSG_Array_Pointer::Get_uSize(), SG_DATATYPE_Double, and SG_FREE_SAFE.

Referenced by Create(), Load(), and ~CSG_Grids().

◆ Divide()

CSG_Grids & CSG_Grids::Divide ( double Value )

virtual

Definition at line 1053 of file grids.cpp.

References CSG_Grid::Divide(), and Get_Grid_Count().

Referenced by operator/=().

◆ Get_Attributes() [1/2]

CSG_Table_Record& CSG_Grids::Get_Attributes ( int i ) const

inline

Definition at line 227 of file grids.h.

◆ Get_Attributes() [2/2]

const CSG_Table& CSG_Grids::Get_Attributes ( void ) const

inline

Definition at line 224 of file grids.h.

Referenced by Create().

◆ Get_Attributes_Ptr()

CSG_Table* CSG_Grids::Get_Attributes_Ptr ( void )

inline

Definition at line 225 of file grids.h.

◆ Get_Cellarea()

double CSG_Grids::Get_Cellarea ( void ) const

inline

Definition at line 193 of file grids.h.

References Get_Cellarea().

Referenced by Get_Cellarea().

◆ Get_Cellsize()

double CSG_Grids::Get_Cellsize ( void ) const

inline

Definition at line 192 of file grids.h.

References Get_Cellsize().

Referenced by Get_Cellsize(), CSG_Data_Manager::Get_Summary(), and Set_Grid_Count().

◆ Get_Data_Count()

sLong CSG_Grids::Get_Data_Count ( void )

Definition at line 1433 of file grids.cpp.

References CSG_Simple_Statistics::Get_Count(), and CSG_Data_Object::Update().

Referenced by Get_Quantile().

◆ Get_Extent() [1/2]

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

inline

Definition at line 195 of file grids.h.

References Get_Extent().

Referenced by Get_Extent().

◆ Get_Extent() [2/2]

virtual const CSG_Rect& CSG_Grids::Get_Extent ( void )

inlinevirtual

Implements CSG_Data_Object.

Definition at line 183 of file grids.h.

References Get_Extent().

Referenced by Get_Extent(), and Get_Value().

◆ Get_Grid()

const CSG_Grid& CSG_Grids::Get_Grid ( int i ) const

inline

Definition at line 259 of file grids.h.

◆ Get_Grid_Count()

int CSG_Grids::Get_Grid_Count ( void ) const

inline

Definition at line 249 of file grids.h.

Referenced by Add(), Assign(), Assign_NoData(), Divide(), Get_Grid_Name(), Multiply(), Set_Max_Samples(), Set_NoData_Value_Range(), Set_Scaling(), Subtract(), CSG_Parameter_Grid_List::Update_Data(), and Update_Z_Order().

◆ Get_Grid_Name()

CSG_String CSG_Grids::Get_Grid_Name	(	int	i,
		int	Style = `0`
	)		const

Definition at line 861 of file grids.cpp.

References _TL, Get_Grid_Count(), CSG_Data_Object::Get_Name(), Get_Z(), Get_Z_Name_Field(), CSG_String::is_Empty(), CSG_String::Printf(), SG_Get_String(), SG_GRIDS_NAME_GRID, SG_GRIDS_NAME_INDEX, SG_GRIDS_NAME_OWNER, and SG_GRIDS_NAME_VALUE.

Referenced by Update_Z_Order().

◆ Get_Grid_Ptr()

CSG_Grid* CSG_Grids::Get_Grid_Ptr ( int i ) const

inline

Definition at line 260 of file grids.h.

Referenced by CSG_Parameter_Data_Object::_Serialize(), Create(), Set_Max_Samples(), and CSG_Parameter_Grid_List::Update_Data().

◆ Get_Histogram() [1/2]

bool CSG_Grids::Get_Histogram	(	const CSG_Rect &	rWorld,
		CSG_Histogram &	Histogram,
		size_t	nClasses = `0`
	)		const

◆ Get_Histogram() [2/2]

const CSG_Histogram & CSG_Grids::Get_Histogram ( size_t nClasses = 0 )

Returns the histogram for the whole data set. It is automatically updated if necessary.

Definition at line 1582 of file grids.cpp.

References CSG_Histogram::Create(), CSG_Histogram::Destroy(), CSG_Histogram::Get_Class_Count(), CSG_Simple_Statistics::Get_Count(), Get_Max(), CSG_Data_Object::Get_Max_Samples(), Get_Min(), CSG_Histogram::Get_Statistics(), SG_GRID_HISTOGRAM_CLASSES_DEFAULT, and CSG_Data_Object::Update().

Referenced by Get_Quantile().

◆ Get_Max()

double CSG_Grids::Get_Max ( void )

Definition at line 1412 of file grids.cpp.

References CSG_Simple_Statistics::Get_Maximum(), and CSG_Data_Object::Update().

Referenced by Get_Histogram(), and Get_Quantile().

◆ Get_Mean()

double CSG_Grids::Get_Mean ( void )

Definition at line 1402 of file grids.cpp.

References CSG_Simple_Statistics::Get_Mean(), and CSG_Data_Object::Update().

◆ Get_Memory_Size()

sLong CSG_Grids::Get_Memory_Size ( void ) const

inline

Definition at line 263 of file grids.h.

References Get_Memory_Size().

Referenced by Get_Memory_Size().

◆ Get_Min()

double CSG_Grids::Get_Min ( void )

Definition at line 1407 of file grids.cpp.

References CSG_Simple_Statistics::Get_Minimum(), and CSG_Data_Object::Update().

Referenced by Get_Histogram(), and Get_Quantile().

◆ Get_NCells()

sLong CSG_Grids::Get_NCells ( void ) const

inline

Definition at line 188 of file grids.h.

References Get_NCells().

Referenced by CSG_Natural_Breaks::Create(), CSG_Histogram::Create(), Get_NCells(), Get_NoData_Count(), and On_Update().

◆ Get_nLineBytes()

int CSG_Grids::Get_nLineBytes ( void ) const

inline

Definition at line 172 of file grids.h.

◆ Get_NoData_Count()

sLong CSG_Grids::Get_NoData_Count ( void )

Definition at line 1438 of file grids.cpp.

References CSG_Simple_Statistics::Get_Count(), Get_NCells(), and CSG_Data_Object::Update().

◆ Get_nValueBytes()

int CSG_Grids::Get_nValueBytes ( void ) const

inline

Definition at line 171 of file grids.h.

References Get_nValueBytes().

Referenced by Get_nValueBytes().

◆ Get_NX()

int CSG_Grids::Get_NX ( void ) const

inline

Definition at line 185 of file grids.h.

References Get_NX().

Referenced by Get_Histogram(), Get_NX(), Get_Statistics(), and CSG_Data_Manager::Get_Summary().

◆ Get_NY()

int CSG_Grids::Get_NY ( void ) const

inline

Definition at line 186 of file grids.h.

References Get_NY().

Referenced by Get_Histogram(), Get_NY(), Get_Statistics(), and CSG_Data_Manager::Get_Summary().

◆ Get_NZ()

int CSG_Grids::Get_NZ ( void ) const

inline

Definition at line 187 of file grids.h.

Referenced by CSG_Parameter_Data_Object::_Serialize(), Add_Grid(), Create(), Del_Grid(), Get_Histogram(), Get_Statistics(), CSG_Data_Manager::Get_Summary(), is_Compatible(), Set_Grid_Count(), and Set_Z().

◆ Get_ObjectType()

virtual TSG_Data_Object_Type CSG_Grids::Get_ObjectType ( void ) const

inlinevirtual

Data object type information.

Implements CSG_Data_Object.

Definition at line 163 of file grids.h.

References SG_DATAOBJECT_TYPE_Grids.

◆ Get_Offset()

double CSG_Grids::Get_Offset ( void ) const

inline

Definition at line 271 of file grids.h.

Referenced by Get_Histogram(), Get_Statistics(), and On_Update().

◆ Get_Percentile()

double CSG_Grids::Get_Percentile	(	double	Percentile,
		bool	bFromHistogram = `true`
	)

Definition at line 1467 of file grids.cpp.

References Get_Quantile().

◆ Get_Quantile()

double CSG_Grids::Get_Quantile	(	double	Quantile,
		bool	bFromHistogram = `true`
	)

Definition at line 1444 of file grids.cpp.

References asDouble(), Get_Data_Count(), Get_Histogram(), Get_Max(), Get_Min(), CSG_Data_Object::Get_NoData_Value(), and Get_Sorted().

Referenced by Get_Percentile().

◆ Get_Range()

double CSG_Grids::Get_Range ( void )

Definition at line 1417 of file grids.cpp.

References CSG_Simple_Statistics::Get_Range(), and CSG_Data_Object::Update().

◆ Get_Scaling()

double CSG_Grids::Get_Scaling ( void ) const

inline

Definition at line 270 of file grids.h.

References Get_Scaling().

Referenced by Get_Histogram(), Get_Scaling(), Get_Statistics(), and On_Update().

◆ Get_Sorted() [1/3]

sLong CSG_Grids::Get_Sorted	(	sLong	Position,
		bool	bDown = `true`,
		bool	bCheckNoData = `true`
	)

inline

Definition at line 450 of file grids.h.

Referenced by Get_Quantile().

◆ Get_Sorted() [2/3]

bool CSG_Grids::Get_Sorted	(	sLong	Position,
		int &	x,
		int &	y,
		int &	z,
		bool	bDown = `true`,
		bool	bCheckNoData = `true`
	)

inline

Definition at line 470 of file grids.h.

◆ Get_Sorted() [3/3]

bool CSG_Grids::Get_Sorted	(	sLong	Position,
		sLong &	i,
		bool	bDown = `true`,
		bool	bCheckNoData = `true`
	)

inline

Definition at line 465 of file grids.h.

◆ Get_Statistics() [1/2]

bool CSG_Grids::Get_Statistics	(	const CSG_Rect &	rWorld,
		CSG_Simple_Statistics &	Statistics,
		bool	bHoldValues = `false`
	)		const

Calculate statistics for the region specified with rWorld. Returns false, if there is no overlapping. Set bHoldValues to true, if you need to obtain quantiles.

Definition at line 1496 of file grids.cpp.

References asDouble(), CSG_Simple_Statistics::Create(), CSG_Simple_Statistics::Get_Count(), CSG_Data_Object::Get_Max_Samples(), Get_NX(), Get_NY(), Get_NZ(), Get_Offset(), Get_Scaling(), Get_System(), CSG_Rect::Get_XMax(), CSG_Rect::Get_XMin(), CSG_Grid_System::Get_xWorld_to_Grid(), CSG_Rect::Get_YMax(), CSG_Rect::Get_YMin(), CSG_Grid_System::Get_yWorld_to_Grid(), CSG_Data_Object::is_NoData_Value(), and is_Scaled().

◆ Get_Statistics() [2/2]

const CSG_Simple_Statistics & CSG_Grids::Get_Statistics ( void )

Returns the statistics for the whole data set. It is automatically updated if necessary. Statistics give no access to parameters like quantiles that need values to be kept internally. Use Get_Quantile() function instead.

Definition at line 1484 of file grids.cpp.

References CSG_Data_Object::Update().

Referenced by Get_Histogram().

◆ Get_StdDev()

double CSG_Grids::Get_StdDev ( void )

Definition at line 1422 of file grids.cpp.

References CSG_Simple_Statistics::Get_StdDev(), and CSG_Data_Object::Update().

◆ Get_System()

const CSG_Grid_System& CSG_Grids::Get_System ( void ) const

inline

Definition at line 181 of file grids.h.

References Get_System().

Referenced by Add_Grid(), Create(), CSG_Parameters_Grid_Target::Get_Grids(), Get_Histogram(), Get_Statistics(), Get_System(), Get_Value(), is_Compatible(), is_Valid(), and Set_Grid_Count().

◆ Get_Type()

TSG_Data_Type CSG_Grids::Get_Type ( void ) const

inline

Definition at line 169 of file grids.h.

References Get_Type().

Referenced by Add_Grid(), Create(), CSG_Parameters_Grid_Target::Get_Grids(), Get_Type(), and is_Compatible().

◆ Get_Unit()

const SG_Char* CSG_Grids::Get_Unit ( void ) const

inline

Definition at line 175 of file grids.h.

References Get_Unit().

Referenced by Get_Unit().

◆ Get_Value() [1/4]

bool CSG_Grids::Get_Value	(	const TSG_Point_3D &	p,
		double &	Value,
		TSG_Grid_Resampling	Resampling = `GRID_RESAMPLING_BSpline`,
		TSG_Grid_Resampling	ZResampling = `GRID_RESAMPLING_Undefined`
	)		const

Definition at line 1085 of file grids.cpp.

References Get_Value(), SSG_Point_3D::x, SSG_Point_3D::y, and SSG_Point_3D::z.

◆ Get_Value() [2/4]

double CSG_Grids::Get_Value	(	const TSG_Point_3D &	p,
		TSG_Grid_Resampling	Resampling = `GRID_RESAMPLING_BSpline`,
		TSG_Grid_Resampling	ZResampling = `GRID_RESAMPLING_Undefined`
	)		const

Definition at line 1071 of file grids.cpp.

References CSG_Data_Object::Get_NoData_Value(), Get_Value(), SSG_Point_3D::x, SSG_Point_3D::y, and SSG_Point_3D::z.

◆ Get_Value() [3/4]

bool CSG_Grids::Get_Value	(	double	x,
		double	y,
		double	z,
		double &	Value,
		TSG_Grid_Resampling	Resampling = `GRID_RESAMPLING_BSpline`,
		TSG_Grid_Resampling	ZResampling = `GRID_RESAMPLING_Undefined`
	)		const

Definition at line 1091 of file grids.cpp.

References ADD_TO_SPLINE, CSG_Table::Get_Count(), Get_Extent(), Get_System(), CSG_Spline::Get_Value(), Get_Value(), GRID_RESAMPLING_BicubicSpline, GRID_RESAMPLING_Bilinear, GRID_RESAMPLING_BSpline, GRID_RESAMPLING_NearestNeighbour, and GRID_RESAMPLING_Undefined.

◆ Get_Value() [4/4]

double CSG_Grids::Get_Value	(	double	x,
		double	y,
		double	z,
		TSG_Grid_Resampling	Resampling = `GRID_RESAMPLING_BSpline`,
		TSG_Grid_Resampling	ZResampling = `GRID_RESAMPLING_Undefined`
	)		const

Definition at line 1078 of file grids.cpp.

References CSG_Data_Object::Get_NoData_Value().

Referenced by Get_Value().

◆ Get_Variance()

double CSG_Grids::Get_Variance ( void )

Definition at line 1427 of file grids.cpp.

References CSG_Simple_Statistics::Get_Variance(), and CSG_Data_Object::Update().

◆ Get_XMax()

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

inline

Definition at line 198 of file grids.h.

◆ Get_XMin()

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

inline

Definition at line 197 of file grids.h.

Referenced by CSG_Data_Manager::Get_Summary().

◆ Get_XRange()

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

inline

Definition at line 199 of file grids.h.

References Get_XRange().

Referenced by Get_XRange().

◆ Get_YMax()

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

inline

Definition at line 202 of file grids.h.

◆ Get_YMin()

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

inline

Definition at line 201 of file grids.h.

Referenced by CSG_Data_Manager::Get_Summary().

◆ Get_YRange()

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

inline

Definition at line 203 of file grids.h.

References Get_YRange().

Referenced by Get_YRange().

◆ Get_Z()

double CSG_Grids::Get_Z ( int i ) const

inline

Definition at line 240 of file grids.h.

Referenced by Get_Grid_Name().

◆ Get_Z_Attribute()

int CSG_Grids::Get_Z_Attribute ( void ) const

inline

Definition at line 214 of file grids.h.

Referenced by Create().

◆ Get_Z_Name_Field()

int CSG_Grids::Get_Z_Name_Field ( void ) const

Definition at line 499 of file grids.cpp.

References CSG_Table::Get_Field_Count().

Referenced by Create(), and Get_Grid_Name().

◆ Get_ZMax()

double CSG_Grids::Get_ZMax ( bool bCells = false ) const

inline

Definition at line 206 of file grids.h.

Referenced by Set_Grid_Count().

◆ Get_ZMin()

double CSG_Grids::Get_ZMin ( bool bCells = false ) const

inline

Definition at line 205 of file grids.h.

◆ Get_ZRange()

double CSG_Grids::Get_ZRange ( bool bCells = false ) const

inline

Definition at line 207 of file grids.h.

◆ is_Compatible() [1/4]

bool CSG_Grids::is_Compatible ( const CSG_Grid_System & System ) const

Definition at line 456 of file grids.cpp.

References Get_System().

◆ is_Compatible() [2/4]

bool CSG_Grids::is_Compatible ( CSG_Grid * pGrid ) const

Definition at line 446 of file grids.cpp.

References CSG_Grid::Get_System(), CSG_Grid::Get_Type(), and Get_Type().

Referenced by Add_Grid(), and is_Compatible().

◆ is_Compatible() [3/4]

bool CSG_Grids::is_Compatible ( CSG_Grids * pGrids ) const

Definition at line 451 of file grids.cpp.

References Get_NZ(), Get_System(), and is_Compatible().

◆ is_Compatible() [4/4]

bool CSG_Grids::is_Compatible	(	int	NX,
		int	NY,
		double	Cellsize,
		double	xMin,
		double	yMin
	)		const

Definition at line 461 of file grids.cpp.

References is_Compatible().

◆ is_InGrid()

bool CSG_Grids::is_InGrid	(	int	x,
		int	y,
		int	z,
		bool	bCheckNoData = `true`
	)		const

inline

Definition at line 306 of file grids.h.

References is_InGrid().

Referenced by is_InGrid().

◆ is_InGrid_byPos() [1/2]

bool CSG_Grids::is_InGrid_byPos	(	const TSG_Point_3D &	p,
		bool	bCheckNoData = `true`
	)		const

inline

Definition at line 308 of file grids.h.

References is_InGrid_byPos(), SSG_Point_3D::x, SSG_Point_3D::y, and SSG_Point_3D::z.

Referenced by is_InGrid_byPos().

◆ is_InGrid_byPos() [2/2]

bool CSG_Grids::is_InGrid_byPos	(	double	x,
		double	y,
		double	z,
		bool	bCheckNoData = `true`
	)		const

inline

Definition at line 307 of file grids.h.

References CSG_Data_Object::Get_Extent().

◆ is_Intersecting() [1/3]

TSG_Intersection CSG_Grids::is_Intersecting ( const CSG_Rect & Extent ) const

inline

Definition at line 297 of file grids.h.

References is_Intersecting().

Referenced by is_Intersecting().

◆ is_Intersecting() [2/3]

TSG_Intersection CSG_Grids::is_Intersecting ( const TSG_Rect & Extent ) const

inline

Definition at line 298 of file grids.h.

References is_Intersecting().

Referenced by is_Intersecting().

◆ is_Intersecting() [3/3]

TSG_Intersection CSG_Grids::is_Intersecting	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)		const

inline

Definition at line 299 of file grids.h.

References is_Intersecting().

Referenced by is_Intersecting().

◆ is_Modified()

virtual bool CSG_Grids::is_Modified ( void ) const

inlinevirtual

Reimplemented from CSG_Data_Object.

Definition at line 326 of file grids.h.

References CSG_Data_Object::is_Modified().

◆ is_NoData() [1/2]

virtual bool CSG_Grids::is_NoData	(	int	x,
		int	y,
		int	z
	)		const

inlinevirtual

Definition at line 370 of file grids.h.

References CSG_Data_Object::is_NoData_Value().

Referenced by CSG_Natural_Breaks::Create(), and CSG_Histogram::Create().

◆ is_NoData() [2/2]

virtual bool CSG_Grids::is_NoData ( sLong i ) const

inlinevirtual

Definition at line 371 of file grids.h.

References CSG_Data_Object::is_NoData_Value().

◆ is_Scaled()

bool CSG_Grids::is_Scaled ( void ) const

inline

Definition at line 272 of file grids.h.

Referenced by Get_Histogram(), Get_Statistics(), and On_Update().

◆ is_Valid()

bool CSG_Grids::is_Valid ( void ) const

virtual

Implements CSG_Data_Object.

Definition at line 440 of file grids.cpp.

References Get_System().

Referenced by Add_Grid(), Create(), On_Update(), Set_Grid_Count(), and SG_Create_Grids().

◆ Load()

bool CSG_Grids::Load	(	const CSG_String &	File,
		bool	bLoadData = `true`
	)

virtual

Definition at line 1709 of file grids.cpp.

References _TL, CSG_String::c_str(), Destroy(), CSG_String::Format(), Set_Modified(), CSG_Data_Object::Set_Name(), SG_File_Get_Name(), SG_UI_Msg_Add(), SG_UI_MSG_STYLE_FAILURE, SG_UI_MSG_STYLE_SUCCESS, and SG_UI_Process_Set_Ready().

Referenced by Create().

◆ Mul_Value() [1/2]

virtual void CSG_Grids::Mul_Value	(	int	x,
		int	y,
		int	z,
		double	Value
	)

inlinevirtual

Definition at line 418 of file grids.h.

◆ Mul_Value() [2/2]

virtual void CSG_Grids::Mul_Value	(	sLong	i,
		double	Value
	)

inlinevirtual

Definition at line 419 of file grids.h.

◆ Multiply()

CSG_Grids & CSG_Grids::Multiply ( double Value )

virtual

Definition at line 1037 of file grids.cpp.

References Get_Grid_Count(), and CSG_Grid::Multiply().

Referenced by operator*=().

◆ On_Delete()

bool CSG_Grids::On_Delete ( void )

protectedvirtual

Implements CSG_Data_Object.

Definition at line 1683 of file grids.cpp.

References CSG_String::Format(), CSG_Data_Object::Get_File_Name(), SG_File_Delete(), and SG_File_Set_Extension().

◆ On_Reload()

bool CSG_Grids::On_Reload ( void )

protectedvirtual

Implements CSG_Data_Object.

Definition at line 1677 of file grids.cpp.

References Create(), and CSG_Data_Object::Get_File_Name().

◆ On_Update()

bool CSG_Grids::On_Update ( void )

protectedvirtual

Reimplemented from CSG_Data_Object.

Definition at line 1355 of file grids.cpp.

References asDouble(), CSG_Histogram::Destroy(), CSG_Simple_Statistics::Get_Count(), CSG_Data_Object::Get_Max_Samples(), Get_NCells(), Get_Offset(), Get_Scaling(), CSG_Simple_Statistics::Invalidate(), CSG_Data_Object::is_NoData_Value(), is_Scaled(), is_Valid(), CSG_Simple_Statistics::Set_Count(), and SG_FREE_SAFE.

◆ operator()()

virtual double CSG_Grids::operator()	(	int	x,
		int	y,
		int	z
	)		const

inlinevirtual

Definition at line 360 of file grids.h.

◆ operator*=()

CSG_Grids & CSG_Grids::operator*= ( double Value )

virtual

Definition at line 1032 of file grids.cpp.

References Multiply().

◆ operator+=()

CSG_Grids & CSG_Grids::operator+= ( double Value )

virtual

Definition at line 1000 of file grids.cpp.

References Add().

◆ operator-=()

CSG_Grids & CSG_Grids::operator-= ( double Value )

virtual

Definition at line 1016 of file grids.cpp.

References Subtract().

◆ operator/=()

CSG_Grids & CSG_Grids::operator/= ( double Value )

virtual

Definition at line 1048 of file grids.cpp.

References Divide().

◆ operator=() [1/2]

CSG_Grids & CSG_Grids::operator= ( const CSG_Grids & Grids )

virtual

Definition at line 989 of file grids.cpp.

References Create().

◆ operator=() [2/2]

CSG_Grids & CSG_Grids::operator= ( double Value )

virtual

Definition at line 994 of file grids.cpp.

References Assign().

◆ operator[]()

virtual CSG_Grid& CSG_Grids::operator[] ( int i )

inlinevirtual

Definition at line 362 of file grids.h.

◆ Save() [1/3]

virtual bool CSG_Grids::Save	(	const char *	File,
		int	Format = `0`
	)

inlinevirtual

Implements CSG_Data_Object.

Definition at line 156 of file grids.h.

References Save().

Referenced by Save().

◆ Save() [2/3]

bool CSG_Grids::Save	(	const CSG_String &	File,
		int	Format = `0`
	)

virtual

◆ Save() [3/3]

virtual bool CSG_Grids::Save	(	const wchar_t *	File,
		int	Format = `0`
	)

inlinevirtual

Implements CSG_Data_Object.

Definition at line 157 of file grids.h.

References Save().

Referenced by Save().

◆ Set_Attribute() [1/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const char *	Field,
		const char *	Value
	)

Definition at line 538 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [2/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const char *	Field,
		double	Value
	)

Definition at line 547 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [3/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const CSG_String &	Field,
		const CSG_String &	Value
	)

Definition at line 540 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [4/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const CSG_String &	Field,
		double	Value
	)

Definition at line 549 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [5/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const wchar_t *	Field,
		const wchar_t *	Value
	)

Definition at line 539 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [6/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		const wchar_t *	Field,
		double	Value
	)

Definition at line 548 of file grids.cpp.

References CSG_Table::Get_Field(), and Set_Attribute().

◆ Set_Attribute() [7/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		int	Field,
		const CSG_String &	Value
	)

Definition at line 541 of file grids.cpp.

References CSG_Table::Get_Count(), and CSG_Table::Set_Value().

Referenced by Set_Attribute().

◆ Set_Attribute() [8/8]

bool CSG_Grids::Set_Attribute	(	int	i,
		int	Field,
		double	Value
	)

Definition at line 550 of file grids.cpp.

References CSG_Table::Get_Count(), and CSG_Table::Set_Value().

◆ Set_Grid_Count()

bool CSG_Grids::Set_Grid_Count ( int Count )

Definition at line 603 of file grids.cpp.

References Add_Grid(), Del_Grids(), CSG_Array_Pointer::Get_Array(), Get_Cellsize(), Get_NZ(), Get_System(), Get_ZMax(), is_Valid(), CSG_Table::Set_Count(), and SG_FREE_SAFE.

◆ Set_Index()

bool CSG_Grids::Set_Index ( bool bOn = true )

inline

Definition at line 438 of file grids.h.

References SG_FREE_SAFE.

◆ Set_Max_Samples()

bool CSG_Grids::Set_Max_Samples ( sLong Max_Samples )

virtual

Reimplemented from CSG_Data_Object.

Definition at line 1559 of file grids.cpp.

References Get_Grid_Count(), Get_Grid_Ptr(), and CSG_Data_Object::Set_Max_Samples().

◆ Set_Modified()

virtual void CSG_Grids::Set_Modified ( bool bModified = true )

inlinevirtual

Reimplemented from CSG_Data_Object.

Definition at line 314 of file grids.h.

References CSG_Data_Object::Set_Modified(), and CSG_Data_Object::Set_Update_Flag().

Referenced by Load(), and Save().

◆ Set_NoData() [1/2]

virtual void CSG_Grids::Set_NoData	(	int	x,
		int	y,
		int	z
	)

inlinevirtual

Definition at line 373 of file grids.h.

References CSG_Data_Object::Get_NoData_Value().

◆ Set_NoData() [2/2]

virtual void CSG_Grids::Set_NoData ( sLong i )

inlinevirtual

Definition at line 374 of file grids.h.

References CSG_Data_Object::Get_NoData_Value().

◆ Set_NoData_Value_Range()

bool CSG_Grids::Set_NoData_Value_Range	(	double	loValue,
		double	hiValue
	)

virtual

Reimplemented from CSG_Data_Object.

Definition at line 393 of file grids.cpp.

References Get_Grid_Count(), and CSG_Data_Object::Set_NoData_Value_Range().

Referenced by Create().

◆ Set_Scaling()

void CSG_Grids::Set_Scaling	(	double	Scale = `1.`,
		double	Offset = `0.`
	)

Definition at line 380 of file grids.cpp.

References Get_Grid_Count(), CSG_Grid::Set_Scaling(), and CSG_Data_Object::Set_Update_Flag().

◆ Set_Unit()

void CSG_Grids::Set_Unit ( const CSG_String & Unit )

Definition at line 374 of file grids.cpp.

References CSG_Grid::Set_Unit().

◆ Set_Value() [1/2]

virtual void CSG_Grids::Set_Value	(	int	x,
		int	y,
		int	z,
		double	Value,
		bool	bScaled = `true`
	)

inlinevirtual

Definition at line 429 of file grids.h.

◆ Set_Value() [2/2]

virtual void CSG_Grids::Set_Value	(	sLong	i,
		double	Value,
		bool	bScaled = `true`
	)

inlinevirtual

Definition at line 422 of file grids.h.

Referenced by Set_Z().

◆ Set_Z()

bool CSG_Grids::Set_Z	(	int	i,
		double	Value
	)

Definition at line 556 of file grids.cpp.

References Get_NZ(), and Set_Value().

◆ Set_Z_Attribute()

bool CSG_Grids::Set_Z_Attribute ( int Field )

Definition at line 474 of file grids.cpp.

References CSG_Table::Get_Field_Count(), and Update_Z_Order().

Referenced by Create().

◆ Set_Z_Name_Field()

bool CSG_Grids::Set_Z_Name_Field ( int Field )

Definition at line 487 of file grids.cpp.

References CSG_Table::Get_Field_Count().

Referenced by Create().

◆ Subtract()

CSG_Grids & CSG_Grids::Subtract ( double Value )

virtual

Definition at line 1021 of file grids.cpp.

References Get_Grid_Count(), and CSG_Grid::Subtract().

Referenced by operator-=().

◆ Update_Z_Order()

bool CSG_Grids::Update_Z_Order ( void )

Definition at line 562 of file grids.cpp.

References CSG_Table::Assign(), CSG_Array_Pointer::Create(), Get_Grid_Count(), Get_Grid_Name(), CSG_Table::Set_Index(), CSG_Data_Object::Set_Name(), and TABLE_INDEX_Ascending.

Referenced by Add_Grid(), and Set_Z_Attribute().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSG_Grids() [1/9]

◆ ~CSG_Grids()

◆ CSG_Grids() [2/9]

◆ CSG_Grids() [3/9]

◆ CSG_Grids() [4/9]

◆ CSG_Grids() [5/9]

◆ CSG_Grids() [6/9]

◆ CSG_Grids() [7/9]

◆ CSG_Grids() [8/9]

◆ CSG_Grids() [9/9]

Member Function Documentation

◆ Add()

◆ Add_Attribute() [1/3]

◆ Add_Attribute() [2/3]

◆ Add_Attribute() [3/3]

◆ Add_Grid() [1/4]

◆ Add_Grid() [2/4]

◆ Add_Grid() [3/4]

◆ Add_Grid() [4/4]

◆ Add_Value() [1/2]

◆ Add_Value() [2/2]

◆ asByte() [1/2]

◆ asByte() [2/2]

◆ asChar() [1/2]

◆ asChar() [2/2]

◆ asDouble() [1/2]

◆ asDouble() [2/2]

◆ asFloat() [1/2]

◆ asFloat() [2/2]

◆ asInt() [1/2]

◆ asInt() [2/2]

◆ asLong() [1/2]

◆ asLong() [2/2]

◆ asShort() [1/2]

◆ asShort() [2/2]

◆ Assign() [1/3]

◆ Assign() [2/3]

◆ Assign() [3/3]

◆ Assign_NoData()

◆ Create() [1/8]

◆ Create() [2/8]

◆ Create() [3/8]

◆ Create() [4/8]

◆ Create() [5/8]

◆ Create() [6/8]

◆ Create() [7/8]

◆ Create() [8/8]

◆ Del_Attribute()

◆ Del_Grid()

◆ Del_Grids()

◆ Destroy()

◆ Divide()

◆ Get_Attributes() [1/2]

◆ Get_Attributes() [2/2]

◆ Get_Attributes_Ptr()

◆ Get_Cellarea()

◆ Get_Cellsize()

◆ Get_Data_Count()

◆ Get_Extent() [1/2]

◆ Get_Extent() [2/2]

◆ Get_Grid()

◆ Get_Grid_Count()

◆ Get_Grid_Name()

◆ Get_Grid_Ptr()

◆ Get_Histogram() [1/2]

◆ Get_Histogram() [2/2]

◆ Get_Max()

◆ Get_Mean()

◆ Get_Memory_Size()

◆ Get_Min()

◆ Get_NCells()

◆ Get_nLineBytes()

◆ Get_NoData_Count()

◆ Get_nValueBytes()

◆ Get_NX()