AstroImage


Files

file  pmAstrometry.h
 This file defines the basic types for astronomical coordinate transformation.
file  pmAstrometryObjects.h
 This file defines the basic types for matching objects based on their astrometry.

Data Structures

struct  p_pmHDU
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, psMetadata *cameradata, psString name)
 Allocates a pmCell.
pmChip * pmChipAlloc (pmFPA *fpa, psString name)
 Allocates a pmChip.
pmFPA * pmFPAAlloc (const psMetadata *camera)
 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 * pmCoordCellToChip (psPlane *out, const psPlane *in, const pmCell *cell)
 Translate a cell coordinate into a chip coordinate.
psPlane * pmCoordChipToFPA (psPlane *out, const psPlane *in, const pmChip *chip)
 Translate a chip coordinate into a FPA coordinate.
psPlane * pmCoordFPAToTP (psPlane *out, const psPlane *in, double color, double magnitude, const pmFPA *fpa)
 Translate a FPA coordinate into a Tangent Plane coordinate.
psSphere * pmCoordTPToSky (psSphere *out, const psPlane *in, const psProjection *projection)
 Translate a Tangent Plane coordinate into a Sky coordinate.
psPlane * pmCoordCellToFPA (psPlane *out, const psPlane *in, const pmCell *cell)
 Translate a cell coordinate into a FPA coordinate.
psSphere * pmCoordCellToSky (psSphere *out, const psPlane *in, double color, double magnitude, const pmCell *cell)
 Translate a cell coordinate into a Sky coordinate.
psSphere * pmCoordCellToSkyQuick (psSphere *out, const psPlane *in, const pmCell *cell)
 Translate a cell coordinate into a Sky coordinate using a 'quick and dirty' method.
psPlane * pmCoordSkyToTP (psPlane *out, const psSphere *in, const psProjection *projection)
 Translate a Sky coordinate into a Tangent Plane coordinate.
psPlane * pmCoordTPToFPA (psPlane *out, const psPlane *in, double color, double magnitude, const pmFPA *fpa)
 Translate a Tangent Plane coordinate into a FPA coordinate.
psPlane * pmCoordFPAToChip (psPlane *out, const psPlane *in, const pmChip *chip)
 Translate a FPA coordinate into a chip coordinate.
psPlane * pmCoordChipToCell (psPlane *out, const psPlane *in, const pmCell *cell)
 Translate a chip coordinate into a cell coordinate.
psPlane * pmCoordSkyToCell (psPlane *out, const psSphere *in, float color, float magnitude, const pmCell *cell)
 Translate a sky coordinate into a cell coordinate.
psPlane * pmCoordSkyToCellQuick (psPlane *out, const psSphere *in, const pmCell *cell)
 Translate a sky coordinate into a cell coordinate using a 'quick and dirty' method.
bool pmFPASelectChip (pmFPA *fpa, int chipNum)
 pmFPASelectChip shall set valid to true for the specified chip number (chipNum), and all other chips shall have valid set to false.
int pmFPAExcludeChip (pmFPA *fpa, int chipNum)
 pmFPAExcludeChip shall set valid to false only for the specified chip number (chipNum).

Variables

psArray * p_pmHDU::pixels
psMetadata * p_pmHDU::header
psPlaneDistort * pmFPA::toTangentPlane
 Transformation from focal plane to tangent plane.
psProjection * pmFPA::projection
 Projection from tangent plane to sky.
psMetadata * pmFPA::concepts
 Cache for PS concepts.
psMetadata * pmFPA::analysis
 FPA-level analysis metadata.
const psMetadata * pmFPA::camera
 Camera configuration.
psArray * pmFPA::chips
 The chips.
p_pmHDU * pmFPA::private
 FITS data.
psMetadata * pmFPA::phu
 Primary Header.
int pmChip::row0
 Offset from the bottom of FPA.
psPlaneTransform * pmChip::toFPA
 Transformation from chip to FPA coordinates.
psPlaneTransform * pmChip::fromFPA
 Transformation from FPA to chip coordinates.
psMetadata * pmChip::concepts
 Cache for PS concepts.
psMetadata * pmChip::analysis
 Chip-level analysis metadata.
psArray * pmChip::cells
 The cells (referred to by name).
pmFPA * pmChip::parent
 Parent FPA.
bool pmChip::valid
 Do we bother about reading and working with this chip?
p_pmHDU * pmChip::private
 FITS data.
int pmCell::row0
 Offset from the bottom of chip.
psPlaneTransform * pmCell::toChip
 Transformations from cell to chip coordinates.
psPlaneTransform * pmCell::toFPA
 Transformations from cell to FPA coordinates.
psPlaneTransform * pmCell::toSky
 Transformations from cell to sky coordinates.
psMetadata * pmCell::concepts
 Cache for PS concepts.
psMetadata * pmCell::camera
 Camera Info.
psMetadata * pmCell::analysis
 Cell-level analysis metadata.
psArray * pmCell::readouts
 The readouts (referred to by number).
pmChip * pmCell::parent
 Parent chip.
bool pmCell::valid
 Do we bother about reading and working with this cell?
p_pmHDU * pmCell::private
 FITS data.
int pmReadout::row0
 Offset from the bottom of chip.
int pmReadout::colBins
 Amount of binning in x-dimension.
int pmReadout::rowBins
 Amount of binning in y-dimension.
psImage * pmReadout::image
 Imaging area of readout.
psImage * pmReadout::mask
 Mask of input image.
psImage * pmReadout::weight
 Weight of input image.
psList * pmReadout::bias
 List of bias section (sub-)images.
psMetadata * pmReadout::analysis
 Readout-level analysis metadata.
pmCell * pmReadout::parent
 Parent cell.

Function Documentation

pmCell* pmCellAlloc (  pmChip *  chip,
psMetadata *  cameradata,
psString  name
) 
 

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

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,
psString  name
) 
 

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

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

psPlane* pmCoordCellToChip (  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* pmCoordCellToFPA (  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* pmCoordCellToSky (  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* pmCoordCellToSkyQuick (  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* pmCoordChipToCell (  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* pmCoordChipToFPA (  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* pmCoordFPAToChip (  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* pmCoordFPAToTP (  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* pmCoordSkyToCell (  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* pmCoordSkyToCellQuick (  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* pmCoordSkyToTP (  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* pmCoordTPToFPA (  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* pmCoordTPToSky (  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

pmFPA* pmFPAAlloc (  const psMetadata *  camera  ) 
 

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

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.

int pmFPAExcludeChip (  pmFPA *  fpa,
int  chipNum
) 
 

pmFPAExcludeChip shall set valid to false only for the specified chip number (chipNum).

In the event that the specified chip number does not exist within the fpa, the function shall generate a warning, and perform no action. The function shall return the number of chips within the fpa that have valid set to true.

bool pmFPASelectChip (  pmFPA *  fpa,
int  chipNum
) 
 

pmFPASelectChip shall set valid to true for the specified chip number (chipNum), and all other chips shall have valid set to false.

In the event that the specified chip number does not exist within the fpa, the function shall return false.

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

Variable Documentation

psMetadata* pmReadout::analysis [inherited]
 

Readout-level analysis metadata.

Definition at line 152 of file pmAstrometry.h.

psMetadata* pmCell::analysis [inherited]
 

Cell-level analysis metadata.

Definition at line 122 of file pmAstrometry.h.

psMetadata* pmChip::analysis [inherited]
 

Chip-level analysis metadata.

Definition at line 93 of file pmAstrometry.h.

psMetadata* pmFPA::analysis [inherited]
 

FPA-level analysis metadata.

Definition at line 61 of file pmAstrometry.h.

psList* pmReadout::bias [inherited]
 

List of bias section (sub-)images.

Definition at line 151 of file pmAstrometry.h.

psMetadata* pmCell::camera [inherited]
 

Camera Info.

Definition at line 121 of file pmAstrometry.h.

const psMetadata* pmFPA::camera [inherited]
 

Camera configuration.

Definition at line 62 of file pmAstrometry.h.

psArray* pmChip::cells [inherited]
 

The cells (referred to by name).

Definition at line 94 of file pmAstrometry.h.

psArray* pmFPA::chips [inherited]
 

The chips.

Definition at line 63 of file pmAstrometry.h.

int pmReadout::colBins [inherited]
 

Amount of binning in x-dimension.

Definition at line 145 of file pmAstrometry.h.

psMetadata* pmCell::concepts [inherited]
 

Cache for PS concepts.

Definition at line 120 of file pmAstrometry.h.

psMetadata* pmChip::concepts [inherited]
 

Cache for PS concepts.

Definition at line 92 of file pmAstrometry.h.

psMetadata* pmFPA::concepts [inherited]
 

Cache for PS concepts.

Definition at line 60 of file pmAstrometry.h.

psPlaneTransform* pmChip::fromFPA [inherited]
 

Transformation from FPA to chip coordinates.

Definition at line 90 of file pmAstrometry.h.

psMetadata* p_pmHDU::header [inherited]
 

Definition at line 33 of file pmAstrometry.h.

psImage* pmReadout::image [inherited]
 

Imaging area of readout.

Definition at line 148 of file pmAstrometry.h.

psImage* pmReadout::mask [inherited]
 

Mask of input image.

Definition at line 149 of file pmAstrometry.h.

pmCell* pmReadout::parent [inherited]
 

Parent cell.

Definition at line 153 of file pmAstrometry.h.

pmChip* pmCell::parent [inherited]
 

Parent chip.

Definition at line 124 of file pmAstrometry.h.

pmFPA* pmChip::parent [inherited]
 

Parent FPA.

Definition at line 95 of file pmAstrometry.h.

psMetadata* pmFPA::phu [inherited]
 

Primary Header.

Definition at line 65 of file pmAstrometry.h.

psArray* p_pmHDU::pixels [inherited]
 

Definition at line 32 of file pmAstrometry.h.

p_pmHDU* pmCell::private [inherited]
 

FITS data.

Definition at line 126 of file pmAstrometry.h.

p_pmHDU* pmChip::private [inherited]
 

FITS data.

Definition at line 97 of file pmAstrometry.h.

p_pmHDU* pmFPA::private [inherited]
 

FITS data.

Definition at line 64 of file pmAstrometry.h.

psProjection* pmFPA::projection [inherited]
 

Projection from tangent plane to sky.

Definition at line 58 of file pmAstrometry.h.

psArray* pmCell::readouts [inherited]
 

The readouts (referred to by number).

Definition at line 123 of file pmAstrometry.h.

int pmReadout::row0 [inherited]
 

Offset from the bottom of chip.

Definition at line 144 of file pmAstrometry.h.

int pmCell::row0 [inherited]
 

Offset from the bottom of chip.

Definition at line 114 of file pmAstrometry.h.

int pmChip::row0 [inherited]
 

Offset from the bottom of FPA.

Definition at line 87 of file pmAstrometry.h.

int pmReadout::rowBins [inherited]
 

Amount of binning in y-dimension.

Definition at line 146 of file pmAstrometry.h.

psPlaneTransform* pmCell::toChip [inherited]
 

Transformations from cell to chip coordinates.

Definition at line 116 of file pmAstrometry.h.

psPlaneTransform* pmCell::toFPA [inherited]
 

Transformations from cell to FPA coordinates.

Definition at line 117 of file pmAstrometry.h.

psPlaneTransform* pmChip::toFPA [inherited]
 

Transformation from chip to FPA coordinates.

Definition at line 89 of file pmAstrometry.h.

psPlaneTransform* pmCell::toSky [inherited]
 

Transformations from cell to sky coordinates.

Definition at line 118 of file pmAstrometry.h.

psPlaneDistort* pmFPA::toTangentPlane [inherited]
 

Transformation from focal plane to tangent plane.

Definition at line 57 of file pmAstrometry.h.

bool pmCell::valid [inherited]
 

Do we bother about reading and working with this cell?

Definition at line 125 of file pmAstrometry.h.

bool pmChip::valid [inherited]
 

Do we bother about reading and working with this chip?

Definition at line 96 of file pmAstrometry.h.

psImage* pmReadout::weight [inherited]
 

Weight of input image.

Definition at line 150 of file pmAstrometry.h.

Generated on Tue Dec 13 13:38:32 2005 for Pan-STARRS Module Library by  doxygen 1.4.5