Changeset 2976 for inundation/utilities

Timestamp:

May 25, 2006, 5:22:58 PM (19 years ago)

Author:

ole

Message:

Option in histogram for frequency

File:

• inundation/utilities/numerical_tools.py (modified) (1 diff)

inundation/utilities/numerical_tools.py

@@ -204 +204 @@
 
 
-def histogram(a, bins):
+def histogram(a, bins, relative=False):
     """Standard histogram straight from the Numeric manual
+
+    If relative is True, values will be normalised againts the total and
+    thus represent frequencies rather than counts.
     """
 
     n = searchsorted(sort(a), bins)
     n = concatenate( [n, [len(a)]] )
-    return n[1:]-n[:-1]
+
+    hist = n[1:]-n[:-1]
+
+    if relative is True:
+        hist = hist/float(sum(hist))
+        
+    return hist 
 
 def create_bins(data, number_of_bins = None):