[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


MINMAX Source code in minmax.pro

MINMAX

Name
      MINMAX
Purpose
      Return a 2 element array giving the minimum and maximum of an array
Explanation
      Using MINMAX() is faster than doing a separate MAX and MIN.
Calling Sequence
      value = minmax( array )
Input Parameters
      array - an IDL numeric scalar, vector or array.
Output Parameters
      value = a two element vector (if DIMEN is not supplied)
            value[0] = minimum value of array
            value[1] = maximum value of array
            If the DIMEN keyword is supplied then value will be a 2 x N element
            array where N is the number of elements in the specified
            dimension
Optional Input Keywords
      /NAN   - Set this keyword to cause the routine to check for occurrences
            of the IEEE floating-point value NaN in the input data.  Elements
            with the value NaN are treated as missing data.
      DIMEN - (V5.5 or later) integer (either 1 or 2) specifying which
            dimension of a 2-d array to  take the minimum and maximum.   Note
            that DIMEN is only valid for a 2-d array, larger dimensions are
            not supported.
Optional Keyword Output
      SUBSCRIPT_MAX and SUBSCRIPT_MIN  Set either of these keywords to
            named variables to return the subscripts of the MIN and MAX
            values (V5.5 or later).
Example
     (1)  Print the minimum and maximum of an image array, im
            IDL> print, minmax( im )
     (2) Given a 2-dimension array of (echelle) wavelengths w, print the
         minimum and maximum of each order (requires V5.5 or later)
         print,minmax(w,dimen=1)
Procedure
      The MIN function is used with the MAX keyword
Revision History
      Written W. Landsman                January, 1990
      Converted to IDL V5.0   W. Landsman   September 1997
      Added NaN keyword.      M. Buie       June 1998
      Added DIMENSION keyword    W. Landsman  January 2002
      Added SUBSCRIPT_MIN and SUBSCRIPT_MAX  BT Jan 2005
      Check for IDL 5.5 or later, W. Thompson, 24-Feb-2005

Last modified by pro2html on 2005 February 25 at 06:12 UTC

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

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically