Back to Alphabetical List



FILTER

Determines the filter used during Maximum Entropy processing, Filter can take values: 0, 1, or 2. Default value is 1. 0: is no filtering at all 1: is filtering done only if one of the following is non 0 : LB GB or JCONS The filter is constructed automatically from the value of those parameters 2: is filtering always, the filter used is the one currently loaded (can be checked with SHOW FILTER , and changed with PUT FILTER)
see also : GET NCHANNEL PUT SHOW WINDOW


FIND

FIND array_name nD (coordinate set) FIND permits to locate in arrays coded with a set of coordinates, the entry closest to a given location. array_name is the name of the searched array, nD (1, 2 or 3) is the number of coordinates used for the search, (coordinate set) is the coordinates of the target for the search. FIND returns the information in the contexts $PK_FND which gives the index of the found entry, and in $PK_FND_DST which gives the distance between the target and the found entry. The coordinates in the array have to be the first values in the field. The array can be user internal array, as well as a dbm bound array. related contexts : $PK_FND $PK_FND_DST
see also : FOREACH VARIABLES


FITGENE

FITGENE 'expression to minimize' num_of_param This command calls the generic minimizer and permits to fit a given function to the data currently held into memory. 'expression to minimize' is the function, given in Gifa language that will be minimized. The free (adaptable) parameters will be called $Pi with i ranging from 1 to num_of_par. the running parameter is to be called $X. num_of_par is the number of parameters to adapt in the previous expression Expression should a function of $X, $X will take all the values stored in the TAB buffer (see PUT TAB), the expression will be matched against the data in the current 1D working buffer. A CHI_square will be computed for the deviation and minimized. The adapted parameter are stored in the global user variables $P1..$Pn, if the variables do not exist before the call they will created with initial value of 1.0, if they exists, their value will be taken as initial value for the minimization. So be carefull with function which cannot accomodate 1.0 as starting value. The algorithm used is the Powell method, which does not require any derivative. The number of iterations is controled by ITER and MINITER. 10 is a good starting value for both of them. eg : dim 1 chsize 50 ; initialize one tm 50 50 put tab ; create a dump TAB[] one mult 1.5 specw 1000 em 100 ; create a dump data-set ; this one look like a T2 data iter 10 miniter 10 ; number of iterations FITGENE '$p1*exp(-$x/$p2)' 2 ; run fit print ($p1; $p2) ; print fitted parameters will produce : FITGENE Final Chi2 : .69268190E-14 1.75513 .1273239 then, try : showexp '$p1*exp(-$x/$p2)' related contexts : $CHI2 $SI_TAB $TAB[]
see also : ITER LINEFIT LINEFITD MINIMIZE MINITER PUT showexp


FLIP

Switch from a itype=1 2D data-set to a itype=2 by exchanging the imaginary parts. Useful only for processing phase modulated 2D data- sets : Gifa> FT F2 FLIP FT F1 REAL F1 will process a phase modulated data-set. related contexts : $ITYPE_2D
see also : FLOP FT ft_phase_modu ITYPE MODULUS


FLOP

Performs the inverse of FLIP. See FLIP. related contexts : $ITYPE_2D
see also : FLIP FT ft_phase_modu ITYPE MODULUS


FLUSH

Flushes the modified blocks of the cache memory system associated to the currently connected file onto the disk. related contexts : $C_JOINED
see also : dataset FLUSHCACHE JOIN LISTFILEC


FLUSHCACHE

Flushes all the modified of the cache memory system onto the associated files. related contexts : $C_JOINED
see also : FLUSH JOIN


FOR

FOR var = n TO p { STEP k } ... GIFA commands ENDFOR Control structure permitting to loop over a set of commands. The variable var will be created if does not yet exist. By default of STEP is 1, but any value can be used (including negative values in which case n should be larger than p). n, p and k should always be integer numbers. FOR and ENDFOR should appear alone on one line, eventually followed by a comment.
see also : CONTROLS FOREACH GOTO IF WHILE


FOREACH

FOREACH var IN array { WITHIN nD coord_set } ... GIFA commands ENDFOR Control structure permitting to go through all the entries of a user array, or a user dbm file. The variable var will take successively all the values of the entries in the array, ( $array[$var] ). The order is irrelevant. var will be created if does not exist yet. If the array entries are of the form : "x { y {z } } some other stuff" where x (y, z) is (are) numerical values, then the optionnal WITHIN syntax permits to specifically restrict the scanning to entries located in a given range. nD (1, 2 or 3) tells WITHIN to use 1, 2 or 3 numerical entries. Then coord_set is a set of coordinates, determining a range, as with the zoom syntax : range_low_1 { range_low_2 { range_low_3 }} range_high_1 { range_high_2 { range_high_3 }} FOREACH and ENDFOR should appear alone on one line, eventually followed by a comment.
see also : CONTROLS DBOPEN FIND FOR GOTO IF WHILE


FORGET

FORGET plot_file_name Permits to remove a plot file from the internal list of opened plots without issuing the PAGE command which also sends the plot to the plotter. However the plotter code for the ejection of the paper sheet is not inserted at the end of the plot_file.
see also : PAGE PLOT


FORMBOX

FORMBOX form_name gifa_command - [field_name field_param ] | - noreturn | (n times) - separator | * Permits to construct a form ( dialog box with editable fields). The box will appear in a window called form_name . The program continues after having created the form, whitch will stay on screen as long as the user dos not close it exolicitely. It will have three buttons at the button : Apply executes the command gifa_command and the form will remain on screen Ok executes the command gifa_command and closes the form Cancel does not execute any command and closes the form The command will be executed exactly as if the user had typed it as the prompt level, thus the command can be a simple command, several commands on a line, of a macro name. However the WHILE, FOR, FOREACH, IF .. THEN, GOTO commands are not available; the IF .. any_command syntaxe is available. If a parameter is missing for the command, the user will be prompted in the text window. The form is also composed en fields which appear one on each line in the window. A form can hold as many field as needed. Each field has the following general format : field_name field_type eventual list of parameters... field_name is displayed on the left side of the field field_type determines the kind of field, field_type is chosen in the following list : message, text, action, string, int, real, file, cursor, enum, multienum Field types are as follow: message type of field have no other field, this kind of entries serves to put plain text in the form text interprets field_name as a file name which is presented in a scrollable window. action gifa_command_2 will create an active button, bound to gifa_command_2; field_name will be used as the name of the button. All following type have a field_var entry which determines the name of the Gifa variable in which the user input will be stored, and the default_value entry which determines the value of that variable when creating the form : field_name field_type (eventual parameters) var_name default_value string int real and file types of field have no additionnal parameters. They appear in the window as editable string. When the user hits return there, the content of the string is copied to the Gifa variable var_name. file entries will have a small arrow which permits to open a standard file dialog window. field_name cursor starting_val ending_val numb_of_digit var_name default_value cursor permits to create a sliding cursors. It has 3 additionnal parameters : starting_val ending_val numb_of_digit. starting_val and ending_val determines the edge of the slider zone. numb_of_digit determines the resolution of the slider, if 0 -> will be integer, if larger -> will be real. field_name enum/multienum enul_list var_name default_value enum and multienum permit to choose an entry into a list. enum will appear as a pop up menu permitting to choose between the entries defined in the list : enum_list. multienum will appear as a scrollable list, and several entries can be chosen from the list These field have an additional entry : enum_list. This list is a single blank separated word, each item being separated with commas. Two special entries are also available, and not associated to fields but rather to formatting the box. separator permits to enter a separator in the form, noreturn implies that the following field will be presented on the same line than the previous entry. The variables used by the editable entries can be global variables, in which case they should have been created as global before calling the FORMBOX command. If this is not the case, they are created in a special context, available only to the command gifa_command when executed with the Apply or Ok buttons or from the actions buutons. This special context is completely local to the form. This permits to have several forms, using the same variables syntax, without interaction. The list is terminated with a star. Within the form the context $WIDGET is the id of the current FORMBOX, and can be used by the CLOSEFORM command. related contexts : $WIDGET $CONFIG_GRAPH
see also : BUTTONBOX CLOSEBUTTON CLOSEFORM DIALOGBOX MACRO


FPRINT

FPRINT file_name string Outputs the string to the file. file must have previously be OPENed (see OPEN).
see also : CLOSE fprintf OPEN PRINT


fprintf

fprintf file format_string arg1 arg2 ... * realises the equivalent of a C `fprintf' all the remaining of the line up to the star is taken as arguments and output the result to "file" (which should have been OPENed before) (known bug : a \n is inserted at the end of the format)
see also : FPRINT OPEN PRINT printf sprintf


FREEZE

freeze { p } FREEZE will freeze the specified graphic window in its current state, and will open a new window which will become the active window. There is no way to kill the frozen window, but to exit GIFA. Useful for comparing many graphics. Depending on which display mode are active, no parameters may be needed, or the user may have to choose which window to freeze : D (density) C (contour) 3 (3D)
see also : CDISP2D DISP1D DISP2D DISP3D


FREQ

FREQ freq_H1 freq1 { freq2 { freq3 } } The context FREQ holds the basic frequency of the spectrometer (in MHz). freq_H1 is meant to be the basic frequency of the spectrometer (1H freq) and is not used in the program. freq2 (and freq1 in 2D) are the freq associated to each dimension (different if in heteronuclear mode). Values are in MHz. related contexts : $FREQ $FREQ_1D $FREQ_1_2D $FREQ_1_3D $FREQ_2_2D $FREQ_2_3D $FREQ_3_3D
see also : calib OFFSET SPECW


FREQLIS

FREQLIST center excursion n Will list the index in the peak table which hold entries with frequency values in a given range of frequencies (centered on center with radius excursion ). The thus selected entries will be then selected with the RTSELECT command.
see also : RTLIST RTSELECT


FT

FT { axis } Performs in-place complex Fourier Transform on the current data-set; Data-set must be Complex. All FT commands work in 1D, 2D or 3D in 1D axis, is not needed in 2D axis, is F1, F2 or F12 in 3D axis, is F1, F2, F3, F12, F13, F23 or F123 Here is a complete overview of FT routines : C stands for Complex, R stands for Real FIDs Spectra C ---FT---> C C <--IFT--- C R --RFT--> C R <--IRFT-- C C -FTBIS-> R C <-IFTBIS- R R Does not exist R related contexts : $ITYPE_1D $ITYPE_2D $ITYPE_3D
see also : easy2d easy3d FLIP FLOP ft_phase_modu ft_seq ft_sh ft_sh_tppi ft_sim ft_tppi IFTBIS MODULUS proc2d proc3d REAL


FTBIS

FTBIS { axis } Performs complex-to-real Fourier Transform on data
see also : FT IFTBIS


ft_n+p

ft_n+p performs the fourier transform of a 2d data-set acquired in "n+p" mode i.e. PFG enhanced acquisition, with positive and negative gradients alternated Processing is performed only along the F1 axis
see also : FT ft_phase_modu ft_seq ft_sh ft_sh_tppi ft_sim ft_tppi


ft_phase_modu

ft_Phase_modu performs the F1 fourier transform of a 2d data-set acquired in phase modulation modea (Bruker magnitude mode MC2=M)
see also : FT ft_seq ft_sh ft_sh_tppi ft_sim ft_tppi


ft_seq

ft_seq performs the fourier transform of a data-set acquired on a Bruker in sequential mode Processing is performed only along the F2 (F3) axis if in 2D (3D) (Bruker QSEQ mode)
see also : FT ft_phase_modu ft_sh ft_sh_tppi ft_sim ft_tppi


ft_sh

ft_sh { axis } performs the fourier transform of a 2d data-set acquired in States-Haberkorn mode Processing is performed only along the F1 axis in 3D, axis may be either f1 or f2 (Bruker sh mode)
see also : FT ft_phase_modu ft_seq ft_sh_tppi ft_sim ft_tppi


ft_sh_tppi

ft_sh_tppi { axis } performs the fourier transform of a 2d data-set acquired in States-Haberkorn tppi mode Processing is performed only along the F1 axis in 3D, axis may be either f1 or f2 (Bruker sh_tppi mode)
see also : FT ft_phase_modu ft_seq ft_sh ft_sim ft_tppi


ft_sim

ft_sim performs the fourier transform of a data-set acquired on a Bruker in simultaneous mode Processing is performed only along the F2 (F3) axis if in 2D (3D) (Bruker QSIM mode)
see also : FT ft_phase_modu ft_seq ft_sh ft_sh_tppi ft_tppi


ft_tppi

ft_tppi { axis } performs the fourier transform of a 2d data-set acquired in tppi mode Processing is performed only along the F1 axis in 3D, axis may be either f1 or f2 (Bruker tppi mode)
see also : FT ft_phase_modu ft_seq ft_sh ft_sh_tppi ft_sim


FUNCTIONS

the following functions and operators are available within evaluated expression : Operators : o the regular 4 operations, modulo and power + - / * % ^ o arithmetic comparison == != < > <= >= o string comparison s= s! o logical operators | (or) & (and) ! (not) o string concatenation // (direct concatenation) ; (concatenation with a blank) functions : o the mathematical functions sqrt(x) cos(x) sin(x) atan(x) log(x) exp(x) abs(x) int(x) power2(n) max(x,y) min(x,y) o the alphanumeric functions : toupper(st) tolower(st) (transformations) sp(i) (makes blank strings) len(st) (length of the string) index(st1,st2) (locates st2 in st1) subst(st,i,j) (extracts (i:j) from st) head(st) (extract the 1st word) tail(st) (everything but the 1st word) headx(st,char) tailx(st,char) (same as head & tail but char is the separator) o file access eof(file) (true if End of File file is reached) o GIFA internal parameters val1d(i) val2d(i,j) val3d(i,j,k) (values in the 1D, 2D and 3D buffers) valamb(i,j) (value of the amoeba buffer) itoh(index,dim,axis) htoi(hertz,dim,axis) itop(index,dim,axis) ptoi(ppm,dim,axis) htop(hertz,dim,axis) ptoh(ppm,dim,axis) (unit conversions) nextlm(array,index) (next entry in associative or dbm array) exist(var_name) (true if var_name exists) dbm(var_name) (true if var_name is a dbm array)
see also : CONTEXTS CONTROLS MACRO VARIABLES