HAWKI Pipeline Reference Manual 1.8.12
Functions
Saving related functions

Functions

int hawki_distortion_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const hawki_distortion **distortion, const char *recipe, const cpl_propertylist *applist, const cpl_propertylist **applists, const char *filename_x, const char *filename_y)
 Save a HAWKI_NB_DETECTORS extensions HAWKI distortion images.
const char * hawki_get_extref_file (const cpl_frameset *frameset)
 Locate a filename where the extension <--> chip id relation can be derived.
int hawki_image_ext_save (const cpl_frameset *allframes, const cpl_image *image, int iext, const cpl_propertylist *ext_prop_list, const char *filename)
 Save an image into a given extension.
int hawki_imagelist_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_imagelist *images, const char *recipe, const char *procat, const char *protype, const cpl_propertylist *applist, const cpl_propertylist **applists, const char *filename)
 Save a HAWKI_NB_DETECTORS extensions HAWKI image.
int hawki_images_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_image **images, const char *recipe, const char *procat, const char *protype, const cpl_propertylist *applist, const cpl_propertylist **applists, const char *filename)
 Save a HAWKI_NB_DETECTORS extensions HAWKI image.
int hawki_main_header_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const char *recipe, const char *procat, const char *protype, const cpl_propertylist *applist, const char *filename)
 Save a main header and prepare it to store additional data units later on.
int hawki_tables_save (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_table **tables, const char *recipe, const char *procat, const char *protype, const cpl_propertylist *applist, const cpl_propertylist **applists, const char *filename)
 Save a HAWKI_NB_DETECTORS extensions HAWKI table.

Function Documentation

int hawki_distortion_save ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const hawki_distortion **  distortion,
const char *  recipe,
const cpl_propertylist *  applist,
const cpl_propertylist **  applists,
const char *  filename_x,
const char *  filename_y 
)

Save a HAWKI_NB_DETECTORS extensions HAWKI distortion images.

Parameters:
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
distortionThe distortion to save
recipeThe recipe name
procatThe product category tag
protypeThe product type tag
applistOptional propertylist to append to primary header or NULL
applistsOptional propertylists to append to ext headers or NULL
pipe_idPACKAGE "/" PACKAGE_VERSION
filename_xFilename for distortion image in X
filename_yFilename for distortion image in Y
Returns:
0 if ok, -1 in error case

This function allows to store images of different sizes in the extensions

Definition at line 514 of file hawki_save.c.

References hawki_get_detector_from_ext(), and hawki_get_extref_file().

const char* hawki_get_extref_file ( const cpl_frameset *  frameset)

Locate a filename where the extension <--> chip id relation can be derived.

Parameters:
framesetA frameset where a suitable frame can be extracted.
Returns:
The filename if ok. NULL otherwise

This function will get the first frame with four extensions that is part of the RAW group.

Definition at line 656 of file hawki_save.c.

Referenced by hawki_distortion_save(), hawki_image_ext_save(), hawki_imagelist_save(), hawki_images_save(), and hawki_tables_save().

int hawki_image_ext_save ( const cpl_frameset *  allframes,
const cpl_image *  image,
int  iext,
const cpl_propertylist *  ext_prop_list,
const char *  filename 
)

Save an image into a given extension.

Returns:
1 if ok. -1 otherwise

Extension iext means the main extension. For HAWK-I, iext should run from 1 to HAWKI_NB_DETECTORS

Definition at line 227 of file hawki_save.c.

References hawki_get_detector_from_ext(), and hawki_get_extref_file().

int hawki_imagelist_save ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_imagelist *  images,
const char *  recipe,
const char *  procat,
const char *  protype,
const cpl_propertylist *  applist,
const cpl_propertylist **  applists,
const char *  filename 
)

Save a HAWKI_NB_DETECTORS extensions HAWKI image.

Parameters:
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
imagesThe image list to be saved
recipeThe recipe name
procatThe product category tag
protypeThe product type tag
applistOptional propertylist to append to primary header or NULL
applistsOptional propertylists to append to ext headers or NULL
pipe_idPACKAGE "/" PACKAGE_VERSION
filenameFilename
Returns:
0 if ok, -1 in error case

Definition at line 72 of file hawki_save.c.

References hawki_get_detector_from_ext(), and hawki_get_extref_file().

int hawki_images_save ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_image **  images,
const char *  recipe,
const char *  procat,
const char *  protype,
const cpl_propertylist *  applist,
const cpl_propertylist **  applists,
const char *  filename 
)

Save a HAWKI_NB_DETECTORS extensions HAWKI image.

Parameters:
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
imagesThe images to be saved
recipeThe recipe name
procatThe product category tag
protypeThe product type tag
applistOptional propertylist to append to primary header or NULL
applistsOptional propertylists to append to ext headers or NULL
pipe_idPACKAGE "/" PACKAGE_VERSION
filenameFilename
Returns:
0 if ok, -1 in error case

This function allows to store images of different sizes in the extensions

Definition at line 302 of file hawki_save.c.

References hawki_get_detector_from_ext(), and hawki_get_extref_file().

int hawki_main_header_save ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const char *  recipe,
const char *  procat,
const char *  protype,
const cpl_propertylist *  applist,
const char *  filename 
)

Save a main header and prepare it to store additional data units later on.

Parameters:
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
imagesThe image list to be saved
recipeThe recipe name
procatThe product category tag
protypeThe product type tag
applistOptional propertylist to append to primary header or NULL
pipe_idPACKAGE "/" PACKAGE_VERSION
filenameFilename
Returns:
0 if ok, -1 in error case

Definition at line 178 of file hawki_save.c.

int hawki_tables_save ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_table **  tables,
const char *  recipe,
const char *  procat,
const char *  protype,
const cpl_propertylist *  applist,
const cpl_propertylist **  applists,
const char *  filename 
)

Save a HAWKI_NB_DETECTORS extensions HAWKI table.

Parameters:
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
tablesThe table list to be saved
recipeThe recipe name
procatThe product category tag
protypeThe product type tag
applistOptional propertylist to append to primary header or NULL
applistsOptional propertylists to append to ext headers or NULL
pipe_idPACKAGE "/" PACKAGE_VERSION
filenameFilename
Returns:
0 if ok, -1 in error case

Definition at line 406 of file hawki_save.c.

References hawki_get_detector_from_ext(), and hawki_get_extref_file().