Changeset 133 for trunk/SRC/Matrix/make_selection.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Matrix

Files:

• . (added)
• make_selection.pro (moved) (moved from trunk/SRC/ToBeReviewed/MATRICE/make_selection.pro) (4 diffs)

trunk/SRC/Matrix/make_selection.pro

@@ -1 @@
-; $Id$
-;-------------------------------------------------------------
 ;+
-; NAME:
-;        MAKE_SELECTION (function)
 ;
-; PURPOSE:
-;        Convert an array of selected values to an index
+; file_comments 
+; Convert an array of selected values to an index
 ;        array that identifies the selected values in a list
 ;        or data array. 
 ;
-; CATEGORY:
-;        Tools
+; categories tools
+; 
+; @param NAMES {in}{required} A list or array of values to choose from 
 ;
-; CALLING SEQUENCE:
-;        index = MAKE_SELECTION(NAMES,SELNAMES [,keywords])
+; @param SELNAMES {in}{required} A list of selected values
 ;
-; INPUTS:
-;        NAMES -> A list or array of values to choose from 
-;
-;        SELNAMES -> A list of selected values
-;
-; KEYWORD PARAMETERS:
-;        ONLY_VALID -> Return only indices of found values. Values not
+; @keyword ONLY_VALID Return only indices of found values. Values not
 ;            found are skipped. Default is to return 1 index value for
 ;            each SELNAME, which is -1 if SELNAME is not contained in 
@@ -29 +19 @@
 ;            at all.
 ;
-;        REQUIRED -> Normally, MAKE_SELECTION will return indices for
+; @keyword REQUIRED Normally, MAKE_SELECTION will return indices for
 ;            all values that are found, simply ignoring the selected
 ;            values that are not in the NAMES array (although an error
@@ -35 +25 @@
 ;            -1 as soon as a selected value is not found.
 ;
-;        QUIET -> Suppress printing of the error message if a
+; @keyword QUIET Suppress printing of the error message if a
 ;            selected value is not found (the error condition will
 ;            still be set).
 ;
-; OUTPUTS:
-;        A (long) array with indices to reference the selected values
+; @returns A (long) array with indices to reference the selected values
 ;        in the NAMES array.
 ;
-; SUBROUTINES:
-;
-; REQUIREMENTS:
-;
-; NOTES:
-;        If the NAMES array contains multiple entries of the same value,
+; @restrictions If the NAMES array contains multiple entries of the same value,
 ;        only the index to the first entry will be returned.
 ;
@@ -55 +39 @@
 ;        (See example below)
 ;
-; EXAMPLE:
-;        names = [ 'Alfred','Anton','Peter','John','Mary']
-;        index = MAKE_SELECTION(names,['Peter','Mary'])
-;        print,index
-;        ; prints  2  4
+; @examples names = [ 'Alfred','Anton','Peter','John','Mary']
+;           index = MAKE_SELECTION(names,['Peter','Mary'])
+;           print,index
+;           ; prints  2  4
 ;
-;        vals = indgen(20)
-;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
-;        print,index
-;        ; prints  9  -1  8  7  7  8  9
+;           vals = indgen(20)
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
+;           print,index
+;           ; prints  9  -1  8  7  7  8  9
 ;
-;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
-;        print,index
-;        ; prints  9  8  7  7  8  9
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
+;           print,index
+;           ; prints  9  8  7  7  8  9
 ;
-;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
-;        print,index
-;        ; prints  -1
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
+;           print,index
+;           ; prints  -1
 ;
+; @history mgs, 28 Aug 1998: VERSION 1.00
+;          mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword
 ;
-; MODIFICATION HISTORY:
-;        mgs, 28 Aug 1998: VERSION 1.00
-;        mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword
+; @version $Id$
 ;
 ;-