Changeset 37892 for trunk/doc/release.2015/ps1.analysis/analysis.tex

Timestamp:

Feb 4, 2015, 2:49:56 PM (11 years ago)

Author:

eugene

Message:

added example figure

File:

• trunk/doc/release.2015/ps1.analysis/analysis.tex (modified) (1 diff)

trunk/doc/release.2015/ps1.analysis/analysis.tex

@@ -1157 +1157 @@
 discussed in the section on Galaxy models.
 
-\section{PSPhot Structures and Data Elements}
-
-The following structures are described in detail in the document
-`Pan-STARRS PS-1 Image Processing Pipeline Modules Supplementary
-Design Requirements' (psModules SDRS; PSDC-430-012).
-
-\begin{verbatim}
- pmModel
- pmModelGroup
- pmGrowthCurve
- pmPSF
- pmPSFTry
- pmSource
- pmPeak
- pmMoments
-\end{verbatim}
-
-\note{psphot is supposed to operate on individual readouts, and use
-  the techniques used by ppImage to extract header-related metadata.
-  currently, psphot uses an alternative to the psReadout until the
-  ppImage code can be folded together with psphot}. 
-
-\subsection{Top-Level APIs}
-
-\begin{verbatim}
-psMetadata     *psphotArguments (int *argc, char **argv);
-\end{verbatim}
-Load the command-line arguments, parse the configuration file, and
-place the configuration information on a single metadata structure.
-This function searches for the following command line option flags,
-and places their corresponding values on the output metadata with the
-given name.  These options override any such values in the
-configuration file.
-\begin{verbatim}
--mask (filename)      : MASK_IMAGE
--weight (filename)    : WEIGHT_IMAGE
--resid (filename)     : RESID_IMAGE
--region [x0:x1,y0:y1] : ANALYSIS_REGIONP
--photcode (code)      : PHOTCODE
--psf (filename)       : PSF_INPUT_FILE
--modeltest x y        : TEST_FIT_X, TEST_FIT_Y
--model (name)         : TEST_FIT_MODEL
--fitmode (name)       : TEST_FIT_MODE
--fitset (name)        : TEST_FIT_SET
-\end{verbatim}
-
-The following option flags can be used to set any option:
-\begin{verbatim}
--D  (key) (value)      : any string value
--Df (key) (value)      : any F32 value
--Di (key) (value)      : any S32 value
-\end{verbatim}
-
-The function next examines the remaining command-line arguments and
-complains if there are not exactly 3 arguments, reporting the program
-usage.  It sets default configuration variables, and then loads the
-configuration file specified as the third command-line option.
-Finally, it sets the \code{IMAGE} and \code{OUTPUT\_FILE} config
-options to arguments 1 and 2, respecitively.
-
-\begin{verbatim}
-eamReadout     *psphotSetup (psMetadata *config);
-\end{verbatim}
-This function examines the configuration data in \code{config} and
-loads the image into memory.  It constructs the weight and mask images
-if they have not been specified, or loads the specified images.  The
-weight image is built based on the read noise and gain of the image,
-as extracted from the header or from the configuration options
-directly.  It defines the mask based on the selection image region,
-the values for saturation and the \code{min\_VALID\_PIXEL}.  
-
-\begin{verbatim}
-bool            psphotModelTest (eamReadout *imdata, psMetadata *config);
-\end{verbatim}
-This function is an optional test mode for psphot.  If the test mode
-has been selected, this function will attempt to fit a single object
-with the requested model.  It writes out subimage containing the
-source, the difference, the mask, and the weight.  This function may
-load a PSF model or fit a floating model.
-
-\begin{verbatim}
-psStats        *psphotImageStats (eamReadout *imdata, psMetadata *config);
-\end{verbatim}
-Measure the basic image properties: median sky, expected sky sigma
-
-\begin{verbatim}
-psPolynomial2D *psphotImageBackground (eamReadout *imdata, psMetadata *config, psStats *sky);
-\end{verbatim}
-Model the image background as a 2D polynomial and subtract from the
-image.   The should use a more sophisticated model and return the
-subtracted image.
-
-\begin{verbatim}
-psArray        *psphotFindPeaks (eamReadout *imdata, psMetadata *config, psStats *sky);
-\end{verbatim}
-Create a smoothed image and find all local peaks above the threshold
-level (uses: \code{PEAKS\_SMOOTH\_SIGMA, PEAKS\_SMOOTH\_NSIGMA,
-PEAKS\_NSIGMA\_LIMIT, PEAKS\_OUTPUT\_FILE})
-
-\begin{verbatim}
-psArray        *psphotSourceStats (eamReadout *imdata, psMetadata *config, psArray *allpeaks);
-\end{verbatim}
-Create the basic source structures for all peaks, define the initial
-pixels, measure the local sky (sky offset) and the source moments.
-
-\begin{verbatim}
-bool            psphotRoughClass (psArray *sources, psMetadata *config);
-\end{verbatim}
-Find the PSF clump and make the first cut source identifications
-
-\begin{verbatim}
-bool            psphotBasicDeblend (psArray *sources, psMetadata *config, psStats *sky);
-\end{verbatim}
-Find all blended peaks and tag, group with single primary source.
-
-\begin{verbatim}
-pmPSF          *psphotChoosePSF (psMetadata *config, psArray *sources, psStats *sky);
-\end{verbatim}
-Try each of the selected PSF models on a subset of likely PSF stars.
-Measure the metric (aperture residual scatter) for each PSF model and
-choose the best model.  
-
-\begin{verbatim}
-bool            psphotEnsemblePSF (eamReadout *imdata, psMetadata *config, psArray *sources, pmPSF *psf, psStats *sky);
-\end{verbatim}
-Perform simultaneous fitting to all sources in the array using a
-linear fitting process which assumes all sources are PSFs and their
-positions are fixed.  Set the positions based on the bilinear
-interpolation of the peak implied by the 3x3 square of pixels
-containing the peak.  Local sky is also assumed to be correctly subtracted.
-
-\begin{verbatim}
-bool            psphotFullFit (eamReadout *imdata, psMetadata *config, psArray *sources, pmPSF *psf, psStats *sky);
-\end{verbatim}
-Fit all sources in sequence starting from the brightest, and
-subtracting the sources as they are fitted.  This function only
-attempts single PSF and single EXT models and chooses between them.
-The sources are assumed to have been subtracted in advance (ie, using
-psphotEnsembleFit).  The models which do not succeed are re-subtracted
-using the prior model.
-
-\begin{verbatim}
-bool            psphotBlendFit (eamReadout *imdata, psMetadata *config, psArray *sources, pmPSF *psf, psStats *sky);
-\end{verbatim}
-Fit all sources in sequence starting from the brightest, and
-subtracting the sources as they are fitted.  This function attempts a
-multi-source fit for blended sources, or a single PSF if it is not a
-blend, followed by both EXT and DBL models and chooses between them.
-The sources are assumed to have been subtracted in advance (ie, using
-psphotEnsembleFit).  The models which do not succeed are re-subtracted
-using the prior model.
-
-\begin{verbatim}
-bool            psphotReplaceUnfit (psArray *sources);
-\end{verbatim}
-After models have been attempted for all sources, this function
-replaces the sources which were temporarily subtracted, but which did
-not succeed or converge on a good solution.
-
-\begin{verbatim}
-bool            psphotApplyPSF (eamReadout *imdata, psMetadata *config, psArray *sources, pmPSF *psf, psStats *sky);
-\end{verbatim}
-Attempt to fit the PSF model to all sources in brightness order,
-subtracting the resulting model if successful.  Only attempts single
-PSF models.   
-
-\begin{verbatim}
-bool            psphotFitExtended (eamReadout *imdata, psMetadata *config, psArray *sources, psStats *skyStats);
-\end{verbatim}
-Attempt to fit the PSF model to all sources in brightness order,
-subtracting the resulting model if successful.  Only attempts single
-EXT models.
-
-\begin{verbatim}
-bool            psphotApResid (eamReadout *imdata, psArray *sources, psMetadata *config, pmPSF *psf);
- \end{verbatim}
-Measure the curve-of-growth and the aperture correction trend.
-
-\begin{verbatim}
-void            psphotOutput (eamReadout *imdata, psMetadata *config, psArray *sources, pmPSF *psf, psStats *sky);
-\end{verbatim}
-Write out data in various formats as selected.
-
-\section{User's Guide}
-
-\subsection{Configuration Parameters}
-
-\begin{verbatim}
-FAINT_SN_LIM
-FIT_MAX_CHI
-FIT_MIN_SN
-FIT_NSIGMA
-FIT_PADDING
-FIT_RADIUS
-GAIN
-GAL_MODEL
-GAL_MOMENTS_RADIUS
-INNER_RADIUS
-INPUT
-MASK
-NOISE
-NSUBSET
-OUTER_RADIUS
-OUTPUT
-OUTPUT_MODE
-PEAK_NSIGMA
-PSF_MODEL_N
-PSF_MOMENTS_RADIUS
-PSF_SHAPE_NSIGMA
-RDNOISE
-SATURATE
-SMOOTH_NSIGMA
-SMOOTH_SIGMA
-XMAX
-XMIN
-YMAX
-YMIN
-\end{verbatim}
-
-\subsection{Command-Line Arguments and Options}
-
 \subsection{Input \& Output Data Formats} 
 
 \section{Sample Tests}
 
-\section{Further Work to be Completed}
-
-\begin{itemize}
-\item convert to pmCell as input data
-\item loop over all readouts in a pmCell
-\item write out multiple files?
-\item better method for defining the recipe?
-\item additional options for image background
-\item image background should return a background image
-\end{itemize}
-
 \end{document}