Changeset 1920 for trunk/psLib/src/image/psImageExtraction.h

Timestamp:

Sep 28, 2004, 1:26:49 PM (22 years ago)

Author:

desonia

Message:

changed function prototypes to match changes in the SDRS.

File:

• trunk/psLib/src/image/psImageExtraction.h (modified) (3 diffs)

trunk/psLib/src/image/psImageExtraction.h

@@ -10 +10 @@
 *  @author Robert DeSonia, MHPCC
 *
-*  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2004-09-28 02:27:58 $
+*  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2004-09-28 23:26:48 $
 *
 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -76 +76 @@
  *
  *  Trim the specified image in-place, which involves shuffling the pixels 
- *  around in memory.  The pixels in the region [x0:x1,y0:y1] (inclusive)
- *  shall consist the output image.
- *
- *  N.b., An image that has a parent image will be orphaned from the parent 
- *  upon trimming.  Any children of the trimmed image will also be obliterated, 
+ *  around in memory.  The pixels in the region [col0:col1,row0:row1] shall consist
+ *  the output image.  The column col1 and row row1 are NOT included in the range.
+ *  In the event that x1 or y1 are non-positive, they shall be interpreted as
+ *  being relative to the size of the parent image in that dimension.
+ *
+ *  If the entire specified subimage is not contained within the parent 
+ *  image, an error results and the return value will be NULL.
+ *
+ *  N.B. If the input psImage is a child of another psImage, no pixel data 
+ *  will be trimmed, rather it equivalent to calling psImageSubset.  If the input 
+ *  psImage is, however, a parent psImage, any children will be obliterated,
  *  i.e., freed from memory.
  *
@@ -87 +93 @@
 psImage* psImageTrim(
     psImage* image,                    ///< image to trim
-    int x0,                            ///< column of trim region's left boundary
-    int x1,                            ///< column of trim region's right boundary
-    int y0,                            ///< row of trim region's lower boundary
-    int y1                             ///< row of trim region's upper boundary
+    int col0,                          ///< column of trim region's left boundary
+    int row0,                          ///< row of trim region's lower boundary
+    int col1,                          ///< column of trim region's right boundary
+    int row1                           ///< row of trim region's upper boundary
 );