./guide
setfind.pro

Last modification date:

Wed Sep 28 13:27:09 2016

setfind

procedure setfind[, param][, val1][, val2], [/append]

Set a selection parameter to be used later by find

This sets one of the fields in the structure used by FIND. There is one field for each of the possible selection parameters (use listcols to see a list of the available search parameters). A single value can be entered as can a range of values. Or, a single string can be used here in which case that string is saved as is to be used by SELECT inside of FIND. See the discussion on "Find" in the User's Guide for selection syntax examples. This routine can be used to either replace the current selection parameter value with another (the default behavior) or it can be used to append more information to the current selection parameter value.

See listfind to show the current value of any of the possible selection parameters used by FIND.

clearfind can be used to unset selection parameters used by FIND.

Examples

See also find

    setfind  ; a list of parameters is shown, you type one
             ;  then you are asked for a value, no quotes necessary
    setfind,'scan' ; you are asked for one value, the SCAN
                   ; selection criteria is set to that value
    setfind,'samp','A1' ; sets SAMPLER (min-match) to 'A1'
    setfind,'int',1,3   ; integrations 1 through 3
    setfind,'int',4,/append ; oops, forgot about 4
    setfind,'int','1:3,4' ; equivalent to the previous 2
    setfind,'restfreq',1420.4e9 ; single precision floating point
    setfind,'restfreq',1420.4058d9 ; double precision
 

Note that nothing happens until you use find

Version

$Id$

Parameters
param in, optional string	The selection parameter to set. If this parameter is omitted, the user is asked to choose from the list of available parameters and all other parameters (val1 and val2) are ignored. Min-match is used to find the parameter to set. If more than one parameter matches, a warning is printed and the procedure ends without setting any values. Case is not important.
val1 in, optional appropriate to param	The value that param is set to. Any valid selection syntax (strings, integers or floating point values) is allowed here. If val2 is also used, then these two values define a range and that range is the value that the selection parameter is set to. In that case, val1 and val2 must not be strings since string selection parameters (e.g. source) do not allow ranges. If val1 is a string then val2 is ignored if supplied and val1 is used "as is" for the selection parameter. There is no syntax checking of string values at this step so an impromperly formed selection string may generate an error later when FIND is used. If not supplied, the user is asked for a value.
val2 in, optional floating or integer	This is used with val1 to define a selection range. If not supplied, only val1 is used and the user is not prompted for val2.

Keywords
append in, optional boolean	When set, the selection parameter value is appended to the existing parameter value for this parameter. Otherwise, the existing value is replaced with the new value.