Index: /trunk/Ohana/src/opihi/cmd.basic/help/break =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/break (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.basic/help/break (revision 14175) @@ -1,7 +1,10 @@ - break + break [-auto on/off] halts macro, if, or for processes and returns to the basic prompt. + -auto: enables or disables DVO from automatically breaking + when it encounters an error + See also: macro, if, for Index: /trunk/Ohana/src/opihi/cmd.basic/help/continue =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/continue (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/continue (revision 14175) @@ -0,0 +1,4 @@ + + continue + + Return to the start of a for-loop. Index: /trunk/Ohana/src/opihi/cmd.basic/help/date =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/date (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/date (revision 14175) @@ -0,0 +1,6 @@ + + date (variable) + + Return the date and place it into (variable). + + Default: print to window Index: /trunk/Ohana/src/opihi/cmd.basic/help/exec =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/exec (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.basic/help/exec (revision 14175) @@ -1,6 +1,6 @@ - exec (or !) system function + exec (shell command) - perform a UNIX system call. variables are parsed before - the commands is passed to the UNIX shell. - + Allows a shell command to be run while running DVO + On the command line, this can also be done by placing a "!" before the shell + command Index: /trunk/Ohana/src/opihi/cmd.basic/help/file =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/file (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/file (revision 14175) @@ -0,0 +1,9 @@ + + file (filename) (variable) + + Checks to see if a file exists + + If a variable is specified, then it is set to 1 if the file is present + and set to 0 if it is not. + + Default: output printed to the window Index: /trunk/Ohana/src/opihi/cmd.basic/help/fprintf =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/fprintf (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/fprintf (revision 14175) @@ -0,0 +1,15 @@ + + fprintf ("format codes") (value1 value2 ...) + + Prints output according to a specified format + + Fomat codes must match the order and number of values. + + FORMAT CODES: + %x.yf : floating point number with x total places and y places after + the decimal point; further decimal places are rounded + %x.ye : number in scientific notation with x places and y places after + the decimal point; further decimal places are rounded + %xs : ASCII output with x places + %xd : Integers with x places + %x : Express number in hexidesimal Index: /trunk/Ohana/src/opihi/cmd.basic/help/getchr =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/getchr (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/getchr (revision 14175) @@ -0,0 +1,8 @@ + + getchr (string) (char) [variable] + + Return the index of the string in the position of the specified character + + Only the first instance of a character is returned. + + If not found, the variable is set to -1. Index: /trunk/Ohana/src/opihi/cmd.basic/help/list =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/list (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/list (revision 14175) @@ -0,0 +1,23 @@ + + list (name) (string1) (string2) ... end + OR + list (name) -split (string1) (string2) ... + OR + list (name) -x "(ls command)" + OR + list (name) -x "cat (file)" + + Create a list of strings that are zero indexed. + + $(name):n = the number of elements in the list (name) + + $(name):5 = the 6th element of the list (name) + + -split option: Turn a list of strings (separated by white spaces) + into a list + + -x option: turn an ls command or file into a list (one list element per + line in the file + 1 white space) + + ***Note: the list ... end version of the command does not currently work + within macros Index: /trunk/Ohana/src/opihi/cmd.basic/help/local =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/local (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/local (revision 14175) @@ -0,0 +1,7 @@ + + local (var) + + Creates a variable that is accessible only within the macro + in which it is created. + + Variable value is listed as (macro).(var) using the "??" command Index: /trunk/Ohana/src/opihi/cmd.basic/help/pwd =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/pwd (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.basic/help/pwd (revision 14175) @@ -1,5 +1,7 @@ - pwd + pwd -var (variable) print current working directory + Using -var will place the output into the specified variable. + Default: print to window Index: /trunk/Ohana/src/opihi/cmd.basic/help/quit =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/quit (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.basic/help/quit (revision 14175) @@ -0,0 +1,4 @@ + + quit + + Exit from DVO Index: /trunk/Ohana/src/opihi/cmd.basic/help/scan =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/scan (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.basic/help/scan (revision 14175) @@ -2,4 +2,7 @@ scan (filename) (variable) [Nline] - place the Nth line in the file in the named variable + Place the Nth line of the file into the named variable + Default N value: 1 (the 1st line) + + The variable recieves the line + 1 white space Index: /trunk/Ohana/src/opihi/cmd.basic/help/sleep =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/sleep (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/sleep (revision 14175) @@ -0,0 +1,4 @@ + + sleep (N) + + Wait for (N) seconds before continuing Index: /trunk/Ohana/src/opihi/cmd.basic/help/sprintf =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/sprintf (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/sprintf (revision 14175) @@ -0,0 +1,17 @@ + + sprintf (var) ("format codes") (value1 value2 ...) + + Prints output according to a specified format + + Works same as fprintf, except it places the output as a string into (var) + + Fomat codes must match the order and number of values. + + FORMAT CODES: + %x.yf : floating point number with x total places and y places after + the decimal point; further decimal places are rounded + %x.ye : number in scientific notation with x places and y places after + the decimal point; further decimal places are rounded + %xs : ASCII output with x places + %xd : Integers with x places + %x : Express number in hexidesimal Index: /trunk/Ohana/src/opihi/cmd.basic/help/strlen =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/strlen (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/strlen (revision 14175) @@ -0,0 +1,10 @@ + + strlen (string) [var] + + Determines the number of characters (plus white spaces) in a string + and places it into var + + Default: print to window + + Note: If the string has white spaces, you need to place it within + double-quotes. Index: /trunk/Ohana/src/opihi/cmd.basic/help/strpop =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/strpop (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/strpop (revision 14175) @@ -0,0 +1,12 @@ + + strpop (string) [var] + + Pops part of a string or a list element that can be placed + into [var] + + Default: print to window + + The output is the first set of characters bordered by white space + + ***Note: Both (string) and [var] must be entered without the "$" + variable identifier for the program to work properly. Index: /trunk/Ohana/src/opihi/cmd.basic/help/substr =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/substr (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/substr (revision 14175) @@ -0,0 +1,11 @@ + + substr (string) (index) (length) [var] + + Returns part of a string starting at the position (index) + and of size (length), which can then be placed into [var] + + Default: print to window + + The sub-string is not removed from the original string + + ***Note: Character positions in strings are zero-indexed Index: /trunk/Ohana/src/opihi/cmd.basic/help/usleep =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/usleep (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/usleep (revision 14175) @@ -0,0 +1,4 @@ + + usleep (N) + + Wait for (N) microseconds before continuing Index: /trunk/Ohana/src/opihi/cmd.basic/help/while =================================================================== --- /trunk/Ohana/src/opihi/cmd.basic/help/while (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.basic/help/while (revision 14175) @@ -0,0 +1,5 @@ + + while (condition) ... end + + Perform a set of actions until the condition is true + Index: /trunk/Ohana/src/opihi/cmd.data/help/close =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/close (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/close (revision 14175) @@ -0,0 +1,14 @@ + + + close [-n win] [-g Kapa win] [-i Kii win] + + Closes the specified graphics window + + Default: the most recently activated window (only works + for the first call) + + [win]: the index of the window to close + + -n: any graphics or plotting window + -g: the Kapa plotting window + -i: the Kii image window Index: /trunk/Ohana/src/opihi/cmd.data/help/concat =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/concat (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.data/help/concat (revision 14175) @@ -2,7 +2,6 @@ concat v1 v2 - concatenates the values of vector v2 to the end of vector - v1, increasing the length of v1. + Concatenates the values of vector v1 to the end of vector + v2, increasing the length of v2. See also: subset, set - Index: /trunk/Ohana/src/opihi/cmd.data/help/create =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/create (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.data/help/create (revision 14175) @@ -1,7 +1,9 @@ - create vector start end [delta] + create (vector) (start) (end) [delta] - create a vector of uniformly spaced values, starting at - start and going to end. By default the spacing is 1, but - may be chosen with the delta option. + Create a vector of uniformly spaced values, starting at + (start) and going to (end). By default the spacing is 1, but + may be chosen with the [delta] option. + Note: A vector cannot be created if an image buffer already + exists with the same name Index: /trunk/Ohana/src/opihi/cmd.data/help/cumulative =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/cumulative (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/cumulative (revision 14175) @@ -0,0 +1,8 @@ + + + cumulative (invec) (outvec) + + Creates a vector (outvec) where the element N is the sum of the elements + 0-N of (invec) + + Note: The final element of (outvec) is always 0 Index: /trunk/Ohana/src/opihi/cmd.data/help/delete =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/delete (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.data/help/delete (revision 14175) @@ -1,5 +1,10 @@ - delete + delete (buffer/vector/variable) - delete the named buffer. Warning: no second chances are given! + Delete the named buffer/vector/variable. + Warning: no second chances are given! + + Note: Delete will remove the buffer/vector of a + given name first, then delete the variable of + the same name upon the second call. Index: /trunk/Ohana/src/opihi/cmd.data/help/dimendown =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/dimendown (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/dimendown (revision 14175) @@ -0,0 +1,7 @@ + + + dimendown (buffer) (vector) [-x/-y] + + Compresses an image into a vector + + The vector can be given either the x or y coordinates of the image Index: /trunk/Ohana/src/opihi/cmd.data/help/dimenup =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/dimenup (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/dimenup (revision 14175) @@ -0,0 +1,5 @@ + + + dimenup (vector) (buffer) (Nx) (Ny) + + Expands a vector into an image with dimensions Nx,Ny Index: /trunk/Ohana/src/opihi/cmd.data/help/dot =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/dot (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/dot (revision 14175) @@ -0,0 +1,7 @@ + + + dot (x) (y) + + Plots a single point + + Uses the same style options as plot Index: /trunk/Ohana/src/opihi/cmd.data/help/fit =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/fit (revision 14174) +++ /trunk/Ohana/src/opihi/cmd.data/help/fit (revision 14175) @@ -1,4 +1,4 @@ - fit x y order [-dy wt] + fit (-q) x y (order) (-dy wt) (-clip sig N) perform a lease-square polynomial fit to the data defined @@ -6,4 +6,10 @@ $C0, $C1, ..., and the order is placed in $Cn. + order: order of fit + -q: quiets the fit (no output to window) + -dy: take into account the error vector wt + -clip: remove outliers beyond sig*sigma from the fit; + perform N iterations of this + See also: applyfit Index: /trunk/Ohana/src/opihi/cmd.data/help/integrate =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/integrate (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/integrate (revision 14175) @@ -0,0 +1,10 @@ + + integrate (x) (y) (start) (end) + + Perform an integration of (y) as a function of (x) from (start) to (end) + + The result is placed into the variable: $sum + + Caution!: Program uses the front end of each x bin to approximate the integral. + Very coarse bins (delta x = 1) over small regions (x=1->5) can introduce + errors as large as 20%. Fine bins are reccommended. Index: /trunk/Ohana/src/opihi/cmd.data/help/interpolate =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/interpolate (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/interpolate (revision 14175) @@ -0,0 +1,5 @@ + + interpolate (xin) (yin) (xout) (yout) + + Performs an interpolation of (xin) and (yin) onto the new grid (xout), + producing the corresponding y values in (yout) Index: /trunk/Ohana/src/opihi/cmd.data/help/peak =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/peak (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/peak (revision 14175) @@ -0,0 +1,12 @@ + + peak [-q] (x) (y) [startx endx] + + Determines the peak of the y vector between starx and endx + or between the extrema of the x vector (default) + + -q: quiets the script (no output to the window) + + Outputs: + $peakval: Value of the peak + $peakpos: X value corresponding to the peak value + $peaknum: Index of the peak value Index: /trunk/Ohana/src/opihi/cmd.data/help/periodogram =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/periodogram (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/periodogram (revision 14175) @@ -0,0 +1,6 @@ + + periodogram (time) (flux) (minP) (maxP) (period) (power) + + creates a periodogram from the vectors (time) and (flux) + between (minP) and (maxP) and outputs the results to + (period) and (power) Index: /trunk/Ohana/src/opihi/cmd.data/help/queuedelete =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/queuedelete (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/queuedelete (revision 14175) @@ -0,0 +1,4 @@ + + queuedelete (name) + + Deletes the entire queue (name) Index: /trunk/Ohana/src/opihi/cmd.data/help/queueinit =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/queueinit (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/queueinit (revision 14175) @@ -0,0 +1,4 @@ + + queueinit (name) + + Creates a queue (name) with an initial size of 0 Index: /trunk/Ohana/src/opihi/cmd.data/help/queuepush =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/queuepush (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/queuepush (revision 14175) @@ -0,0 +1,8 @@ + + queuepush (queue) (value) [-key N] [-uniq] [-replace] + + Pushes (value) onto the back of (queue) + + -key N: + -uniq: + -replace: Index: /trunk/Ohana/src/opihi/cmd.data/help/queuesize =================================================================== --- /trunk/Ohana/src/opihi/cmd.data/help/queuesize (revision 14175) +++ /trunk/Ohana/src/opihi/cmd.data/help/queuesize (revision 14175) @@ -0,0 +1,5 @@ + + queuesize (name) [-var variable] + + Returns the size of the queue (name), either to variable + or to the window (default)