Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

pmSource.h File Reference


Detailed Description

Author:
EAM, IfA; GLG, MHPCC
Version:
Revision
1.5
Name
rel12
Date:
Date
2006/06/22 20:04:13
Copyright 2004 Maui High Performance Computing Center, University of Hawaii

Definition in file pmSource.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pmSource
 pmSource data structure More...
struct  pmPSFClump
 pmPSFClump data structure More...

Enumerations

enum  pmSourceType { PM_SOURCE_TYPE_UNKNOWN, PM_SOURCE_TYPE_DEFECT, PM_SOURCE_TYPE_SATURATED, PM_SOURCE_TYPE_STAR, PM_SOURCE_TYPE_EXTENDED }
 pmSourceType enumeration More...
enum  pmSourceMode { PM_SOURCE_MODE_TEMPSUB = 0x0800 }

Functions

pmSourcepmSourceAlloc ()
 pmSourceAlloc()
void pmSourceFreePixels (pmSource *source)
bool pmIsSource (const psPtr ptr)
bool pmSourceDefinePixels (pmSource *mySource, const pmReadout *readout, psF32 x, psF32 y, psF32 Radius)
 pmSourceDefinePixels()
bool pmSourceRedefinePixels (pmSource *mySource, const pmReadout *readout, psF32 x, psF32 y, psF32 Radius)
pmPSFClump pmSourcePSFClump (psArray *source, psMetadata *metadata)
 pmSourcePSFClump()
bool pmSourceRoughClass (psArray *source, psMetadata *metadata, pmPSFClump clump)
 pmSourceRoughClass()
bool pmSourceMoments (pmSource *source, float radius)
 pmSourceMoments()
pmModelpmSourceSelectModel (pmSource *source)


Enumeration Type Documentation

enum pmSourceMode
 

Enumerator:
PM_SOURCE_MODE_TEMPSUB  XXX get me a better name!

Definition at line 50 of file pmSource.h.

enum pmSourceType
 

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)

Enumerator:
PM_SOURCE_TYPE_UNKNOWN  a cosmic-ray
PM_SOURCE_TYPE_DEFECT  a cosmic-ray
PM_SOURCE_TYPE_SATURATED  random saturated pixels
PM_SOURCE_TYPE_STAR  a good-quality star
PM_SOURCE_TYPE_EXTENDED  an extended object (eg, galaxy)

Definition at line 42 of file pmSource.h.


Function Documentation

bool pmIsSource const psPtr  ptr  ) 
 

pmSource* pmSourceAlloc  ) 
 

pmSourceAlloc()

bool pmSourceDefinePixels pmSource mySource,
const pmReadout readout,
psF32  x,
psF32  y,
psF32  Radius
 

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 a square window (of full width 2Radius+1) centered on the pixel which contains the given coordinate, in the frame of the readout. The window is defined to have limits which are valid within the boundary of the readout image, thus if the radius would fall outside the image pixels, the subimage is truncated to only consist of valid pixels. If readout->mask or readout->weight are not NULL, matching subimages are defined for those images as well. This function fails if no valid pixels can be defined (x or y less than Radius, for example). This function should be used to define a region of interest around a source, including both source and sky pixels.

Parameters:
mySource  source to be re-defined
readout  base the source on this readout
x  center coords of source
y  center coords of source
Radius  size of box on source

void pmSourceFreePixels pmSource source  ) 
 

bool pmSourceMoments pmSource source,
float  radius
 

pmSourceMoments()

Measure source moments for the given source, using the value of source.moments.sky provided as the local background value and the peak coordinates as the initial source location. The resulting moment values are applied to the source.moments entry, and the source is returned. The moments are measured within the given circular radius of the source.peak coordinates. The return value indicates the success (TRUE) of the operation.

Parameters:
source  The input pmSource for which moments will be computed
radius  Use a circle of pixels around the peak

pmPSFClump pmSourcePSFClump psArray *  source,
psMetadata *  metadata
 

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 the image. As long as the PSF shape does not vary excessively across the image, the sources which are represented by a PSF (the start) will have very similar second moments. The function pmSourcePSFClump searches a collection of sources with measured moments for a group with moments which are all very 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 represent this plane. The units of sigma_x and sigma_y are in image pixels. A pixel in this analysis image represents 0.1 pixels in the input image. The dimensions of the image need only be 10 pixels. The peak pixel in this image (above a threshold of half of the image maximum) is found. The coordinates of this peak pixel represent the 2D mode of the sigma_x, sigma_y distribution. The sources with sigma_x, sigma_y within 0.2 pixels of this value are then * 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)

Parameters:
source  The input pmSource
metadata  Contains classification parameters

bool pmSourceRedefinePixels pmSource mySource,
const pmReadout readout,
psF32  x,
psF32  y,
psF32  Radius
 

Parameters:
mySource  source to be re-defined
readout  base the source on this readout
x  center coords of source
y  center coords of source
Radius  size of box on source

bool pmSourceRoughClass psArray *  source,
psMetadata *  metadata,
pmPSFClump  clump
 

pmSourceRoughClass()

Based on the specified data values, make a guess at the source classification. The sources are provides as a psArray of pmSource entries. Definable parameters needed to make the classification are provided to the routine with the psMetadata structure. The rules (in SDRS) refer to values which can be extracted from the metadata using the given keywords. Except as noted, the data type for these parameters are psF32.

Parameters:
source  The input pmSource
metadata  Contains classification parameters
clump  Statistics about the PSF clump

pmModel* pmSourceSelectModel pmSource source  ) 
 


Generated on Mon Jul 3 14:24:54 2006 for Pan-STARRS Module Library by  doxygen 1.4.4