Global Function Manual (GET)

GETALIGN

| HOME | BACK |

Purpose

To get the current setting of alignment mode of string printing.  The return value will be L (left), R (right) or C (center).

Usage

{String} ret  =  GETALIGN()

Example:

->align_mode = getalign()

->print align_mode

L

See also

set align

| HOME | BACK |


GETANGLE

| HOME | BACK |

Purpose

To get the current angle mode, stored in a string.  The returning result is "DEG", degree, or "RAD", radian, or "GRA", grade

Usage

{String} ret  =  GETANGLE()

Example:

->angle_mode = getangle()

->print angle_mode

DEG

See also

set angle

| HOME | BACK |


GETBLKSIZE

| HOME | BACK |

Purpose

To get the current block size, which is the size of a sub-block used in some image processing function, such as edgesobel, stretch, etc.  Data processing using sub-block technique can increase speed and reduce the amount of required memory.

Usage

{int} ret  =  GETBLKSIZE()

Example:

->n = getangle()

->print n

        64

See also

set blksize

| HOME | BACK |


GETCOLORMAP

| HOME | BACK |

Purpose

To get the current color map.

Usage

{Matrix_uch} ret  =  GETCOLORMAP()

Example:

->M = getcolormap()

->print M

no of row :    64
no of column :    3

0:     255   0   0
1:     255  24   0
2:     255  48   0
3:     255  72   0
4:     255  96   0
5:     255 120   0
6:     255 143   0
7:     255 167   0
8:     255 191   0
9:     255 215   0
10:    255 239   0
11:    247 255   0
12:    223 255   0
13:    199 255   0
14:    175 255   0
15:    151 255   0
16:    128 255   0
17:    104 255   0
18:     80 255   0
19:     56 255   0
20:     32 255   0
21:      8 255   0
22:      0 255  16
23:      0 255  40
24:      0 255 64
25:      0 255  88
26:      0 255 112
27:      0 255 135
28:      0 255 159
29:      0 255 183
30:      0 255 207
31:      0 255 231
32:      0 255 255
33:      0 231 255
34:      0 207 255
35:      0 183 255
36:      0 159 255
37:      0 135 255
38:      0 112 255
39:      0  88 255
40:      0  64 255
41:      0  40 255
42:      0  16 255
43:      8   0 255
44:     32   0 255
45:     56   0 255
46:     80   0 255
47:    104   0 255
48:    128   0 255
49:    151   0 255
50:    175   0 255
51:    199   0 255
52:    223   0 255
53:    247   0 255
54:    255   0 239
55:    255   0 215
56:    255   0 191
57:    255   0 167
58:    255   0 143
59:    255   0 120
60:    255   0  96
61:    255   0  72
62:    255   0  48
63:    255   0  24

See also

set colormap

| HOME | BACK |


GETDISTTOL

| HOME | BACK |

Purpose

To get the current value of distance tolerance, which is used in some function in COGO, e.g. 3D line intersection.

Usage

{double} ret  =  GETDISTTOL()

Example:

->dist_tol = getdisttol()

->

See also

set disttol

| HOME | BACK |


GETFORMAT

| HOME | BACK |

Purpose

To get the current output format.  The returning result is either "FIX", or "SCI".

Usage

{String} ret  =  GETFORMAT()

Example:

->f = getformat()

->print f

SCI

See also

set format

| HOME | BACK |


GETFOUT

| HOME | BACK |

Purpose

To get the current output file name for commands "fprint" and "flist".

Usage

{String} ret  =  GETFOUT()

Example:

->fname = getfout()

->print fname

RPT.txt

See also

set fout

| HOME | BACK |


GETINTP_MODE

| HOME | BACK |

Purpose

To get the current interpolation mode, resample type.  The returning result is "NEAREST", or "BILINEAR" or "BICUBIC".

Usage

{String} ret  =  GETINTP_MODE()

Example:

->resample = getintp_mode()

->print resample

NEAREST

See also

set intp_mode

| HOME | BACK |


GETMAGIC_NUMBER

| HOME | BACK |

Purpose

To get the current value of magic number, which is a constant used in some functions, e.g. estimated percent of noise in an image etc.  The magic number cannot be set.  Its sole purpose is to inform some of the important constants used in a particular function.

Usage

{double} ret  =  GETMAGIC_NUMBER()

Example:

->num = getmagic_number()

->

See also

 

| HOME | BACK |


GETMAX_NO_ITERATE

| HOME | BACK |

Purpose

To get the current number of the maximum number of iteration.  This is a system integer variable that control the maximum number of iteration in functions that require an iteration processing, for example exterior orientation, 3D conformal transformation, etc.

Usage

{int} ret  =  GETMAX_NO_ITERATE()

Example:

->no = getmax_no_iterate()

->print no

20

See also

set max_no_iterate

| HOME | BACK |


GETMAX_NO_ITERATE

| HOME | BACK |

Purpose

To get the current number of the maximum number of poly-line in vectors of poly-lines, e.g. VecIndx, VecPt2D, VecPt3D, VecRCpline, etc.

Usage

{int} ret  =  GETMAX_NO_PLINE()

Example:

->no = getmax_no_pline()

->print no

100000

See also

set max_no_pline

| HOME | BACK |


GETNA

| HOME | BACK |

Purpose

To get the current value of n/a (not applicable).  This value is used when no solution is found in some COGO functions, e.g. line intersection.

Usage

{double} ret  =  GETNA()

Example:

->na = getna()

->

See also

set na

| HOME | BACK |


GETNULL

| HOME | BACK |

Purpose

To get the current value of null data.

Usage

{double} ret  =  GETNULL()

Example:

->nul = getnull()

->

See also

set null

| HOME | BACK |


GETPATH

| HOME | BACK |

Purpose

To get the current data path, the directory where data files are to be searched.

Usage

{String} ret  =  GETPATH()

Example:

->path_1 = getpath()

->

See also

set path

| HOME | BACK |


GETPATHFUN

| HOME | BACK |

Purpose

To get the current function path, the directory from where function files are to be loaded.

Usage

{String} ret  =  GETPATHFUN()

Example:

->path_1 = getpathfun()

->

See also

set pathfun

| HOME | BACK |


GETPATHPRG

| HOME | BACK |

Purpose

To get the current program path, the directory from where program files are to be loaded.

Usage

{String} ret  =  GETPATHPRG()

Example:

->path_1 = getpathprg()

->

See also

set pathprg

| HOME | BACK |


GETPENCOLOR

| HOME | BACK |

Purpose

To get the current pen color, R (red), G (green, B (blue).

Usage

{Vector} ret  =  GETPENCOLOR()

Example:

->pen_1 = getpencolor()

->print pen_1

Vector size : 3

255.000

255.000

255.000

See also

set pencolor

| HOME | BACK |


GETPRECISION

| HOME | BACK |

Purpose

To get the current number of decimal digits used in command "print" and "fprint".

Usage

{int} ret  =  GETPRECISION()

Example:

->n = getprecision()

->

See also

set precision

| HOME | BACK |


GETRANDMAX

| HOME | BACK |

Purpose

To get the current default maximum value of the function "rand". 

Usage

{double} ret  =  GETRANDMAX()

Example:

->max_rand_val = getrandmax()

->

See also

set randmax

| HOME | BACK |


GETWIDTH

| HOME | BACK |

Purpose

To get the current printing width of commands "print" and "fprint".

Usage

{int} ret  =  GETWIDTH()

Example:

->n = getwidth()

->

See also

set width

| HOME | BACK |