[libcvd-members] libcvd/cvd image.h [subimage2]

[Edward Rosten]

CVSROOT:        /cvsroot/libcvd
Module name:    libcvd
Branch:         subimage2
Changes by:     Edward Rosten <edrosten>        06/06/29 18:58:20

Modified files:
        cvd            : image.h 

Log message:
        Removed old documentation.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/libcvd/cvd/image.h?cvsroot=libcvd&only_with_tag=subimage2&r1=1.20.2.5&r2=1.20.2.6

Patches:
Index: image.h
===================================================================
RCS file: /cvsroot/libcvd/libcvd/cvd/image.h,v
retrieving revision 1.20.2.5
retrieving revision 1.20.2.6
diff -u -b -r1.20.2.5 -r1.20.2.6
--- image.h     29 Jun 2006 18:49:31 -0000      1.20.2.5
+++ image.h     29 Jun 2006 18:58:20 -0000      1.20.2.6
@@ -30,97 +30,6 @@
 //                                                                      //
 //////////////////////////////////////////////////////////////////////////
 
-
-/*******************************************************************************
-
-                                                       CVD::Image
-       assume typedef ImageRef Ir, from here
-       
-       
-       CLASS HEIRACHY:
-
-       BasicImage                           Access an arbitraty block of data 
as an image
-         | 
-         +-VideoFrame               } Access blocks of data returned from video
-         |   |                      } capture devices as images. Defined in 
other
-      |   +-V4L2Frame            } files.
-         |   +-O2Frame              } 
-         |   :                  
-         |       +-LocalVideoFrame          } Access blocks of data from local 
sources 
-         |       |                  } as video frames. Since the data is 
local, 
-         |               +-DiskBuffer2Frame } these use Image to manage 
memory. Access
-         |       :                  } to the private image is allowed
-         |       +-etc              }
-         |
-         +-Image                  Images with memory management.
-
-       
-       METHODS
-
-         All images have the following methods (with const versions where 
-         applicable):
-
-         int           totalsize()                             Number of 
elements in the image
-         Ir            size()                                  Size (x by y) 
of image
-         bool          in_image(Ir)                    Is an ImageRef inside 
the image
-         T*            data()                                  block of data 
the image is in
-         T&            operator[](Ir)                  access pixels lika an 
array with an Ir
-         T*            operator[](int)                 return a row of the 
image
-         Ir            pos()                                   return position 
of a pointer
-
-         BasicImage is constructed from a blobck of data:
-
-         BasicImage(T*, ImageRef);
-
-
-
-         Image provides images which do reference counting on the data. 
Multiple
-         images can point to one block of data (so use the same care as with 
-         pointers). Copy constructing is quite fast (a 16 byte copy and an
-         increment) so they can be efficiently used in containers like 
std::vector.
-
-         copy_from(BasicImage)         Copies from an image, rather than 
referencing
-                                                               it.
-                                                               
-         make_unique()                         Makes the image be the only 
reference to the 
-                                                               data by copying 
the data if necessary.
-       
-         resize()                                      Resize the image. The 
image disowns the data 
-                                                               before resizing 
so that other images referencing
-                                                               it are not 
affected. data() will be altered.
-
-         Image(ImageRef)                       Create an empty image of this 
size.
-
-         Image(Image)                          Make this image reference the 
same block of
-         operator=(Image)                      data as the argument.
-
-         Image(BasicImage)                     Copy from a BasicImage. SLOW! 
-
-
-       USAGE 
-               
-         void do_stuff(BasicImage<T>);
-           Defines a function which can work on any kind of image, eg Images,
-               VideoFrames, etc.
-
-         Image<T> foo; 
-               Creates an image of type T, which can be copied, assigned to, 
and used 
-               in STL containers efficiently.
-       
-
-         Images behave like pointers. Copying an image is like copying a 
pointer:
-         both the source and destination point to the same chunk of data. To 
-         further the analogy, [] dereferences images.
-
-       MACROS
-         
-         Defining CVD_IMAGE_DEBUG before including this file compiles in bounds
-         checking with operator[]
-
-
-*******************************************************************************/
-
-
 #ifndef CVD_IMAGE_H
 #define CVD_IMAGE_H