AstroImage

Files
file	pmAstrometry.h
	This file defines the basic types for astronomical coordinate transformation.
Data Structures
struct	pmFPA
	Focal plane data structure. More...
struct	pmChip
	Chip data structure. More...
struct	pmCell
	Cell data structure. More...
struct	pmReadout
	Readout data structure. More...
Functions
pmReadout *	pmReadoutAlloc (pmCell *cell)
	Allocates a pmReadout.
pmCell *	pmCellAlloc (pmChip *chip)
	Allocates a pmCell.
pmChip *	pmChipAlloc (pmFPA *fpa)
	Allocates a pmChip.
pmFPA *	pmFPAAlloc (const psMetadata *camera, psDB *db)
	Allocates a pmFPA.
bool	pmFPACheckParents (pmFPA *fpa)
	Verify parent links.
pmCell *	pmCellInFPA (const psPlane *coord, const pmFPA *FPA)
	Find cooresponding cell for given FPA coordinate.
pmChip *	pmChipInFPA (const psPlane *coord, const pmFPA *FPA)
	Find cooresponding chip for given FPA coordinate.
pmCell *	pmCellInChip (const psPlane *coord, const pmChip *chip)
	Find cooresponding cell for given Chip coordinate.
psPlane *	psCoordCellToChip (psPlane *out, const psPlane *in, const pmCell *cell)
	Translate a cell coordinate into a chip coordinate.
psPlane *	psCoordChipToFPA (psPlane *out, const psPlane *in, const pmChip *chip)
	Translate a chip coordinate into a FPA coordinate.
psPlane *	psCoordFPAToTP (psPlane *out, const psPlane *in, double color, double magnitude, const pmFPA *fpa)
	Translate a FPA coordinate into a Tangent Plane coordinate.
psSphere *	psCoordTPToSky (psSphere *out, const psPlane *in, const psProjection *projection)
	Translate a Tangent Plane coordinate into a Sky coordinate.
psPlane *	psCoordCellToFPA (psPlane *out, const psPlane *in, const pmCell *cell)
	Translate a cell coordinate into a FPA coordinate.
psSphere *	psCoordCellToSky (psSphere *out, const psPlane *in, double color, double magnitude, const pmCell *cell)
	Translate a cell coordinate into a Sky coordinate.
psSphere *	psCoordCellToSkyQuick (psSphere *out, const psPlane *in, const pmCell *cell)
	Translate a cell coordinate into a Sky coordinate using a 'quick and dirty' method.
psPlane *	psCoordSkyToTP (psPlane *out, const psSphere *in, const psProjection *projection)
	Translate a Sky coordinate into a Tangent Plane coordinate.
psPlane *	psCoordTPToFPA (psPlane *out, const psPlane *in, double color, double magnitude, const pmFPA *fpa)
	Translate a Tangent Plane coordinate into a FPA coordinate.
psPlane *	psCoordFPAToChip (psPlane *out, const psPlane *in, const pmChip *chip)
	Translate a FPA coordinate into a chip coordinate.
psPlane *	psCoordChipToCell (psPlane *out, const psPlane *in, const pmCell *cell)
	Translate a chip coordinate into a cell coordinate.
psPlane *	psCoordSkyToCell (psPlane *out, const psSphere *in, float color, float magnitude, const pmCell *cell)
	Translate a sky coordinate into a cell coordinate.
psPlane *	psCoordSkyToCellQuick (psPlane *out, const psSphere *in, const pmCell *cell)
	Translate a sky coordinate into a cell coordinate using a 'quick and dirty' method.
psMetadataItem *	pmCellGetConcept (pmCell *cell, const char *concept)
psMetadataItem *	pmChipGetConcept (pmChip *chip, const char *concept)
psMetadataItem *	pmFPAGetConcept (pmFPA *fpa, const char *concept)
float	pmFPAGetAirmass (pmFPA *fpa)
psString	pmFPAGetFilter (pmFPA *fpa)
float	pmFPAGetPosAngle (pmFPA *fpa)
double	pmFPAGetRA (pmFPA *fpa)
double	pmFPAGetDec (pmFPA *fpa)
psString	pmFPAGetRADecSys (pmFPA *fpa)
psString	pmFPAGetName (pmFPA *fpa)
psString	pmChipGetName (pmChip *chip)
psString	pmCellGetName (pmCell *cell)
psTime *	pmCellGetTime (pmCell *cell)
psList *	pmCellGetBiasSec (pmCell *cell)
psRegion	pmCellGetTrimSec (pmCell *cell)
float	pmCellGetGain (pmCell *cell)
float	pmCellGetReadNoise (pmCell *cell)
float	pmCellGetSaturation (pmCell *cell)
float	pmCellGetBad (pmCell *cell)
psPixelCoord	pmCellGetBin (pmCell *cell)
psPixelCoord	pmCellGetParity (pmCell *cell)
float	pmReadoutGetExposure (pmReadout *readout)
float	pmReadoutGetDarkTime (pmReadout *readout)

---

Function Documentation

pmCell* pmCellAlloc (  pmChip *  chip  )

Allocates a pmCell. The constructor shall make an empty pmCell. If the parent chip is not NULL, the parent link is made and the cell shall be placed in the parents array of cells. The readouts array shall be allocated with a zero size, and the metadata containers constructed. All other pointers in the structure shall be initialized to NULL. Returns: pmCell* newly allocated pmCell Parameters: chip  Parent chip

float pmCellGetBad (  pmCell *  cell  )

psList* pmCellGetBiasSec (  pmCell *  cell  )

psPixelCoord pmCellGetBin (  pmCell *  cell  )

psMetadataItem* pmCellGetConcept (  pmCell *  cell, const char *  concept )

float pmCellGetGain (  pmCell *  cell  )

psString pmCellGetName (  pmCell *  cell  )

psPixelCoord pmCellGetParity (  pmCell *  cell  )

float pmCellGetReadNoise (  pmCell *  cell  )

float pmCellGetSaturation (  pmCell *  cell  )

psTime* pmCellGetTime (  pmCell *  cell  )

psRegion pmCellGetTrimSec (  pmCell *  cell  )

pmCell* pmCellInChip (  const psPlane *  coord, const pmChip *  chip )

Find cooresponding cell for given Chip coordinate. Returns: pmCell* the cell cooresponding to coord Parameters: coord  the coordinate in Chip plane chip  the chip to search for the cell

pmCell* pmCellInFPA (  const psPlane *  coord, const pmFPA *  FPA )

Find cooresponding cell for given FPA coordinate. Returns: pmCell* the cell cooresponding to the coord in FPA Parameters: coord  the coordinate in FPA plane FPA  the FPA to search for the cell

pmChip* pmChipAlloc (  pmFPA *  fpa  )

Allocates a pmChip. The constructor shall make an empty pmChip. If the parent fpa is not NULL, the parent link is made and the chip shall be placed in the parent's array of chips. The cells array shall be allocated with a zero size, and the metadata containers constructed. All other pointers in the structure shall be initialized to NULL. Returns: pmChip* newly allocated pmChip

psMetadataItem* pmChipGetConcept (  pmChip *  chip, const char *  concept )

psString pmChipGetName (  pmChip *  chip  )

pmChip* pmChipInFPA (  const psPlane *  coord, const pmFPA *  FPA )

Find cooresponding chip for given FPA coordinate. Returns: pmChip* the chip cooresponding to coord Parameters: coord  the coordinate in FPA plane FPA  the FPA to search for the cell

pmFPA* pmFPAAlloc (  const psMetadata *  camera, psDB *  db )

Allocates a pmFPA. The constructor shall make an empty pmFPA. The chips array shall be allocated with a zero size, the camera and db pointers set to the values provided, and the concepts metadata constructed. All other pointers in the structure shall be initialized to NULL. Parameters: camera  Camera configuration db  Database handle

bool pmFPACheckParents (  pmFPA *  fpa  )

Verify parent links. This function checks the validity of the parent links in the FPA hierarchy. If a parent link is not set (or not set correctly), it is corrected, and the function shall return false. If all the parent pointers were correct, the function shall return true.

float pmFPAGetAirmass (  pmFPA *  fpa  )

We next specify a series of specific functions for concept lookups. These will generally be what the user utilises, so the goal is to provide a simple interface providing a single type back, so the user doesnt have to go to the trouble of checking types, etc. These functions should employ the above three general lookup functions and deal with the result appropriately.

psMetadataItem* pmFPAGetConcept (  pmFPA *  fpa, const char *  concept )

double pmFPAGetDec (  pmFPA *  fpa  )

psString pmFPAGetFilter (  pmFPA *  fpa  )

psString pmFPAGetName (  pmFPA *  fpa  )

float pmFPAGetPosAngle (  pmFPA *  fpa  )

double pmFPAGetRA (  pmFPA *  fpa  )

psString pmFPAGetRADecSys (  pmFPA *  fpa  )

pmReadout* pmReadoutAlloc (  pmCell *  cell  )

Allocates a pmReadout. The constructor shall make an empty pmReadout. If the parent cell is not NULL, the parent link is made and the readout shall be placed in the parents array of readouts. The metadata containers shall be allocated. All other pointers in the structure shall be initialized to NULL. Returns: pmReadout* newly allocated pmReadout with all internal pointers set to NULL Parameters: cell  Parent cell

float pmReadoutGetDarkTime (  pmReadout *  readout  )

float pmReadoutGetExposure (  pmReadout *  readout  )

psPlane* psCoordCellToChip (  psPlane *  out, const psPlane *  in, const pmCell *  cell )

Translate a cell coordinate into a chip coordinate. Returns: psPlane* the resulting chip coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the coordinate within Cell cell  the Cell in interest

psPlane* psCoordCellToFPA (  psPlane *  out, const psPlane *  in, const pmCell *  cell )

Translate a cell coordinate into a FPA coordinate. Returns: psPlane* the resulting FPA coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the coordinate within cell cell  the cell in interest

psSphere* psCoordCellToSky (  psSphere *  out, const psPlane *  in, double  color, double  magnitude, const pmCell *  cell )

Translate a cell coordinate into a Sky coordinate. Returns: psSphere* the resulting Sky coordinate Parameters: out  a sphere struct to recycle. If NULL, a new struct is created in  the coordinate within cell color  Color of source magnitude  Magnitude of source cell  the cell in interest

psSphere* psCoordCellToSkyQuick (  psSphere *  out, const psPlane *  in, const pmCell *  cell )

Translate a cell coordinate into a Sky coordinate using a 'quick and dirty' method. Returns: psSphere* the resulting Sky coordinate Parameters: out  a sphere struct to recycle. If NULL, a new struct is created in  the coordinate within cell cell  the cell in interest

psPlane* psCoordChipToCell (  psPlane *  out, const psPlane *  in, const pmCell *  cell )

Translate a chip coordinate into a cell coordinate. Returns: psPlane* the resulting cell coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the Chip coordinate cell  the cell of interest

psPlane* psCoordChipToFPA (  psPlane *  out, const psPlane *  in, const pmChip *  chip )

Translate a chip coordinate into a FPA coordinate. Returns: psPlane* the resulting FPA coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the coordinate within Chip chip  the chip in interest

psPlane* psCoordFPAToChip (  psPlane *  out, const psPlane *  in, const pmChip *  chip )

Translate a FPA coordinate into a chip coordinate. Returns: psPlane* the resulting chip coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the FPA coordinate chip  the chip of interest

psPlane* psCoordFPAToTP (  psPlane *  out, const psPlane *  in, double  color, double  magnitude, const pmFPA *  fpa )

Translate a FPA coordinate into a Tangent Plane coordinate. Returns: psPlane* the resulting Tangent Plane coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the coordinate within FPA color  Color of source magnitude  Magnitude of source fpa  the FPA in interest

psPlane* psCoordSkyToCell (  psPlane *  out, const psSphere *  in, float  color, float  magnitude, const pmCell *  cell )

Translate a sky coordinate into a cell coordinate. Returns: psPlane* the resulting cell coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the Sky coordinate color  Color of source magnitude  Magnitude of source cell  the cell of interest

psPlane* psCoordSkyToCellQuick (  psPlane *  out, const psSphere *  in, const pmCell *  cell )

Translate a sky coordinate into a cell coordinate using a 'quick and dirty' method. Returns: psPlane* the resulting cell coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the Sky coordinate cell  the cell of interest

psPlane* psCoordSkyToTP (  psPlane *  out, const psSphere *  in, const psProjection *  projection )

Translate a Sky coordinate into a Tangent Plane coordinate. Returns: psPlane* the resulting Tangent Plane coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the sky coordinate

psPlane* psCoordTPToFPA (  psPlane *  out, const psPlane *  in, double  color, double  magnitude, const pmFPA *  fpa )

Translate a Tangent Plane coordinate into a FPA coordinate. Returns: psPlane* the resulting FPA coordinate Parameters: out  a plane struct to recycle. If NULL, a new struct is created in  the coordinate within tangent plane color  Color of source magnitude  Magnitude of source fpa  the FPA of interest

psSphere* psCoordTPToSky (  psSphere *  out, const psPlane *  in, const psProjection *  projection )

Translate a Tangent Plane coordinate into a Sky coordinate. Returns: psSphere* the resulting Sky coordinate Parameters: out  a sphere struct to recycle. If NULL, a new struct is created in  the coordinate within Tangent Plane

---