/usr/share/doc/libcpl-doc/html/group__cpl__dfs.html is in libcpl-doc 5.3.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Common Pipeline Library Reference Manual: DFS related functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Common Pipeline Library Reference Manual
 <span id="projectnumber">5.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DFS related functions</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga4552e433babd9d05002a271254bb21e4">CPL_DFS_PRO_CATG</a>   "ESO PRO CATG"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the Product Category key. <a href="#ga4552e433babd9d05002a271254bb21e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#gad60331be899db8f601edfbd554a29372">CPL_DFS_PRO_SCIENCE</a>   "ESO PRO SCIENCE"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the Product Science key. <a href="#gad60331be899db8f601edfbd554a29372"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga40d1927c8f109dad33dd4106b0aa3162">CPL_DFS_PRO_TECH</a>   "ESO PRO TECH"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the Product Tech key. <a href="#ga40d1927c8f109dad33dd4106b0aa3162"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#gaa10eaf25bc756a8ca647b6329bc28831">CPL_DFS_PRO_TYPE</a>   "ESO PRO TYPE"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the Product Type key. <a href="#gaa10eaf25bc756a8ca647b6329bc28831"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#gaf3f075cbadf59d3c6596df35a783f41e">cpl_dfs_save_imagelist</a> (<a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *allframes, <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *header, const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> *parlist, const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *usedframes, const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *inherit, const cpl_imagelist *imagelist, <a class="el" href="group__cpl__io.html#ga2c21b80b61e0c7fc7799c6cc61b170ba">cpl_type_bpp</a> bpp, const char *recipe, const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *applist, const char *remregexp, const char *pipe_id, const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save an imagelist as a DFS-compliant pipeline product. <a href="#gaf3f075cbadf59d3c6596df35a783f41e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga9ff70ecb81f021929b2d9ad0f62b7fa3">cpl_dfs_save_paf</a> (const char *instrume, const char *recipe, const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *paflist, const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new PAF file. <a href="#ga9ff70ecb81f021929b2d9ad0f62b7fa3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga80f700d2f28b4e02f49a52aa4551566c">cpl_dfs_save_propertylist</a> (<a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *allframes, <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *header, const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> *parlist, const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *usedframes, const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *inherit, const char *recipe, const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *applist, const char *remregexp, const char *pipe_id, const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a propertylist as a DFS-compliant pipeline product. <a href="#ga80f700d2f28b4e02f49a52aa4551566c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#gaac1a9db0bc2f92fd912192c696b0637d">cpl_dfs_save_table</a> (<a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *allframes, <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *header, const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> *parlist, const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *usedframes, const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *inherit, const cpl_table *table, const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *tablelist, const char *recipe, const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *applist, const char *remregexp, const char *pipe_id, const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a table as a DFS-compliant pipeline product. <a href="#gaac1a9db0bc2f92fd912192c696b0637d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga5945764c09e904efe5cc15172ed36fb3">cpl_dfs_setup_product_header</a> (<a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> *header, const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *product_frame, const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *framelist, const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> *parlist, const char *recid, const char *pipeline_id, const char *dictionary_id, const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *inherit_frame)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add product keywords to a pipeline product property list. <a href="#ga5945764c09e904efe5cc15172ed36fb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__dfs.html#ga8d813636e3822382fab1d165ee035d4d">cpl_dfs_update_product_header</a> (<a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform any DFS-compliancy required actions (DATAMD5/PIPEFILE update) <a href="#ga8d813636e3822382fab1d165ee035d4d"></a><br/></td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga4552e433babd9d05002a271254bb21e4"></a><!-- doxytag: member="cpl_dfs.h::CPL_DFS_PRO_CATG" ref="ga4552e433babd9d05002a271254bb21e4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__dfs.html#ga4552e433babd9d05002a271254bb21e4">CPL_DFS_PRO_CATG</a>   "ESO PRO CATG"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the Product Category key. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image() </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>A pipeline product must contain a string property with this name </dd></dl>
</div>
</div>
<a class="anchor" id="gad60331be899db8f601edfbd554a29372"></a><!-- doxytag: member="cpl_dfs.h::CPL_DFS_PRO_SCIENCE" ref="gad60331be899db8f601edfbd554a29372" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__dfs.html#gad60331be899db8f601edfbd554a29372">CPL_DFS_PRO_SCIENCE</a>   "ESO PRO SCIENCE"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the Product Science key. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image() </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>A pipeline product should contain a boolean property with this name </dd></dl>
</div>
</div>
<a class="anchor" id="ga40d1927c8f109dad33dd4106b0aa3162"></a><!-- doxytag: member="cpl_dfs.h::CPL_DFS_PRO_TECH" ref="ga40d1927c8f109dad33dd4106b0aa3162" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__dfs.html#ga40d1927c8f109dad33dd4106b0aa3162">CPL_DFS_PRO_TECH</a>   "ESO PRO TECH"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the Product Tech key. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image() </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>A pipeline product should contain a string property with this name </dd></dl>
</div>
</div>
<a class="anchor" id="gaa10eaf25bc756a8ca647b6329bc28831"></a><!-- doxytag: member="cpl_dfs.h::CPL_DFS_PRO_TYPE" ref="gaa10eaf25bc756a8ca647b6329bc28831" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__dfs.html#gaa10eaf25bc756a8ca647b6329bc28831">CPL_DFS_PRO_TYPE</a>   "ESO PRO TYPE"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the Product Type key. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image() </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>A pipeline product should contain a string property with this name </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaf3f075cbadf59d3c6596df35a783f41e"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_save_imagelist" ref="gaf3f075cbadf59d3c6596df35a783f41e" args="(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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#gaf3f075cbadf59d3c6596df35a783f41e">cpl_dfs_save_imagelist</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>allframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>header</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> * </td>
<td class="paramname"><em>parlist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>usedframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>inherit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const cpl_imagelist * </td>
<td class="paramname"><em>imagelist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__io.html#ga2c21b80b61e0c7fc7799c6cc61b170ba">cpl_type_bpp</a> </td>
<td class="paramname"><em>bpp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>recipe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>applist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>remregexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pipe_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save an imagelist as a DFS-compliant pipeline product. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">allframes</td><td>The list of input frames for the recipe </td></tr>
<tr><td class="paramname">header</td><td>NULL, or filled with properties written to product header </td></tr>
<tr><td class="paramname">parlist</td><td>The list of input parameters </td></tr>
<tr><td class="paramname">usedframes</td><td>The list of raw/calibration frames used for this product </td></tr>
<tr><td class="paramname">inherit</td><td>NULL or product frames inherit their header from this frame </td></tr>
<tr><td class="paramname">imagelist</td><td>The imagelist to be saved </td></tr>
<tr><td class="paramname">bpp</td><td>Bits per pixel </td></tr>
<tr><td class="paramname">recipe</td><td>The recipe name </td></tr>
<tr><td class="paramname">applist</td><td>Optional propertylist to append to primary header or NULL </td></tr>
<tr><td class="paramname">remregexp</td><td>Optional regexp of properties not to put in main header </td></tr>
<tr><td class="paramname">pipe_id</td><td>PACKAGE "/" PACKAGE_VERSION </td></tr>
<tr><td class="paramname">filename</td><td>Filename of created product </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>remregexp may be NULL </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPL_ERROR_NONE or the relevant CPL error code on error </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_image_save(), cpl_imagelist_save(). </dd></dl>
</div>
</div>
<a class="anchor" id="ga9ff70ecb81f021929b2d9ad0f62b7fa3"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_save_paf" ref="ga9ff70ecb81f021929b2d9ad0f62b7fa3" args="(const char *instrume, const char *recipe, const cpl_propertylist *paflist, const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#ga9ff70ecb81f021929b2d9ad0f62b7fa3">cpl_dfs_save_paf</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>instrume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>recipe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>paflist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new PAF file. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">instrume</td><td>Name of instrument in capitals (NACO, VISIR, etc.) </td></tr>
<tr><td class="paramname">recipe</td><td>Name of recipe </td></tr>
<tr><td class="paramname">paflist</td><td>Propertylist to save </td></tr>
<tr><td class="paramname">filename</td><td>Filename of created PArameter File </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPL_ERROR_NONE or the relevant CPL error code on error </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image().</dd></dl>
<p>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 cpl_dfs_save_image() and <a class="el" href="group__cpl__dfs.html#gaac1a9db0bc2f92fd912192c696b0637d" title="Save a table as a DFS-compliant pipeline product.">cpl_dfs_save_table()</a>. Error handling is omitted for brevity:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">const</span> <span class="keywordtype">char</span> pafcopy[] = <span class="stringliteral">"^(DATE-OBS|ARCFILE|ESO TPL ID|ESO DET DIT|MJD-OBS)$"</span>;
<a class="code" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab" title="The opaque property list data type.">cpl_propertylist</a> * paflist = <a class="code" href="group__cpl__propertylist.html#ga5c4db6b7ef4694e8a94f30de72213048" title="Create a filtered property list from a file.">cpl_propertylist_load_regexp</a>(ref_file, 0,
pafcopy, 0);
<a class="code" href="group__cpl__propertylist.html#ga3ebb6f76a2230db7122272bef044d4d8" title="Append a property list..">cpl_propertylist_append</a>(paflist, qclist);
<a class="code" href="group__cpl__dfs.html#ga9ff70ecb81f021929b2d9ad0f62b7fa3" title="Create a new PAF file.">cpl_dfs_save_paf</a>(<span class="stringliteral">"IIINSTRUMENT"</span>, <span class="stringliteral">"rrrecipe"</span>, paflist, <span class="stringliteral">"rrrecipe.paf"</span>);
<a class="code" href="group__cpl__propertylist.html#gae02f740d29133f8ecd419cf2f4e31efe" title="Destroy a property list.">cpl_propertylist_delete</a>(paflist);
</pre></div>
</div>
</div>
<a class="anchor" id="ga80f700d2f28b4e02f49a52aa4551566c"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_save_propertylist" ref="ga80f700d2f28b4e02f49a52aa4551566c" args="(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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#ga80f700d2f28b4e02f49a52aa4551566c">cpl_dfs_save_propertylist</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>allframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>header</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> * </td>
<td class="paramname"><em>parlist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>usedframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>inherit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>recipe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>applist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>remregexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pipe_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save a propertylist as a DFS-compliant pipeline product. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">allframes</td><td>The list of input frames for the recipe </td></tr>
<tr><td class="paramname">header</td><td>NULL, or filled with properties written to product header </td></tr>
<tr><td class="paramname">parlist</td><td>The list of input parameters </td></tr>
<tr><td class="paramname">usedframes</td><td>The list of raw/calibration frames used for this product </td></tr>
<tr><td class="paramname">inherit</td><td>NULL or product frames inherit their header from this frame </td></tr>
<tr><td class="paramname">recipe</td><td>The recipe name </td></tr>
<tr><td class="paramname">applist</td><td>Optional propertylist to append to primary header or NULL </td></tr>
<tr><td class="paramname">remregexp</td><td>Optional regexp of properties not to put in main header </td></tr>
<tr><td class="paramname">pipe_id</td><td>PACKAGE "/" PACKAGE_VERSION </td></tr>
<tr><td class="paramname">filename</td><td>Filename of created product </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>remregexp may be NULL </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPL_ERROR_NONE or the relevant CPL error code on error </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_image_save(), cpl_propertylistlist_save().</dd></dl>
<p>The FITS header of the created product is created from the provided applist and the cards copied by <a class="el" href="group__cpl__dfs.html#ga5945764c09e904efe5cc15172ed36fb3" title="Add product keywords to a pipeline product property list.">cpl_dfs_setup_product_header()</a>, with exception of the cards whose keys match the provided remregexp.</p>
<p>The FITS data unit will be empty. </p>
</div>
</div>
<a class="anchor" id="gaac1a9db0bc2f92fd912192c696b0637d"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_save_table" ref="gaac1a9db0bc2f92fd912192c696b0637d" args="(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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#gaac1a9db0bc2f92fd912192c696b0637d">cpl_dfs_save_table</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>allframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>header</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> * </td>
<td class="paramname"><em>parlist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>usedframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>inherit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const cpl_table * </td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>tablelist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>recipe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>applist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>remregexp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pipe_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save a table as a DFS-compliant pipeline product. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">allframes</td><td>The list of input frames for the recipe </td></tr>
<tr><td class="paramname">header</td><td>NULL, or filled with properties written to product header </td></tr>
<tr><td class="paramname">parlist</td><td>The list of input parameters </td></tr>
<tr><td class="paramname">usedframes</td><td>The list of raw/calibration frames used for this product </td></tr>
<tr><td class="paramname">inherit</td><td>NULL or product frames inherit their header from this frame </td></tr>
<tr><td class="paramname">table</td><td>The table to be saved </td></tr>
<tr><td class="paramname">tablelist</td><td>Optional propertylist to use in table extension or NULL </td></tr>
<tr><td class="paramname">recipe</td><td>The recipe name </td></tr>
<tr><td class="paramname">applist</td><td>Optional propertylist to append to primary header or NULL </td></tr>
<tr><td class="paramname">remregexp</td><td>Optional regexp of properties not to put in main header </td></tr>
<tr><td class="paramname">pipe_id</td><td>PACKAGE "/" PACKAGE_VERSION </td></tr>
<tr><td class="paramname">filename</td><td>Filename of created product </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPL_ERROR_NONE or the relevant CPL error code on error </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>cpl_dfs_save_image(), <a class="el" href="group__cpl__table.html#ga0f74c8d7e280b0676d890f48a7b48977" title="Save a cpl_table to a FITS file.">cpl_table_save()</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5945764c09e904efe5cc15172ed36fb3"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_setup_product_header" ref="ga5945764c09e904efe5cc15172ed36fb3" args="(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)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#ga5945764c09e904efe5cc15172ed36fb3">cpl_dfs_setup_product_header</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__propertylist.html#gab1629461e5d64dd8594cd505e3ea46ab">cpl_propertylist</a> * </td>
<td class="paramname"><em>header</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>product_frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>framelist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__parameterlist.html#gaa9c8a14c0aa89145ed8f6381d07e6c17">cpl_parameterlist</a> * </td>
<td class="paramname"><em>parlist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>recid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pipeline_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dictionary_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>inherit_frame</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add product keywords to a pipeline product property list. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">header</td><td>Property list where keywords must be written </td></tr>
<tr><td class="paramname">product_frame</td><td>Frame describing the product </td></tr>
<tr><td class="paramname">framelist</td><td>List of frames including all input frames </td></tr>
<tr><td class="paramname">parlist</td><td>Recipe parameter list </td></tr>
<tr><td class="paramname">recid</td><td>Recipe name </td></tr>
<tr><td class="paramname">pipeline_id</td><td>Pipeline unique identifier </td></tr>
<tr><td class="paramname">dictionary_id</td><td>PRO dictionary identifier </td></tr>
<tr><td class="paramname">inherit_frame</td><td>Frame from which header information is inherited</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>CPL_ERROR_NONE</code> on success.</dd></dl>
<dl width="100%">
<dt><b>Errors:</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">An input pointer is <code>NULL</code>. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The input <em>framelist</em> contains no input frames or a frame in the input <em>framelist</em> does not specify a file. In the former case the string "Empty set-of-frames" is appended to the error message returned by <a class="el" href="group__cpl__error.html#ga388e8330b31e5a488c16a00da6816c4c" title="Get the text message of the current CPL error.">cpl_error_get_message()</a>. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_ILLEGAL_INPUT </td><td class="ecr">The product frame is not tagged or not grouped as <code>CPL_FRAME_GROUP_PRODUCT</code>. A specified <em>inherit_frame</em> doesn't belong to the input frame list, or it is not in FITS format. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_FILE_NOT_FOUND </td><td class="ecr">A frame in the input <em>framelist</em> specifies a non-existing file. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_BAD_FILE_FORMAT </td><td class="ecr">A frame in the input <em>framelist</em> specifies an invalid file. </td></tr>
</table>
</dd>
</dl>
<p>This function checks the <em>header</em> associated to a pipeline product, to ensure that it is DICB compliant. In particular, this function does the following:</p>
<ol type="1">
<li>Selects a reference frame from which the primary and secondary keyword information is inherited. The primary information is contained in the FITS keywords ORIGIN, TELESCOPE, INSTRUME, OBJECT, RA, DEC, EPOCH, EQUINOX, RADECSYS, DATE-OBS, MJD-OBS, UTC, LST, PI-COI, OBSERVER, while the secondary information is contained in all the other keywords. If the <em>inherit_frame</em> is just a NULL pointer, both primary and secondary information is inherited from the first frame in the input framelist with group CPL_FRAME_GROUP_RAW, or if no such frames are present the first frame with group CPL_FRAME_GROUP_CALIB. If <em>inherit_frame</em> is non-NULL, the secondary information is inherited from <em>inherit_frame</em> instead.</li>
</ol>
<ol type="1">
<li>Copy to <em>header</em>, if they are present, the following primary FITS keywords from the first input frame in the <em>framelist:</em> ORIGIN, TELESCOPE, INSTRUME, OBJECT, RA, DEC, EPOCH, EQUINOX, RADECSYS, DATE-OBS, MJD-OBS, UTC, LST, PI-COI, OBSERVER. If those keywords are already present in the <em>header</em> property list, they are overwritten only in case they have the same type. If any of these keywords are present with an unexpected type, a warning is issued, but the keywords are copied anyway (provided that the above conditions are fulfilled), and no error is set.</li>
</ol>
<ol type="1">
<li>Copy all the HIERARCH.ESO._ keywords from the primary FITS header of the <em>inherit_frame</em> in <em>framelist</em>, with the exception of the HIERARCH.ESO.DPR._, and of the .PRO._ and .DRS._ keywords if the <em>inherit_frame</em> is a calibration. If those keywords are already present in <em>header</em>, they are overwritten.</li>
</ol>
<ol type="1">
<li>If found, remove the HIERARCH.ESO.DPR._ keywords from <em>header</em>.</li>
</ol>
<ol type="1">
<li>If found, remove the ARCFILE and ORIGFILE keywords from <em>header</em>.</li>
</ol>
<ol type="1">
<li>Add to <em>header</em> the following mandatory keywords from the PRO dictionary: PIPEFILE, PRO.DID, PRO.REC1.ID, PRO.REC1.DRS.ID, PRO.REC1.PIPE.ID, and PRO.CATG. If those keywords are already present in <em>header</em>, they are overwritten. The keyword PRO.CATG is always set identical to the tag in <em>product_frame</em>.</li>
</ol>
<ol type="1">
<li>Only if missing, add to <em>header</em> the following mandatory keywords from the PRO dictionary: PRO.TYPE, PRO.TECH, and PRO.SCIENCE. The keyword PRO.TYPE will be set to "REDUCED". If the keyword DPR.TECH is found in the header of the first frame, PRO.TECH is given its value, alternatively if the keyword PRO.TECH is found it is copied instead, and if all fails the value "UNDEFINED" is set. Finally, if the keyword DPR.CATG is found in the header of the first frame and is set to "SCIENCE", the boolean keyword PRO.SCIENCE will be set to "true", otherwise it will be copied from an existing PRO.SCIENCE jeyword, while it will be set to "false" in all other cases.</li>
</ol>
<ol type="1">
<li>Check the existence of the keyword PRO.DATANCOM in <em>header</em>. If this keyword is missing, one is added, with the value of the total number of raw input frames.</li>
</ol>
<ol type="1">
<li>Add to <em>header</em> the keywords PRO.REC1.RAW1.NAME, PRO.REC1.RAW1.CATG, PRO.REC1.CAL1.NAME, PRO.REC1.CAL1.CATG, to describe the content of the input set-of-frames.</li>
</ol>
<p>See the DICB PRO dictionary to have details on the mentioned PRO keywords.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Non-FITS files are handled as files with an empty FITS header. </dd></dl>
</div>
</div>
<a class="anchor" id="ga8d813636e3822382fab1d165ee035d4d"></a><!-- doxytag: member="cpl_dfs.c::cpl_dfs_update_product_header" ref="ga8d813636e3822382fab1d165ee035d4d" args="(cpl_frameset *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__error.html#ga44b4287e8a7a22122b94c220a1dd9459">cpl_error_code</a> <a class="el" href="group__cpl__dfs.html#ga8d813636e3822382fab1d165ee035d4d">cpl_dfs_update_product_header</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frameset.html#ga3dbb2e3c25fc8f498172799575fbab9d">cpl_frameset</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform any DFS-compliancy required actions (DATAMD5/PIPEFILE update) </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The list of frames with FITS products created by the recipe </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>CPL_ERROR_NONE or the relevant CPL error code on error </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Each product frame must correspond to a FITS file created with a CPL FITS saving function.</dd></dl>
<dl width="100%">
<dt><b>Errors:</b></dt>
<dd></dd>
<dt></dt>
<dd><table class="ec" align="center">
<tr>
<td class="ecl">CPL_ERROR_NULL_INPUT </td><td class="ecr">An input pointer is <code>NULL</code>. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The input <em>framelist</em> contains a frame of type product with a missing filename. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_BAD_FILE_FORMAT </td><td class="ecr">The input <em>framelist</em> contains a frame of type product without a FITS card with key 'DATAMD5'. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_FILE_IO </td><td class="ecr">The input <em>framelist</em> contains a frame of type product for which the FITS card with key 'DATAMD5' could not be updated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 29 2011 09:56:20 for Common Pipeline Library Reference Manual by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
|