Changeset 16141 for branches/pap_branch_080117/psLib/src/fits/psFitsScale.h

Timestamp:

Jan 18, 2008, 3:04:13 PM (19 years ago)

Author:

Paul Price

Message:

Moving all options on FITS I/O into an additional structure, psFitsOptions. The idea is that this can be carried around independently of the FITS structure, which is only created when opening a file.

File:

• branches/pap_branch_080117/psLib/src/fits/psFitsScale.h (modified) (2 diffs)

branches/pap_branch_080117/psLib/src/fits/psFitsScale.h

@@ -14 +14 @@
 /// functions.  Therefore, since the other FITS functions don't have the mask, while the user may, it is the
 /// user's responsibility to call this function.
-bool psFitsScaleMeasure(psFits *fits,   ///< FITS options
+bool psFitsScaleMeasure(psFits *fits,   ///< FITS file
                         const psImage *image, ///< Image to measure
                         const psImage *mask, ///< Mask image, or NULL
                         psMaskType maskVal, ///< Value to mask
-                        psRandom *rng // Random number generator, or NULL
+                        psRandom *rng ///< Random number generator, or NULL
     );
 
 /// Determine BSCALE and BZERO for an image
-bool psFitsScaleDetermine(double *bscale, // Scaling, to return
-                          double *bzero, // Zero point, to return
-                          const psImage *image, // Image to scale
-                          const psFits *fits // FITS options
+bool psFitsScaleDetermine(double *bscale, ///< Scaling, to return
+                          double *bzero, ///< Zero point, to return
+                          const psImage *image, ///< Image to scale
+                          const psFits *fits ///< FITS options
     );
 
@@ -34 +34 @@
 /// time, and unity 10% of the time), though at the cost of adding an additional variance of 1/12 (a standard
 /// deviation of ~0.29).
-psImage *psFitsScaleForDisk(const psImage *image, // Image to which to apply BSCALE and BZERO
-                            int bitpix, // Output BITPIX
-                            double bscale, // Scaling
-                            double bzero, // Zero point
-                            bool fuzz,  // Apply fuzz?
-                            psRandom *rng // Random number generator (for the "fuzz"), or NULL
+psImage *psFitsScaleForDisk(const psImage *image, ///< Image to which to apply BSCALE and BZERO
+                            const psFits *fits, ///< FITS file
+                            double bscale, ///< Scaling
+                            double bzero, ///< Zero point
+                            psRandom *rng ///< Random number generator (for the "fuzz"), or NULL
     );
 
+/// Interpret a string as a scaling method
+psFitsScaling psFitsScalingFromString(const char *string ///< String to interpret
+    );
 
 #endif