Defines | |
#define | CPL_DFS_PRO_CATG "ESO PRO CATG" |
The name of the Product Category key. | |
#define | CPL_DFS_PRO_SCIENCE "ESO PRO SCIENCE" |
The name of the Product Science key. | |
#define | CPL_DFS_PRO_TECH "ESO PRO TECH" |
The name of the Product Tech key. | |
#define | CPL_DFS_PRO_TYPE "ESO PRO TYPE" |
The name of the Product Type key. | |
Functions | |
cpl_error_code | cpl_dfs_save_image (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const cpl_image *image, cpl_type_bpp bpp, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename) |
Save an image as a DFS-compliant pipeline product. | |
cpl_error_code | cpl_dfs_save_imagelist (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const cpl_imagelist *imagelist, cpl_type_bpp bpp, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename) |
Save an imagelist as a DFS-compliant pipeline product. | |
cpl_error_code | cpl_dfs_save_paf (const char *instrume, const char *recipe, const cpl_propertylist *paflist, const char *filename) |
Create a new PAF file. | |
cpl_error_code | cpl_dfs_save_propertylist (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename) |
Save a propertylist as a DFS-compliant pipeline product. | |
cpl_error_code | cpl_dfs_save_table (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const cpl_table *table, const cpl_propertylist *tablelist, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *pipe_id, const char *filename) |
Save a table as a DFS-compliant pipeline product. | |
cpl_error_code | cpl_dfs_setup_product_header (cpl_propertylist *header, const cpl_frame *product_frame, const cpl_frameset *framelist, const cpl_parameterlist *parlist, const char *recid, const char *pipeline_id, const char *dictionary_id, const cpl_frame *inherit_frame) |
Add product keywords to a pipeline product property list. | |
cpl_error_code | cpl_dfs_update_product_header (cpl_frameset *self) |
Perform any DFS-compliancy required actions (DATAMD5/PIPEFILE update). |
#define CPL_DFS_PRO_CATG "ESO PRO CATG" |
The name of the Product Category key.
#define CPL_DFS_PRO_SCIENCE "ESO PRO SCIENCE" |
The name of the Product Science key.
#define CPL_DFS_PRO_TECH "ESO PRO TECH" |
The name of the Product Tech key.
#define CPL_DFS_PRO_TYPE "ESO PRO TYPE" |
The name of the Product Type key.
cpl_error_code cpl_dfs_save_image | ( | cpl_frameset * | allframes, | |
cpl_propertylist * | header, | |||
const cpl_parameterlist * | parlist, | |||
const cpl_frameset * | usedframes, | |||
const cpl_frame * | inherit, | |||
const cpl_image * | image, | |||
cpl_type_bpp | bpp, | |||
const char * | recipe, | |||
const cpl_propertylist * | applist, | |||
const char * | remregexp, | |||
const char * | pipe_id, | |||
const char * | filename | |||
) |
Save an image as a DFS-compliant pipeline product.
allframes | The list of input frames for the recipe | |
header | NULL, or filled with properties written to product header | |
parlist | The list of input parameters | |
usedframes | The list of raw/calibration frames used for this product | |
inherit | NULL or product frames inherit their header from this frame | |
image | The image to be saved | |
bpp | Bits per pixel | |
recipe | The recipe name | |
applist | Propertylist to append to primary header, w. PRO.CATG | |
remregexp | Optional regexp of properties not to put in main header | |
pipe_id | PACKAGE "/" PACKAGE_VERSION | |
filename | Filename of created product |
remregexp may be NULL
applist must contain a string-property with key CPL_DFS_PRO_CATG
On success and iff header is non-NULL, it will be emptied and then filled with the properties written to the primary header of the product
cpl_error_code cpl_dfs_save_imagelist | ( | cpl_frameset * | allframes, | |
cpl_propertylist * | header, | |||
const cpl_parameterlist * | parlist, | |||
const cpl_frameset * | usedframes, | |||
const cpl_frame * | inherit, | |||
const cpl_imagelist * | imagelist, | |||
cpl_type_bpp | bpp, | |||
const char * | recipe, | |||
const cpl_propertylist * | applist, | |||
const char * | remregexp, | |||
const char * | pipe_id, | |||
const char * | filename | |||
) |
Save an imagelist as a DFS-compliant pipeline product.
allframes | The list of input frames for the recipe | |
header | NULL, or filled with properties written to product header | |
parlist | The list of input parameters | |
usedframes | The list of raw/calibration frames used for this product | |
imagelist | The imagelist to be saved | |
bpp | Bits per pixel | |
recipe | The recipe name | |
applist | Optional propertylist to append to primary header or NULL | |
remregexp | Optional regexp of properties not to put in main header | |
pipe_id | PACKAGE "/" PACKAGE_VERSION | |
filename | Filename of created product |
cpl_error_code cpl_dfs_save_paf | ( | const char * | instrume, | |
const char * | recipe, | |||
const cpl_propertylist * | paflist, | |||
const char * | filename | |||
) |
Create a new PAF file.
instrume | Name of instrument in capitals (NACO, VISIR, etc.) | |
recipe | Name of recipe | |
paflist | Propertylist to save | |
filename | Filename of created PArameter File |
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); cpl_dfs_save_paf("IIINSTRUMENT", "rrrecipe", paflist, "rrrecipe.paf"); cpl_propertylist_delete(paflist);
cpl_error_code cpl_dfs_save_propertylist | ( | cpl_frameset * | allframes, | |
cpl_propertylist * | header, | |||
const cpl_parameterlist * | parlist, | |||
const cpl_frameset * | usedframes, | |||
const cpl_frame * | inherit, | |||
const char * | recipe, | |||
const cpl_propertylist * | applist, | |||
const char * | remregexp, | |||
const char * | pipe_id, | |||
const char * | filename | |||
) |
Save a propertylist as a DFS-compliant pipeline product.
allframes | The list of input frames for the recipe | |
header | NULL, or filled with properties written to product header | |
parlist | The list of input parameters | |
usedframes | The list of raw/calibration frames used for this product | |
recipe | The recipe name | |
applist | Optional propertylist to append to primary header or NULL | |
remregexp | Optional regexp of properties not to put in main header | |
pipe_id | PACKAGE "/" PACKAGE_VERSION | |
filename | Filename of created product |
The FITS data unit will be empty.
cpl_error_code cpl_dfs_save_table | ( | cpl_frameset * | allframes, | |
cpl_propertylist * | header, | |||
const cpl_parameterlist * | parlist, | |||
const cpl_frameset * | usedframes, | |||
const cpl_frame * | inherit, | |||
const cpl_table * | table, | |||
const cpl_propertylist * | tablelist, | |||
const char * | recipe, | |||
const cpl_propertylist * | applist, | |||
const char * | remregexp, | |||
const char * | pipe_id, | |||
const char * | filename | |||
) |
Save a table as a DFS-compliant pipeline product.
allframes | The list of input frames for the recipe | |
header | NULL, or filled with properties written to product header | |
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 use in table extension or NULL | |
recipe | The recipe name | |
applist | Optional propertylist to append to primary header or NULL | |
remregexp | Optional regexp of properties not to put in main header | |
pipe_id | PACKAGE "/" PACKAGE_VERSION | |
filename | Filename of created product |
cpl_error_code cpl_dfs_setup_product_header | ( | cpl_propertylist * | header, | |
const cpl_frame * | product_frame, | |||
const cpl_frameset * | framelist, | |||
const cpl_parameterlist * | parlist, | |||
const char * | recid, | |||
const char * | pipeline_id, | |||
const char * | dictionary_id, | |||
const cpl_frame * | inherit_frame | |||
) |
Add product keywords to a pipeline product property list.
header | Property list where keywords must be written | |
product_frame | Frame describing the product | |
framelist | List of frames including all input frames | |
parlist | Recipe parameter list | |
recid | Recipe name | |
pipeline_id | Pipeline unique identifier | |
dictionary_id | PRO dictionary identifier | |
inherit_frame | Frame from which header information is inherited |
CPL_ERROR_NONE
on success.CPL_ERROR_NULL_INPUT | An input pointer is NULL . |
CPL_ERROR_DATA_NOT_FOUND | The input framelist contains no input frames or a frame in the input framelist does not specify a file. In the former case the string "set-of-frames" would be appended to the error message returned by cpl_error_get_message(). |
CPL_ERROR_ILLEGAL_INPUT | The product frame is not tagged or not grouped as CPL_FRAME_GROUP_PRODUCT . |
CPL_ERROR_FILE_NOT_FOUND | A frame in the input framelist specifies a non-existing file. |
CPL_ERROR_BAD_FILE_FORMAT | A frame in the input framelist specifies an invalid file. |
This function checks the header associated to a pipeline product, to ensure that it is DICB compliant. In particular, this function does the following:
See the DICB PRO dictionary to have details on the mentioned PRO keywords.
cpl_error_code cpl_dfs_update_product_header | ( | cpl_frameset * | self | ) |
Perform any DFS-compliancy required actions (DATAMD5/PIPEFILE update).
self | The list of frames with FITS products created by the recipe |
CPL_ERROR_NULL_INPUT | An input pointer is NULL . |
CPL_ERROR_DATA_NOT_FOUND | The input framelist contains a frame of type product with a missing filename. |
CPL_ERROR_BAD_FILE_FORMAT | The input framelist contains a frame of type product without a FITS card with key 'DATAMD5'. |
CPL_ERROR_FILE_IO | The input framelist contains a frame of type product for which the FITS card with key 'DATAMD5' could not be updated. |