cafeextract

           extracts data arrays according given range/subgroup/group

           cafe

         cafeextract,env, x, y, err, range, subgroup, group

           env      - Cafe environment to get data from.
           range    - (optional) Defines range of data points to extract. This can
                      be either:
                       - Data point range, denoted by the data
                         point number:
                         <n1>[-], while ,  are positive
                         numbers. Data point numbers start from zero.
                         Open intervals can be represented with a
                         "*" instead of the number.
                         If only one number is given, a single
                         data point will be returned as index.
                         If <val2> is less than  all but the
                         interval <val2>.. are taken into account.
                       - X value range, denoted by float point numbers:
                         <val1>-,
                         while <val1>,  represents X values
                         defining the interval to return. Open
                         intervals can be represented with a *
                         instead of the value. If <val2> is less than
                         <val1> all but the interval ..
                         is returned.
                       - Vector of data point indices. The vector is
                         denoted with [val,val,...,val] (indgen may
                         be used also).
                       - Boolean expressions with X/Y values. All
                         values for which this expression is true are
                         returned as index. The expression may contain
                         algebraic formulas combined with comparison
                         operators "lt", "le", "eq", "gt", "ge" as used in IDL
                         comparisons. For each data point a keyword
                         is defined which has meaning and can be used
                         for the boolean expression:
                                 x - The x-column value.
                                 y - The y-column value.
                             error - The error column value.
                          selected - True when the data point is selected.
                               def - True when the data point is defined.
                               x1  - Multi column first column value.
                               x2  - Multi column second column
                                     value.
                               x3  - Multi column third column value.
                         To avoid interference with functions which
                         also can be used a lower/upper case
                         distinction  is made. IDL funktions should
                         be upper case.
                      Default is the entire data set to extract.
           subgroup - (optional) The data set (subgroup) for which the model
                      should be applied. This can be either the
                      subgroup number or the file name representing
                      the data set. It is possible to set more than
                      one subgroup, either with numbers in brackets
                      ([]) separated with ","; or denoting filenames
                      with wildcards ("*").
                      Default are all subgroups in currently used
                      group.
           group    - (optional) The data group for which folding
                      should applied.
                      Default is the current group. Must be in
                      range [0..29].

            verbose - Report extraction parameters.

                  x - combined x value according
                      range/def/subgroup/group specification.
                  y - combined y value according
                      range/def/subgroup/group specification.
                 err- combined error value according
                      range/def/subgroup/group specification.
                      If subgroup does not contain error this
                      variable remains undefined.

           None.

           > cafeextract,x,y,err
           > pfold,x,y,profile

           $Id: cafeextract.pro,v 1.10 2005/01/04 10:56:05 goehler Exp $
 $Log: cafeextract.pro,v $
 Revision 1.10  2005/01/04 10:56:05  goehler
 fix: make shure all (internal) routines are properly documented
 Revision 1.9  2004/09/10 08:38:06  goehler
 report only in verbose case
 Revision 1.8  2004/01/02 05:32:45  goehler
 fix: no recognition of error column due to wrong comparison.
 Revision 1.7  2003/12/15 10:37:47  goehler
 fix: allow multi dimension x variables to return
 Revision 1.6  2003/12/01 07:53:00  goehler
 change: data sets contain "title" to store information in.
         files remain unmodified when applying modify,file=foo command.
 Revision 1.5  2003/09/19 07:45:44  goehler
 update range selection documentation
 Revision 1.4  2003/05/23 12:46:51  goehler
 - moved range string expansion into caferange.pro
 - caferange now supports vector indices
 Revision 1.3  2003/05/08 10:05:48  goehler
 fix: recognize error existence properly
 Revision 1.2  2003/05/06 16:20:06  goehler
 bug fix: extract defined points only
 Revision 1.1  2003/05/06 13:19:01  goehler
 initial version of extractor function which returns for given range/subgroup/group
 a full data list.

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]