Changeset 344 for trunk/archive/pslib/include/psImage.h

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

• trunk/archive/pslib/include/psImage.h (modified) (12 diffs)

trunk/archive/pslib/include/psImage.h

@@ -22 +22 @@
         psF32 **rows_f32;               ///< pointers to psF32 data 
         psF64 **rows_f64;               ///< pointers to psF64 data 
-        psComplex **rows_complex;       //!< pointers to psComplex data
+        psComplex **rows_complex;       ///< pointers to psComplex data
     } rows;
     psImage *parent;                    ///< parent, if a subimage 
@@ -45 +45 @@
 /// Create a subimage of the specified area.
 psImage *
-psImageSubset(psImage *out,             //!< Subimage to return, or NULL
+psImageSubset(psImage *out,             ///< Subimage to return, or NULL
               const psImage *image,     ///< parent image 
               int nx,                   ///< subimage width (<= image.nx - x0)  
@@ -60 +60 @@
 /** Destroy the pixels of the specified image */
 psImage *
-psImageFreePixels(psImage *restrict image //!< Image whose pixels are to be freed
+psImageFreePixels(psImage *restrict image ///< Image whose pixels are to be freed
     );
 
@@ -78 +78 @@
 /// Extract pixels from rectlinear region to a vector.
 psFloatArray *
-psImageSlice(psFloatArray *out,         //!< Vector to output, or NULL
+psImageSlice(psFloatArray *out,         ///< Vector to output, or NULL
              const psImage *input,      ///< extract slice from this image
              int x,                     ///< starting x coord of region to slice
@@ -90 +90 @@
 /// Extract pixels along a line to a vector.
 psFloatArray *
-psImageCut(psFloatArray *out,           //!< Vector to output, or NULL
+psImageCut(psFloatArray *out,           ///< Vector to output, or NULL
            const psImage *input,        ///< extract cut from this image
            float xs,                    ///< starting x coord of cut
@@ -102 +102 @@
 /// Extract radial annulii data to a vector.
 psFloatArray *
-psImageRadialCut(psFloatArray *out,     //!< Vector to output, or NULL
+psImageRadialCut(psFloatArray *out,     ///< Vector to output, or NULL
                  const psImage *input,  ///< extract profile from this image
                  float x,               ///< center x coord of annulii
@@ -115 +115 @@
 /// Extract a 2-d contour from an image at the given threshold.
 psFloatArray *
-psImageContour(psFloatArray *out,       //!< Vector to output, or NULL
+psImageContour(psFloatArray *out,       ///< Vector to output, or NULL
                const psImage *input,    ///< create contour for this image
                float threshold, ///< contour image at this threshold
@@ -125 +125 @@
 /// Rebin image to new scale.
 psImage *
-psImageRebin(psImage *out,              //!< Image to output, or NULL
+psImageRebin(psImage *out,              ///< Image to output, or NULL
              const psImage *input,      ///< rebin this image
              float scale,               ///< rebinning scale: doutput = scale*dinput
@@ -133 +133 @@
 /// Rotate image by given angle.
 psImage *
-psImageRotate(psImage *out,             //!< Image to output, or NULL
+psImageRotate(psImage *out,             ///< Image to output, or NULL
               const psImage *input,     ///< rotate this image
               float angle               ///< rotate by this amount anti-clockwise (degrees)
@@ -141 +141 @@
 /// Drop edge pixels, and set newly exposed pixels to 'exposed'.
 psImage *
-psImageShift(psImage *out,              //!< Image to output, or NULL
+psImageShift(psImage *out,              ///< Image to output, or NULL
              const psImage *input,      ///< shift this image
              float dx,                  ///< shift by this amount in x
@@ -151 +151 @@
 /// Edge pixels wrap to the other side (no values are lost).
 psImage *
-psImageRoll(psImage *out,               //!< Image to output, or NULL
+psImageRoll(psImage *out,               ///< Image to output, or NULL
             const psImage *input,       ///< roll this image
             int dx,                     ///< roll this amount in x
@@ -249 +249 @@
 /// Perform an FFT on the image.  The output image type is psComplex.
 psImage *
-psImageFFT(psImage *output,             //!< Output image
+psImageFFT(psImage *output,             ///< Output image
            const psImage *input,        ///< image to FFT
            int direction                ///< FFT direction