Changeset 1570 in lmdz_wrf for trunk

Timestamp:

May 12, 2017, 5:20:10 PM (8 years ago)

Author:

lfita

Message:

Adding:

`minmax_range': Function to provide a range for a given pair of minimum and maximum

File:

• trunk/tools/generic_tools.py (modified) (2 diffs)

trunk/tools/generic_tools.py

@@ -95 +95 @@
 # list_differences: Function to provide the differences between two lists
 # list_norepeatcombos: Function to all possible (Num-1)-combinations of a Num values without repetitions
-# lstring_values: Function to provide a new list-string from a string which is a list of word separated by a character if some values
-#   are repeated they are not included
+# lstring_values: Function to provide a new list-string from a string which is a list of word separated by a character if some values are repeated they are not included
+# minmax_range: Function to provide a range for a given pair of minimum and maximum
 # multi_index_mat: Function to provide the multiple coordinates of a given value inside a matrix
 # multi_index_string: Function to provide the indeces of every repetition of a group of characters within a string
@@ -11965 +11965 @@
     return slices
 
+def minmax_range(minv,maxv,rangekind):
+    """ Function to provide a range for a given pair of minimum and maximum
+      minv: minimum value from data
+      maxv: maximum value from data
+      rangekind: kind of range
+        [val1],[val2]: tacking the provided ',' separated list of desired [val1] and [val2]
+        'auto': automatically set up range using minv and maxv
+        'extremescentered': extremes automatically centered on zero by computing from data -absmax, absmax; 
+          absmax=max(abs(minval),maxval)
+        'meancentered': extremes automatically centered on mean by computing from data minv+meanv, maxv-meanv; 
+          meanv=(minval + maxval)/2.
+      >>> minmax_range(-3.25, 4.75, '-2.0,2.0')
+        [-2.0, 2.0]
+      >>> minmax_range(-3.25, 4.75, 'extremescentered')
+        [-4.75, 4.75]
+      >>> minmax_range(-3.25, 4.75, 'meancentered')
+        [-2.5, 4.0]
+    """
+    possibleranges = ['auto', 'extremescentered', 'meancentered']
+    if rangekind == 'None':
+        valmin = minv
+        valmax = maxv
+    else:
+        if not searchInlist(possibleranges, rangekind):
+            valmin = np.float(rangekind.split(',')[0])
+            valmax = np.float(rangekind.split(',')[1])
+        else:
+            if rangekind == 'auto':
+                valmin = minv
+                valmax = maxv
+            elif rangekind == 'extremescentered':
+                absmax = np.max([np.abs(minv), maxv])
+                valmin = -absmax*1.
+                valmax = absmax
+            elif rangekind == 'meancentered':
+                meanv = (minv + maxv)/2.
+                valmin = minv+meanv
+                valmax = maxv-meanv
+            else:
+                print errormsg
+                print '  ' +fname+ ": type of range '" + rangekind + "' not ready !!"
+                print '    available ones:', possibleranges
+                quit(-1)            
+
+    return [valmin, valmax]
+
 #quit()