psRegion.h File Reference

#include "psString.h"

Include dependency graph for psRegion.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	psRegion
	Basic image region structure. More...
Functions
psRegion *	psRegionAlloc (float x0, float x1, float y0, float y1)
	Create a pointer to a psRegion, with associated psMemBlock.
psRegion	psRegionSet (float x0, float x1, float y0, float y1)
	Create a psRegion with the specified attributes.
psRegion	psRegionFromString (const char *region)
	Create a psRegion with the attribute values given as a string.
psString	psRegionToString (const psRegion region)
	Create a string of the standard IRAF form '[x0:x1,y0:y1]' from a psRegion.
psRegion	psRegionForSquare (double x, double y, double radius)
	Defines a region corresponding to the square with center at coordinate x,y and with coderadius.
bool	psRegionIsNaN (psRegion region)

---

Function Documentation

psRegion* psRegionAlloc (  float  x0, float  x1, float  y0, float  y1 )

Create a pointer to a psRegion, with associated psMemBlock. Returns: psRegion* : a new psRegion. Parameters: x0  the first column of the region. x1  the last column of the region + 1. y0  the first row of the region. y1  the last row of the region + 1.

psRegion psRegionForSquare (  double  x, double  y, double  radius )

Defines a region corresponding to the square with center at coordinate x,y and with coderadius. The width of the square is 2radius + 1. Returns: psRegion: the newly defined psRegion. Parameters: x  x coordinate at square-center y  y coordinate at square-center radius  radius of square

psRegion psRegionFromString (  const char *  region  )

Create a psRegion with the attribute values given as a string. Create a psRegion with the attribute values given as a string. The format shall be of the standard IRAF form '[x0:x1,y0:y1]' Returns: psRegion: A new psRegion struct, or NULL is not successful. Parameters: region  image rectangular region in the form '[x0:x1,y0:y1]'

bool psRegionIsNaN (  psRegion  region  )

psRegion psRegionSet (  float  x0, float  x1, float  y0, float  y1 )

Create a psRegion with the specified attributes. Returns: psRegion : a cooresponding psRegion. Parameters: x0  the first column of the region. x1  the last column of the region + 1. y0  the first row of the region. y1  the last row of the region + 1.

psString psRegionToString (  const psRegion  region  )

Create a string of the standard IRAF form '[x0:x1,y0:y1]' from a psRegion. Returns: psString: A new string representing the psRegion as text, or NULL is not successful. Parameters: region  the psRegion to convert to a string

---