IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Apr 1, 2004, 12:31:20 AM (22 years ago)
Author:
eugene
Message:

added doxygen-generated structure & function lists

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/pslib/psAstroGroup.tex

    r285 r381  
    3737float {\bf ps\-Get\-Refraction} (float colour, {\bf ps\-Phot\-System} color\-Plus, {\bf ps\-Phot\-System} color\-Minus, const {\bf ps\-Exposure} $\ast$exp)
    3838\begin{CompactList}\small\item\em Estimate atmospheric refraction, along the parallactic.\item\end{CompactList}\item
     39{\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Parallax\-Factor} (const {\bf ps\-Exposure} $\ast$exp)
     40\begin{CompactList}\small\item\em Calculate the parallax factor.\item\end{CompactList}\item
    3941{\bf ps\-Exposure} $\ast$ {\bf ps\-Exposure\-Alloc} (double ra, double dec, double ha, double zd, double az, double lst, float mjd, float rot\-Angle, float temp, float pressure, float humidity, float exptime)
    4042\begin{CompactList}\small\item\em Constructor.\item\end{CompactList}\item
    … …  
    8789{\bf ps\-Float\-Array} $\ast$ {\bf ps\-Image\-Radial\-Cut} ({\bf ps\-Float\-Array} $\ast$out, const {\bf ps\-Image} $\ast$input, float x, float y, float radius, float dr, const {\bf ps\-Stats} $\ast$stats)
    8890\begin{CompactList}\small\item\em Extract radial annulii data to a vector.\item\end{CompactList}\item
    89 {\bf ps\-Float\-Array} $\ast$ {\bf ps\-Image\-Contour} ({\bf ps\-Float\-Array} $\ast$out, const {\bf ps\-Image} $\ast$input, float threshold, int binning)
    90 \begin{CompactList}\small\item\em Extract a 2-d contour from an image at the given threshold.\item\end{CompactList}\item
    9191{\bf ps\-Image} $\ast$ {\bf ps\-Image\-Rebin} ({\bf ps\-Image} $\ast$out, const {\bf ps\-Image} $\ast$input, float scale, const {\bf ps\-Stats} $\ast$stats)
    9292\begin{CompactList}\small\item\em Rebin image to new scale.\item\end{CompactList}\item
    … …  
    9797{\bf ps\-Image} $\ast$ {\bf ps\-Image\-Roll} ({\bf ps\-Image} $\ast$out, const {\bf ps\-Image} $\ast$input, int dx, int dy)
    9898\begin{CompactList}\small\item\em Roll image by an integer number of pixels in either direction.\item\end{CompactList}\item
    99 {\bf ps\-Stats} $\ast$ {\bf ps\-Image\-Get\-Stats} ({\bf ps\-Image} $\ast$out, const {\bf ps\-Image} $\ast$input, {\bf ps\-Stats} $\ast$stats)
     99{\bf ps\-Stats} $\ast$ {\bf ps\-Image\-Get\-Stats} (const {\bf ps\-Image} $\ast$input, {\bf ps\-Stats} $\ast$stats)
    100100\begin{CompactList}\small\item\em Determine statistics for image (or subimage).\item\end{CompactList}\item
    101101{\bf ps\-Histogram} $\ast$ {\bf ps\-Image\-Histogram} ({\bf ps\-Histogram} $\ast$hist, const {\bf ps\-Image} $\ast$input)
    … …  
    107107{\bf ps\-Image} $\ast$ {\bf ps\-Image\-Read\-Section} ({\bf ps\-Image} $\ast$output, int x, int y, int nx, int ny, int z, const char $\ast$extname, int extnum, const char $\ast$filename)
    108108\begin{CompactList}\small\item\em Read an image or subimage from a named file.\item\end{CompactList}\item
    109 {\bf ps\-Image} $\ast$ {\bf ps\-Image\-FRead\-Section} ({\bf ps\-Image} $\ast$output, int x, int y, int dx, int dy, int z, const char $\ast$extname, int extnum, const FILE $\ast$f)
     109{\bf ps\-Image} $\ast$ {\bf ps\-Image\-FRead\-Section} ({\bf ps\-Image} $\ast$output, int x, int y, int nx, int ny, int z, const char $\ast$extname, int extnum, FILE $\ast$f)
    110110\begin{CompactList}\small\item\em Read an image or subimage from file descriptor.\item\end{CompactList}\item
    111111{\bf ps\-Image} $\ast$ {\bf ps\-Image\-Write\-Section} ({\bf ps\-Image} $\ast$input, int x, int y, int z, const char $\ast$extname, int extnum, const char $\ast$filename)
    112112\begin{CompactList}\small\item\em Write an image section to named file (which may exist).\item\end{CompactList}\item
    113 {\bf ps\-Image} $\ast$ {\bf ps\-Image\-FWrite\-Section} ({\bf ps\-Image} $\ast$input, int x, int y, int z, const char $\ast$extname, int extnum, const FILE $\ast$f)
     113{\bf ps\-Image} $\ast$ {\bf ps\-Image\-FWrite\-Section} ({\bf ps\-Image} $\ast$input, int x, int y, int z, const char $\ast$extname, int extnum, FILE $\ast$f)
    114114\begin{CompactList}\small\item\em Write an image section to named file (which may exist).\item\end{CompactList}\item
    115115ps\-Metadata $\ast$ {\bf ps\-Image\-Read\-Header} (ps\-Metadata $\ast$output, const char $\ast$extname, int extnum, const char $\ast$filename)
    116116\begin{CompactList}\small\item\em Read only header from image file.\item\end{CompactList}\item
    117 ps\-Metadata $\ast$ {\bf ps\-Image\-FRead\-Header} (ps\-Metadata $\ast$output, const char $\ast$extname, int extnum, const FILE $\ast$f)
     117ps\-Metadata $\ast$ {\bf ps\-Image\-FRead\-Header} (ps\-Metadata $\ast$output, const char $\ast$extname, int extnum, FILE $\ast$f)
    118118\begin{CompactList}\small\item\em Read only header from image file descriptor.\item\end{CompactList}\item
    119 {\bf ps\-Image} $\ast$ {\bf ps\-Image\-FFT} ({\bf ps\-Image} $\ast$output, const {\bf ps\-Image} $\ast$input, int direction)
    120 \begin{CompactList}\small\item\em Perform an FFT on the image. The output image type is ps\-Complex.\item\end{CompactList}\item
    121119int {\bf ps\-Image\-Clip} ({\bf ps\-Image} $\ast$input, float min, float vmin, float max, float vmax)
    122120\begin{CompactList}\small\item\em Clip image values outside of range to given values. Return number of clipped pixels.\item\end{CompactList}\item
    123121int {\bf ps\-Image\-Clip\-Na\-N} ({\bf ps\-Image} $\ast$input, float value)
    124122\begin{CompactList}\small\item\em Clip Na\-N image pixels to given value. Return number of clipped pixels.\item\end{CompactList}\item
    125 int {\bf ps\-Image\-Overlay\-Section} ({\bf ps\-Image} $\ast$image, const {\bf ps\-Image} $\ast$overlay, int x0, int y0, const char $\ast$operator)
     123int {\bf ps\-Image\-Overlay\-Section} ({\bf ps\-Image} $\ast$image, const {\bf ps\-Image} $\ast$overlay, int x0, int y0, const char $\ast$op)
    126124\begin{CompactList}\small\item\em Overlay subregion of image with another image. Return number of pixels replaced.\item\end{CompactList}\item
    127125{\bf ps\-Meta\-Data\-Item} $\ast$ {\bf ps\-Meta\-Data\-Item\-Alloc} (int type\-Flags, const void $\ast$val, const char $\ast$comment, const char $\ast$name,...)
    … …  
    130128\begin{CompactList}\small\item\em Destructor.\item\end{CompactList}\item
    131129{\bf ps\-Meta\-Data\-Set} $\ast$ {\bf ps\-Meta\-Data\-Set\-Alloc} (void)
    132 \begin{CompactList}\small\item\em Constructor.\item\end{CompactList}\item
     130\begin{CompactList}\small\item\em make a new set of metadata\item\end{CompactList}\item
    133131void {\bf ps\-Meta\-Data\-Set\-Free} ({\bf ps\-Meta\-Data\-Set} $\ast$ms)
    134132\begin{CompactList}\small\item\em Destructor.\item\end{CompactList}\item
    … …  
    145143void {\bf ps\-Meta\-Data\-Item\-Print} (FILE $\ast$fd, const {\bf ps\-Meta\-Data\-Item} $\ast$restrict ms, const char $\ast$prefix)
    146144\begin{CompactList}\small\item\em print metadata item to the specified stream\item\end{CompactList}\item
    147 {\bf ps\-Coord} $\ast$ {\bf ps\-Coord\-Xform\-Apply} ({\bf ps\-Coord\-Xform} $\ast$frame, {\bf ps\-Coord} $\ast$coords)
     145{\bf ps\-Coord} $\ast$ {\bf ps\-Coord\-Xform\-Apply} ({\bf ps\-Coord} $\ast$out, const {\bf ps\-Coord\-Xform} $\ast$frame, const {\bf ps\-Coord} $\ast$coords)
    148146\begin{CompactList}\small\item\em apply the coordinate transformation to the given coordinate\item\end{CompactList}\item
    149 {\bf ps\-Coord} $\ast$ {\bf ps\-Distortion\-Apply} ({\bf ps\-Distortion} $\ast$pattern, {\bf ps\-Coord} $\ast$coords, float mag, float color)
     147{\bf ps\-Coord} $\ast$ {\bf ps\-Distortion\-Apply} ({\bf ps\-Coord} $\ast$out, const psdistortion $\ast$pattern, const {\bf ps\-Coord} $\ast$coords, float mag, float color)
    150148\begin{CompactList}\small\item\em apply the optical distortion to the given coordinate, magnitude, color\item\end{CompactList}\item
    151 {\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Offset} (const {\bf ps\-Coord} $\ast$restrict position1, const {\bf ps\-Coord} $\ast$restrict position2, char $\ast$system)
     149{\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Offset} (const {\bf ps\-Coord} $\ast$restrict position1, const {\bf ps\-Coord} $\ast$restrict position2, const char $\ast$type)
    152150\begin{CompactList}\small\item\em Get offset (RA,Dec) on the sky between two positions position1 and position2 may not be identical.\item\end{CompactList}\item
    153 {\bf ps\-Coord} $\ast$ {\bf ps\-Apply\-Offset} (const {\bf ps\-Coord} $\ast$restrict position, const {\bf ps\-Coord} $\ast$restrict offset, char $\ast$system)
     151{\bf ps\-Coord} $\ast$ {\bf ps\-Apply\-Offset} (const {\bf ps\-Coord} $\ast$restrict position, const {\bf ps\-Coord} $\ast$restrict offset, const char $\ast$type)
    154152\begin{CompactList}\small\item\em Apply an offset to a position.\item\end{CompactList}\item
    155153{\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Sun\-Pos} (float mjd)
    … …  
    159157float {\bf ps\-Get\-Moon\-Phase} (float mjd)
    160158\begin{CompactList}\small\item\em Get Moon phase.\item\end{CompactList}\item
    161 {\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Solar\-System\-Pos} (char $\ast$solar\-System\-Object, float mjd)
     159{\bf ps\-Coord} $\ast$ {\bf ps\-Get\-Solar\-System\-Pos} (const char $\ast$solar\-System\-Object, float mjd)
    162160\begin{CompactList}\small\item\em Get Planet positions.\item\end{CompactList}\item
    163161{\bf ps\-Coord} $\ast$ {\bf ps\-Coordinates\-Ito\-E} (const {\bf ps\-Coord} $\ast$restrict coordinates)
    … …  
    169167{\bf ps\-Coord} $\ast$ {\bf ps\-Coordinates\-Gto\-I} (const {\bf ps\-Coord} $\ast$restrict coordinates)
    170168\begin{CompactList}\small\item\em Convert Galactic to ICRS.\item\end{CompactList}\end{CompactItemize}
     169
Note: See TracChangeset for help on using the changeset viewer.