Changeset 11755 for trunk/psLib/src/math/psClip.h

Timestamp:

Feb 12, 2007, 2:19:51 PM (19 years ago)

Author:

Paul Price

Message:

Can really only code a single rejection iteration in psClip, because the user needs to be able to re-run his analysis to produce a new list of values to clip at each iteration. Moved the min-max rejection into a separate function.

File:

• trunk/psLib/src/math/psClip.h (modified) (2 diffs)

trunk/psLib/src/math/psClip.h

@@ -2 +2 @@
  * @brief vector clipping functions
  *
- * $Revision: 1.2 $ $Name: not supported by cvs2svn $
- * $Date: 2007-01-23 22:47:23 $
- * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
+ * @author Paul Price, IfA.
+ *
+ * $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ * $Date: 2007-02-13 00:19:51 $
+ * Copyright 2007 Institute for Astronomy, University of Hawaii
  */
 
@@ -21 +23 @@
     float fracLow;                      ///< Fraction of low values to clip
     int numKeep;                        ///< Minimum number of values to keep from clipping
-    int iter;                           ///< Number of rejection iterations
+    int iter;                           ///< Number of rejection iterations; unused by psClip functions
     float rej;                          ///< Rejection limit (standard deviations)
     psMaskType masked;                  ///< Mask value for entries already masked
     psMaskType clipped;                 ///< Mask value to give to clipped entries
-    float mean;                         ///< Resultant mean
-    float stdev;                        ///< Resultant stdev
+    double mean;                        ///< Resultant mean
+    double stdev;                       ///< Resultant stdev
 }
 psClipParams;
 
 
-long psClip(psClipParams *params,       ///< Clip parameters
-            psVector *values,           ///< Values to inspect and clip
-            psVector *mask,             ///< Mask for values
-            const psVector *errors      ///< Errors for values
-           );
+
+/// Apply min-max clipping to a list of values
+///
+/// The specified fraction of high and low values are identified as clipped in the mask.  Errors are not used
+/// in this step.
+long psClipMinMax(const psClipParams *params, ///< Clip parameters
+                  const psVector *values, ///< Values to inspect and clip
+                  psVector *mask        ///< Mask for values
+    );
+
+
+
+/// Apply a rejection iteration to a list of values
+///
+/// The specified rejection limit is applied to the values and errors; discrepant values are identified as
+/// clipped in the mask.  This function only applies a single rejection iteration.
+long psClipReject(psClipParams *params, ///< Clip parameters
+                  const psVector *values, ///< Values to inspect and clip
+                  psVector *mask,       ///< Mask for values
+                  const psVector *errors ///< Errors for values, or NULL
+    );
 
 /// @}