[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


cafeparam Source code in cafeparam.pro

cafeparam

Name
           cafeparam
Purpose
           converts parameter to an index referencing this parameter
           in environment parameter list
Category
           CAFE
SUBCATEGORY:
           AUXILIARY ROUTINE
SYNTAX:
           index=cafeparam(env, string, group,options=options)
Input Parameters
           env      - The fit environment as defined in
                      cafeenv__define. Contains the parameters.
           param    - The parameter(s) to look for. These can be
                      either:
                        - The absolute parameter number in the
                          current model.
                        - An parameter number range, defined by the
                          first parameter and last parameter,
                          separated with "-".
                        - A string designating the parameter
                          name. The parameter name is usually
                          "model:parname". If this parameter name is
                          not unique in current model all matching
                          parameters tied.
                          Using the parameter name "*" matches all
                          parameters in current group.
                        - Both variants may be given as lists in
                          [...]. This allows to select more than one
                          parameter. The group must be set for each
                          parameters separately:
                          [par1:g1,par2:g2...par_n:g_n].
           group    - The group to use as default.
Output Parameters
           Returns index array referring a parameter in
           (*env).parameter. Returns -1 if nothing found.
Optional Output
           options  - String defining options to the parameter
                      which are given by strings in brackets (eg:
                      test[foo;bar]). If not defined the string is
                      empty.
Revision History
           $Id: cafeparam.pro,v 1.8 2005/01/04 14:04:53 goehler Exp $
 $Log: cafeparam.pro,v $
 Revision 1.8  2005/01/04 14:04:53  goehler
 fix: proper header
 Revision 1.7  2004/02/13 14:00:50  goehler
 - use strmatch instead strpos for wildcarded parameters
 - allow more than one parameter in [].
 Revision 1.6  2003/03/03 11:18:34  goehler
 major change: environment struct has become a pointer -> support of wplot/command line
 in common.
 Branch to be able to maintain the former line also.
 Revision 1.5  2002/09/10 13:06:47  goehler
 removed ";-" to make auxilliary routines invisible
 Revision 1.4  2002/09/09 17:36:20  goehler
 public version: updated help matching aitlib html structure.
 common version: 3.0

Last modified by pro2html on 2005 January 04 at 16:29 UTC

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

Jörn Wilms ([email protected])
Updated automatically