SML 関数解説 for TNTmips ver6.6

Math functions (66)

Absolute value

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
|x| in same format as input value,
that is, float for input gives float for output

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = -6
     b = abs(2 * a)   # b = 12
     print(b)

trigonometric arccosine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acos(0.5)
     print(b)
     # b = 1.0471975511965979

trigonometric arccosine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arccosine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acosh(0.5)
     print(b)
     # b = NULL

hyperbolic arccotangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

When values outside the domain are used, the solution is defined
as either Infinity or -Infinity.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acoth(0)
     print(b)
     # b = NULL

hyperbolic arccosecant

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

The solution at zero is taken to be the limit as one approaches
zero from the positive x axis.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acsch(0)
     print(b)
     # b = Infinity

hyperbolic arcsecant

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = asech(1)
     print(b)   # b = 0

trigonometric arcsine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = sqrt(3) / 2
     b = deg * asin(a)
     print(b)
     # b = 59.99999999999999

trigonometric arcsine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arcsine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number in the same format as the input parameter

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = (exp(0) - exp(-0)) / 2
     b = asinh(a)
     print(b)   # b = 0

trigonometric arctangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = 1 ; b = deg * atan(a)
     print(b)   # b = 45

trigonometric arctangent

Where:

[Function / Math]

Parameters:

y : number

any expression evaluating to a number corresponding
to the non-hypotenuse side of a right triangle
opposite the angle of interest

x : number

any expression evaluating to a number corresponding
to the non-hypotenuse side of a right triangle
adjacent to the angle of interest

Details:

none

Returns:

number
an angle in radians such that 0 <= angle <= 360. The quadrant
of the unit circle in which the triangle falls is maintained.

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = sqrt(3) / 2 ; b = -.5
     c = deg * atan2(a, b)
     print(c)   # c = 120

trigonometric arctangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arctangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number in the same format as the input parameter

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = exp(0) - exp(-0)
     b = exp(0) + exp(-0)
     c = atanh(a/b)
     print(c)   # c = 0

Force a value into given range.

Where:

[Function / math]

Parameters:

val : number

the value to bound

min : number

minimum value to bound to

max : number

maximum value to bound to

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of Bound()

Round decimal up to integer

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = ceil(7.499)   # a = 8
     b = ceil(7.001)   # b = 8
     c = ceil(-7.01)   # c = -7
     d = ceil(-7.99)   # d = -7
     print(a, b, c, d)

Converts polar coordinates to rectangular (radians).

Where:

[Function / math]

Parameters:

theta : number

theta value

r : number

r value

x : numeric variable

the x coordinate of the point

y : numeric variable

the x coordinate of the point

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertPolartoXY()

Converts polar coordinates to rectangular (degrees).

Where:

[Function / math]

Parameters:

theta : number

theta value

r : number

r value

x : numeric variable

the x coordinate of the point

y : numeric variable

the x coordinate of the point

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertPolartoXYd()

Converts polar coordinates to rectangular (radians).

Where:

[Function / math]

Parameters:

rho : number

rho value

theta : number

theta value

phi : number

phi

x : numeric variable

the x coordinate of the point

y : numeric variable

the y coordinate of the point

z : numeric variable

the z coordinate of the point

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertSphericaltoXYZ()

Converts polar coordinates to rectangular (degrees).

Where:

[Function / math]

Parameters:

rho : number

rho value

theta : number

theta value

phi : number

phi

x : numeric variable

the x coordinate of the point

y : numeric variable

the y coordinate of the point

z : numeric variable

the z coordinate of the point

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertSphericaltoXYZd()

Converts rectangular coordinates to polar (radians).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

theta : numeric variable

theta value

r : numeric variable

r value

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYtoPolar()

Converts rectangular coordinates to polar (degrees).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

theta : numeric variable

theta value

r : numeric variable

r value

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYtoPolard()

Converts rectangular coordinates to spherical (radians).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

z : number

Z coordinate

rho : numeric variable

rho value

theta : numeric variable

theta value

phi : numeric variable

phi value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYZtoSpherical()

Converts rectangular coordinates to spherical (degrees).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

z : number

Z coordinate

rho : numeric variable

rho value

theta : numeric variable

theta value

phi : numeric variable

phi value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYZtoSphericald()

Copies a given range of elements form one array into another.

Where:

[Function / Math]

Parameters:

dest : array

Array that you want values copied into

source : array

Array that you want values copied from

dest_start : number

Destination start position

dest_end : number

Destination end position

source_start : number

Source start position

source_end : number

Source end position

Details:

The copy ranges must be equal and all values in the range must be valid.

Returns:

nothing

Create Date: 22-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     clear();
     Array a1[10];
     Array a2[10];
     for x=1 to 10{
     	a1[x]=20+x;
     	a2[x]=x;
     }
     CopyArrayElements(a2,a1,3,6,5,8);
     for x=1 to 10{
     	print(a2[x]);
     }

trigonometric cosine

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(cos(60 / deg))   # prints .500000000000001

trigonometric cosine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic cosine

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(cosh(0))   # prints 1

trigonometric cosecant

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(csc(30 / deg))   # prints 2

trigonometric cosecant (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

trigonometric cotangent

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(ctn(0 / deg))   # prints Infinity

trigonometric cotangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Calculate the distance, azimuth, and elevation from the first point to the second (radians).

Where:

[Function / math]

Parameters:

x1 : number

the x coordinate of the first point

y1 : number

the y coordinate of the first point

z1 : number

First z coordinate

x2 : number

Second x coordinate

y2 : number

Second y coordinate

z2 : number

Second z coordinate

distance : numeric variable

distance value

azimuth : numeric variable

azimuth value

elevation : numeric variable

elevation value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of Displacement3D()

Calculate the distance, azimuth, and elevation from the first point to the second (degrees).

Where:

[Function / math]

Parameters:

x1 : number

the x coordinate of the first point

y1 : number

the y coordinate of the first point

z1 : number

First z coordinate

x2 : number

Second x coordinate

y2 : number

Second y coordinate

z2 : number

Second z coordinate

distance : numeric variable

distance value

azimuth : numeric variable

azimuth value

elevation : numeric variable

elevation value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of Displacement3Dd()

Exponential (e to the power of x)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(exp(-1/0))   # prints 0

Exponential (10 to the power of x)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(exp10(3))   # prints 1000

Round decimal down to integer

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
the next lower integer value

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(floor(7.5))   # prints 7
     print(floor(-7.5))   # prints -8

Get scale factor for angle unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvAngle()

Get scale factor for area unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvArea()

Get scale factor for distance unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvDist()

Get scale factor for volume unit.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvVolume()

Find hypotenuse of right triangle

Where:

[Function / Math]

Parameters:

dx : number

a number representing the horizontal component of
the right triangle

dy : number

a number representing the vertical component of
the right triangle

Details:

none

Returns:

number
a number (sqrt((sqr(dx)+sqr(dy)))

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear(); dx = 3; dy = 4
     print(hypot(dx, dy))   # 5

Integer portion of argument (truncate)

Where:

[Function / Math]

Parameters:

x : number

a decimal number

Details:

none

Returns:

number
a base 10 integer rounded down

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     a = int(7.7)   # a = 7
     a = int(-7.7)   # a = -8

Does the argument have the value NULL?

Where:

[Function / Math]

Parameters:

x : list of numbers

a number(or infinity or NULL)

Details:

NULL is by definition unknown. Therefore it cannot be
compared to any value, including NULL. Therefore
IsNull() is used to determine if a numerical value is
NULL.

Returns:

number
TRUE(1) if num is NULL
FALSE(0) if num is not NULL

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(IsNull(NULL))

Calculate the linear regression coeficients for a group of points.

Where:

[Function / math]

Parameters:

x : array

the x coordinates of the points

y : array

the y coordinates of the points

num : number

the number of points

slope : numeric variable (optional)

slope returned

intercept : numeric variable (optional)

intercept returned

omit : number (optional)

use to create "jack-knife" slope

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of LinearRegression()

Natural logarithm of argument

Where:

[Function / Math]

Parameters:

x : number

a number

Details:

log(0) = -infinity
log(-1) = -infinity (normally undefined)
log(infinity) = infinity

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a number.") ; a=input
     print("log(x)=", log(x))

Base 10 logarithm of argument

Where:

[Function / Math]

Parameters:

x : number

XXX

Details:

log10(0) = -infinity
log10(-1) = -infinity (normally undefined)
log10(infinity) = infinity

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a number.") ; a=input
     print("log10(x)=", log10(x))

Computes an equation of given power that best fits the given points.

Where:

[Function / math]

Parameters:

x : array

Array of the x coordinates

y : array

Array of the y coordinates

num : number

Number of points

power : number

Power to wich the polynomial should be

carray : array (optional)

Array to store the coeffecients of the polynomial

r : numeric variable (optional)

The multiple correlation coefficient, basically how well the polynomial fits the points
A value between 0 and 1 with 1 being a perfect fit and 0 being absolutely no correlation

Details:

Power must be less then 15

Returns:

string
String containing the function.

Create Date: 22-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of PolynomialCurveFit()
     clear();
     array xpoints[4];
     array ypoints[4];
     array carray[3];
     xpoints[1]=-1;
     xpoints[2]=0;
     xpoints[3]=1;
     xpoints[4]=2;
     ypoints[1]=4;
     ypoints[2]=10;
     ypoints[3]=20;
     ypoints[4]=34;
     string$=PolynomialCurveFit(xpoints,ypoints,4,2,carray,r);
     printf("%s\n",string$);
     printf("%f %f %f\n",carray[1],carray[2],carray[3]);
     printf("r = %f\n",r);

return x to the power of y

Where:

[Function / Math]

Parameters:

x : number

a number

y : number

a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(pow(2, 3))   # 8

Returns random value between zero (0) and x

Where:

[Function / Math]

Parameters:

x : number

a number, positive or negative

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(rand(1))

Computes a pair of random numbers based on a normal distibution.

Where:

[Function / math]

Parameters:

mu : number

mu value (the value you want your random numbers around)

sigma : number

standard deviation

x1 : numeric variable

first number in the pair of numbers returned

x2 : numeric variable

second number

Details:

none

Returns:

nothing

Create Date: 21-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of RandomGaussian()

Resize a one dimensional array ( a[col] ), or two dimensional array ( a[row, col] )

Where:

[Function / Miscellaneous]

Parameters:

array : array

the array to resize

index1Size : number

New index size (column for one dimensional array, row for dimensional dim array)

index2Size : number (optional)

New column size (two dimensional array only)

Details:

the new array is set to all zeros

Returns:

nothing

Create Date: 08-Oct-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of ResizeArrayClear()
 
       array a[3];
       array a2[3, 4];
 
       ResizeArrayClear(a, 5); # increase size of one dimensional array
       ResizeArrayClear(a, 2); # decrease size of one dimensional array
 
       ResizeArrayClear(a2, 5, 6); # increase size of two dimensional array
       ResizeArrayClear(a2, 2, 3); # decrease size of two dimensional array

Resize a one dimensional array ( a[col] ), or two dimensional array ( a[row, col] )

Where:

[Function / Miscellaneous]

Parameters:

array : array

the array to resize

index1Size : number

New index size (column for one dimensional array, row for two dimensional array)

index2Size : number (optional)

New column size (two dimensional array only)

Details:

if the array is enlarged the extra values will be set to zero
but the origional values will be preserved

Returns:

nothing

Create Date: 08-Oct-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of ResizeArrayPreserve()
 
       array a[3];
       array a2[3, 4];
 
       ResizeArrayPreserve(a, 5); # increase size of one dimensional array
       ResizeArrayPreserve(a, 2); # decrease size of one dimensional array
 
       ResizeArrayPreserve(a2, 5, 6); # increase size of two dimensional array
       ResizeArrayPreserve(a2, 2, 3); # decrease size of two dimensional array

Round x to nearest integer

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

Values ending with .5 are rounded up.

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(round(10.5))   # 11
     print(round(-10.5)   #-10

trigonometric secant

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(sec(60/deg))

trigonometric secant (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Return -1, 0 or 1 depending on sign of argument

Where:

[Function / math]

Parameters:

x : number

XXX

Details:

none

Returns:

number
number

Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

trigonometric sine

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sin(30/deg))   #.5

trigonometric sine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic sine

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sinh(0))   # 0

Gaussian elimination solution of system of linear equations

Where:

[Function / Math]

Parameters:

coefArray : array

m by n array of coefficients

constArray : array

m by n array of values

result : array

n x 1 array of unknowns

Details:

The linear system of equations is assumed to be in the
form arrayA * x arrayB = arrayX. For more details, see the
reference manual.

Returns:

nothing
none - arrayX stores the resulting array

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     array a[2, 2] ; array b[2] ; array x[2]
     a[1,1]=1 ; a[1,2]=0 ; a[2,1]=1; a[2,2]=1
     b[1]=1; b[2]=1
     Solve(a, b, x)
     print(x[1], x[2])

Return the square of the argument

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sqr(-3))   # 9

Returns the (positive) square root of the argument

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x >= 0. If x < 0 then zero will be returned, which may
result in unexpected results.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sqrt(9))   # 3
     print(sqrt(-9))   # 0

trigonometric tangent

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print(tan(90/deg))   # -2147483648 (roundoff error)

trigonometric tangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic tangent

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print(tanh(0))   # 0

Date functions (6)

Returns the current date in YYYYMMDD format

Where:

[Function / Date]

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=Date() ; print(x)

Returns number of days between two dates

Where:

[Function / Date]

Parameters:

yyyymmdd1 : number

a number in YYYYMMDD format

yyyymmdd2 : number

a number in YYYYMMDD format

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateDiff(19960101, 19970101)
     print(x)   # 365

Converts YYYYMMDD format to Julian date

Where:

[Function / Date]

Parameters:

yyyymmdd : number

a number in YYYYMMDD format

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateToJulian(19960101)
     print(x) ; print(JulianToDate(x))

Convert a number date to a string.

Where:

[Function / date]

Parameters:

yyyymmdd : number

the date to convert

format$ : string (optional)

the format to convert to

Details:

If the format parameter is omitted, a default format will be
used. Otherwise, the format string can have any of the following
special codes:

%% Same as %
%a abbreviated weekday name
%A full weekday name
%b abbreviated month name

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of DateToString()

Returns the current Julian date

Where:

[Function / Date]

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=JulianDate() ; print(x)

Converts Julian date to YYYYMMDD format

Where:

[Function / Date]

Parameters:

julian : number

a number

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number in YYYYMMDD format

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateToJulian(19960101)
     print(x) ; print(JulianToDate(x))

Set functions (11)

Most frequently occurring value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

In a tie, the first item encountered is returned.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMajority(1, 3, 3, 4, 4, 5))   # prints 3

Returns the largest of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMax(1, 3, 3, 4, 4, 5))   # prints 5

Returns average of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 5))   # prints 3

Returns the median of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 7))   # prints 3

Returns minimum value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 5))   # prints 1

Least frequently occurring value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

In a tie, the first item encountered is returned.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMinority(1, 3, 3, 4, 4, 5))   # prints 1

Returns the total number of elements

Where:

[Function / Set]

Parameters:

x1 : list of numbers or strings

First value

x2 : list of numbers or strings (optional)

Second value

... : list of numbers or strings (optional)

(any number of values)

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetNum(2, 1, 3, 4, 99))   # returns 5

Returns standard deviation of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetSD(2, 1, 3, 4, 99))

Returns sum of arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetSum(2, 1, 3, 4, 99))   # prints 109

Returns statistical variance of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetVariance(2, 1, 3, 4, 99))

Returns number of different values among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetVariety(2, 1, 3, 4, 99))

String functions (15)

Convert an angle in degress to an angle in degress, minutes, seconds format.

Where:

[Function / String]

Parameters:

num : number

angle in degrees

Details:

none

Returns:

string
A string containing degrees, minutes, and seconds of the angle.

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear();
     print(DegToStr(94.345));

Returns file extension portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetExt()

Returns filename portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetName()

Returns path portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetPath()

Get the nth token from a string

Where:

[Function / string]

Parameters:

string$ : string

the string to get the token from

delimiters$ : string

the characters that delimit tokens

tokenNumber : number

the token number to get

compress : number (optional)

1 (default) to treat multiple consecutive tokens as one, 0 to accept each one

Details:

none

Returns:

string
string

Create Date: 25-Sep-1998
Modify Date: 05-Jun-2001
Available in SML for Windows: Yes

Example:

       # Example of GetToken()
       clear();
 
       str$ = "a  b c,d";
       delimit$ = " ,";
 
       n = NumberTokens(str$, delimit$);
 
       for i = 1 to n {
          token$ = GetToken(str$, delimit$, i);
          print(i, token$);
          }

Return leftmost n characters of string

Where:

[Function / String]

Parameters:

str$ : string

a string

length : number

an integer

Details:

1 <= n - if n is longer than Len(string$), then the
entire string is returned.

Returns:

string
a string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a sentence.") ; a$=input$()
     print("Enter # of chars to get.")) ; n=input()
     print(left$(a$, n))

Return n characters of string$ starting at m

Where:

[Function / String]

Parameters:

str$ : string

a string

start : number

an integer

length : number

an integer

Details:

1 <= m , n <= length of string, 1 <= m+n <= length of string
If m is greater then the length of str$, then nothing is returned.
If m is in the normal range, but m+n is greater than the length of
str$, then the entire string to the right of m is returned.

Returns:

string
a string, starting with the mth character

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a sentence.") ; a$=input$()
     print("Enter start position.")) ; m=input()
     print("Enter # of chars to get.")) ; n=input()
     print(mid$, m, n))

Returns number of tokens in a string

Where:

[Function / string]

Parameters:

string$ : string

the string to find tokens in

delimiters$ : string

the characters that delimit tokens

Details:

none

Returns:

number
number

Create Date: 25-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of NumberTokens()
       clear();
 
       str$ = "a  b c,d";
       delimit$ = " ,";
 
       n = NumberTokens(str$, delimit$);
 
       for i = 1 to n {
          token$ = GetToken(str$, delimit$, i);
          print(i, token$);
          }

Convert a number to a string

Where:

[Function / math]

Parameters:

num : number

Number to convert

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of NumToStr()

Return right-most n characters of string$

Where:

[Function / String]

Parameters:

str$ : string

a string

length : number

an integer

Details:

1 <= n - If n is greater than the length of string$, then
the entire string is returned.

Returns:

string
a string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a$="Reenter this sentence."
     print(a$) ; b$=input$()
     print("Enter n.")
     n=input()
     print(right$(a$, n))
     print(right$(b$, n))

Assign formatted text to a string variable

Where:

[Function / String]

Parameters:

format$ : string

printf-style format string.

The format string is scanned for format specification fields, which all start with
a percent sign (%). Each format specification is replaced by the value of the next
parameter passed after the format string. There should be a value passed for each
format specification field.

Format Specification fields have the following form (parts in square brackets are
optional)

%[flags][width][.precision]type

flags
Optional characters to control justification and sign display
- : Left align the result within the field
+ : Prefix numeric value with a sign (+ or -), even if positive
0 : If with is prefixed with a zero, the number will have leading zeros

width
Optional number that specifies the minimum number of characters output

precision
Optional number that specifies the maximum number of digits after the
decimal place for floating point numbers

type
Required character specifying the type of parameter to output
s : String
d : Signed decimal integer
u : Unsigned decimal integer
o : Unsigned octal integer
x : Unsigned hexadecimal integer, using "abcdef"
X : Unsigned hexadecimal integer, using "ABCDEF"
c : A single character, specified the ASCII value.
e : Floating point value in scientific notation (e.g.: 1e6 for 1,000,000)
f : Floating point value, not in scientific notation
g : Floating point value in e or f format, whichever is more compact


value : any value (optional)

etc. one or more numbers or strings

... : any value (optional)

optional additional strings or numbers

Details:

This function allows formatting to be applied to
strings which may then be used in regular print
statements. This helps prevent formatted printf()
statements from becoming unwieldy. Specifications for
the format string are too numerous to list here - see the
reference manual for information on format strings.

Returns:

string
a (formatted) string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     format$="%s%d%s\n%s"
     str1$="This is line " ; str2$="you see."
     str3$="This is line 2" ; number=1
     s4$=sprintf(format$, str1$, 1, str2$, str3$)
     print(s4$)

Returns number of characters in string variable

Where:

[Function / Math]

Parameters:

str$ : string

a string

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print("Enter a string. ") ; a$=input$()
      print(strlen(a$))

Return numerical value of string with number in it

Where:

[Function / Math]

Parameters:

str$ : string

a string

Details:

The first non-whitespace characters encountered must be
numerical for a number to be returned.

Returns:

number
a number in base 10

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a string. ") ; a$=input$()
     b=StrToNum(a$) ; print(b/10)

Convert string to lower case

Where:

[Function / string]

Parameters:

string$ : string

input string

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of tolower$()

Convert string to upper case

Where:

[Function / string]

Parameters:

string$ : string

input string

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of toupper$()

Database functions (32)

Get database table information

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

name : any value

name of the table

Details:

none

Returns:

class DBTABLEINFO
class DBTABLEINFO

Create Date: 29-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of DatabaseGetTableInfo()

Returns a field class.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to query

name$ : string

name of the field

Details:

none

Returns:

class DBFIELDINFO


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of FieldGetInfoByName()



Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to query

number : number

number of the field

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of FieldGetInfoByNumber()

Returns number of records in database table

Where:

[Function / Math]

Parameters:

table : class DBTABLEINFO

a database table from a Raster of Vector object

Details:

The table name must be spelled exactly as it appears
when examining it in Spatial Data Display. If may NOT
be placed in a string and substituted in the table
name, as in 'V.poly.table$'.

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     # assume you know the table name, here we used the
     # Crow Butte Soils Vector object.  Note that 'YIELD'
     # is the correct field name,not 'yield'.
     n=NumRecords(V.poly.YIELD)
     print("Record count:", n)

Open the database subobject of a CAD object

Where:

[Function / database]

Parameters:

CADVar : CAD

The CAD object to open the database of

Details:

none

Returns:

class DATABASE


Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Open a main level database

Where:

[Function / database]

Parameters:

filename$ : string

RVC filename

objectname$ : string

Object name

Details:

none

Returns:

class DATABASE

Create Date: 11-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of OpenDatabase()

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Rast : Raster

Raster object

Returns:

class DATABASE

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenRasterDatabase()

Open the database subobject of a TIN object

Where:

[Function / database]

Parameters:

TINVar : TIN

The TIN object to open the database of

Details:

none

Returns:

class DATABASE

Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Vect : Vector

Vector object

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenVectorLineDatabase()

Open a Vector point database

Where:

[Function / database]

Parameters:

Vect : Vector

The Vector

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE
class DATABASE

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of OpenVectorPointDatabase()

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Vect : Vector

Vector object

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenVectorPolyDatabase()

Delete one or more records.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to delete from

recordnum1 : list of numbers

the record list to delete

recordnum2 : list of numbers (optional)

optional record list to delete

... : list of numbers (optional)

optional record list to delete

Details:

none

Returns:

nothing

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of RecordDelete()

Append a field to a table

Where:

[Function / Database]

Parameters:

table : class DBTABLEINFO

Table to add the field to

field : class DBFIELDINFO

Information about the field to add

Details:

none

Returns:

class DBFIELDINFO

Create Date: 08-Jun-2001
Modify Date: none
Available in SML for Windows: Yes

Add a new field of type float but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

dispwidth : number (optional)

number of digits to display

places : number (optional)

number of decimal places to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldFloat()

Add a new field of type integer but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

dispwidth : number (optional)

number of digits to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldInteger()

Add a new field of type string.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

maxlength : number

maximum length of string field

dispwidth : number (optional)

number of characters to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldString()

Copy a database table to a DBASE file

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

filename$ : string

DBASE file name

Details:

none

Returns:

nothing

Create Date: 11-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableCopyToDBASE()

Creates an empty table. Use TableAddField???() functions to add fields to it.

Where:

[Function / database]

Parameters:

database : class DATABASE

the database to add the table to

name$ : string

name of the table

description$ : string (optional)

description of the table

Details:

none

Returns:

class DBTABLEINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableCreate()

returns 1 if table exists, -1 if table doesn't exist

Where:

[Function / database]

Parameters:

database : class DATABASE

Open database handle

name : any value

Table Name or number

Details:

The "name" parameter will also take a number, in which case, it checks to see if
there is a table with that number. This is useful when looping through all the
tables in a database. A database may claim to have 3 tables, but that really only
means that the highest valid table number is 3. TableExists() will return false
for any tables which have been dropped.

Returns:

number
1 if the table exists, 0 if it doesn't

Create Date: 27-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Returns a table class.

Where:

[Function / database]

Parameters:

Table : table

the table to get info about

Details:

none

Returns:

class DBTABLEINFO


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

 # Example of TableGetInfo()
 # (Assume Vect is a vector object)
 
 class DBTABLEINFO table;
 table = TableGetInvo(Vect.poly.YIELD);
 
 # Another example:
 tablename$ = "YIELD";
 table = TableGetInfo(Vect.poly.(tablename$));
 

Add a new field of type float but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

dispwidth : number (optional)

number of digits display

places : number (optional)

number of decimal places to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldFloat()

Add a new field of type integer but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

dispwidth : number (optional)

number of digits to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldInteger()

Add a new field of type string but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

maxlength : number

maximum length of string field

dispwidth : number (optional)

number of characters to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldString()

Find the first record in a table that matches a given key

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

fieldValue1 : any value

The field value to match. Should be numeric or string, depending on the type of the
field you're doing the lookup on.

Details:

If more than one record in a table matches the given field value, the record number of
the first match will be returned.

Note, that if the field you're doing the comparison on is not indexed, this will end up
doing a linear search through the table, which is very slow.

Returns:

number
A record number or 0 if none related.

Create Date: 13-Jul-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableKeyFieldLookup()

Makes a link to a dBase file.

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

filename$ : string

RVC file name

name$ : string

table name

description$ : string (optional)

table description

Details:

none

Returns:

class DBTABLEINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableLinkDBASE()

Add new record to a database

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the database

fieldValue1 : any value (optional)

record to add

fieldValue2 : any value (optional)

optional record to add

... : any value (optional)

optional record to add

Details:

none

Returns:

number
number - record number

Create Date: 29-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableNewRecord()

Open a database table

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

tablename$ : string

the table to open

Details:

none

Returns:

class DBTABLEVAR
class DBTABLEVAR

Create Date: 26-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableOpen()

Returns records that are attached to or related to a given element in a object

Where:

[Function / database]

Parameters:

table : class class

The table to get attachments for

element_number : number

number of element

records : array

array that records are returned in

element_type$ : string (optional)

the type of element to read attachment from
"node" Vector node
"point" Vector point
"line" Vector line
"polygon" Vector polygon
"CAD" CAD element
"rastercell" Raster cell value

Details:

Note: TableReadAttachment() will work for tables which are related only as well as
ones which have direct attachments. TableWriteAttachment() only works for tables
which have direct attachments.

Returns:

number
The number of records from the specified table that were attached to the element

Create Date: 14-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Read a number from a table (using DBTABLEINFO)

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

recordNum : number

Record number

Details:

none

Returns:

number
number

Create Date: 12-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableReadFieldNum()

Read a string from a table (using DBTABLEINFO)

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

recordNum : number

Record number

Details:

none

Returns:

string
string

Create Date: 12-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableReadFieldStr()

Attaches records in a table to an element in a object

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table to attach to

element_number : number

number of element to attach to

records : array

array holding the list of record numbers to attach

num_records : number

number of records listed in the records array

element_type$ : string (optional)

the type of element to write attachment to
"node" Vector node
"point" Vector point
"line" Vector line
"polygon" Vector polygon
"CAD" CAD element
"rastercell" Raster cell value

Details:

The table must be in a database which is a subobject of the object that it is being attached to.

The behavior of this function depends on the attachment type of the table being
attached.

If it is "Related Only" you can't attach anything directly. In this case, the records
are related via a key field to another table which is directly attached to elements.
This relationship doesn't have to be a direct one. A table can be related to a table
which is related to another table until eventually one of them is directly attached
object elements. Note that TableReadAttachments() still works for tables which
are "Related Only", you just can't force the attachment with this function.
If it is "One Record per Element" or "One to One", you can only attach one record.
If there is already a record from this table attached to the element, that
attachment will be broken in favor of the new attachment.
If the table is "Implied One to One", attachment is implied (hence the name) and
you don't need to attach anything. In the Implied case, record 1 is attached to
element 1, record 2 to element 2, etc...

Returns:

number
The number of records attached to the element after the operation

Create Date: 14-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 # Example:
 # Have the user select a vector object.
 # attach records 5 and 7 to polygon number 12.
 
 VECTOR Vect;
 class DBTABLEINFO table;
 array records[2];
 
 GetInputVector(Vect);
 table = TableGetInfo(Vect.poly.YIELD);
 records[1] = 5;
 records[2] = 7;
 TableWriteAttachment(table, 12, records, 2, "polygon");
 

Write values to an existing database record

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

recordNum : number

Record number to write. 0 for new record

fieldValue1 : any value (optional)

Value to write

fieldValue2 : any value (optional)

Value to write

... : any value (optional)

Value to write

Details:

none

Returns:

number
number

Create Date: 15-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableWriteRecord()

Raster functions (46)

Adjust point position of Raster to match known position in refererence Raster

Where:

[Function / georeference]

Parameters:

RasterSource : Raster

source Raster

xSource : number

x position in source

ySource : number

y position in source

RasterDestination : Raster

destination Raster

xDestination : numeric variable

x position in destination (passed/returned)

yDestination : numeric variable

y position in destination (passed/returned)

sourceSize : number

size of the correlation window ( > 3)

targetSize : number

size of the area in target to search around

Details:

none

Returns:

number
number (0 if correlation cannot be calculated)

Create Date: 20-Jul-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of AreaCorrAdjustPoint()
       clear();
       GetInputRaster(Rs);
       GetInputRaster(Rd);
       xS = 55;
       yS = 60;
       xD = 50;
       yD = 63;
       sourceSize = 21;
       targetSize = 50;
       cor = AreaCorrelatePoint(Rs, xS, yS, Rd, xD, yD, sourceSize, targetSize);
       print(xS, yS, xD, yD, cor);

Calculates a raster binarization on an 8 or 4 bit raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

Raster variable to run binarization on.

filename$ : string

RVC project.

objname$ : string

Object name of binary raster to be created.

array : array

Array of raster values you want changed.

binaryValue : number (optional)

Value to change the raster values in the above array to (0 or 1).

Details:

none

Returns:

nothing

Create Date: 15-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     clear();
     array myarray[15];
     for x=1 to 15{
     	myarray[x]=80+x;
     }
     OpenRaster(Rvar, "c:/tnt/testdata.rvc", "GREEN");
     Binarization(Rvar, "c:/tnt/testdata.rvc", "binaryout", myarray, 1);
     OpenRaster(Rout, "c:/tnt/testdata.rvc", "binaryout");
    handle=DispOpen(750,550);
    DispQuickAddRasterVar(handle, Rout);
    DispRedraw(handle);
    CloseRaster(Rvar);
    CloseRaster(Rout);

Close an open raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

Details:

Raster was previously opened. Flushes this raster to disk.

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     OpenRaster(Rvar)
     Rvar[1, 1] = 42 ; print(Rvar[1, 1])
     CloseRaster(Rvar)

Get horizontal size of raster cell

Where:

[Function / Raster]

Parameters:

Raster : Raster

any expression evaluating to a Raster (capitalized name)

Details:

none

Returns:

number
the horizontal dimension of a cell in Raster, as a decimal value

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     GetInputRaster(A)
     print(ColScale(A))

Compute Raster attribute tables from a Vector object

Where:

[Function / miscellaneous]

Parameters:

Raster : Raster

the Raster object

Vector : Vector

the Vector object

tableName$ : string

the name given to the table

tableDescription$ : string

the table description

flag1$ : string

"IncludeAll" include all boundary cells
"IncludeLargest" include if larger proportion of cell is inside
"Proportionally" compute proportionally (split boundary cells)
"ExcludeAll" do not include boundary cells

flag2$ : string (optional)

flag for computing histogram and/or including islands (none, one, or both may be used)
"ComputeHistogram" compute histogram for each Vector polygon
"IncludeIsland" include islands in computations
"NULL" ignore this flag

... : Raster (optional)

More Raster objects

Details:

none

Returns:

nothing

Create Date: 11-Aug-1998
Modify Date: 08-Jul-1999
Available in SML for Windows: Yes

Example:

       # Example of ComputeRasterProperties()
      OpenRaster(R, "c:/tnt/win32/CB_tm.rvc", "BLUE");
      OpenRaster(R1, "c:/tnt/win32/CB_tm.rvc", "RED");
      OpenRaster(R2, "c:/tnt/win32/CB_tm.rvc", "GREEN");
      OpenVector(V, "c:/tnt/win32/vector.rvc", "VectorObject");
      ComputeRasterProperties(R, V, "TableName", "Description", "IncludeAll", "ComputeHistogram", R1, R2);

Compute slope/aspect/shading from elevation Raster

Where:

[Function / Conversion]

Parameters:

inputRVCFile$ : string

Input RVC file name

inputRaster$ : string

Input Raster name

outputRVCFile$ : string

Output RVC file name

rescaleSlope : number

Boolean - rescale slope range to 0 -> 255

numberSlopeCells$ : string

"4 neighbor" - Use 4 neighbors to compute slope
"8 neighbor" - Use 8 neighbors to compute slope

slopeTypeDegrees$ : string

1 for degrees, else percent - defaults to degrees
"Degrees" compute slope in degrees
"Percent" compute slope in percent

rescaleAspect : number

Boolean - rescale aspect range to 0 -> 240

horizontalScale : number

horizontal cell size - if 0 use inputs

verticalScale : number

vertical cell size - if 0 use inputs

elevationScale : number

elevation scale - if 0 use inputs

sunElevationAngle : number

sun elevation in degrees - 0 -> 90

sunDirection : number

direction of sun in degrees - 0 -> 360

slopeObjectName$ : string (optional)

default - "Slope"

slopeDescription$ : string (optional)

default - "Computed from slopeFileName"

slopeDataType$ : string (optional)

"8-bit unsigned" 8 bit unsigned integer
"8-bit signed" 8 bit signed integer
"16-bit unsigned" 16 bit unsigned integer
"16-bit signed" 16 bit signed integer
"32-bit unsigned" 32 bit unsigned integer
"32-bit signed" 32 bit signed integer
"32-bit float" 32 bit floating point
"64-bit float" 64 bit floating point

aspectObjectName$ : string (optional)

default - "Aspect"

aspectDescription$ : string (optional)

default - "Computed from aspectFileName"

aspectDataType$ : string (optional)

"8-bit unsigned" 8 bit unsigned integer
"8-bit signed" 8 bit signed integer
"16-bit unsigned" 16 bit unsigned integer
"16-bit signed" 16 bit signed integer
"32-bit unsigned" 32 bit unsigned integer
"32-bit signed" 32 bit signed integer
"32-bit float" 32 bit floating point
"64-bit float" 64 bit floating point

shadingObjectName$ : string (optional)

default - "Shading"

shadingDescription$ : string (optional)

default - "Computed from shadingFileName"

shadingDataType$ : string (optional)

"8-bit unsigned" 8 bit unsigned integer
"8-bit signed" 8 bit signed integer
"16-bit unsigned" 16 bit unsigned integer
"16-bit signed" 16 bit signed integer
"32-bit unsigned" 32 bit unsigned integer
"32-bit signed" 32 bit signed integer
"32-bit float" 32 bit floating point
"64-bit float" 64 bit floating point

Details:

none

Returns:

nothing

Create Date: 22-Dec-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

      # Example of ComputeSlopeAspectShading()
      inputFile$ = "c:/cb_tm.rvc";
      inputRaster$ = "ELEVATION";
      outputFile$ = "c:/SAS.rvc";
      rescaleSlope = 1;
      numberSlopeCells$ = "4 neighbor";
      slopeTypeDegrees$ = "Degrees";
      rescaleAspect = 1;
      horizontalScale = 30.0;
      verticalScale = 30.0;
      elevationScale = 1.0;
      sunElevationAngle = 50.0;
      sunDirection = 45.0;
      ComputeSlopeAspectShading(inputFile$, inputRaster$, outputFile$,
            rescaleSlope, numberSlopeCells$, slopeTypeDegrees$,
            rescaleAspect, horizontalScale, verticalScale,
            elevationScale, sunElevationAngle, sunDirection);

Converts the color depth of a raster to another color depth.

Where:

[Function / Raster]

Parameters:

InputRaster : Raster

Raster object to convert color of.

fileName$ : string

Name of RVC file to make new raster in.

objName$ : string

Object name of the new raster.

colorDepth : number

New images color depth (24, 16, 8, and 4 are valid values).

Details:

None

Returns:

nothing
Nothing

Create Date: 06-Aug-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of ConvertCompToComp
       clear();
       OpenRaster(Rvar, "c:/tnt/samp.rvc", "COMP24");
       ConvertCompToComp(Rvar, "c:/tnt/samp.rvc", "conv8", 8);
 
       OpenRaster(Ovar, "c:/tnt/samp.rvc", "conv8");
       handle=DispOpen(750,550);
       DispQuickAddRasterVar(handle, Ovar);
       DispRedraw(handle);
 
       CloseRaster(Rvar);
       CloseRaster(Ovar);

Converts and RGB raster to an 8 or 4 bit composite

Where:

[Function / Raster]

Parameters:

RedRaster : Raster

Red raster variable.

GreenRaster : Raster

Green raster variable.

BlueRaster : Raster

Blue raster variable.

fileName$ : string

Name of the RVC file to output to.

objName$ : string

Name of the output raster.

numColors : number

Number of colors to be used in output raster.

bitDepth : number

Color depth in the output raster (8 or 4).

samplingRate : number

Sampling rate.

Details:

NumColors must be valid for the given color depth, NumColors < 2^BitDepth.

Returns:

nothing

Create Date: 28-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     clear();
     OpenRaster(Rvar, "c:/tnt/samp.rvc", "RED");
     OpenRaster(Gvar, "c:/tnt/samp.rvc", "GREEN");
     OpenRaster(Bvar, "c:/tnt/samp.rvc", "BLUE");
 
     ConvertRGBToComposite(Rvar, Gvar, Bvar, "c:/tnt/samp.rvc", "composite", 16, 8, 2);
 
     OpenRaster(Ovar, "c:/tnt/samp.rvc", "composite");
     handle=DispOpen(750,550);
     DispQuickAddRasterVar(handle, Ovar);
     DispRedraw(handle);
 
     CloseRaster(Rvar);
     CloseRaster(Gvar);
     CloseRaster(Bvar);
     CloseRaster(Ovar);

Create a histogram for a Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

Details:

none

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     GetInputRaster(R)
     CreateHistogram(R)
     CloseRaster(R)

Create a pyramid version of Rvar and store it as Rvar

Where:

[Function / Raster]

Parameters:

Raster : Raster

Any valid raster variable

average : number (optional)

If non-zero, each output cell will be the average of the cells it represents

Details:

none

Returns:

nothing
none - raster stored in Raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     CreatePyramid(R)
     CloseRaster(R)

Create a new raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid, as-yet-unused raster variable

filename$ : string

a string containing the complete path name for
the new raster

objname$ : string

a string containing the name to use for the
raster object in the rvc file (DOS filename
format assumed - case sensitive)

desc$ : string

a string containing the description of the
raster object used in the rvc file
(64 character maximum)

lins : number

an integer holding the number of lines in the
raster being created

cols : number

an integer holding the number of columns in
the raster being created

datatype$ : string

a string holding the data type used for each raster cell (see below)
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

Details:

None

Returns:

nothing
none - raster stored in Raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     file$="c:/temp.rvc"
     obj$="TempRast" ; description$="temporary raster for test"
     lin = 1024 ; col = 512 ; type$="8-bit unsigned"
     CreateRaster(Rvar, file$, obj$, description$, lin, col, type$)
     print(NumLins(Rvar), NumCols(Rvar))
     # do some things to Rvar
     CloseRaster(Rvar)

Crete a binary mask raster

Where:

[Function / raster]

Parameters:

Raster : Raster

Input raster

filename$ : string

Output raster filename

objname$ : string

Output raster object name

maskValue : number

Value to mask

Details:

The output raster will be a binary raster the same size as the
input raster, with 1's for every cell in the input raster that
matches the maskValue.

Returns:

nothing

Create Date: 23-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of CreateRasterBinaryMask()

Create a Raster to match a given Object.

Where:

[Function / raster]

Parameters:

Object : Raster, Vector or CAD

the Object to match

Raster : Raster

the Raster to create

filename$ : string

Raster RVC filename

objname$ : string

Raster object name

description$ : string

Raster description

horizontalScale : number

horizontal cell size - in meters

verticalScale : number

vertical cell size - in meters

datatype$ : string

Raster type (see below)
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

georef : class Georef

georeference of Vector

Details:

none

Returns:

nothing
georeference handle created for Raster

Create Date: 29-Apr-1998
Modify Date: 29-Apr-1998
Available in SML for Windows: Yes

Example:

    # example of CreateRasterFromObject()
    GetInputVector(V);
    georef = GetLastUsedGeorefObject(V);
    CreateBlankRasterFromObject(V, R, "c:/tnt/win32/projects/vtor/RasOut.rvc",
          "VtoR", "Raster from Vector", 30, 30, "8-bit unsigned", georef);
    R = 0 # zero out the Raster
    CloseRaster(R);
    CloseVector(V);
    print("done");

Crete a mask raster (for use as a transparancy mask)

Where:

[Function / raster]

Parameters:

Raster : Raster

Input raster

filename$ : string

Output filename

objname$ : string

Output raster object name

maskValue : number

value to put in output raster

Details:

The output raster will be an 8-bit unsigned raster the same size as
the input raster. For each non-null cell in the input raster, the
output raster will be given the maskValue. For each null cell in
input raster, the output raster cell will be 0. This is used to
create a transparancy mask. If you want a binary output raster,
try CreateRasterBinaryMask()

Returns:

nothing

Create Date: 23-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of CreateRasterMask()

Create a raster in RAM

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid, as-yet-unused raster variable

lins : number

an integer holding the number of lines in the
raster being created

cols : number

an integer holding the number of columns in the
raster being created

datatype$ : string

a string holding the data type used for each
raster cell (see below)
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

noDeleteOnClose : number (optional)

if non-zero, the raster won't be automatically deleted when it is closed.
It will be deleted when the SML script exits.

Details:

none

Returns:

nothing
none, raster stored in Raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     lin = 1024 ; col = 512 ; type$="8-bit unsigned"
     CreateTempRaster(Rvar, lin, col, type$)
     print(NumLins(Rvar), NumCols(Rvar))
     # do some things to Rvar
     CloseRaster(Rvar)

Delete contrast subobjects of raster Rvar

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

Details:

none

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     DeleteContrast(Rvar)

Delete histogram subobject of raster Rvar

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

Details:

none

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     DeleteHistogram(Rvar)

Delete pyramid subobject of raster Rvar

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

Details:

none

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     DeletePyramid(Rvar)

Delete a raster that has been created with CreateTempRaster()

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable that was created with
CreateTempRaster()

Details:

You should remove unused rasters from RAM so that
resources are not wasted

Returns:

nothing
none raster stored in Raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     lin = 1024 ; col = 512 ; type$ = "8-bit unsigned"
     CreateTempRaster(A, lin, col, type$)
     # do something with A
     DeleteTempRaster(A)

Use a File/Object selection dialog to select an input Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid Raster object name

lins : number (optional)

optional - the number of lines allowed in the
raster to be chosen

cols : number (optional)

optional - the number of lines allowed in the
raster to be chosen

datatype$ : string (optional)

optional - a string containing the data type
requirement for the selected raster.
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

Details:

If they are used, lines and columns must be used together.
If it is used, type$ must follow lines and columns. If you
do not care about the dimensions of the raster, but
only the type, then set lines and columns to 0

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     lines=488 ; columns=361   # Crow Butte TM raster dimensions
     type$="8-bit unsigned"
     # allow only specific raster size and type
     GetInputRaster(R, lines, columns, type$) ; CloseRaster(R)
     # allow any size, but only a specific type
     GetInputRaster(R, 0, 0, type$) ; CloseRaster(R)

Get more than one raster.

Where:

[Function / raster]

Parameters:

Raster : Raster

first Raster object

... : Raster (optional)

additional Raster objects

Details:

none

Returns:

nothing

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetInputRasters()

Use a File/Object selection dialog to select an output Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

lins : number (optional)

optional - a number, use to force number of
lines in output raster

cols : number (optional)

optional - a number, use to force number of
columns in output raster

datatype$ : string (optional)

optional - a string, use to force data type
of output raster, (see below)
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

Details:

If they are used, lines and columns must be used together.
If it is used, type$ must follow lines and columns. If you
do not care about the dimensions of the raster, but
only the type, then set lines and columns to 0.
This function allows you to select an existing object
to overwrite, or to create a new object. Once it has
been selected, writing to the object on disk is handled
transparently.

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     GetInputRaster(R)
     lines=NumLins(R) ; columns=NumCols(R) ; type$=RastType(R)
     # allow selection or creation of a raster identical
     # in size and type to R.
     GetOutputRaster(R2, lines, columns, type$)
     CloseRaster(R) ; CloseRaster(R2)

Does a raster object have an assigned NULL value?

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster object

Details:

none

Returns:

number
TRUE(1) if a NULL is used in Raster
FALSE(0) if a NULL is not used in Raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     if (HasNull(R) then
        print("R has a NULL value.") else
           print("R does not have a NULL value.")
     # The last line is always executed - it's not in the loop.
     CloseRaster(R)

Do not report NULLs in raster object

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster object

Details:

A raster cell otherwise labeled as NULL will be reported as its
actual value

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     if (HasNull(R)) then begin
        print("R has a NULL value.")
        print("\nIt is now ignored.")
        IgnoreNull(R) end else begin
           print("R has no NULL value.")
           print("That's all, folks.")
           end
     # The last line is always executed - it's not in the loop.
     CloseRaster(R)

Vertical size of raster cell

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     a=LinScale(R) ; print("Line scale is:", a)
     CloseRaster(R)

Computes coefficients of multilinear regression equations on a set of rasters

Where:

[Function / Classify]

Parameters:

resultMat : class MATRIX

the coefficients are returned via resultMat

Raster1 : Raster

Rasters to compute regression for

Raster2 : Raster

... : Raster (optional)

optional additional rasters

Details:

The first column of resultMat contains the offsets,
columns 1 to N contain the coefficents.

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear() # clear the console
     h1 = CreateMatrix(3, 4) # holds the results
     # get three input rasters to do multiregression on
     GetInputRaster(Rr)   # get red input raster
     GetInputRaster(Rg)   # get green input raster
     GetInputRaster(Rb)   # get blue input raster
     # do the multi-regression - result in h1
     MultiRegression(h1, Rr, Rg, Rb)
     print("Multi-Regression Output")
     for r = 0 to 2 {
        for c = 0 to 3 {
           a = GetMatrixItem(h1, r, c)
           printf("%8.4f ", a)
           }
        print(" ")
        }
     CloseRaster(Rr) # do clean up
     CloseRaster(Rg)
     CloseRaster(Rb)
     DestroyMatrix(h1)

Value (if any) assigned as NULL for a raster object

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster variable

Details:

none

Returns:

number
a number, of the same type used by the raster

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     n=NullValue(R) ; print("Null value is",n)
     CloseRaster(R)

Number of columns in a raster object

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     columns=NumCols(R)
     print("Number of columns:", columns)
     CloseRaster(R)

Number of lines (rows) in a raster object

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputRaster(R)
     lines=NumLins(R)
     print("Number of lines:", lines)
     CloseRaster(R)

Open an existing raster file, putting it in Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid raster object

filename$ : string

a string holding the RVC file in which the
raster object is found - file$ includes the
full path name.

objname$ : string

a string holding the name of the raster
object in the RVC file

Details:

On Windows platforms, the backslashes between directory
names must come in pair,(\\). You may use a single forward
slash in place of double backslashes,(/).

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     OpenRaster(R, "c:/data/cb_tm.rvc", "blue")
     #  or OpenRaster(R, "c:\\data\\cb_tm.rvc", "blue")
     print("Line count: ", NumLines(R))

Open a raster given object from SelectInputObject()

Where:

[Function / raster]

Parameters:

Raster : Raster

Raster variable (undefined ok)

object : class OBJECT

An OBJECT class

Details:

none

Returns:

nothing

Create Date: 18-Nov-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of OpenRasterObject()

Computes principal component transformation matrix for a set of rasters

Where:

[Function / Classify]

Parameters:

forwardMat : class MATRIX

matrix used for calculating the
projection of the N-tuple vector
created from the raster values at a
common cell location onto the
principal component basis vectors.

inverseMat : class MATRIX

matrix used for converting back to
origional cell values

Raster1 : Raster

XXX

Raster2 : Raster

XXX

... : Raster (optional)

optional additional rasters