<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/MATRICE/

make_selection.pro

topmake_selection

result = make_selection(names, selnames, only_valid=only_valid, required=required, quiet=quiet)

NAME: MAKE_SELECTION (function) PURPOSE: Convert an array of selected values to an index array that identifies the selected values in a list or data array. CATEGORY: Tools CALLING SEQUENCE: index = MAKE_SELECTION(NAMES,SELNAMES [,keywords]) 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 found are skipped. Default is to return 1 index value for each SELNAME, which is -1 if SELNAME is not contained in NAMES. If ONLY_VALID is set, the -1 values will be deleted, and a value of -1 indicates that no SELNAME has been found at all. 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 message is displayed). Set this keyword to return with -1 as soon as a selected value is not found. 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 in the NAMES array. SUBROUTINES: REQUIREMENTS: NOTES: If the NAMES array contains multiple entries of the same value, only the index to the first entry will be returned. A selection can contain multiple instances of the same value. The index array will contain one entry per selected item (See example below) EXAMPLE: 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 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 MODIFICATION HISTORY: mgs, 28 Aug 1998: VERSION 1.00 mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword

Parameters

names       

selnames       

Keywords

only_valid       

required       

quiet       

Produced by IDLdoc 2.0.