Changeset 4417 for trunk/psModules/src/pmImageSubtract.h

Timestamp:

Jun 28, 2005, 1:23:55 PM (21 years ago)

Author:

gusciora

Message:

Significant modifications.

File:

• trunk/psModules/src/pmImageSubtract.h (modified) (4 diffs)

trunk/psModules/src/pmImageSubtract.h

@@ -1 +1 @@
 /** @file  ImageSubtract.h
  *
- *  This file will ...
+ *  This file will contain code which creates a set of kernel basis
+ *  functions, solves for their solution, and applies them to an image.
  *
+ *  @author Paul Price, IfA (original prototype)
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-20 23:21:05 $
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-28 23:23:55 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -26 +28 @@
 typedef enum {
     PM_SUBTRACTION_KERNEL_POIS,    ///< POIS kernel --- delta functions
-    PM_SUBTRACTION_KERNEL_ISIS    ///< ISIS kernel --- gaussians modified by polynomials
+    PM_SUBTRACTION_KERNEL_ISIS     ///< ISIS kernel --- gaussians modified by polynomials
 } pmSubtractionKernelsType;
 
@@ -32 +34 @@
 {
     pmSubtractionKernelsType type;   ///< Type ofKernels --- allowing the use of multiple kernels
-    psVector *u, *v;     ///< Offset (for POIS) or polynomial order (for ISIS)
-    psVector *sigma;     ///< Width of Gaussian (for ISIS)
-    psVector *xOrder, *yOrder;    ///< Spatial Polynomial order (for all)
-    int subIndex;     ///< Index of kernel to be subtracted to maintain flux conservation
-    psArray *preCalc;     ///< Array of images containing pre-calculated kernel (to
+    psVector *u, *v;                 ///< Offset (for POIS) or polynomial order (for ISIS)
+    psVector *sigma;                 ///< Width of Gaussian (for ISIS)
+    psVector *xOrder, *yOrder;       ///< Spatial Polynomial order (for all)
+    int subIndex;                    ///< Index of kernel to be subtracted to maintain flux conservation
+    psArray *preCalc;                ///< Array of images containing pre-calculated kernel (to
     ///< accelerate ISIS; don't use for POIS)
-    psS32 p_size;                                       ///< The halfsize of the kernel
-    psS32 p_spatialOrder;                               ///< The spatial order of the kernels
+    psS32 p_size;                    ///< The halfsize of the kernel
+    psS32 p_spatialOrder;            ///< The spatial order of the kernels
 }
 psSubtractionKernels;
@@ -52 +54 @@
 
 typedef enum {
-    PM_STAMP_INIT,     ///< Initial state
-    PM_STAMP_USED,     ///< Use this stamp
-    PM_STAMP_REJECTED,     ///< This stamp has been rejected
-    PM_STAMP_RECALC,     ///< Having been reset, this stamp is to be recalculated
-    PM_STAMP_NONE     ///< No stamp in this region
+    PM_STAMP_INIT,                   ///< Initial state
+    PM_STAMP_USED,                   ///< Use this stamp
+    PM_STAMP_REJECTED,               ///< This stamp has been rejected
+    PM_STAMP_RECALC,                 ///< Having been reset, this stamp is to be recalculated
+    PM_STAMP_NONE                    ///< No stamp in this region
 } pmStampStatus;