mathematical commands for surfaces
[commands for surfaces]


Modules

 wavelet commands for surfaces

Functions

bool surfit::surf_plus_area (const char *surface1_name_or_position, const char *area_name_or_position, const char *surface2_name_or_position)
REAL surfit::surf_getValue (REAL x, REAL y, const char *surface_name_or_position="0")
REAL surfit::surf_getValueIJ (int I, int J, const char *surface_name_or_position="0")
bool surfit::surf_resid (const char *filename, const char *surface_name_or_position="0", const char *points_name_or_position="0")
REAL surfit::surf_D1 (const char *surface_name_or_position="0")
REAL surfit::surf_D2 (const char *surface_name_or_position="0")
bool surfit::surf_gradient (const char *newname, const char *surface_name_or_position="0")
bool surfit::surf_project (const char *newname, const char *surface_name_or_position="0")
bool surfit::surf_add_noise (REAL std, const char *surface_name_or_position="0")
REAL surfit::surf_minz (const char *surface_name_or_position="0")
REAL surfit::surf_area_minz (const char *area_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_maxz (const char *surface_name_or_position="0")
REAL surfit::surf_area_maxz (const char *area_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_mean (const char *surface_name_or_position="0")
REAL surfit::surf_area_mean (const char *area_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_mask_mean (const char *mask_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_wmean (const char *wsurface_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_area_wmean (const char *area_name_or_position="0", const char *wsurface_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_mask_wmean (const char *mask_name_or_position="0", const char *wsurface_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_sum (const char *surface_name_or_position="0")
REAL surfit::surf_sum_area (const char *area_name_or_position="0", const char *surface_name_or_position="0")
int surfit::surf_cells_in_area (const char *area_name_or_position="0", const char *surface_name_or_position="0")
REAL surfit::surf_std (REAL mean, const char *surface_name_or_position="0")
bool surfit::surf_plus (const char *surface1_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_minus (const char *surface1_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_minus_area (const char *surface1_name_or_position, const char *area_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_mult (const char *surface1_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_mult_area (const char *surface1_name_or_position, const char *area_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_div (const char *surface1_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_div_area (const char *surface1_name_or_position, const char *area_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_set (const char *surface1_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_set_area (const char *surface1_name_or_position, const char *area_name_or_position, const char *surface2_name_or_position)
bool surfit::surf_plus_value (REAL val, const char *surface_name_or_position="0")
bool surfit::surf_plus_value_area (REAL val, const char *surface_name_or_position="0", const char *area_name_or_position="0")
bool surfit::surf_minus_value (REAL val, const char *surface_name_or_position="0")
bool surfit::surf_minus_value_area (REAL val, const char *area_name_or_position="0", const char *surface_name_or_position="0")
bool surfit::surf_mult_value (REAL val, const char *surface_name_or_position="0")
bool surfit::surf_mult_value_area (REAL val, const char *area_name_or_position="0", const char *surface_name_or_position="0")
bool surfit::surf_div_value (REAL val, const char *surface_name_or_position="0")
bool surfit::surf_div_value_area (REAL val, const char *area_name_or_position="0", const char *surface_name_or_position="0")
bool surfit::surf_set_value (REAL val, const char *surface_name_or_position="0")
bool surfit::surf_set_value_area (const char *val, const char *area_name_or_position="0", const char *surface_name_or_position="0")

Function Documentation

bool surf_add_noise (  REAL  std,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_add_noise std "surface_name_or_position"
Description:
adds normally-distributed noise with parameters N(0,std) to coeff
Parameters:
std standart deviation
surface_name_or_position name of surface dataset, or surface position number

REAL surf_area_maxz (  const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_area_maxz "area_name_or_position" "surface_name_or_position"
Description:
returns maximum value for surface in area
Parameters:
area_name_or_position name of area dataset, or area position number
surface_name_or_position name of surface dataset, or surface position number
Examples:
area_ineq.tcl.

REAL surf_area_mean (  const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_area_mean "area_name_or_position" "surface_name_or_position"
Description:
returns mean value for surface in area
Parameters:
area_name_or_position name of area dataset, or area position number
surface_name_or_position name of surface dataset, or surface position number
Examples:
area_mean.tcl.

REAL surf_area_minz (  const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_area_minz "area_name_or_position" "surface_name_or_position"
Description:
returns minimum value for surface in area
Parameters:
area_name_or_position name of area dataset, or area position number
surface_name_or_position name of surface dataset, or surface position number

REAL surf_area_wmean (  const char *  area_name_or_position = "0",
const char *  wsurface_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_area_wmean "area_name_or_position" "wsurface_name_or_position" "surface_name_or_position"
Description:
returns weighted mean value for surface in area
Parameters:
area_name_or_position name of area dataset, or area position number
wsurface_name_or_position name of weighting surface dataset, or surface position number
surface_name_or_position name of surface dataset, or surface position number
Examples:
area_wmean.tcl.

int surf_cells_in_area (  const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_cells_in_area "area_name_or_position" "surface_name_or_position"
Description:
returns number of cells in area
Parameters:
area_name_or_position name of area dataset, or area position number
surface_name_or_position name of surface dataset, or surface position number

REAL surf_D1 (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_D1 "surface_name_or_position"
Description:
calculates value of $ \int\limits_\Omega \left[ f_x^2 + f_y^2 \right] dx dy $ for surface, where f is a surface.
Parameters:
surface_name_or_position name of surface dataset, or surface position number

REAL surf_D2 (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_D2 "surface_name_or_position"
Description:
calculates value of $ \int\limits_\Omega \left[ f_{xx}^2 + 2f_{xy}^2 + f_{yy}^2 \right] dx dy $ for surface, where f is a surface.
Parameters:
surface_name_or_position name of surface dataset, or surface position number

bool surf_div (  const char *  surface1_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_mult "surface1_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values: surface1 = surface1 / surface2

bool surf_div_area (  const char *  surface1_name_or_position,
const char *  area_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_div_area "surface1_name_or_position" "area_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface1 = surface1 / surface2

bool surf_div_value (  REAL  val,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_div_value val "surface_name_or_position"
Description:
Performs operation with surfaces cells values: surface = surface / val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number

bool surf_div_value_area (  REAL  val,
const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_div_value_area val "area_name_or_position" "surface_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface = surface / val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
area_name_or_position name of area dataset, or area position number

REAL surf_getValue (  REAL  x,
REAL  y,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_getValue x y "surface_name_or_position"
Description:
calculates surface value at point (x,y)
Parameters:
x point x-coordinate
y point y-coordinate
surface_name_or_position name of surface dataset, or surface position number.

REAL surf_getValueIJ (  int  I,
int  J,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_getValueIJ I J "surface_name_or_position"
Description:
returns surface value at node (I,J)
Parameters:
I node number in X direction
J node number in Y direction
surface_name_or_position name of surface dataset, or surface position number.

bool surf_gradient (  const char *  newname,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_gradient "newname" "surface_name_or_position"
Description:
calculates surface of "gradients lengths" for surface and saves result to new surface named "newname"
Parameters:
newname name for resulting surface
surface_name_or_position name of surface dataset, or surface position number

REAL surf_mask_mean (  const char *  mask_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_mask_mean "mask_name_or_position" "surface_name_or_position"
Description:
returns mean value for surface where mask is "true"
Parameters:
mask_name_or_position name of mask dataset, or mask position number
surface_name_or_position name of surface dataset, or surface position number

REAL surf_mask_wmean (  const char *  mask_name_or_position = "0",
const char *  wsurface_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_mask_wmean "mask_name_or_position" "wsurface_name_or_position" "surface_name_or_position"
Description:
returns weighted mean value for surface where mask is "true"
Parameters:
mask_name_or_position name of mask dataset, or mask position number
wsurface_name_or_position name of weighting surface dataset, or surface position number
surface_name_or_position name of surface dataset, or surface position number
Examples:
mask_wmean.tcl.

REAL surf_maxz (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_maxz "surface_name_or_position"
Description:
returns maximum value for surface
Parameters:
surface_name_or_position name of surface dataset, or surface position number

REAL surf_mean (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_mean "surface_name_or_position"
Description:
returns mean value for surface
Parameters:
surface_name_or_position name of surface dataset, or surface position number
Examples:
area_mean.tcl, and mean.tcl.

bool surf_minus (  const char *  surface1_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_minus "surface1_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values: surface1 = surface1 - surface2

bool surf_minus_area (  const char *  surface1_name_or_position,
const char *  area_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_minus_area "surface1_name_or_position" "area_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface1 = surface1 - surface2

bool surf_minus_value (  REAL  val,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_minus_value val "surface_name_or_position"
Description:
Performs operation with surfaces cells values: surface = surface - val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number

bool surf_minus_value_area (  REAL  val,
const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_minus_value_area val "area_name_or_position" "surface_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface = surface - val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
area_name_or_position name of area dataset, or area position number

REAL surf_minz (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_minz "surface_name_or_position"
Description:
returns minimum value for surface
Parameters:
surface_name_or_position name of surface dataset, or surface position number

bool surf_mult (  const char *  surface1_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_mult "surface1_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values: surface1 = surface1 * surface2

bool surf_mult_area (  const char *  surface1_name_or_position,
const char *  area_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_mult_area "surface1_name_or_position" "area_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface1 = surface1 * surface2

bool surf_mult_value (  REAL  val,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_mult_value val "surface_name_or_position"
Description:
Performs operation with surfaces cells values: surface = surface * val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number

bool surf_mult_value_area (  REAL  val,
const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_mult_value_area val "area_name_or_position" "surface_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface = surface * val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
area_name_or_position name of area dataset, or area position number

bool surf_plus (  const char *  surface1_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_plus "surface1_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values: surface1 = surface1 + surface2

bool surfit::surf_plus_area (  const char *  surface1_name_or_position,
const char *  area_name_or_position,
const char *  surface2_name_or_position
) 
 

bool surf_plus_area(const char * surface1_name_or_position, const char * area_name_or_position, const char * surface2_name_or_position);

Tcl syntax:
surf_plus_area "surface1_name_or_position" "area_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface1 = surface1 + surface2

bool surf_plus_value (  REAL  val,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_plus_value val "surface_name_or_position"
Description:
Performs operation with surfaces cells values: surface = surface + val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
Examples:
surface_ineq.tcl.

bool surf_plus_value_area (  REAL  val,
const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_plus_value_area val "area_name_or_position" "surface_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface = surface + val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
area_name_or_position name of area dataset, or area position number

bool surf_project (  const char *  newname,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_project "newname" "surface_name_or_position"
Description:
recalculates surface on current grid using bilinear interpolation algorithm
Parameters:
newname name for resulting surface
surface_name_or_position name of surface dataset, or surface position number

bool surf_resid (  const char *  filename,
const char *  surface_name_or_position = "0",
const char *  points_name_or_position = "0"
) 
 

Tcl syntax:
surf_resid "filename" "surface_name_or_position" "points_name_or_position"
Description:
calculates residuals between points values and surface values, calculated at points (x,y) coordinates. Saves result to text file.
Parameters:
filename text file with residuals
points_name_or_position name of points dataset, or points position number
surface_name_or_position name of surface dataset, or surface position number

bool surf_set (  const char *  surface1_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_set "surface1_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values: surface1 = surface2

bool surf_set_area (  const char *  surface1_name_or_position,
const char *  area_name_or_position,
const char *  surface2_name_or_position
) 
 

Tcl syntax:
surf_set_area "surface1_name_or_position" "area_name_or_position" "surface2_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface1 = surface2

bool surf_set_value (  REAL  val,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_set_value val "surface_name_or_position"
Description:
Performs operation with surfaces cells values: surface = val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number

bool surf_set_value_area (  const char *  val,
const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_set_value_area val "area_name_or_position" "surface_name_or_position"
Description:
Performs operation with surfaces cells values for cells in area: surface = val
Parameters:
val real number
surface_name_or_position name of surface dataset, or surface position number
area_name_or_position name of area dataset, or area position number

REAL surf_std (  REAL  mean,
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_std mean "surface_name_or_position"
Description:
calculates standard deviation for surface cells values with respect to surface mean value
Parameters:
mean surface mean value
surface_name_or_position name of surface dataset, or surface position number

REAL surf_sum (  const char *  surface_name_or_position = "0"  ) 
 

Tcl syntax:
surf_sum "surface_name_or_position"
Description:
returns sum of all surface cell values
Parameters:
surface_name_or_position name of surface dataset, or surface position number

REAL surf_sum_area (  const char *  area_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_sum_area "area_name_or_position" "surface_name_or_position"
Description:
returns sum of all surface cells values in area
Parameters:
area_name_or_position name of area dataset, or area position number
surface_name_or_position name of surface dataset, or surface position number

REAL surf_wmean (  const char *  wsurface_name_or_position = "0",
const char *  surface_name_or_position = "0"
) 
 

Tcl syntax:
surf_wmean "wsurface_name_or_position" "surface_name_or_position"
Description:
returns weighted mean value for surface
Parameters:
wsurface_name_or_position name of weighting surface dataset, or surface position number
surface_name_or_position name of surface dataset, or surface position number
Examples:
wmean.tcl.


surfit: open source gridding and contouring software.