Context Navigation

← Previous Change
Next Change →

pmObjects.h

Timestamp:

Jan 19, 2006, 4:38:28 PM (21 years ago)

Author:

Paul Price

Message:

Getting a working ppImage

File:

: 1 edited

branches/eam_rel9_p0/psModules/src/objects/pmObjects.h (modified) (55 diffs)

Legend:

: Unmodified
: Added
: Removed

branches/eam_rel9_p0/psModules/src/objects/pmObjects.h

-              r5990
+              r6062
  * images is one of the critical tasks of the IPP or any astronomical software
  * system. This file will define structures and functions related to the task
  * of source detection and measurement. The elements defined in this section
+ * of source detection and measurement. The elements defined in this section
  * are generally low-level components which can be connected together to
  * construct a complete object measurement suite.
 …
  *  @author GLG, MHPCC
+ *
  *  @version $Revision: 1.4.4.3 $ $Name: not supported by cvs2svn $
  *  @date $Date: 2006-01-15 18:21:19 $
+ *  @version $Revision: 1.4.4.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-01-20 02:38:28 $
+ *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
 …
 #include <math.h>
 #include "pslib.h"
 #include "pmAstrometry.h"
+#include "pmFPA.h"
 /**
  * In the object analysis process, we will use specific mask values to mark the
 …
 /** pmPeakType
+ *
+ *
  *  A peak pixel may have several features which may be determined when the
  *  peak is found or measured. These are specified by the pmPeakType enum.
 …
  *  edge. The PM_PEAK_FLAT represents a peak pixel which has more than a specific
  *  number of neighbors at the same value, within some tolarence:
+ *
+ *
  */
 typedef enum {
 …
 /** pmPeak data structure
+ *
+ *
  *  A source has the capacity for several types of measurements. The
  *  simplest measurement of a source is the location and flux of the peak pixel
  *  associated with the source:
+ *
+ *
  */
 typedef struct
 …
 /** pmMoments data structure
+ *
+ *
  * One of the simplest measurements which can be made quickly for an object
  * are the object moments. We specify a structure to carry the moment information
  * for a specific source:
+ *
+ *
  */
 typedef struct
 …
 /** pmPSFClump data structure
+ *
+ *
  * A collection of object moment measurements can be used to determine
  * approximate object classes. The key to this analysis is the location and
  * statistics (in the second-moment plane,
+ *
+ *
  */
 typedef struct
 …
 /** pmModel data structure
+ *
+ *
  * Every source may have two types of models: a PSF model and a EXT (extended-source)
  * model. The PSF model represents the best fit of the image PSF to the specific
 …
  * object by the PSF, not by the fit. The EXT model represents the best fit of
  * the given model to the object, with all shape parameters floating in the fit.
+ *
+ *
  */
 typedef struct
 …
 /** pmSourceType enumeration
+ *
+ *
  * A given source may be identified as most-likely to be one of several source
  * types. The pmSource entry pmSourceType defines the current best-guess for this
  * source.
+ *
+ *
  * XXX: The values given below are currently illustrative and will require
  * some modification as the source classification code is developed. (TBD)
+ *
+ *
  */
 typedef enum {
 …
 /** pmSource data structure
+ *
+ *
  *  This source has the capacity for several types of measurements. The
  *  simplest measurement of a source is the location and flux of the peak pixel
  *  associated with the source:
+ *
+ *
  */
 typedef struct
 …
 /** pmMomentsAlloc()
+ *
+ *
  */
 pmMoments *pmMomentsAlloc();
 …
 /** pmModelAlloc()
+ *
+ *
  */
 pmModel *pmModelAlloc(pmModelType type);
 …
 /** pmSourceAlloc()
+ *
+ *
  */
 pmSource  *pmSourceAlloc();
 …
 /** pmFindVectorPeaks()
+ *
+ *
  * Find all local peaks in the given vector above the given threshold. A peak
  * is defined as any element with a value greater than its two neighbors and with
 …
  * a vector containing the coordinates (element number) of the detected peaks
  * (type psU32).
+ *
+ *
  */
 psVector *pmFindVectorPeaks(
 …
 /** pmFindImagePeaks()
+ *
+ *
  * Find all local peaks in the given image above the given threshold. This
  * function should find all row peaks using pmFindVectorPeaks, then test each row
 …
  * peaks at the (+x,+y) corner. When selecting the peaks, their type must also be
  * set. The result of this function is an array of pmPeak entries.
+ *
+ *
  */
 psArray *pmFindImagePeaks(
 …
 /** pmCullPeaks()
+ *
+ *
  * Eliminate peaks from the psList that have a peak value above the given
  * maximum, or fall outside the valid region.
+ *
+ *
  */
 psList *pmCullPeaks(
 …
 /** pmPeaksSubset()
+ *
+ *
  * Create a new peaks array, removing certain types of peaks from the input
  * array of peaks based on the given criteria. Peaks should be eliminated if they
 …
  * the valid region.  The result of the function is a new array with a reduced
  * number of peaks.
+ *
+ *
  */
 psArray *pmPeaksSubset(
 …
 /** pmSourceDefinePixels()
+ *
+ *
  * Define psImage subarrays for the source located at coordinates x,y on the
  * image set defined by readout. The pixels defined by this operation consist of
 …
  * example). This function should be used to define a region of interest around a
  * source, including both source and sky pixels.
+ *
+ *
  * XXX: must code this.
+ *
+ *
  */
 // XXX: Uncommenting the pmReadout causes compile errors.
 …
 /** pmSourceLocalSky()
+ *
+ *
  * Measure the local sky in the vicinity of the given source. The Radius
  * defines the square aperture in which the moments will be measured. This
 …
  * This function allocates the pmMoments structure. The resulting sky is used to
  * set the value of the pmMoments.sky element of the provided pmSource structure.
+ *
+ *
  */
 bool pmSourceLocalSky(
 …
 /** pmSourceMoments()
+ *
+ *
  * Measure source moments for the given source, using the value of
  * source.moments.sky provided as the local background value and the peak
 …
  * are measured within the given circular radius of the source.peak coordinates.
  * The return value indicates the success (TRUE) of the operation.
+ *
+ *
  */
 bool pmSourceMoments(
 …
 /** pmSourcePSFClump()
+ *
+ *
  * We use the source moments to make an initial, approximate source
  * classification, and as part of the information needed to build a PSF model for
 …
  * similar. The function returns a pmPSFClump structure, representing the
  * centroid and size of the clump in the sigma_x, sigma_y second-moment plane.
+ *
+ *
  * The goal is to identify and characterize the stellar clump within the
  * sigma_x, sigma_y second-moment plane.  To do this, an image is constructed to
 …
  *  * used to calculate the median and standard deviation of the sigma_x, sigma_y
  * values. These resulting values are returned via the pmPSFClump structure.
+ *
+ *
  * The return value indicates the success (TRUE) of the operation.
+ *
+ *
  * XXX: Limit the S/N of the candidate sources (part of Metadata)? (TBD).
  * XXX: Save the clump parameters on the Metadata (TBD)
+ *
+ *
  */
 pmPSFClump pmSourcePSFClump(
 …
 /** pmSourceRoughClass()
+ *
+ *
  * Based on the specified data values, make a guess at the source
  * classification. The sources are provides as a psArray of pmSource entries.
 …
  * can be extracted from the metadata using the given keywords. Except as noted,
  * the data type for these parameters are psF32.
+ *
+ *
  */
 bool pmSourceRoughClass(
 …
 /** pmSourceModelGuess()
+ *
+ *
  * Convert available data to an initial guess for the given model. This
  * function allocates a pmModel entry for the pmSource structure based on the
 …
  * are specified for each model below. The guess values are placed in the model
  * parameters. The function returns TRUE on success or FALSE on failure.
+ *
+ *
  */
 pmModel *pmSourceModelGuess(
 …
 /** pmContourType
+ *
+ *
  * Only one type is defined at present.
+ *
+ *
  */
 typedef enum {
 …
 /** pmSourceContour()
+ *
+ *
  * Find points in a contour for the given source at the given level. If type
  * is PM_CONTOUR_CRUDE, the contour is found by starting at the source peak,
 …
  * This function may be used as part of the model guess inputs.  Other contour
  * types may be specified in the future for more refined contours (TBD)
+ *
+ *
  */
 psArray *pmSourceContour(
 …
 /** pmSourceFitModel()
+ *
+ *
  * Fit the requested model to the specified source. The starting guess for the
  * model is given by the input source.model parameter values. The pixels of
 …
  * function calls psMinimizeLMChi2() on the image data. The function returns TRUE
  * on success or FALSE on failure.
+ *
+ *
  */
 bool pmSourceFitModel(
 …
 /** pmModelFitStatus()
+ *
+ *
  * This function wraps the call to the model-specific function returned by
  * pmModelFitStatusFunc_GetFunction.  The model-specific function examines the
  * model parameters, parameter errors, Chisq, S/N, and other parameters available
  * from model to decide if the particular fit was successful or not.
+ *
+ *
  * XXX: Must code this.
+ *
+ *
  */
 bool pmModelFitStatus(
 …
 /** pmSourceAddModel()
+ *
+ *
  * Add the given source model flux to/from the provided image. The boolean
  * option center selects if the source is re-centered to the image center or if
 …
  * is at most the pixel range specified by the source.pixels image. The success
  * status is returned.
+ *
+ *
  */
 bool pmSourceAddModel(
 …
 /** pmSourceSubModel()
+ *
+ *
  * Subtract the given source model flux to/from the provided image. The
  * boolean option center selects if the source is re-centered to the image center
 …
  * image is at most the pixel range specified by the source.pixels image. The
  * success status is returned.
+ *
+ *
  */
 bool pmSourceSubModel(
 …
 /**
+ *
+ *
  * The function returns both the magnitude of the fit, defined as -2.5log(flux),
  * where the flux is integrated under the model, theoretically from a radius of 0
 …
  * not excluded by the aperture mask. The model flux is calculated by calling the
  * model-specific function provided by pmModelFlux_GetFunction.
+ *
+ *
  * XXX: must code this.
+ *
+ *
  */
 bool pmSourcePhotometry(
 …
 /**
+ *
+ *
  * This function converts the source classification into the closest available
  * approximation to the Dophot classification scheme:
  * XXX EAM : fix this to use current source classification scheme
+ *
+ *
  * PM_SOURCE_DEFECT: 8
  * PM_SOURCE_SATURATED: 8
 …
  * PM_SOURCE_POOR_FIT_GAL: 2
  * PM_SOURCE_OTHER: ?
+ *
+ *
  */
 int pmSourceDophotType(
 …
 /** pmSourceSextractType()
+ *
+ *
  * This function converts the source classification into the closest available
  * approximation to the Sextractor classification scheme. the correspondence is
  * not yet defined (TBD) .
+ *
+ *
  * XXX: Must code this.
+ *
+ *
  */
 int pmSourceSextractType(
 …
 /** pmSourceFitModel_v5()
+ *
+ *
  * Fit the requested model to the specified source. The starting guess for the
  * model is given by the input source.model parameter values. The pixels of
 …
  * function calls psMinimizeLMChi2() on the image data. The function returns TRUE
  * on success or FALSE on failure.
+ *
+ *
  */
 bool pmSourceFitModel_v5(
 …
 /** pmSourceFitModel_v7()
+ *
+ *
  * Fit the requested model to the specified source. The starting guess for the
  * model is given by the input source.model parameter values. The pixels of
 …
  * function calls psMinimizeLMChi2() on the image data. The function returns TRUE
  * on success or FALSE on failure.
+ *
+ *
  */
 bool pmSourceFitModel_v7(
 …
 /** pmSourcePhotometry()
+ *
+ *
  * XXX: Need descriptions
+ *
+ *
  */
 bool pmSourcePhotometry(

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 6062 for branches/eam_rel9_p0/psModules/src/objects/pmObjects.h

Legend:

branches/eam_rel9_p0/psModules/src/objects/pmObjects.h

Download in other formats: