commands for areas saving and loading
[commands for areas]


Functions

bool surfit::area_read (const char *filename, const char *areaname=NULL, int col1=1, int col2=2, const char *delimiter=" ", int skip_lines=0, int grow_by=250)
bool surfit::area_load (const char *filename, const char *area_name=NULL)
bool surfit::area_write (const char *filename, const char *area_name_or_position="0", const char *delimiter="\t")
bool surfit::area_save (const char *filename, const char *area_name_or_position="0")
bool surfit::area_load_bln (const char *filename, const char *areaname=NULL)
bool surfit::area_load_shp (const char *filename, const char *area_name=NULL)
bool surfit::areas_load_shp (const char *filename)
bool surfit::area_save_bln (const char *filename, const char *area_name_or_position="0", int flag=1)
bool surfit::area_save_shp (const char *filename, const char *area_name_or_position="0")

Function Documentation

bool area_load (  const char *  filename,
const char *  area_name = NULL
) 
 

Tcl syntax:
area_load "filename" "area_name"
Description:
loads area from surfit datafile. if no areaname specified, then loads the first area in the file.
Parameters:
filename surfit datafile filename
area_name area name for load
Example
area_load "C:\\area.dat" my_area

bool area_load_bln (  const char *  filename,
const char *  areaname = NULL
) 
 

Tcl syntax:
area_load_bln "filename" "area_name"
Description:
loads area from Surfer BLN files and sets its name to "areaname"
Example
area_load_bln "C:\\area.bln" area_from_bln
Implemented in library:
libsurfit_io

bool area_load_shp (  const char *  filename,
const char *  area_name = NULL
) 
 

Tcl syntax:
area_load_shp "filename" "area_name"
Description:
loads area named "area_name" from ERSI shape file.
Parameters:
filename ERSI shape file name
area_name area name for load
Example
area_load_shp "C:\\area.shp" my_area
Implemented in library:
libsurfit_io

bool area_read (  const char *  filename,
const char *  areaname = NULL,
int  col1 = 1,
int  col2 = 2,
const char *  delimiters = " ",
int  skip_lines = 0,
int  grow_by = 250
) 
 

Tcl syntax:
area_read "filename" "area_name" first_column_position second_column_position "delimiters" skip_lines
Description:
reads area from formatted text file and sets its name to "areaname"
Parameters:
filename name of formatted text file
areaname name for area dataset
col1 column with X coordinates
col2 column with Y coordinates
skip_lines number of lines to skip header
delimiters delimiters between columns. May be " ", "\t", "," or other symbols
grow_by =250
Example
area_read "C:\\area.txt" my_area area_read "C:\\area2.txt" my_area2 2 3 "\t"
Examples:
area.tcl, area_completer.tcl, area_ineq.tcl, area_mean.tcl, area_surf.tcl, area_surf_ineq.tcl, area_wmean.tcl, canyon_prepare.tcl, flow_area.tcl, map_hor_frac.tcl, and map_ver_frac.tcl.

bool area_save (  const char *  filename,
const char *  area_name_or_position = "0"
) 
 

Tcl syntax:
area_save "filename" "area_name_or_position"
Description:
saves area to surfit datafile
Parameters:
filename Surfer BLN file
area_name_or_position area name, or area position number
Example
area_save "C:\\area.dat" my_area

bool area_save_bln (  const char *  filename,
const char *  area_name_or_position = "0",
int  orient = 1
) 
 

Tcl syntax:
area_save_bln "filename" "area_name_or_position" orient
Description:
saves area to Surfer BLN file
Parameters:
filename name for BLN file
area_name_or_position area name, or area position number
orient This value is equal to 1 if the region is inside area and equal to 0 if the region is outside area
Example
area_save_bln "C:\\area.bln" my_area 1
Implemented in library:
libsurfit_io

bool area_save_shp (  const char *  filename,
const char *  area_name_or_position = "0"
) 
 

Tcl syntax:
area_save_shp "filename" "area_name_or_position"
Description:
saves area to ERSI shape file
Parameters:
filename ERSI shape file name
area_name_or_position area name, or area position number
Example
area_save_shp "C:\\area.shp" my_area
Implemented in library:
libsurfit_io

bool area_write (  const char *  filename,
const char *  area_name_or_position = "0",
const char *  delimiter = "\t"
) 
 

Tcl syntax:
area_write "filename" "area_name_or_position" "delimiter"
Description:
writes area to formatted text file
Parameters:
filename text file filename
area_name_or_position area name, or area position number
delimiter delimiter between columns. May be " ", "\t", "," or other symbols
Example
area_write "C:\\area.txt" my_area

bool areas_load_shp (  const char *  filename  ) 
 

Tcl syntax:
areas_load_shp "filename"
Description:
loads all areas from ERSI shape file.
Parameters:
filename ERSI shape file name
Example
areas_load_shp "C:\\area.shp"
Implemented in library:
libsurfit_io


surfit: open source gridding and contouring software.