Changeset 13741 for trunk/psLib/src/math/psRegion.h

Timestamp:

Jun 10, 2007, 7:54:05 AM (19 years ago)

Author:

magnier

Message:

adding psRegionAndParityFromString

File:

• trunk/psLib/src/math/psRegion.h (modified) (2 diffs)

trunk/psLib/src/math/psRegion.h

@@ -2 +2 @@
  * @brief image regions and related functions
  *
- * $Revision: 1.8 $ $Name: not supported by cvs2svn $
- * $Date: 2007-01-23 22:47:23 $
+ * $Revision: 1.9 $ $Name: not supported by cvs2svn $
+ * $Date: 2007-06-10 17:54:05 $
  * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
@@ -72 +72 @@
 );
 
+/** Create a psRegion from a string in IRAF form '[x0:x1,y0:y1]', returning range parities
+ *
+ *  Create a psRegion using the range defined by a string in the standard IRAF form
+ *  '[x0:x1,y0:y1]'.  Unlike psRegionFromString, the ranges may have x0 > x1 or y0 > y1, in
+ *  which case the xParity or yParity terms will be set to -1 (instead of the default +1).
+ *
+ *  @return psRegion:       A new psRegion struct, or NULL is not successful.
+ */
+psRegion psRegionAndParityFromString(
+    int *xParity,                     ///< +1 if x0 <= x1, -1 otherwise
+    int *yParity,                     ///< +1 if y0 <= y1, -1 otherwise
+    const char* region                ///< image rectangular region in the form '[x0:x1,y0:y1]'
+);
+
 /** Create a string of the standard IRAF form '[x0:x1,y0:y1]' from a psRegion.
  *