Functions
for masks
surfit gridding rules

Functions

boolvec * mask (const char *val, const char *mask_name="*")
 
boolvec * mask_add (REAL val, REAL weight=1, const char *mask_name="*")
 
boolvec * mask_leq (REAL value, const char *mask_name="*", REAL penalty_factor=0)
 
boolvec * mask_geq (REAL value, const char *mask_name="*", REAL penalty_factor=0)
 
boolvec * mask_surf (const char *surf_name="*", const char *mask_name="*")
 
boolvec * mask_surf_add (const char *surf_name="*", REAL weight=1, const char *mask_name="*")
 
boolvec * mask_surf_leq (const char *surf_name="*", const char *mask_name="*", REAL penalty_factor=0)
 
boolvec * mask_surf_geq (const char *surf_name="*", const char *mask_name="*", REAL penalty_factor=0)
 
boolvec * mask_mean (REAL mean, const char *mask_name="*", REAL penalty_factor=-2)
 
boolvec * mask_wmean (REAL mean, const char *mask_name="*", const char *surf_name="*", REAL penalty_factor=-2)
 
boolvec * mask_completer (const char *mask_name="*", REAL D1=1, REAL D2=2, REAL alpha=0, REAL w=1)
 
boolvec * mask_completer_add (REAL weight=1, const char *mask_name="*", REAL D1=1, REAL D2=2, REAL alpha=0, REAL w=1)
 

Detailed Description

Function Documentation

boolvec* surfit::mask ( const char *  val,
const char *  mask_name = "*" 
)
Tcl syntax:
mask val "surface_name"
Description:
Using this rule the resulting surface approximates cells where mask is true with constant real number. In case val is equal to word "undef", resulting surface would have "undefined values" for cells where mask is true.
Parameters
valreal number or word "undef" for approximation.
mask_namename of mask dataset
Math:
This command adds the following functional to the functional sequence:

\[ \Phi(u_{1,1},\ldots,u_{N,M}) = \sum_{i,j} \left( u_{i,j} - z \right)^2, \]

where (i,j) - indices of the cells where mask is true, z - constant real number.
boolvec* surfit::mask_add ( REAL  val,
REAL  weight = 1,
const char *  mask_name = "*" 
)
Tcl syntax:
mask_add val weight "surface_name"
Description:
This function modifies previous (modifiable) rule by adding the mask rule with some weight.
Parameters
valreal number for approximation.
weightinformational weight for mask rule
mask_namename of mask dataset
boolvec* surfit::mask_completer ( const char *  mask_name = "*",
REAL  D1 = 1,
REAL  D2 = 2,
REAL  alpha = 0,
REAL  w = 1 
)
Tcl syntax:
mask_completer "mask_name" D1 D2 alpha w
Description
This rule implements completer rule where mask is true
Parameters
mask_namemask name
D1weight coefficient for rule that the resulting surface should tend to constant surface
D2weight coefficient for rule that the resulting surface should tend to plane surface
alphaanisotropy angle (degrees)
wanisotropy factor
boolvec* surfit::mask_completer_add ( REAL  weight = 1,
const char *  mask_name = "*",
REAL  D1 = 1,
REAL  D2 = 2,
REAL  alpha = 0,
REAL  w = 1 
)
Tcl syntax:
mask_completer_add weight "mask_name" D1 D2 alpha w inside
Description
This rule adds rule mask_completer with informational "weight" to the previous rule.
Parameters
mask_namename of a mask object
weightinformational weight for mask gridding rule
D1weight coefficient for rule that the resulting surface should tend to constant surface
D2weight coefficient for rule that the resulting surface should tend to plane surface
alphaanisotropy angle (degrees)
wanisotropy factor
boolvec* surfit::mask_geq ( REAL  value,
const char *  mask_name = "*",
REAL  penalty_factor = 0 
)
Tcl syntax:
mask_geq value "mask_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface should be greater than or equal to value where mask is true".
Parameters
valueresulting surface values should be greater than or equal to this real number
mask_namename of mask dataset
penalty_factorparameter for penalty algorithm
Math:
This command adds the condition:

\[ u_{i,j} \geq z, \]

where (i,j) - indices of the cells where mask is true, z - constant value
See Also
mask_leq area_leq area_geq
boolvec* surfit::mask_leq ( REAL  value,
const char *  mask_name = "*",
REAL  penalty_factor = 0 
)
Tcl syntax:
mask_leq value "mask_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface should be lower than or equal to value where mask is true".
Parameters
valueresulting surface values should be lower than or equal to this real number
mask_namename of mask dataset
penalty_factorparameter for penalty algorithm
Math:
This command adds the condition:

\[ u_{i,j} \leq z, \]

where (i,j) - indices of the cells where mask is true, z - constant value
boolvec* surfit::mask_mean ( REAL  mean,
const char *  mask_name = "*",
REAL  penalty_factor = -2 
)
Tcl syntax:
mask_mean mean_value "mask_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface mean value should be equal to real number where mask is true".
Math:
This command adds the condition:

\[ \frac {\sum\limits_{i,j} u_{i,j}} {Q} = m \]

where (i,j) - indices of the cells where mask is true, Q - number of cells in mask, m - desired mean value
boolvec* surfit::mask_surf ( const char *  surf_name = "*",
const char *  mask_name = "*" 
)
Tcl syntax:
mask_surf "surf_name" mult
Description:
Using this rule the resulting surface approximates values taken from the other surface in least squares meaning where mask is "true".
Parameters
surf_namename of surface
mask_namename of mask dataset
Math:
This command adds the following functional to the functional sequence:

\[ \Phi(u_{1,1},\ldots,u_{N,M}) = \sum_{p=1}^P \left( u_{i,j} - z(x_i, y_j) \right)^2, \]

where (i,j) - indices of the cells, where mask is "true", $z(x_i, y_j)$ - surface value for the (i,j) cell.
boolvec* surfit::mask_surf_add ( const char *  surf_name = "*",
REAL  weight = 1,
const char *  mask_name = "*" 
)
Tcl syntax:
mask_surf_add "surf_name" weight "mask_name"
Description:
This function modifies previous (modifiable) rule by adding the mask_surf rule with some weight. Using this rule the resulting surface approximates other surface "values" where mask is "true", taking into account a previous (modifiable) rule.
Parameters
surf_namename of surface
weightinformational weight for this rule
mask_namename of mask dataset
Math:
This command modifies previous functional $ \Phi_0 $ by adding $ \Phi_1 $:

\[ \Phi(u_{1,1},\ldots,u_{N,M}) = \Phi_0(u_{1,1},\ldots,u_{N,M}) + w\Phi_1(u_{1,1},\ldots,u_{N,M}), \]

where $ w $ - informational weight,

\[ \Phi_1(u_{1,1},\ldots,u_{N,M}) = \sum_{p=1}^P \left( u_{i,j} - z(x_i, y_j) \right)^2, \]

where (i,j) - indices of the cells where mask is "true", $z(x_i, y_j)$ - surface value for the (i,j) cell.
boolvec* surfit::mask_surf_geq ( const char *  surf_name = "*",
const char *  mask_name = "*",
REAL  penalty_factor = 0 
)
Tcl syntax:
mask_surf_geq "surf_name" "mask_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface should be greater than or equal to other surface values where mask is true".
Math:
This command adds the condition:

\[ u_{i,j} \geq f(x_{u_i},y_{u_j}) \]

where (i,j) - indices of the cells where mask is true, $f(x_{u_i},y_{u_j})$ - surface value in the center of the cell.
boolvec* surfit::mask_surf_leq ( const char *  surf_name = "*",
const char *  mask_name = "*",
REAL  penalty_factor = 0 
)
Tcl syntax:
mask_surf_leq "surf_name" "mask_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface should be lower than or equal to other surface values where mask is true".
Math:
This command adds the condition:

\[ u_{i,j} \leq f(x_{u_i},y_{u_j}) \]

where (i,j) - indices of the cells where mask is true, $f(x_{u_i},y_{u_j})$ - surface value in the center of the cell.
boolvec* surfit::mask_wmean ( REAL  mean,
const char *  mask_name = "*",
const char *  surf_name = "*",
REAL  penalty_factor = -2 
)
Tcl syntax:
mask_wmean weighted_mean_value "mask_name" "surf_name" penalty_factor
Description:
This rule adds the surface condition - "the resulting surface weighted mean value should be equal to real number where mask is true".
Math:
This command adds the condition:

\[ \frac {\sum\limits_{i,j} z(x_i,y_j) u_{i,j}} {z(x_i,y_j)} = m \]

where (i,j) - indices of the cells where mask is true, $z(x_i,y_j)$ - weighted surface value for the (i,j) cell, m - desired weighted mean value


surfit: gridding and contouring software.