Changeset 4954 for trunk/psphot/doc/psphot.txt

Timestamp:

Sep 6, 2005, 5:33:01 PM (21 years ago)

Author:

eugene

Message:

psphot reorganization: merged in pmObjects code from psModule, modified to work with psLib 0.7.0

File:

• trunk/psphot/doc/psphot.txt (modified) (1 diff)

trunk/psphot/doc/psphot.txt

@@ -1 +1 @@
 
-psphot is a stand-alone program which implements the Pan-STARRS IPP
-object detection and analysis functions for using with individual
-images.  
+Defined APIs:
 
+pmMoments           *pmMomentsAlloc();
+pmModel             *pmModelAlloc();
+pmSource            *pmSourceAlloc();
+psVector            *pmFindVectorPeaks()
+psArray             *pmFindImagePeaks()
+psList              *pmCullPeaks()
+pmSource            *pmSourceLocalSky()
+bool                 pmSourceMoments()
+pmPSFClump           pmSourcePSFClump()
+bool                 pmSourceRoughClass()
+bool                 pmSourceSetPixelsCircle()
+pmModel             *pmSourceModelGuess()
+psArray             *pmSourceContour()
+bool                 pmSourceFitModel()
+bool                 pmSourceAddModel()
+bool                 pmSourceSubModel()
+int                  pmModelParameterCount ();
+char                *pmModelGetType ();
+pmModelType          pmModelSetType ();
+pmModelFunc          pmModelFunc_GetFunction ();
+pmModelFlux          pmModelFlux_GetFunction ();
+pmModelRadius        pmModelRadius_GetFunction ();
+pmModelLimits        pmModelLimits_GetFunction ();
+pmModelGuessFunc     pmModelGuessFunc_GetFunction ();
+pmModelFromPSFFunc   pmModelFromPSFFunc_GetFunction ();
+pmModelFitStatusFunc pmModelFitStatusFunc_GetFunction ();
+
+model function abstractions:
+  typedef psMinimizeLMChi2Func pmModelFunc;
+  typedef psF64 (*pmModelFlux)(const psVector *params);
+  typedef psF64 (*pmModelRadius)(const psVector *params, double flux);
+  typedef bool (*pmModelLimits)(psVector **beta_lim, psVector **params_min, psVector **params_max);
+  typedef bool (*pmModelGuessFunc)(pmModel *model, pmSource *source);
+  typedef bool (*pmModelFromPSFFunc)(pmModel *modelPSF, pmModel *modelFLT, pmPSF *psf);
+  typedef bool (*pmModelFitStatusFunc)(pmModel *model);