Changeset 1710
- Timestamp:
- Sep 7, 2004, 1:27:04 PM (22 years ago)
- File:
-
- 1 edited
-
trunk/doc/pslib/psLibSDRS.tex (modified) (23 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/pslib/psLibSDRS.tex
r1707 r1710 1 %%% $Id: psLibSDRS.tex,v 1.11 1 2004-09-07 23:23:40 price Exp $1 %%% $Id: psLibSDRS.tex,v 1.112 2004-09-07 23:27:04 eugene Exp $ 2 2 \documentclass[panstarrs,spec]{panstarrs} 3 3 … … 1330 1330 } data; 1331 1331 const struct psImage *parent; ///< parent, if a subimage 1332 psArray *children; 1332 psArray *children; ///< children of this region 1333 1333 } psImage; 1334 1334 \end{verbatim} … … 1823 1823 double min; ///< minimum data value in data; input range 1824 1824 double max; ///< maximum data value in data; input range 1825 double binsize; 1825 double binsize; ///< binsize for robust fit (input/output) 1826 1826 psStatsOptions options; ///< bitmask of calculated values 1827 1827 } psStats; … … 1936 1936 /** One-dimensional polynomial */ 1937 1937 typedef struct { 1938 psPolynomialType type; 1938 psPolynomialType type; ///< Polynomial type 1939 1939 int n; ///< Number of terms 1940 1940 float *restrict coeff; ///< Coefficients … … 1947 1947 /** Two-dimensional polynomial */ 1948 1948 typedef struct { 1949 psPolynomialType type; 1949 psPolynomialType type; ///< Polynomial type 1950 1950 int nX, nY; ///< Number of terms in x and y 1951 1951 float *restrict *restrict coeff; ///< Coefficients … … 1961 1961 \begin{verbatim} 1962 1962 typedef enum { 1963 PS_POLYNOMIAL_ORD, 1964 PS_POLYNOMIAL_CHEB 1963 PS_POLYNOMIAL_ORD, ///< Ordinary polynomial 1964 PS_POLYNOMIAL_CHEB ///< Chebyshev polynomial 1965 1965 } psPolynomialType; 1966 1966 \end{verbatim} … … 1971 1971 /** Double-precision one-dimensional polynomial */ 1972 1972 typedef struct { 1973 psPolynomialType type; 1973 psPolynomialType type; ///< Polynomial type 1974 1974 int n; ///< Number of terms 1975 1975 double *restrict coeff; ///< Coefficients … … 1982 1982 /** Double-precision two-dimensional polynomial */ 1983 1983 typedef struct { 1984 psPolynomialType type; 1984 psPolynomialType type; ///< Polynomial type 1985 1985 int nX, nY; ///< Number of terms in x and y 1986 1986 double *restrict *restrict coeff; ///< Coefficients … … 2029 2029 typedef struct { 2030 2030 int n; ///< Number of spline pieces 2031 psPolynomial1D **spline; 2031 psPolynomial1D **spline; ///< Array of n pointers to splines 2032 2032 float *domains; ///< The boundaries between each spline piece. Size is n+1. 2033 2033 } psSpline1D; … … 2129 2129 \begin{verbatim} 2130 2130 typedef struct { 2131 const int maxIter; 2132 const float tol; 2133 float value; 2134 int iter; 2135 float lastDelta; 2131 const int maxIter; ///< Maximum number of iterations 2132 const float tol; ///< Tolerance to reach 2133 float value; ///< Value after minimization 2134 int iter; ///< Actual number of iterations performed 2135 float lastDelta; ///< Last change before quitting 2136 2136 } psMinimization; 2137 2137 \end{verbatim} … … 2308 2308 psSpline1D *psVectorFitSpline1D(psSpline1D *mySpline, 2309 2309 const psVector *x, 2310 2311 2310 const psVector *y, 2311 const psVector *yErr); 2312 2312 \end{verbatim} 2313 2313 \code{psVectorFitSpline} shall return the spline that best fits the … … 2432 2432 unsigned int maskVal, 2433 2433 float x0, 2434 2435 2436 2437 2438 2434 float y0, 2435 float x1, 2436 float y1, 2437 unsigned int nSamples, 2438 psImageInterpolateMode mode); 2439 2439 \end{verbatim} 2440 2440 Extract pixels along a line segment, \code{(x0,y0)} to \code{(x1,y1)}, … … 2455 2455 unsigned int maskVal, 2456 2456 float x, 2457 2457 float y, 2458 2458 const psVector *radii, 2459 2459 const psStats *stats); 2460 2460 \end{verbatim} 2461 2461 Extract radial region data to a vector. A vector is constructed where … … 2566 2566 const psImage *in, 2567 2567 const psImage *mask, 2568 2568 unsigned int maskVal); 2569 2569 \end{verbatim} 2570 2570 Determine statistics for image (or subimage). The statistics to be … … 2579 2579 const psImage *in, 2580 2580 const psImage *mask, 2581 2581 unsigned int maskVal); 2582 2582 \end{verbatim} 2583 2583 Construct a histogram from an image (or subimage). The histogram to … … 2959 2959 PS_FFT_FORWARD = 0, ///< psImageFFT/psVectorFFT should perform a forward FFT. 2960 2960 PS_FFT_REVERSE = 1, ///< psImageFFT/psVectorFFT should perform a reverse FFT. 2961 PS_FFT_REAL_RESULT = 2 2962 2963 2961 PS_FFT_REAL_RESULT = 2 ///< psImageFFT/psVectorFFT should return a real image. This is valid 2962 ///< for only reverse FFT, i.e., the psImageFFT/psVectorFFT flag 2963 ///< parameter should appear as PS_FFT_REVERSE+PS_FFT_REAL_RESULT. 2964 2964 } psFFTFlags; 2965 2965 \end{verbatim} … … 3347 3347 psMetadataType type; ///< type of this item 3348 3348 const union { 3349 bool bool; 3349 bool bool; ///< boolean value 3350 3350 psS32 S32; ///< integer value 3351 3351 psF32 F32; ///< floating value … … 3370 3370 typedef enum { ///< type of data.item is: 3371 3371 PS_META_ITEM_SET = 0, ///< NULL; metadata is in psMetadataType.items 3372 PS_META_BOOL, 3372 PS_META_BOOL, ///< bool (.bool) 3373 3373 PS_META_S32, ///< int (.S32) 3374 3374 PS_META_F32, ///< float (.F32) … … 3529 3529 \end{verbatim} 3530 3530 Read header data from a FITS image file into a \code{psMetadata} 3531 structure (see section~\ref{sec:metadata}. The \code{extname} and 3532 \code{extnum} parameters specify the extension of interest as above. 3533 If the named extension does not exist, the function should return an 3534 error. 3531 structure. The \code{extname} and \code{extnum} parameters specify 3532 the extension of interest as above. The data is read from the 3533 extension specified by extname (matching the EXTNAME keyword) or by 3534 the extnum value (with 0 representing the primary header unit (PHU), 1 3535 the first extension, etc). This function must call \code{psError} and 3536 return \code{NULL} if the specified extension does not exist. If 3537 \code{extname} is not \code{NULL}, \code{extnum} must be set to -1 or 3538 the function shall raise an error. 3535 3539 3536 3540 \begin{verbatim} … … 3582 3586 \code{STRING}. 3583 3587 3584 \tbd{May, in the future, require more types, including 3585 \code{U8,S16,C64}, which will also necessitate updating the definition 3586 of \code{psMetadata}.} 3588 \tbd{May, in the future, require more types, including U8,S16,C64, 3589 which will also necessitate updating the definition of psMetadata.} 3587 3590 3588 3591 The value shall follow the type: strings may consist of multiple … … 3611 3614 3612 3615 \tbd{May add complex types, likely to be specified with values such as 3613 \code{1.23+4.56i}in the future.}3616 1.23+4.56i in the future.} 3614 3617 3615 3618 An additional hurdle is the specification of keys that may be … … 3633 3636 Here are some examples of lines of a valid configuration file: 3634 3637 \begin{verbatim} 3635 Double F64 1.23456789 # This is a comment 3636 Float F32 0.98765#This is a comment too 3637 String STR This is the string that forms the value #comment 3638 #This is a comment line and is to be ignored 3638 Double F64 1.23456789 # This is a comment 3639 Float F32 0.98765#This is a comment too 3640 String STR This is the string that forms the value #comment 3641 3642 # This is a comment line and is to be ignored 3639 3643 boolean BOOL T # The value of `boolean' is `true' 3640 3644 3641 3645 @primes U8 2,3 5 7,11,13 17 # These are prime numbers 3646 3642 3647 comment * The rest of this line is ignored, but `comment' is set to be non-unique 3643 3648 comment STR This 3644 3645 3646 3647 3649 comment STR is 3650 comment STR a 3651 comment STR non-unique 3652 comment STR key 3648 3653 Float F64 1.23456 # This generates a warning, and, if `overwrite' is `false', is ignored 3649 3654 \end{verbatim} … … 3929 3934 3930 3935 typedef enum { 3931 PS_SPHERICAL; 3932 PS_LINEAR; 3936 PS_SPHERICAL; ///< Offset on a sphere 3937 PS_LINEAR; ///< Linear offset 3933 3938 } psSphereOffsetMode; 3934 3939 3935 3940 typedef enum { 3936 PS_ARCSEC; 3937 PS_ARCMIN; 3938 PS_DEGREE; 3939 PS_RADIAN; 3941 PS_ARCSEC; ///< Arcseconds 3942 PS_ARCMIN; ///< Arcminutes 3943 PS_DEGREE; ///< Degrees 3944 PS_RADIAN; ///< Radians 3940 3945 } psSphereOffsetUnit; 3941 3946 \end{verbatim}
Note:
See TracChangeset
for help on using the changeset viewer.
