DFS related functions


Functions

cpl_error_code irplib_image_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_image *image, cpl_type_bpp bpp, const char *recipe, const char *procat, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename)
 Save an image as a pipeline product.
cpl_error_code irplib_table_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_table *table, const cpl_propertylist *tablelist, const char *recipe, const char *procat, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename)
 Save a table as a pipeline product.
cpl_error_code irplib_paf_save (const char *instrume, const char *recipe, const cpl_propertylist *paflist, const char *filename)
 Create a new PAF file.

Function Documentation

cpl_error_code irplib_image_save cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_image *  image,
cpl_type_bpp  bpp,
const char *  recipe,
const char *  procat,
const cpl_propertylist *  applist,
const char *  remregexp,
const char *  pipe_id,
const char *  filename
 

Save an image as a pipeline product.

Parameters:
allframes The list of input frames for the recipe
parlist The list of input parameters
usedframes The list of raw/calibration frames used for this product
image The image to be saved or NULL
bpp Bits per pixel
recipe The recipe name
procat The product category tag
applist Optional propertylist to append to product or NULL
remregexp Optional regexp of properties not to put in main header
pipe_id PACKAGE "/" PACKAGE_VERSION
filename Filename of created product
Note:
The image may be NULL in which case only the header information is saved

remregexp may be NULL

Returns:
CPL_ERROR_NONE or the relevant CPL error code on error

Definition at line 193 of file irplib_dfs.c.

cpl_error_code irplib_paf_save const char *  instrume,
const char *  recipe,
const cpl_propertylist *  paflist,
const char *  filename
 

Create a new PAF file.

Parameters:
instrume Name of instrument in capitals (NACO, VISIR, etc.)
recipe Name of recipe
paflist Propertylist to save
filename Filename of created PArameter File
Returns:
CPL_ERROR_NONE or the relevant CPL error code on error
See also:
irplib_image_save().
The example below shows how to create a PAF from some FITS cards from the file ref_file and QC parameters in a propertylist qclist. Please note that qclist can be used also in calls to irplib_image_save() and irplib_table_save(). Error handling is omitted for brevity:

   const char pafcopy[] = "^(DATE-OBS|ARCFILE|ESO TPL ID|ESO DET DIT|MJD-OBS)$";
   cpl_propertylist * paflist = cpl_propertylist_load_regexp(ref_file, 0,
                                                             pafcopy, 0);

   cpl_propertylist_append(paflist, qclist);

   irplib_paf_save("IIINSTRUMENT", "rrrecipe", paflist, "rrrecipe");

   cpl_propertylist_delete(paflist);

Definition at line 294 of file irplib_dfs.c.

cpl_error_code irplib_table_save cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_table *  table,
const cpl_propertylist *  tablelist,
const char *  recipe,
const char *  procat,
const cpl_propertylist *  applist,
const char *  remregexp,
const char *  pipe_id,
const char *  filename
 

Save a table as a pipeline product.

Parameters:
allframes The list of input frames for the recipe
parlist The list of input parameters
usedframes The list of raw/calibration frames used for this product
table The table to be saved
tablelist Optional propertylist to append to table extension or NULL
recipe The recipe name
procat The product category tag
applist Optional propertylist to append to product or NULL
remregexp Optional regexp of properties not to put in main header
pipe_id PACKAGE "/" PACKAGE_VERSION
filename Filename of created product
Returns:
CPL_ERROR_NONE or the relevant CPL error code on error
See also:
irplib_image_save().

Definition at line 236 of file irplib_dfs.c.


Generated on Wed Jan 17 08:33:45 2007 for SINFONI Pipeline Reference Manual by  doxygen 1.4.4