Changeset 1390 in Sophya for trunk/SophyaLib/NTools/cimage.cc

Timestamp:

Feb 9, 2001, 6:08:57 PM (25 years ago)

Author:

ansari

Message:

Modifs interface FFTServer , Reza 9/2/2001

File:

• trunk/SophyaLib/NTools/cimage.cc (modified) (5 diffs)

trunk/SophyaLib/NTools/cimage.cc

@@ -9 +9 @@
 #include "cimage.h"
 
+/*!
+   \class SOPHYA::Image
+   \ingroup NTools
+   This class specializes the Matrix class, for representing intensity 
+   (or grey-level) images. It adds the possibility of defining pixel
+   size and offset. The convention for the acces operator is also
+   changed, compared to the matrix class.
+*/
+
+//! Default constructor - Pixel array not allocated
 template <class T>
 Image<T>::Image()
@@ -18 +28 @@
 }
 
-template <class T>
-Image<T>::Image(uint_4 sizx, uint_4 sizy, r_8 szpx, r_8 szpy, r_8 orgx, r_8 orgy)
+//! Constructor, with specification of the image size, pixel size and offsets
+template <class T>
+Image<T>::Image(sa_size_t sizx, sa_size_t sizy, r_8 szpx, r_8 szpy, r_8 orgx, r_8 orgy)
 // Constructeur par defaut.
   : TMatrix<T>(sizy, sizx) 
@@ -27 +38 @@
 }
 
+//! Copy constructor
 template <class T>
 Image<T>::Image(const Image<T>& a)
@@ -35 +47 @@
 }
 
+
+//! Copy constructor with possibility of duplicating the pixel array
+/*!
+  \param share : if true, the data is shared, duplicated if false.
+*/
 template <class T>
 Image<T>::Image(const Image<T>& a, bool share)
@@ -42 +59 @@
   SetPixelSize(a.XPixSize(), a.YPixSize());
 }
+
+//! Destructor 
 template <class T>
 Image<T>::~Image()