Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

psRegionForImage.h

Go to the documentation of this file.
00001 #ifndef PS_REGION_FOR_IMAGE_H
00002 #define PS_REGION_FOR_IMAGE_H
00003 
00004 
00005 /** Sets an actual region based on image parameters.
00006  *
00007  *  An image region defined with negative upper limits may be rationalized for the bounds of a
00008  *  specific image with psRegionForImage.  The output of this function is a region with negative
00009  *  upper limits replaced by their corrected value appropriate to the given image.  In addition,
00010  *  the lower and upper limits are foced to lie within the bounds of the image.  If the lower-
00011  *  limit coordinates are lewss than the lower bound of the image, they are limited to the lower
00012  *  bound of the image.  Conversely, if the upper-limit coordinates are greater than the upper
00013  *  bound of the image, they are truncated to define only valid pixels.  If the lower-limit
00014  *  coordinates are greater than the upper bounds of the image, or the upper-limit coordinates
00015  *  are less than the lower bounds of the image, the coordinates should saturate on those limits.
00016  *
00017  *  @return psRegion:       A region with negative upper limits replaced by the corrected
00018  */
00019 psRegion psRegionForImage(
00020     psImage *image,                    ///< the image for which the region is to be set
00021     psRegion in                        ///< the image region limits
00022 );
00023 
00024 
00025 
00026 #endif

Generated on Mon Jul 3 14:13:44 2006 for Pan-STARRS Foundation Library by  doxygen 1.4.4