src

pmObjects.h File Reference

Detailed Description

This file will ...

Author:: GLG, MHPCC

Version:

Revision: 1.15

Name: rel7

Date:

Date: 2005/09/11 22:25:39

Definition in file pmObjects.h.

#include <stdio.h>
#include <math.h>
#include "pslib.h"

Include dependency graph for pmObjects.h:

Go to the source code of this file.

Defines

#define PM_OBJECTS_H

Typedefs

typedef psMinimizeLMChi2Func pmModelFunc

typedef psF64(* pmModelFlux )(const psVector *params)

typedef bool(* pmModelGuessFunc )(pmModel *model, pmSource *source)

typedef bool(* pmModelFromPSFFunc )(pmModel *modelPSF, pmModel *modelFLT, pmPSF *psf)

typedef psF64(* pmModelRadius )(const psVector *params, double flux)

Enumerations

enum pmPeakType { PM_PEAK_LONE, PM_PEAK_EDGE, PM_PEAK_FLAT, PM_PEAK_UNDEF }

pmPeakType More...

enum pmModelType { PS_MODEL_GAUSS, PS_MODEL_PGAUSS, PS_MODEL_TWIST_GAUSS, PS_MODEL_WAUSS, PS_MODEL_SERSIC, PS_MODEL_SERSIC_CORE, PS_MODEL_UNDEFINED }

pmModelType enumeration More...

enum pmSourceType { PS_SOURCE_PSFSTAR, PS_SOURCE_GALAXY, PS_SOURCE_DEFECT, PS_SOURCE_SATURATED, PS_SOURCE_SATSTAR, PS_SOURCE_FAINTSTAR, PS_SOURCE_BRIGHTSTAR, PS_SOURCE_OTHER }

pmSourceType enumeration More...

enum pmContourType { PS_CONTOUR_CRUDE }

Functions

pmPeak * pmPeakAlloc (int x, int y, float counts, pmPeakType class)

pmMoments * pmMomentsAlloc ()

pmModel * pmModelAlloc (pmModelType type)

pmSource * pmSourceAlloc ()

psVector * pmFindVectorPeaks (const psVector *vector, float threshold)

psArray * pmFindImagePeaks (const psImage *image, float threshold)

psList * pmCullPeaks (psList *peaks, float maxValue, const psRegion valid)

pmSource * pmSourceLocalSky (const psImage *image, const pmPeak *peak, psStatsOptions statsOptions, float innerRadius, float outerRadius)

pmSource * pmSourceMoments (pmSource *source, float radius)

bool pmSourceRoughClass (psArray *source, psMetadata *metadata)

bool pmSourceSetPixelsCircle (pmSource *source, const psImage *image, float radius)

bool pmSourceModelGuess (pmSource *source, const psImage *image, pmModelType model)

psArray * pmSourceContour (pmSource *source, const psImage *image, float level, pmContourType mode)

bool pmSourceFitModel (pmSource *source, const psImage *image)

bool pmSourceAddModel (psImage *image, pmSource *source, bool center)

bool pmSourceSubModel (psImage *image, pmSource *source, bool center)

float pmMinLM_Gauss2D (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_PsuedoGauss2D (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_Wauss2D (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_TwistGauss2D (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_Sersic (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_SersicCore (psVector *deriv, const psVector *params, const psVector *x)

float pmMinLM_PsuedoSersic (psVector *deriv, const psVector *params, const psVector *x)

pmModelFunc pmModelFunc_GetFunction (pmModelType type)

pmModelFlux pmModelFlux_GetFunction (pmModelType type)

pmModelGuessFunc pmModelGuessFunc_GetFunction (pmModelType type)

pmModelFromPSFFunc pmModelFromPSFFunc_GetFunction (pmModelType type)

pmModelRadius pmModelRadius_GetFunction (pmModelType type)

psS32 pmModelParameterCount (pmModelType type)

psS32 pmModelSetType (char *name)

char * pmModelGetType (pmModelType type)

Define Documentation

#define PM_OBJECTS_H

Definition at line 15 of file pmObjects.h.

Typedef Documentation

typedef psF64(* pmModelFlux)(const psVector *params)

This function returns the integrated flux for the given model parameters.
Definition at line 352 of file pmObjects.h.

typedef bool(* pmModelFromPSFFunc)(pmModel *modelPSF, pmModel *modelFLT, pmPSF *psf)

This function constructs the PSF model for the given source based on the supplied psf and the FLT model for the object.
Definition at line 370 of file pmObjects.h.

typedef psMinimizeLMChi2Func pmModelFunc

This function is the model chi-square minimization function for this model.
Definition at line 345 of file pmObjects.h.

typedef bool(* pmModelGuessFunc)(pmModel *model, pmSource *source)

This function provides the model guess parameters based on the details of the given source.
Definition at line 361 of file pmObjects.h.

typedef psF64(* pmModelRadius)(const psVector *params, double flux)

This function returns the radius at which the given model and parameters achieves the given flux.
Definition at line 379 of file pmObjects.h.

Enumeration Type Documentation

enum pmContourType

Enumeration values:

PS_CONTOUR_CRUDE

Definition at line 237 of file pmObjects.h.

enum pmModelType

pmModelType enumeration

Enumeration values:

PS_MODEL_GAUSS Regular 2-D Gaussian.

PS_MODEL_PGAUSS Psuedo 2-D Gaussian.

PS_MODEL_TWIST_GAUSS 2-D Twisted Gaussian

PS_MODEL_WAUSS 2-D Waussian

PS_MODEL_SERSIC Sersic.

PS_MODEL_SERSIC_CORE Sersic Core.

PS_MODEL_UNDEFINED Undefined.

Definition at line 74 of file pmObjects.h.

enum pmPeakType

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. PM_PEAK_LONE represents a single pixel which is higher than its 8 immediate neighbors. The PM_PEAK_EDGE represents a peak pixel which touching the image 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:
Enumeration values:

PM_PEAK_LONE Isolated peak.

PM_PEAK_EDGE Peak on edge.

PM_PEAK_FLAT Peak has equal-value neighbors.

PM_PEAK_UNDEF Undefined.

Definition at line 35 of file pmObjects.h.

enum pmSourceType

pmSourceType enumeration

Enumeration values:

PS_SOURCE_PSFSTAR

PS_SOURCE_GALAXY

PS_SOURCE_DEFECT

PS_SOURCE_SATURATED

PS_SOURCE_SATSTAR

PS_SOURCE_FAINTSTAR

PS_SOURCE_BRIGHTSTAR

PS_SOURCE_OTHER

Definition at line 104 of file pmObjects.h.

Function Documentation

psList* pmCullPeaks ( psList * peaks,

float maxValue,

const psRegion valid

)

Parameters:

peaks The psList of peaks to be culled

maxValue Cull peaks above this value

valid Cull peaks otside this psRegion

psArray* pmFindImagePeaks ( const psImage * image,

float threshold

)

Parameters:

image The input image where peaks will be found (float)

threshold Threshold above which to find a peak

psVector* pmFindVectorPeaks ( const psVector * vector,

float threshold

)

Parameters:

vector The input vector (float)

threshold Threshold above which to find a peak

float pmMinLM_Gauss2D ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_PsuedoGauss2D ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_PsuedoSersic ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_Sersic ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_SersicCore ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_TwistGauss2D ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

float pmMinLM_Wauss2D ( psVector * deriv,

const psVector * params,

const psVector * x

)

Parameters:

deriv A possibly-NULL structure for the output derivatives

params A psVector which holds the parameters of this function

x A psVector which holds the row/col coordinate

pmModel* pmModelAlloc ( pmModelType type )

pmModelFlux pmModelFlux_GetFunction ( pmModelType type )

pmModelFromPSFFunc pmModelFromPSFFunc_GetFunction ( pmModelType type )

pmModelFunc pmModelFunc_GetFunction ( pmModelType type )

Each of the function types above has a corresponding function which returns the function given the model type:

char* pmModelGetType ( pmModelType type )

pmModelGuessFunc pmModelGuessFunc_GetFunction ( pmModelType type )

psS32 pmModelParameterCount ( pmModelType type )

pmModelRadius pmModelRadius_GetFunction ( pmModelType type )

psS32 pmModelSetType ( char * name )

pmMoments* pmMomentsAlloc ( )

pmPeak* pmPeakAlloc ( int x,

int y,

float counts,

pmPeakType class

)

Parameters:

x Row-coordinate in image space

y Col-coordinate in image space

counts The value of the peak pixel

class The type of peak pixel

bool pmSourceAddModel ( psImage * image,

pmSource * source,

bool center

)

Parameters:

image The opuut image (float)

source The input pmSource

center A boolean flag that determines whether pixels are centered

pmSource* pmSourceAlloc ( )

psArray* pmSourceContour ( pmSource * source,

const psImage * image,

float level,

pmContourType mode

)

Parameters:

source The input pmSource

image The input image (float) (this arg should be removed)

level The level of the contour

mode Currently this must be PS_CONTOUR_CRUDE

bool pmSourceFitModel ( pmSource * source,

const psImage * image

)

Parameters:

source The input pmSource

image The input image (float)

pmSource* pmSourceLocalSky ( const psImage * image,

const pmPeak * peak,

psStatsOptions statsOptions,

float innerRadius,

float outerRadius

)

Parameters:

image The input image (float)

peak The peak for which the psSource struct is created.

statsOptions The statistic used in calculating the background sky

innerRadius The inner radius of the suqare annulus for calculating sky

outerRadius The outer radius of the suqare annulus for calculating sky

bool pmSourceModelGuess ( pmSource * source,

const psImage * image,

pmModelType model

)

Parameters:

source The input pmSource

image The input image (float)

model The type of model to be created.

pmSource* pmSourceMoments ( pmSource * source,

float radius

)

Parameters:

source The input pmSource for which moments will be computed

radius Use a circle of pixels around the peak

bool pmSourceRoughClass ( psArray * source,

psMetadata * metadata

)

Parameters:

source The input pmSource

metadata Contains classification parameters

bool pmSourceSetPixelsCircle ( pmSource * source,

const psImage * image,

float radius

)

Parameters:

source The input pmSource

image The input image (float)

radius The radius of the circle

bool pmSourceSubModel ( psImage * image,

pmSource * source,

bool center

)

Parameters:

image The output image (float)

source The input pmSource

center A boolean flag that determines whether pixels are centered

Generated on Wed Sep 14 11:09:19 2005 for Pan-STARRS Module Library by

1.4.2


Defines
#define	PM_OBJECTS_H
Typedefs
typedef psMinimizeLMChi2Func	pmModelFunc
typedef psF64(*	pmModelFlux )(const psVector *params)
typedef bool(*	pmModelGuessFunc )(pmModel model, pmSource source)
typedef bool(*	pmModelFromPSFFunc )(pmModel modelPSF, pmModel modelFLT, pmPSF *psf)
typedef psF64(*	pmModelRadius )(const psVector *params, double flux)
Enumerations
enum	pmPeakType { PM_PEAK_LONE, PM_PEAK_EDGE, PM_PEAK_FLAT, PM_PEAK_UNDEF }
	pmPeakType More...
enum	pmModelType { PS_MODEL_GAUSS, PS_MODEL_PGAUSS, PS_MODEL_TWIST_GAUSS, PS_MODEL_WAUSS, PS_MODEL_SERSIC, PS_MODEL_SERSIC_CORE, PS_MODEL_UNDEFINED }
	pmModelType enumeration More...
enum	pmSourceType { PS_SOURCE_PSFSTAR, PS_SOURCE_GALAXY, PS_SOURCE_DEFECT, PS_SOURCE_SATURATED, PS_SOURCE_SATSTAR, PS_SOURCE_FAINTSTAR, PS_SOURCE_BRIGHTSTAR, PS_SOURCE_OTHER }
	pmSourceType enumeration More...
enum	pmContourType { PS_CONTOUR_CRUDE }
Functions
pmPeak *	pmPeakAlloc (int x, int y, float counts, pmPeakType class)
pmMoments *	pmMomentsAlloc ()
pmModel *	pmModelAlloc (pmModelType type)
pmSource *	pmSourceAlloc ()
psVector *	pmFindVectorPeaks (const psVector *vector, float threshold)
psArray *	pmFindImagePeaks (const psImage *image, float threshold)
psList *	pmCullPeaks (psList *peaks, float maxValue, const psRegion valid)
pmSource *	pmSourceLocalSky (const psImage image, const pmPeak peak, psStatsOptions statsOptions, float innerRadius, float outerRadius)
pmSource *	pmSourceMoments (pmSource *source, float radius)
bool	pmSourceRoughClass (psArray source, psMetadata metadata)
bool	pmSourceSetPixelsCircle (pmSource source, const psImage image, float radius)
bool	pmSourceModelGuess (pmSource source, const psImage image, pmModelType model)
psArray *	pmSourceContour (pmSource source, const psImage image, float level, pmContourType mode)
bool	pmSourceFitModel (pmSource source, const psImage image)
bool	pmSourceAddModel (psImage image, pmSource source, bool center)
bool	pmSourceSubModel (psImage image, pmSource source, bool center)
float	pmMinLM_Gauss2D (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_PsuedoGauss2D (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_Wauss2D (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_TwistGauss2D (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_Sersic (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_SersicCore (psVector deriv, const psVector params, const psVector *x)
float	pmMinLM_PsuedoSersic (psVector deriv, const psVector params, const psVector *x)
pmModelFunc	pmModelFunc_GetFunction (pmModelType type)
pmModelFlux	pmModelFlux_GetFunction (pmModelType type)
pmModelGuessFunc	pmModelGuessFunc_GetFunction (pmModelType type)
pmModelFromPSFFunc	pmModelFromPSFFunc_GetFunction (pmModelType type)
pmModelRadius	pmModelRadius_GetFunction (pmModelType type)
psS32	pmModelParameterCount (pmModelType type)
psS32	pmModelSetType (char *name)
char *	pmModelGetType (pmModelType type)