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

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.h (modified) (7 diffs)

trunk/SophyaLib/NTools/cimage.h

@@ -16 +16 @@
 namespace SOPHYA {
 
+//! Class for handling images
 template <class T>
 class Image : public TMatrix<T> {
@@ -21 +22 @@
 public:
   Image();
-  Image(uint_4 sizx, uint_4 sizy, r_8 szpx=1., r_8 szpy=1., r_8 orgx=0., r_8 orgy=0.);
+  Image(sa_size_t sizx, sa_size_t sizy, r_8 szpx=1., r_8 szpy=1., r_8 orgx=0., r_8 orgy=0.);
   Image(const Image<T>& a);
   Image(const Image<T>& a, bool share);
@@ -28 +29 @@
 
   // Inline element acces methods 
-  inline T const& operator()(uint_4 ix,uint_4 jy) const;
-  inline T&       operator()(uint_4 ix,uint_4 jy);
+  inline T const& operator()(sa_size_t ix, sa_size_t jy) const;
+  inline T&       operator()(sa_size_t ix, sa_size_t jy);
 
-  inline uint_4  XSize() const {return NCols();}
-  inline uint_4  YSize() const {return NRows();}
+  //! Returns the image size along X (corresponding to the number of columns)  
+  inline sa_size_t  XSize() const {return NCols();}
+  //! Returns the image size along Y (corresponding to the number of lines)  
+  inline sa_size_t  YSize() const {return NRows();}
 
+  //! Returns the X position, for pixel(0,0)
   inline r_8     XOrg() const {return org_x;}
+  //! Returns the Y position, for pixel(0,0)
   inline r_8     YOrg() const {return org_y;}
 
+  //! Returns pixel size along X 
   inline r_8     XPixSize() const {return pxsz_x;}
+  //! Returns pixel size along Y
   inline r_8     YPixSize() const {return pxsz_y;}
 
-  inline r_8     XPos(uint_4 i) const {return org_x + i*pxsz_x;}
-  inline r_8     YPos(uint_4 j) const {return org_y + j*pxsz_y;}
+  //! Returns the pixel position along X, for pixels with X index \b i
+  inline r_8     XPos(sa_size_t i) const {return org_x + i*pxsz_x;}
+  //! Returns the pixel position along Y, for pixels with Y index \b j
+  inline r_8     YPos(sa_size_t j) const {return org_y + j*pxsz_y;}
 
+  //! Set the position for pixel(0,0)
   inline void    SetOrg(r_8 orgx=0., r_8 orgy=0.)
                        { org_x = orgx;  org_y = orgy; }  
+  //! Set the pixel size
   inline void    SetPixelSize(r_8 szx=1., r_8 szy=1.)
                        { pxsz_x = szx;   pxsz_y = szy; }
@@ -53 +64 @@
 };
 
+//! () : Return the pixel value (element) for pixel \b ix (column index) and \b jy (line index)
 template <class T>
-inline T const& Image<T>::operator()(uint_4 ix, uint_4 jy) const
+inline T const& Image<T>::operator()(sa_size_t ix, sa_size_t jy) const
 {
   return (TMatrix<T>::operator() (jy, ix));
 }
 
+//! () : Return the pixel value (element) for pixel \b ix (column index) and \b jy (line index)
 template <class T>
-inline T & Image<T>::operator()(uint_4 ix, uint_4 jy) 
+inline T & Image<T>::operator()(sa_size_t ix, sa_size_t jy) 
 {
   return (TMatrix<T>::operator() (jy, ix));
@@ -82 +95 @@
 };
 
-/*! \ingroup Image \fn operator<<(POutPersist&,Image<T>&)
+/*! \ingroup NTools \fn operator<<(POutPersist&,Image<T>&)
   \brief Write Image \b obj into POutPersist stream \b os */
 template <class T>
@@ -88 +101 @@
 { FIO_Image<T> fio(&obj);  fio.Write(os);  return(os); }
 
-/*! \ingroup Image \fn operator>>(PInPersist&,Image<T>&)
+/*! \ingroup NTools \fn operator>>(PInPersist&,Image<T>&)
   \brief Read Image \b obj from PInPersist stream \b os */
 template <class T>
@@ -102 +115 @@
 
 class GeneralFit;
+//! OBSOLETE - Should not be used - for compatibility with peida in (s)piapp
 class RzImage {
 public: