int ardlib_initialize (char *mission, char *obsinfo_file);
-1 upon error.
The library may be used for only one mission at a time. To use it
with another mission within the same program instance, close the
library with the ardlib_finalize function and then re-open it
with the specified mission.
Supported missions include: "CHANDRA".
int ardlib_finalize (void);
-1, otherwise it returns 0.
Ardlib_Det_QE_Type *ardlib_open_det_qe (char *detsubsys);
NULL upon failure. The ardlib_close_det_qe function
must be used to delete the returned object.
int ardlib_close_det_qe (Ardlib_Det_QE_Type *q);
Ardlib_Det_QE_Type
object. If for some reason this function fails, -1 will be
returned, otherwise it returns 0.
int ardlib_compute_det_qe (Ardlib_Det_QE_Type *q,
double x, double y,
float *energies, unsigned int num,
float *qes);
x,y) for the list of num energies and returns
the results via the last parameter (qes), which is assumed to
point to num floats. The function returns 0 upon success, or
-1 upon error.
Ardlib_Mirror_EA_Type *ardlib_open_mirror_ea (char *mirror);
0 upon success, or -1 otherwise.
int ardlib_close_mirror_ea (Ardlib_Mirror_EA_Type *);
-1 will be returned, otherwise it will return 0.
int ardlib_compute_mirror_ea (Ardlib_Mirror_EA_Type *object,
double theta, double phi,
float *energies,
unsigned int num_energies,
float *eff_areas);
theta and azimuthal angle
phi. The function returns 0 upon success, or -1 otherwise.
Ardlib_Grating_Eff_Type *
ardlib_open_grating_eff (char *grating, int order);
NULL will be returned. After the pointer is no
longer needed, it must be freed via a call to
ardlib_close_grating_eff.
int ardlib_close_grating_eff (Ardlib_Grating_Eff_Type *g);
-1 will be
returned, otherwise 0 will be returned.
int ardlib_compute_grating_eff (Ardlib_Grating_Eff_Type *g,
float *energies,
unsigned int num,
float *eff);
num grating efficiencies for the
grating object g and energy list energies. The
efficiencies are returned via the pointer eff, which is
assumed to contain enough space for num values.
Upon success, 0 will be returned, otherwise -1 will be returned to
indicate an error.
Ardlib_Det_BadPix_Type *ardlib_open_det_badpix (char *det);
NULL. When the pointer is no longer
needed, it should be freed via the ardlib_close_det_badpix
function.
int ardlib_close_det_badpix (Ardlib_Det_BadPix_Type *b);
int ardlib_det_is_badpix (Ardlib_Det_BadPix_Type *b,
double x, double y);
b contains a bad-pixel
at (x, y). It returns 1 is the pixel is bad, 0 if
good, or -1 if an error occurs.
int Ardlib_Version;
char *ardlib_get_version_string (void);
int ardlib_set_parfile (char *file);
ardlib_initialize function. It returns 0 upon success, or -1
upon failure.
int ardlib_set_verbosity (int verbose);
int ardlib_is_option_present (char *instrum,
char *qualifier_name,
char **valuep);
0 if the
qualifier is not present. If an error occurs, the function will
return -1. If the pointer valuep is non-NULL and the
specified qualifier exists, then the qualifier's value will be
returned via valuep. It is up to the caller to free this
pointer.
int ardlib_write_history (int (*callback)(void *, char *),
void *client_data);
0 upon success, or -1
upon error. The callback function is passed client_data as
its first argument and an ardlib history record as is second. The
callback function is assumed to return 0 if successful, or
-1 upon failure. If callback is NULL, then the history
records will be written to a file represented by
(FILE*)client_data. If in addition client_data is
NULL, the history will be written to stdout.
As an example of the use of the ardlib_write_history function,
suppose that one simply wants to write the history to a fits file
represented by a dmBlock pointer. The following code fragment
illustrates how this may be accomplished:
static int dmblock_callback (void *b, char *str)
{
if (0 == dmBlockWriteComment ((dmBlock *) b, dmHISTORY, str))
return -1;
return 0;
}
int main (int argc, char **argv)
{
dmBlock *b;
.
.
(void) ardlib_write_history (dmblock_callback, (void *) b);
.
.
}