Changeset 19961 for trunk/psModules/src/objects/pmTrend2D.h

Timestamp:

Oct 7, 2008, 12:47:04 PM (18 years ago)

Author:

Paul Price

Message:

Statistics are only required when fitting a trend. If we load a trend (e.g., pmPSFmodelRead) then we don't need the statistics. Similar to psImageMap.

File:

• trunk/psModules/src/objects/pmTrend2D.h (modified) (2 diffs)

trunk/psModules/src/objects/pmTrend2D.h

@@ -5 +5 @@
  * @author EAM, IfA
  *
- * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
- * @date $Date: 2007-12-15 01:23:18 $
+ * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-10-07 22:47:04 $
  * Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
@@ -33 +33 @@
 } pmTrend2D;
 
+// Assertion for pmTrend2D
+#define PM_ASSERT_TREND2D_NON_NULL(TREND, RVAL) \
+if (!(TREND)) { \
+    psError(PS_ERR_UNEXPECTED_NULL, true, "Trend %s is NULL", #TREND); \
+    return RVAL; \
+} \
+if ((TREND)->mode == PM_TREND_MAP) { \
+    PS_ASSERT_IMAGE_MAP_NON_NULL((TREND)->map, RVAL); \
+} else if ((TREND)->mode == PM_TREND_POLY_ORD || (TREND)->mode == PM_TREND_POLY_CHEB) { \
+    PS_ASSERT_POLY_NON_NULL((TREND)->poly, RVAL); \
+} else if ((TREND)->mode != PM_TREND_NONE) { \
+    psError(PS_ERR_BAD_PARAMETER_VALUE, true, "Unknown trend mode for %s: %x", #TREND, (TREND)->mode); \
+    return RVAL; \
+}
+
+#define PM_ASSERT_TREND2D_STATS(TREND, RVAL) \
+if (!(TREND)->stats) { \
+    psError(PS_ERR_UNEXPECTED_NULL, true, "Trend %s statistics is NULL", #TREND); \
+    return RVAL; \
+}
+
+
 // allocate a pmTrend2D structure tied to an image dimensions.  nXtrend,nYtrend is the order for the polynomials, max number of grid cells for
 // psImageMap
-pmTrend2D *pmTrend2DAlloc (pmTrend2DMode mode, psImage *image, int nXtrend, int nYtrend, psStats *stats);
+pmTrend2D *pmTrend2DAlloc(pmTrend2DMode mode,
+                          psImage *image,
+                          int nXtrend, int nYtrend,
+                          psStats *stats
+);
 
-bool psMemCheckTrend2D(psPtr ptr);
+bool psMemCheckTrend2D(psPtr ptr
+    );
 
-pmTrend2D *pmTrend2DNoImageAlloc (pmTrend2DMode mode, psImageBinning *binning, psStats *stats);
+pmTrend2D *pmTrend2DNoImageAlloc(pmTrend2DMode mode,
+                                 psImageBinning *binning,
+                                 psStats *stats
+    );
 
 // allocate a pmTrend2D tied to an abstract field with size nXfield,nYfield
-pmTrend2D *pmTrend2DFieldAlloc (pmTrend2DMode mode, int nXfield, int nYfield, int nXtrend, int nYtrend, psStats *stats);
+pmTrend2D *pmTrend2DFieldAlloc(pmTrend2DMode mode,
+                               int nXfield, int nYfield,
+                               int nXtrend, int nYtrend,
+                               psStats *stats
+    );
 
-bool pmTrend2DFit (pmTrend2D *trend, psVector *mask, psMaskType maskVal, psVector *x, psVector *y, psVector *f, psVector *df);
+bool pmTrend2DFit(pmTrend2D *trend,
+                  psVector *mask,       // Warning: mask is modified!
+                  psMaskType maskVal,
+                  const psVector *x,
+                  const psVector *y,
+                  const psVector *f,
+                  const psVector *df
+    );
 
-double pmTrend2DEval (pmTrend2D *trend, float x, float y);
-psVector *pmTrend2DEvalVector (pmTrend2D *trend, psVector *x, psVector *y);
+double pmTrend2DEval(const pmTrend2D *trend,
+                     float x, float y
+    );
+psVector *pmTrend2DEvalVector(const pmTrend2D *trend,
+                              const psVector *x, const psVector *y
+    );
 
-psString pmTrend2DModeToString (pmTrend2DMode mode);
-pmTrend2DMode pmTrend2DModeFromString (psString name);
+psString pmTrend2DModeToString(pmTrend2DMode mode);
+pmTrend2DMode pmTrend2DModeFromString(psString name);
 
 /// @}