pmFringeStats.h File Reference

---

Detailed Description

Measure Fringe statistics and apply correction.

Author:

Eugene Magnier, IfA

Version:

Revision

1.5

Name

rel12

Date:

Date

2006/06/14 22:04:40

Copyright 2004 IfA, University of Hawaii

Definition in file pmFringeStats.h.

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

Go to the source code of this file.

Data Structures
struct	pmFringeRegions
	Structure to hold the fringe measurement regions. More...
struct	pmFringeStats
	Structure to hold the fringe measurements for a particular image. More...
struct	pmFringeScale
	the pmFringeScale structure defines the relationship between two fringe measurements More...
Functions
pmFringeRegions *	pmFringeRegionsAlloc (int nPts, int dX, int dY, int nX, int nY)
	Allocate fringe regions.
bool	pmFringeRegionsCreatePoints (pmFringeRegions *fringe, const psImage *image)
pmFringeStats *	pmFringeStatsAlloc (pmFringeRegions *regions)
	Allocate fringe statistics.
pmFringeStats *	pmFringeStatsMeasure (pmFringeRegions *fringe, pmReadout *readout, psMaskType maskVal)
	Measure the fringe stats for an image.
bool	pmFringeStatsWriteFits (psFits *fits, const pmFringeStats *fringe, const char *extname)
pmFringeStats *	pmFringeStatsReadFits (const psFits *fits, const char *extname)
pmFringeScale *	pmFringeScaleMeasure (pmFringeStats *science, psArray *fringes, float rej, unsigned int nIter, float keepFrac)
	Determine the scales for the fringe correction.
pmFringeScale *	pmFringeScaleAlloc (int nFringeFrames)
	Allocate fringe scales.
psImage *	pmFringeCorrect (pmReadout *in, pmFringeRegions *fringes, psArray *fringeImages, psArray *fringeStats, psMaskType maskVal, float rej, unsigned int nIter, float keepFrac)
	Fringe correct the science image.

---

Function Documentation

psImage* pmFringeCorrect (  pmReadout *  in, pmFringeRegions *  fringes, psArray *  fringeImages, psArray *  fringeStats, psMaskType  maskVal, float  rej, unsigned int  nIter, float  keepFrac )

Fringe correct the science image. Given a science image, a set of fringe stats and a matched set of fringe images, correct the science image for the fringe images. Returns: psImage: summed fringe image

pmFringeRegions* pmFringeRegionsAlloc (  int  nPts, int  dX, int  dY, int  nX, int  nY )

Allocate fringe regions.

bool pmFringeRegionsCreatePoints (  pmFringeRegions *  fringe, const psImage *  image )

pmFringeScale* pmFringeScaleAlloc (  int  nFringeFrames  )

Allocate fringe scales.

pmFringeScale* pmFringeScaleMeasure (  pmFringeStats *  science, psArray *  fringes, float  rej, unsigned int  nIter, float  keepFrac )

Determine the scales for the fringe correction. Given an input fringe measurement, and an array of template fringe measurements, measure the contribution of each of the templates to the input. Rejection is performed on the fringe regions, to weed out stars etc. Returns: pmFringeScale*

pmFringeStats* pmFringeStatsAlloc (  pmFringeRegions *  regions  )

Allocate fringe statistics.

pmFringeStats* pmFringeStatsMeasure (  pmFringeRegions *  fringe, pmReadout *  readout, psMaskType  maskVal )

Measure the fringe stats for an image. Given an input image and a fringe stats structure, measure the statistics for each of the fringe points on the image. If the fringe vectors are NULL, new vectors are created. XXX should the structure carry the image dimensions for validation? Returns: bool: True or false for success or failure Parameters: fringe  fringe regions readout  measure fringes on this readout maskVal  Mask value for statistics

pmFringeStats* pmFringeStatsReadFits (  const psFits *  fits, const char *  extname )

bool pmFringeStatsWriteFits (  psFits *  fits, const pmFringeStats *  fringe, const char *  extname )

---