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

AstroImage


Files

file  pmAstrometryDistortion.h
 This file defines the basic types for measuring and fitting the focal-plane distortion.
file  pmAstrometryObjects.h
 This file defines the basic types for matching objects based on their astrometry.
file  pmFPA.h
 This file defines the basic types the focal plane hierarchy.
file  pmFPAview.h
 Tools to manipulate the FPA structure elements.

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...
struct  pmFPAview

Enumerations

enum  pmFPALevel { PM_FPA_LEVEL_NONE, PM_FPA_LEVEL_FPA, PM_FPA_LEVEL_CHIP, PM_FPA_LEVEL_CELL, PM_FPA_LEVEL_READOUT }
 Specify the level for an operation. More...

Functions

void pmCellFreeReadouts (pmCell *cell)
void pmChipFreeCells (pmChip *chip)
void pmReadoutFreeData (pmReadout *readout)
void pmCellFreeData (pmCell *cell)
void pmChipFreeData (pmChip *chip)
void pmFPAFreeData (pmFPA *fpa)
pmReadoutpmReadoutAlloc (pmCell *cell)
 Allocates a pmReadout.
pmCellpmCellAlloc (pmChip *chip, const char *name)
 Allocates a pmCell.
pmChippmChipAlloc (pmFPA *fpa, const char *name)
 Allocates a pmChip.
pmFPApmFPAAlloc (const psMetadata *camera)
 Allocates a pmFPA.
bool pmFPACheckParents (pmFPA *fpa)
 Verify parent links.
bool pmFPASetFileStatus (pmFPA *fpa, bool status)
bool pmChipSetFileStatus (pmChip *chip, bool status)
bool pmCellSetFileStatus (pmCell *cell, bool status)
bool pmFPASetDataStatus (pmFPA *fpa, bool status)
bool pmChipSetDataStatus (pmChip *chip, bool status)
bool pmCellSetDataStatus (pmCell *cell, bool status)
bool pmFPASelectChip (pmFPA *fpa, int chipNum, bool exclusive)
 pmFPASelectChip shall set valid to true for the specified chip number (chipNum), and all other chips shall have valid set to false.
bool pmChipSelectCell (pmChip *chip, int cellNum, bool exclusive)
int pmFPAExcludeChip (pmFPA *fpa, int chipNum)
 pmFPAExcludeChip shall set valid to false only for the specified chip number (chipNum).
int pmChipExcludeCell (pmChip *chip, int cellNum)
bool pmCellSetWeights (pmCell *cell)
char * pmFPALevelToName (pmFPALevel level)
pmFPALevel pmFPALevelFromName (const char *name)
bool pmFPAviewWriteJPEG (const pmFPAview *view, pmFPAfile *file)
bool pmFPAWriteJPEG (pmFPA *fpa, const pmFPAview *view, pmFPAfile *file)
bool pmChipWriteJPEG (pmChip *chip, const pmFPAview *view, pmFPAfile *file)
bool pmCellWriteJPEG (pmCell *cell, const pmFPAview *view, pmFPAfile *file)
bool pmReadoutWriteJPEG (pmReadout *readout, const pmFPAview *view, pmFPAfile *file)
pmFPAviewpmFPAviewAlloc (int nRows)
pmFPALevel pmFPAviewLevel (const pmFPAview *view)
pmChippmFPAviewThisChip (const pmFPAview *view, pmFPA *fpa)
pmChippmFPAviewNextChip (pmFPAview *view, pmFPA *fpa, int nStep)
pmCellpmFPAviewThisCell (const pmFPAview *view, pmFPA *fpa)
pmCellpmFPAviewNextCell (pmFPAview *view, pmFPA *fpa, int nStep)
pmReadoutpmFPAviewThisReadout (const pmFPAview *view, pmFPA *fpa)
pmReadoutpmFPAviewNextReadout (pmFPAview *view, pmFPA *fpa, int nStep)
pmHDUpmFPAviewThisHDU (const pmFPAview *view, pmFPA *fpa)
pmHDUpmFPAviewThisPHU (const pmFPAview *view, pmFPA *fpa)

Variables

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.
unsigned int pmFPA::conceptsRead
 Which concepts have been read.
psMetadata * pmFPA::analysis
 FPA-level analysis metadata.
const psMetadata * pmFPA::camera
 Camera configuration.
psArray * pmFPA::chips
 The chips.
pmHDUpmFPA::hdu
 FITS data.
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.
unsigned int pmChip::conceptsRead
 Which concepts have been read.
psMetadata * pmChip::analysis
 Chip-level analysis metadata.
psArray * pmChip::cells
 The cells (referred to by name).
pmFPApmChip::parent
 Parent FPA.
bool pmChip::process
 Do we bother about reading and working with this chip?
bool pmChip::file_exists
 Does the file for this chip exist (read case only)?
bool pmChip::data_exists
 Does the data for this chip exist (read case only)?
pmHDUpmChip::hdu
 FITS data.
pmCellpmChip::mosaic
 A mosaic cell.
unsigned int pmCell::conceptsRead
 Which concepts have been read.
psMetadata * pmCell::config
 Cell configuration info.
psMetadata * pmCell::analysis
 Cell-level analysis metadata.
psArray * pmCell::readouts
 The readouts (referred to by number).
pmChippmCell::parent
 Parent chip.
bool pmCell::process
 Do we bother about reading and working with this cell?
bool pmCell::file_exists
 Does the file for this cell exist (read case only)?
bool pmCell::data_exists
 Does the data for this cell exist (read case only)?
pmHDUpmCell::hdu
 FITS data.
int pmReadout::row0
 Row offset; non-zero if reading in rows bit by bit.
psImage * pmReadout::image
 Imaging area of readout.
psImage * pmReadout::mask
 Mask of input image.
psImage * pmReadout::weight
 Weight of input image.
psList * pmReadout::bias
 Overscan images.
psMetadata * pmReadout::analysis
 Readout-level analysis metadata.
pmCellpmReadout::parent
 Parent cell.
bool pmReadout::process
 Do we bother about reading and working with this readout?
bool pmReadout::file_exists
 Does the file for this readout exist (read case only)?
bool pmReadout::data_exists
 Does the data for this readout exist (read case only)?
int pmFPAview::cell
int pmFPAview::readout
int pmFPAview::nRows
int pmFPAview::iRows


Enumeration Type Documentation

enum pmFPALevel
 

Specify the level for an operation.

Enumerator:
PM_FPA_LEVEL_NONE  No particular level specified.
PM_FPA_LEVEL_FPA  Level corresponds to an FPA.
PM_FPA_LEVEL_CHIP  Level corresponds to a Chip.
PM_FPA_LEVEL_CELL  Level corresponds to a Cell.
PM_FPA_LEVEL_READOUT  Level corresponds to a Readout.

Definition at line 239 of file pmFPA.h.


Function Documentation

pmCell* pmCellAlloc pmChip chip,
const char *  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
name  Name of cell

void pmCellFreeData pmCell cell  ) 
 

void pmCellFreeReadouts pmCell cell  ) 
 

bool pmCellSetDataStatus pmCell cell,
bool  status
 

bool pmCellSetFileStatus pmCell cell,
bool  status
 

bool pmCellSetWeights pmCell cell  ) 
 

bool pmCellWriteJPEG pmCell cell,
const pmFPAview view,
pmFPAfile file
 

pmChip* pmChipAlloc pmFPA fpa,
const char *  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
Parameters:
fpa  FPA to which the chip belongs
name  Name of chip

int pmChipExcludeCell pmChip chip,
int  cellNum
 

void pmChipFreeCells pmChip chip  ) 
 

void pmChipFreeData pmChip chip  ) 
 

bool pmChipSelectCell pmChip chip,
int  cellNum,
bool  exclusive
 

bool pmChipSetDataStatus pmChip chip,
bool  status
 

bool pmChipSetFileStatus pmChip chip,
bool  status
 

bool pmChipWriteJPEG pmChip chip,
const pmFPAview view,
pmFPAfile file
 

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.

void pmFPAFreeData pmFPA fpa  ) 
 

pmFPALevel pmFPALevelFromName const char *  name  ) 
 

char* pmFPALevelToName pmFPALevel  level  ) 
 

bool pmFPASelectChip pmFPA fpa,
int  chipNum,
bool  exclusive
 

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.

bool pmFPASetDataStatus pmFPA fpa,
bool  status
 

bool pmFPASetFileStatus pmFPA fpa,
bool  status
 

pmFPAview* pmFPAviewAlloc int  nRows  ) 
 

pmFPALevel pmFPAviewLevel const pmFPAview view  ) 
 

pmCell* pmFPAviewNextCell pmFPAview view,
pmFPA fpa,
int  nStep
 

pmChip* pmFPAviewNextChip pmFPAview view,
pmFPA fpa,
int  nStep
 

pmReadout* pmFPAviewNextReadout pmFPAview view,
pmFPA fpa,
int  nStep
 

pmCell* pmFPAviewThisCell const pmFPAview view,
pmFPA fpa
 

pmChip* pmFPAviewThisChip const pmFPAview view,
pmFPA fpa
 

pmHDU* pmFPAviewThisHDU const pmFPAview view,
pmFPA fpa
 

pmHDU* pmFPAviewThisPHU const pmFPAview view,
pmFPA fpa
 

pmReadout* pmFPAviewThisReadout const pmFPAview view,
pmFPA fpa
 

bool pmFPAviewWriteJPEG const pmFPAview view,
pmFPAfile file
 

bool pmFPAWriteJPEG pmFPA fpa,
const pmFPAview view,
pmFPAfile file
 

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

void pmReadoutFreeData pmReadout readout  ) 
 

bool pmReadoutWriteJPEG pmReadout readout,
const pmFPAview view,
pmFPAfile file
 


Variable Documentation

psMetadata* pmReadout::analysis [inherited]
 

Readout-level analysis metadata.

Definition at line 143 of file pmFPA.h.

psMetadata* pmCell::analysis [inherited]
 

Cell-level analysis metadata.

Definition at line 115 of file pmFPA.h.

psMetadata* pmChip::analysis [inherited]
 

Chip-level analysis metadata.

Definition at line 90 of file pmFPA.h.

psMetadata* pmFPA::analysis [inherited]
 

FPA-level analysis metadata.

Definition at line 56 of file pmFPA.h.

psList* pmReadout::bias [inherited]
 

Overscan images.

Definition at line 142 of file pmFPA.h.

const psMetadata* pmFPA::camera [inherited]
 

Camera configuration.

Definition at line 57 of file pmFPA.h.

int pmFPAview::cell [inherited]
 

Definition at line 26 of file pmFPAview.h.

psArray* pmChip::cells [inherited]
 

The cells (referred to by name).

Definition at line 91 of file pmFPA.h.

psArray* pmFPA::chips [inherited]
 

The chips.

Definition at line 58 of file pmFPA.h.

psMetadata* pmChip::concepts [inherited]
 

Cache for PS concepts.

Definition at line 88 of file pmFPA.h.

psMetadata* pmFPA::concepts [inherited]
 

Cache for PS concepts.

Definition at line 54 of file pmFPA.h.

unsigned int pmCell::conceptsRead [inherited]
 

Which concepts have been read.

Definition at line 113 of file pmFPA.h.

unsigned int pmChip::conceptsRead [inherited]
 

Which concepts have been read.

Definition at line 89 of file pmFPA.h.

unsigned int pmFPA::conceptsRead [inherited]
 

Which concepts have been read.

Definition at line 55 of file pmFPA.h.

psMetadata* pmCell::config [inherited]
 

Cell configuration info.

Definition at line 114 of file pmFPA.h.

bool pmReadout::data_exists [inherited]
 

Does the data for this readout exist (read case only)?

Definition at line 147 of file pmFPA.h.

bool pmCell::data_exists [inherited]
 

Does the data for this cell exist (read case only)?

Definition at line 120 of file pmFPA.h.

bool pmChip::data_exists [inherited]
 

Does the data for this chip exist (read case only)?

Definition at line 95 of file pmFPA.h.

bool pmReadout::file_exists [inherited]
 

Does the file for this readout exist (read case only)?

Definition at line 146 of file pmFPA.h.

bool pmCell::file_exists [inherited]
 

Does the file for this cell exist (read case only)?

Definition at line 119 of file pmFPA.h.

bool pmChip::file_exists [inherited]
 

Does the file for this chip exist (read case only)?

Definition at line 94 of file pmFPA.h.

psPlaneTransform* pmChip::fromFPA [inherited]
 

Transformation from FPA to chip coordinates.

Definition at line 85 of file pmFPA.h.

pmHDU* pmCell::hdu [inherited]
 

FITS data.

Definition at line 121 of file pmFPA.h.

pmHDU* pmChip::hdu [inherited]
 

FITS data.

Definition at line 96 of file pmFPA.h.

pmHDU* pmFPA::hdu [inherited]
 

FITS data.

Definition at line 59 of file pmFPA.h.

psImage* pmReadout::image [inherited]
 

Imaging area of readout.

Definition at line 139 of file pmFPA.h.

int pmFPAview::iRows [inherited]
 

Definition at line 29 of file pmFPAview.h.

psImage* pmReadout::mask [inherited]
 

Mask of input image.

Definition at line 140 of file pmFPA.h.

struct pmCell* pmChip::mosaic [inherited]
 

A mosaic cell.

Definition at line 97 of file pmFPA.h.

int pmFPAview::nRows [inherited]
 

Definition at line 28 of file pmFPAview.h.

pmCell* pmReadout::parent [inherited]
 

Parent cell.

Definition at line 144 of file pmFPA.h.

pmChip* pmCell::parent [inherited]
 

Parent chip.

Definition at line 117 of file pmFPA.h.

pmFPA* pmChip::parent [inherited]
 

Parent FPA.

Definition at line 92 of file pmFPA.h.

bool pmReadout::process [inherited]
 

Do we bother about reading and working with this readout?

Definition at line 145 of file pmFPA.h.

bool pmCell::process [inherited]
 

Do we bother about reading and working with this cell?

Definition at line 118 of file pmFPA.h.

bool pmChip::process [inherited]
 

Do we bother about reading and working with this chip?

Definition at line 93 of file pmFPA.h.

psProjection* pmFPA::projection [inherited]
 

Projection from tangent plane to sky.

Definition at line 51 of file pmFPA.h.

int pmFPAview::readout [inherited]
 

Definition at line 27 of file pmFPAview.h.

psArray* pmCell::readouts [inherited]
 

The readouts (referred to by number).

Definition at line 116 of file pmFPA.h.

int pmReadout::row0 [inherited]
 

Row offset; non-zero if reading in rows bit by bit.

Definition at line 138 of file pmFPA.h.

int pmChip::row0 [inherited]
 

Offset from the bottom of FPA.

Definition at line 82 of file pmFPA.h.

psPlaneTransform* pmChip::toFPA [inherited]
 

Transformation from chip to FPA coordinates.

Definition at line 84 of file pmFPA.h.

psPlaneDistort* pmFPA::toTangentPlane [inherited]
 

Transformation from focal plane to tangent plane.

Definition at line 50 of file pmFPA.h.

psImage* pmReadout::weight [inherited]
 

Weight of input image.

Definition at line 141 of file pmFPA.h.


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