./guide
get.pro

Last modification date:

Wed Sep 28 13:27:09 2016

get

procedure get, [useflag=boolean or string], [skipflag=boolean or string], [_EXTRA=extra keywords]

Get data from the input data file and put that into the primary data container (buffer 0).

The data to be retrieved are specified by giving a number of selection parameters. If more than one record satisfies the selection criteria given, only the first is returned. If you need to retrieve one of the other records you must first refine the selection criteria. A better approach might be to use select to get the list of records that satisfy that selection and then use getrec to get the individual records.

Note : All of the data satisfying the selection criteria (or lack of criteria if none are given) are extracted from the file before this routine copies the first one found and puts it into buffer 0. There is no protection against running out of memory by grabbing too much data.

Run the procedure listcols to see a complete list of selection parameters.

See the discussion on "Select" in the User's Guide for a summary of selection syntax.

Flags (set via flag) can be selectively applied or ignored using the useflag and skipflag keywords. Only one of those two keywords can be used at a time (it is an error to use both at the same time). Both can be either a boolean (/useflag or /skipflag) or an array of strings. The default is /useflag, meaning that all flag rules that have been previously set are applied when the data is fetched from disk, blanking any data as described by each rule. If /skipflag is set, then all of the flag rules associated with this data are ignored and no data will be blanked when fetched from disk (it may still contain blanked values if the actual values in the disk file have already been blanked by some other process). If useflag is a string or array of strings, then only those flag rules having the same idstring value are used to blank the data. If skipflag is a string or array of strings, then all flag rules except those with the same idstring value are used to blank the data.

Examples

   filein,'my_raw_data.fits'
   listcols                  ; show the parameters that can be used
   get,index=0               ; retrieves the first record
   copy, 0, 10
   get, scan=6, plnum=0, ifnum=1, int=2
   oshow, 10
   get, scan=6, plnum=0, ifnum=1, int=2, /skipflag ; ignore all flags
   ; in this next example, only flags with idstring='wind' are ignored.
   get, scan=6, plnum=0, ifnum=1, int=2, skipflag='wind'
 

Uses

set_data_container

Version

$Id$

Keywords
useflag in, optional boolean or string (def. true)	Apply all or just some of the flag rules?
skipflag in, optional boolean or string	Do not apply any or do not apply a few of the flag rules?
_EXTRA in, optional extra keywords	These are selection parameters that determine which data to retrieve.