SAGA API  v9.6
grids.h File Reference
#include "grid.h"

Go to the source code of this file.

Classes

class  CSG_Grids
 

Macros

#define SG_GRIDS_NAME_OWNER   0x01
 
#define SG_GRIDS_NAME_INDEX   0x02
 
#define SG_GRIDS_NAME_VALUE   0x04
 
#define SG_GRIDS_NAME_GRID   0x08
 
#define SG_GRIDS_PTR_SAFE_SET_NODATA(g, x, y, z)   { if( g && g->is_InGrid(x, y, z, false) ) { g->Set_NoData(x, y, z ); } }
 
#define SG_GRIDS_PTR_SAFE_SET_VALUE(g, x, y, z, v)   { if( g && g->is_InGrid(x, y, z, false) ) { g->Set_Value (x, y, z, v); } }
 

Enumerations

enum  TSG_Grids_File_Format { GRIDS_FILE_FORMAT_Undefined = 0, GRIDS_FILE_FORMAT_Normal, GRIDS_FILE_FORMAT_Compressed, GRIDS_FILE_FORMAT_GeoTIFF }
 

Functions

SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (void)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const CSG_Grids &Grids)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const CSG_Grids *pGrids, bool bCopyData=false)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const char *FileName, bool bLoadData=true)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const wchar_t *FileName, bool bLoadData=true)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const CSG_String &FileName, bool bLoadData=true)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const CSG_Grid_System &System, int NZ=0, double zMin=0., TSG_Data_Type Type=SG_DATATYPE_Undefined)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_Grids (const CSG_Grid_System &System, const CSG_Table &Attributes, int zAttribute=0, TSG_Data_Type Type=SG_DATATYPE_Undefined, bool bCreateGrids=false)
 
SAGA_API_DLL_EXPORT CSG_GridsSG_Create_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)
 

Detailed Description

Classes for multi-dimensional raster data management, so called grid collections.

See also
CSG_Data_Object
CSG_Grid_System
CSG_Grid
CSG_Grids

Definition in file grids.h.

Macro Definition Documentation

◆ SG_GRIDS_NAME_GRID

#define SG_GRIDS_NAME_GRID   0x08

Definition at line 103 of file grids.h.

◆ SG_GRIDS_NAME_INDEX

#define SG_GRIDS_NAME_INDEX   0x02

Definition at line 101 of file grids.h.

◆ SG_GRIDS_NAME_OWNER

#define SG_GRIDS_NAME_OWNER   0x01

Definition at line 100 of file grids.h.

◆ SG_GRIDS_NAME_VALUE

#define SG_GRIDS_NAME_VALUE   0x04

Definition at line 102 of file grids.h.

◆ SG_GRIDS_PTR_SAFE_SET_NODATA

#define SG_GRIDS_PTR_SAFE_SET_NODATA (   g,
  x,
  y,
 
)    { if( g && g->is_InGrid(x, y, z, false) ) { g->Set_NoData(x, y, z ); } }

Definition at line 573 of file grids.h.

◆ SG_GRIDS_PTR_SAFE_SET_VALUE

#define SG_GRIDS_PTR_SAFE_SET_VALUE (   g,
  x,
  y,
  z,
 
)    { if( g && g->is_InGrid(x, y, z, false) ) { g->Set_Value (x, y, z, v); } }

Definition at line 574 of file grids.h.

Enumeration Type Documentation

◆ TSG_Grids_File_Format

Enumerator
GRIDS_FILE_FORMAT_Undefined 
GRIDS_FILE_FORMAT_Normal 
GRIDS_FILE_FORMAT_Compressed 
GRIDS_FILE_FORMAT_GeoTIFF 

Definition at line 90 of file grids.h.

Function Documentation

◆ SG_Create_Grids() [1/9]

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

Safe construction of a grid collection

Definition at line 87 of file grids.cpp.

References SG_Create_Grids().

◆ SG_Create_Grids() [2/9]

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

Safe construction of a grid collection

Definition at line 105 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [3/9]

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

Safe construction of a grid collection

Definition at line 97 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [4/9]

SAGA_API_DLL_EXPORT CSG_Grids* SG_Create_Grids ( const CSG_Grids Grids)

Safe construction of a grid collection

Definition at line 71 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [5/9]

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

Safe construction of a grid collection

Definition at line 79 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [6/9]

SAGA_API_DLL_EXPORT CSG_Grids* SG_Create_Grids ( const CSG_String FileName,
bool  bLoadData = true 
)

Safe construction of a grid collection

Definition at line 89 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [7/9]

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

Safe construction of a grid collection

Definition at line 88 of file grids.cpp.

References SG_Create_Grids().

◆ SG_Create_Grids() [8/9]

SAGA_API_DLL_EXPORT CSG_Grids* SG_Create_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 
)

Safe construction of a grid collection

Definition at line 113 of file grids.cpp.

References CSG_Grids::is_Valid().

◆ SG_Create_Grids() [9/9]

SAGA_API_DLL_EXPORT CSG_Grids* SG_Create_Grids ( void  )

Safe construction of a grid collection

Definition at line 65 of file grids.cpp.

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