/usr/share/doc/libcpl-doc/html/group__cpl__frame.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 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 | <!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: Frames</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="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Frames</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__frame.html#gaa289c04ba927b95dca922bc1a6b7ad17">CPL_FRAME_GROUP_CALIB_ID</a>   "CALIB"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frame group tag for calibration data. <a href="#gaa289c04ba927b95dca922bc1a6b7ad17"></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__frame.html#gaca85883393f241290b964f3469cd872a">CPL_FRAME_GROUP_PRODUCT_ID</a>   "PRODUCT"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frame group tag for processed data. <a href="#gaca85883393f241290b964f3469cd872a"></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__frame.html#ga9bc7557e2bfb6809e5c7858b3e086ac8">CPL_FRAME_GROUP_RAW_ID</a>   "RAW"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frame group tag for unprocessed data. <a href="#ga9bc7557e2bfb6809e5c7858b3e086ac8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct _cpl_frame_ </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The frame data type. <a href="#gab894bdf9aacef0c9eab73a1f93df8fc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__cpl__frame.html#ga1e95fbf84f17f9b9975dcedc2bdcaf49">_cpl_frame_group_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The frame group data type. <a href="#ga62536160ff8d384e009d716447ed20c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__cpl__frame.html#ga0297cc7529e060bbc9cf679c0bf3d7f2">_cpl_frame_level_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The frame level data type. <a href="#ga5e4c76b31088091a8b7b33792297b7ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__cpl__frame.html#gaf6203afa18a89ea6dfb3ea51adb1e51f">_cpl_frame_type_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The frame type data type. <a href="#ga3acab0522ad0e77e5f8465d86a620968"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga1e95fbf84f17f9b9975dcedc2bdcaf49">_cpl_frame_group_</a> { <br/>
  <a class="el" href="group__cpl__frame.html#gga1e95fbf84f17f9b9975dcedc2bdcaf49ab4518700a2e5e1d235f470f04b60bd5c">CPL_FRAME_GROUP_NONE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga1e95fbf84f17f9b9975dcedc2bdcaf49a25fb34b92b31f35bf3a60d6b15c6def9">CPL_FRAME_GROUP_RAW</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga1e95fbf84f17f9b9975dcedc2bdcaf49aef55137f124a7891b848d173d83d102c">CPL_FRAME_GROUP_CALIB</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga1e95fbf84f17f9b9975dcedc2bdcaf49ae9bf30bca110b032879006d1d73d8b78">CPL_FRAME_GROUP_PRODUCT</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Supported frame groups. <a href="group__cpl__frame.html#ga1e95fbf84f17f9b9975dcedc2bdcaf49">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga0297cc7529e060bbc9cf679c0bf3d7f2">_cpl_frame_level_</a> { <br/>
  <a class="el" href="group__cpl__frame.html#gga0297cc7529e060bbc9cf679c0bf3d7f2a916e44e0cc5abfb7d2f2fe55692d1c70">CPL_FRAME_LEVEL_NONE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga0297cc7529e060bbc9cf679c0bf3d7f2a6a67bdf88734dab0e70b4044c59481b1">CPL_FRAME_LEVEL_TEMPORARY</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga0297cc7529e060bbc9cf679c0bf3d7f2a4b150fb82e1efbd6d2348fa5fc90bb1f">CPL_FRAME_LEVEL_INTERMEDIATE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#gga0297cc7529e060bbc9cf679c0bf3d7f2a9be45c1ba39d85750c47c642bd5a49bb">CPL_FRAME_LEVEL_FINAL</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Supported frame processing levels. <a href="group__cpl__frame.html#ga0297cc7529e060bbc9cf679c0bf3d7f2">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#gaf6203afa18a89ea6dfb3ea51adb1e51f">_cpl_frame_type_</a> { <br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51fa138d07961f8c8106533432824351f888">CPL_FRAME_TYPE_NONE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51fa934c22d7179228c6a280f7e0738c42dc">CPL_FRAME_TYPE_IMAGE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51faf78317dba909a2fec7cc264479630e8d">CPL_FRAME_TYPE_MATRIX</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51fa63d4b6b6e5fbeb771e227e4f57ad3804">CPL_FRAME_TYPE_TABLE</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51fa1686f55b652a5fb21fcaf562715a2b33">CPL_FRAME_TYPE_PAF</a>,
<br/>
  <a class="el" href="group__cpl__frame.html#ggaf6203afa18a89ea6dfb3ea51adb1e51faf8349f44bad9020853dcad3cf06d17ac">CPL_FRAME_TYPE_ANY</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Supported frame types. <a href="group__cpl__frame.html#gaf6203afa18a89ea6dfb3ea51adb1e51f">More...</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga21dde9359bac302f64d8711c5b29552b">cpl_frame_delete</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a frame. <a href="#ga21dde9359bac302f64d8711c5b29552b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga1fbc4ef9764927c2453d3a49f50f4d22">cpl_frame_dump</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *frame, FILE *stream)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump the frame debugging information to the given stream. <a href="#ga1fbc4ef9764927c2453d3a49f50f4d22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#gabb34df91dd27a122de7fa9f5dfc2e863">cpl_frame_duplicate</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of a frame. <a href="#gabb34df91dd27a122de7fa9f5dfc2e863"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga9e35a805531aaf1f41569f0330754684">cpl_frame_get_filename</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file name to which a frame refers. <a href="#ga9e35a805531aaf1f41569f0330754684"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga130fe65cfb8a9e0587af0d2fbc638e70">cpl_frame_get_group</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current group of a frame. <a href="#ga130fe65cfb8a9e0587af0d2fbc638e70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga9f73b0bdf43b7b1b8ab146cc2d97cc7e">cpl_frame_get_level</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current level of a frame. <a href="#ga9f73b0bdf43b7b1b8ab146cc2d97cc7e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga4a0bf321f7cfd014f91eb11ee4cc854d">cpl_frame_get_nextensions</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of extensions of this frame. <a href="#ga4a0bf321f7cfd014f91eb11ee4cc854d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga6e0f66f528c8cef07216b9425684169a">cpl_frame_get_tag</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the category tag of a frame. <a href="#ga6e0f66f528c8cef07216b9425684169a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga3115baaaedd8b7b3d35b21b4ffdb4605">cpl_frame_get_type</a> (const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of a frame. <a href="#ga3115baaaedd8b7b3d35b21b4ffdb4605"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpl__frame.html#ga8301c4d58b4134c9e3fb87a833f81b4c">cpl_frame_new</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new, empty frame. <a href="#ga8301c4d58b4134c9e3fb87a833f81b4c"></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__frame.html#ga5867827e4efd1eb247553e041849ecd5">cpl_frame_set_filename</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self, const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the file name to which a frame refers. <a href="#ga5867827e4efd1eb247553e041849ecd5"></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__frame.html#ga4f9b543aff3664e97ef3b537c0a29152">cpl_frame_set_group</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self, <a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a> group)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the group attribute of a frame. <a href="#ga4f9b543aff3664e97ef3b537c0a29152"></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__frame.html#ga37c48554fbe7d3e5746c927c9c775517">cpl_frame_set_level</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self, <a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a> level)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the level attribute of a frame. <a href="#ga37c48554fbe7d3e5746c927c9c775517"></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__frame.html#gacfde0073787ee6dc8a71434f91164e22">cpl_frame_set_tag</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self, const char *tag)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a frame's category tag. <a href="#gacfde0073787ee6dc8a71434f91164e22"></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__frame.html#ga4754a9e5dc78dd7dbc120125afa1ae15">cpl_frame_set_type</a> (<a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> *self, <a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the type of a frame. <a href="#ga4754a9e5dc78dd7dbc120125afa1ae15"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>This module implements the <code>cpl_frame</code> type. A frame is a container for descriptive attributes related to a data file. The attributes are related to a data file through the file name member of the frame type. Among the attributes which may be assigned to a data file is an attribute identifying the type of the data stored in the file (image or table data), a classification tag indicating the kind of data the file contains and an attribute denoting to which group the data file belongs (raw, processed or calibration file). For processed data a processing level indicates whether the product is an temporary, intermediate or final product.</p>
<dl class="user"><dt><b>Synopsis:</b></dt><dd><div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <cpl_frame.h></span>
</pre></div> </dd></dl>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gaa289c04ba927b95dca922bc1a6b7ad17"></a><!-- doxytag: member="cpl_frame.h::CPL_FRAME_GROUP_CALIB_ID" ref="gaa289c04ba927b95dca922bc1a6b7ad17" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__frame.html#gaa289c04ba927b95dca922bc1a6b7ad17">CPL_FRAME_GROUP_CALIB_ID</a>   "CALIB"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frame group tag for calibration data. </p>
</div>
</div>
<a class="anchor" id="gaca85883393f241290b964f3469cd872a"></a><!-- doxytag: member="cpl_frame.h::CPL_FRAME_GROUP_PRODUCT_ID" ref="gaca85883393f241290b964f3469cd872a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__frame.html#gaca85883393f241290b964f3469cd872a">CPL_FRAME_GROUP_PRODUCT_ID</a>   "PRODUCT"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frame group tag for processed data. </p>
</div>
</div>
<a class="anchor" id="ga9bc7557e2bfb6809e5c7858b3e086ac8"></a><!-- doxytag: member="cpl_frame.h::CPL_FRAME_GROUP_RAW_ID" ref="ga9bc7557e2bfb6809e5c7858b3e086ac8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="group__cpl__frame.html#ga9bc7557e2bfb6809e5c7858b3e086ac8">CPL_FRAME_GROUP_RAW_ID</a>   "RAW"</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frame group tag for unprocessed data. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gab894bdf9aacef0c9eab73a1f93df8fc2"></a><!-- doxytag: member="cpl_frame.h::cpl_frame" ref="gab894bdf9aacef0c9eab73a1f93df8fc2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _cpl_frame_ <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The frame data type. </p>
</div>
</div>
<a class="anchor" id="ga62536160ff8d384e009d716447ed20c0"></a><!-- doxytag: member="cpl_frame.h::cpl_frame_group" ref="ga62536160ff8d384e009d716447ed20c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__cpl__frame.html#ga1e95fbf84f17f9b9975dcedc2bdcaf49">_cpl_frame_group_</a> <a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The frame group data type. </p>
</div>
</div>
<a class="anchor" id="ga5e4c76b31088091a8b7b33792297b7ad"></a><!-- doxytag: member="cpl_frame.h::cpl_frame_level" ref="ga5e4c76b31088091a8b7b33792297b7ad" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__cpl__frame.html#ga0297cc7529e060bbc9cf679c0bf3d7f2">_cpl_frame_level_</a> <a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The frame level data type. </p>
</div>
</div>
<a class="anchor" id="ga3acab0522ad0e77e5f8465d86a620968"></a><!-- doxytag: member="cpl_frame.h::cpl_frame_type" ref="ga3acab0522ad0e77e5f8465d86a620968" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__cpl__frame.html#gaf6203afa18a89ea6dfb3ea51adb1e51f">_cpl_frame_type_</a> <a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The frame type data type. </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga1e95fbf84f17f9b9975dcedc2bdcaf49"></a><!-- doxytag: member="cpl_frame.h::_cpl_frame_group_" ref="ga1e95fbf84f17f9b9975dcedc2bdcaf49" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__cpl__frame.html#ga1e95fbf84f17f9b9975dcedc2bdcaf49">_cpl_frame_group_</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Supported frame groups. </p>
<p>Defines the possible values for the frame's group attribute. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga1e95fbf84f17f9b9975dcedc2bdcaf49ab4518700a2e5e1d235f470f04b60bd5c"></a><!-- doxytag: member="CPL_FRAME_GROUP_NONE" ref="gga1e95fbf84f17f9b9975dcedc2bdcaf49ab4518700a2e5e1d235f470f04b60bd5c" args="" -->CPL_FRAME_GROUP_NONE</em> </td><td>
<p>The frame does not belong to any supported group. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga1e95fbf84f17f9b9975dcedc2bdcaf49a25fb34b92b31f35bf3a60d6b15c6def9"></a><!-- doxytag: member="CPL_FRAME_GROUP_RAW" ref="gga1e95fbf84f17f9b9975dcedc2bdcaf49a25fb34b92b31f35bf3a60d6b15c6def9" args="" -->CPL_FRAME_GROUP_RAW</em> </td><td>
<p>The frame is associated to unprocessed data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga1e95fbf84f17f9b9975dcedc2bdcaf49aef55137f124a7891b848d173d83d102c"></a><!-- doxytag: member="CPL_FRAME_GROUP_CALIB" ref="gga1e95fbf84f17f9b9975dcedc2bdcaf49aef55137f124a7891b848d173d83d102c" args="" -->CPL_FRAME_GROUP_CALIB</em> </td><td>
<p>The frame is associated to calibration data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga1e95fbf84f17f9b9975dcedc2bdcaf49ae9bf30bca110b032879006d1d73d8b78"></a><!-- doxytag: member="CPL_FRAME_GROUP_PRODUCT" ref="gga1e95fbf84f17f9b9975dcedc2bdcaf49ae9bf30bca110b032879006d1d73d8b78" args="" -->CPL_FRAME_GROUP_PRODUCT</em> </td><td>
<p>The frame is associated to processed data. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0297cc7529e060bbc9cf679c0bf3d7f2"></a><!-- doxytag: member="cpl_frame.h::_cpl_frame_level_" ref="ga0297cc7529e060bbc9cf679c0bf3d7f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__cpl__frame.html#ga0297cc7529e060bbc9cf679c0bf3d7f2">_cpl_frame_level_</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Supported frame processing levels. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The processing levels are just flags and it is left to the application to trigger the appropriate action for the different levels. </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga0297cc7529e060bbc9cf679c0bf3d7f2a916e44e0cc5abfb7d2f2fe55692d1c70"></a><!-- doxytag: member="CPL_FRAME_LEVEL_NONE" ref="gga0297cc7529e060bbc9cf679c0bf3d7f2a916e44e0cc5abfb7d2f2fe55692d1c70" args="" -->CPL_FRAME_LEVEL_NONE</em> </td><td>
<p>Undefined processing level </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga0297cc7529e060bbc9cf679c0bf3d7f2a6a67bdf88734dab0e70b4044c59481b1"></a><!-- doxytag: member="CPL_FRAME_LEVEL_TEMPORARY" ref="gga0297cc7529e060bbc9cf679c0bf3d7f2a6a67bdf88734dab0e70b4044c59481b1" args="" -->CPL_FRAME_LEVEL_TEMPORARY</em> </td><td>
<p>Temporary product. The corresponding file will be deleted when the processing chain is completed. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga0297cc7529e060bbc9cf679c0bf3d7f2a4b150fb82e1efbd6d2348fa5fc90bb1f"></a><!-- doxytag: member="CPL_FRAME_LEVEL_INTERMEDIATE" ref="gga0297cc7529e060bbc9cf679c0bf3d7f2a4b150fb82e1efbd6d2348fa5fc90bb1f" args="" -->CPL_FRAME_LEVEL_INTERMEDIATE</em> </td><td>
<p>Intermediate product. The corresponding file is only kept on request. The default is to delete these products at the end of the processing chain. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga0297cc7529e060bbc9cf679c0bf3d7f2a9be45c1ba39d85750c47c642bd5a49bb"></a><!-- doxytag: member="CPL_FRAME_LEVEL_FINAL" ref="gga0297cc7529e060bbc9cf679c0bf3d7f2a9be45c1ba39d85750c47c642bd5a49bb" args="" -->CPL_FRAME_LEVEL_FINAL</em> </td><td>
<p>Final data product, which is always written to a file at the end of the processing chain. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaf6203afa18a89ea6dfb3ea51adb1e51f"></a><!-- doxytag: member="cpl_frame.h::_cpl_frame_type_" ref="gaf6203afa18a89ea6dfb3ea51adb1e51f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__cpl__frame.html#gaf6203afa18a89ea6dfb3ea51adb1e51f">_cpl_frame_type_</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Supported frame types. </p>
<p>Defines the possible values for the frame's type attribute. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51fa138d07961f8c8106533432824351f888"></a><!-- doxytag: member="CPL_FRAME_TYPE_NONE" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51fa138d07961f8c8106533432824351f888" args="" -->CPL_FRAME_TYPE_NONE</em> </td><td>
<p>Undefined frame type </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51fa934c22d7179228c6a280f7e0738c42dc"></a><!-- doxytag: member="CPL_FRAME_TYPE_IMAGE" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51fa934c22d7179228c6a280f7e0738c42dc" args="" -->CPL_FRAME_TYPE_IMAGE</em> </td><td>
<p>Image frame type identifier </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51faf78317dba909a2fec7cc264479630e8d"></a><!-- doxytag: member="CPL_FRAME_TYPE_MATRIX" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51faf78317dba909a2fec7cc264479630e8d" args="" -->CPL_FRAME_TYPE_MATRIX</em> </td><td>
<p>Matrix frame type identifier </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51fa63d4b6b6e5fbeb771e227e4f57ad3804"></a><!-- doxytag: member="CPL_FRAME_TYPE_TABLE" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51fa63d4b6b6e5fbeb771e227e4f57ad3804" args="" -->CPL_FRAME_TYPE_TABLE</em> </td><td>
<p>Table frame type identifier </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51fa1686f55b652a5fb21fcaf562715a2b33"></a><!-- doxytag: member="CPL_FRAME_TYPE_PAF" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51fa1686f55b652a5fb21fcaf562715a2b33" args="" -->CPL_FRAME_TYPE_PAF</em> </td><td>
<p>paf frame type identifier </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf6203afa18a89ea6dfb3ea51adb1e51faf8349f44bad9020853dcad3cf06d17ac"></a><!-- doxytag: member="CPL_FRAME_TYPE_ANY" ref="ggaf6203afa18a89ea6dfb3ea51adb1e51faf8349f44bad9020853dcad3cf06d17ac" args="" -->CPL_FRAME_TYPE_ANY</em> </td><td>
<p>identifier for any other type </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga21dde9359bac302f64d8711c5b29552b"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_delete" ref="ga21dde9359bac302f64d8711c5b29552b" args="(cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__cpl__frame.html#ga21dde9359bac302f64d8711c5b29552b">cpl_frame_delete</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
<p>The function deallocates the memory used by the frame <em>self</em>. If <em>self</em> is <code>NULL</code>, nothing is done, and no error is set. </p>
</div>
</div>
<a class="anchor" id="ga1fbc4ef9764927c2453d3a49f50f4d22"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_dump" ref="ga1fbc4ef9764927c2453d3a49f50f4d22" args="(const cpl_frame *frame, FILE *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="group__cpl__frame.html#ga1fbc4ef9764927c2453d3a49f50f4d22">cpl_frame_dump</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump the frame debugging information to the given stream. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">frame</td><td>The frame. </td></tr>
<tr><td class="paramname">stream</td><td>The output stream to use.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
<p>The function dumps the contents of the frame <em>frame</em> to the output stream <em>stream</em>. If <em>stream</em> is <code>NULL</code> the function writes to the standard output. If <em>frame</em> is <code>NULL</code> the function does nothing. </p>
</div>
</div>
<a class="anchor" id="gabb34df91dd27a122de7fa9f5dfc2e863"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_duplicate" ref="gabb34df91dd27a122de7fa9f5dfc2e863" args="(const cpl_frame *other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a>* <a class="el" href="group__cpl__frame.html#gabb34df91dd27a122de7fa9f5dfc2e863">cpl_frame_duplicate</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a copy of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The frame to copy.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns a handle for the created clone. If an error occurs the function returns <code>NULL</code> and sets an appropriate error code.</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">The parameter <em>other</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function creates a clone of the input frame <em>other</em>. All members of the input frame are copied. </p>
</div>
</div>
<a class="anchor" id="ga9e35a805531aaf1f41569f0330754684"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_filename" ref="ga9e35a805531aaf1f41569f0330754684" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__cpl__frame.html#ga9e35a805531aaf1f41569f0330754684">cpl_frame_get_filename</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the file name to which a frame refers. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The file name to which the frame refers, or <code>NULL</code> if a file name has not been set.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The frame <em>self</em> is not associated to a file. </td></tr>
</table>
</dd>
</dl>
<p>The function returns the read-only name of a file associated to <em>self</em>. A file is associated to <em>self</em> by calling <b><a class="el" href="group__cpl__frame.html#ga5867827e4efd1eb247553e041849ecd5" title="Set the file name to which a frame refers.">cpl_frame_set_filename()</a></b> for <em>self</em>. If <em>self</em> is not associated to a file this function returns <code>NULL</code>. </p>
</div>
</div>
<a class="anchor" id="ga130fe65cfb8a9e0587af0d2fbc638e70"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_group" ref="ga130fe65cfb8a9e0587af0d2fbc638e70" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a> <a class="el" href="group__cpl__frame.html#ga130fe65cfb8a9e0587af0d2fbc638e70">cpl_frame_get_group</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current group of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The frame's current group. The function returns <code>CPL_FRAME_GROUP_NONE</code> if an error occurs and sets an appropriate error code.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function returns the group attribute of the frame <em>self</em>. </p>
</div>
</div>
<a class="anchor" id="ga9f73b0bdf43b7b1b8ab146cc2d97cc7e"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_level" ref="ga9f73b0bdf43b7b1b8ab146cc2d97cc7e" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a> <a class="el" href="group__cpl__frame.html#ga9f73b0bdf43b7b1b8ab146cc2d97cc7e">cpl_frame_get_level</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current level of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The frame's current level. The function returns <code>CPL_FRAME_LEVEL_NONE</code> if an error occurs and sets an appropriate error code.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function returns the level attribute of the frame <em>self</em>. </p>
</div>
</div>
<a class="anchor" id="ga4a0bf321f7cfd014f91eb11ee4cc854d"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_nextensions" ref="ga4a0bf321f7cfd014f91eb11ee4cc854d" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__cpl__frame.html#ga4a0bf321f7cfd014f91eb11ee4cc854d">cpl_frame_get_nextensions</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of extensions of this frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of extensions in the file <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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
<tr>
<td class="ecl">CPL_ERROR_DATA_NOT_FOUND </td><td class="ecr">The frame <em>self</em> is not associated to a file. </td></tr>
</table>
</dd>
</dl>
</dd></dl>
<p>The function returns the number of extensions in the frame or -1 in case of error. </p>
</div>
</div>
<a class="anchor" id="ga6e0f66f528c8cef07216b9425684169a"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_tag" ref="ga6e0f66f528c8cef07216b9425684169a" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__cpl__frame.html#ga6e0f66f528c8cef07216b9425684169a">cpl_frame_get_tag</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the category tag of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The frame's category tag or <code>NULL</code> if the tag is not set. The function returns <code>NULL</code> if an error occurs and an appropriate error code is set.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function returns the read-only frame's category tag. If a tag has not yet been set a <code>NULL</code> pointer is returned. </p>
</div>
</div>
<a class="anchor" id="ga3115baaaedd8b7b3d35b21b4ffdb4605"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_get_type" ref="ga3115baaaedd8b7b3d35b21b4ffdb4605" args="(const cpl_frame *self)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a> <a class="el" href="group__cpl__frame.html#ga3115baaaedd8b7b3d35b21b4ffdb4605">cpl_frame_get_type</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the type of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The frame's type. The returns <code>CPL_FRAME_TYPE_NONE</code> if an error occurs and sets an appropriate error code.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function returns the type of the data object to which it currently refers. </p>
</div>
</div>
<a class="anchor" id="ga8301c4d58b4134c9e3fb87a833f81b4c"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_new" ref="ga8301c4d58b4134c9e3fb87a833f81b4c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a>* <a class="el" href="group__cpl__frame.html#ga8301c4d58b4134c9e3fb87a833f81b4c">cpl_frame_new</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new, empty frame. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A handle for the newly created frame.</dd></dl>
<p>The function allocates the memory for the new frame and initialises it to an empty frame, i.e. it is created without tag and file information, and the type, group and level set to <code>CPL_FRAME_TYPE_NONE</code>, <code>CPL_FRAME_GROUP_NONE</code>, and <code>CPL_FRAME_LEVEL_NONE</code>, resepctively. </p>
</div>
</div>
<a class="anchor" id="ga5867827e4efd1eb247553e041849ecd5"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_set_filename" ref="ga5867827e4efd1eb247553e041849ecd5" args="(cpl_frame *self, 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__frame.html#ga5867827e4efd1eb247553e041849ecd5">cpl_frame_set_filename</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</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>Set the file name to which a frame refers. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame. </td></tr>
<tr><td class="paramname">filename</td><td>The new file name.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns <code>CPL_ERROR_NONE</code> on success or a CPL error code otherwise.</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">The parameter <em>self</em> or <em>filename</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the name of the file, to which the frame <em>self</em> refers. Any file name which was previously set by a call to this function is replaced. If no file name is present yet it is created and initialised to <em>filename</em>. </p>
</div>
</div>
<a class="anchor" id="ga4f9b543aff3664e97ef3b537c0a29152"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_set_group" ref="ga4f9b543aff3664e97ef3b537c0a29152" args="(cpl_frame *self, cpl_frame_group group)" -->
<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__frame.html#ga4f9b543aff3664e97ef3b537c0a29152">cpl_frame_set_group</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#ga62536160ff8d384e009d716447ed20c0">cpl_frame_group</a> </td>
<td class="paramname"><em>group</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the group attribute of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame. </td></tr>
<tr><td class="paramname">group</td><td>New group attribute.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns <code>CPL_ERROR_NONE</code> on success or a CPL error code otherwise.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the group attribute of the frame <em>self</em> to <em>group</em>. </p>
</div>
</div>
<a class="anchor" id="ga37c48554fbe7d3e5746c927c9c775517"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_set_level" ref="ga37c48554fbe7d3e5746c927c9c775517" args="(cpl_frame *self, cpl_frame_level level)" -->
<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__frame.html#ga37c48554fbe7d3e5746c927c9c775517">cpl_frame_set_level</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#ga5e4c76b31088091a8b7b33792297b7ad">cpl_frame_level</a> </td>
<td class="paramname"><em>level</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the level attribute of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame. </td></tr>
<tr><td class="paramname">level</td><td>New level attribute.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns <code>CPL_ERROR_NONE</code> on success or a CPL error code otherwise.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the level attribute of the frame <em>self</em> to <em>level</em>. </p>
</div>
</div>
<a class="anchor" id="gacfde0073787ee6dc8a71434f91164e22"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_set_tag" ref="gacfde0073787ee6dc8a71434f91164e22" args="(cpl_frame *self, const char *tag)" -->
<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__frame.html#gacfde0073787ee6dc8a71434f91164e22">cpl_frame_set_tag</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a frame's category tag. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame. </td></tr>
<tr><td class="paramname">tag</td><td>The new category tag.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns <code>CPL_ERROR_NONE</code> on success or a CPL error code otherwise.</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">The parameter <em>self</em> or <em>tag</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the category tag of <em>self</em>, replacing any previously set tag. If the frame does not yet have a tag is is created and initialised to <em>tag</em>. </p>
</div>
</div>
<a class="anchor" id="ga4754a9e5dc78dd7dbc120125afa1ae15"></a><!-- doxytag: member="cpl_frame.c::cpl_frame_set_type" ref="ga4754a9e5dc78dd7dbc120125afa1ae15" args="(cpl_frame *self, cpl_frame_type type)" -->
<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__frame.html#ga4754a9e5dc78dd7dbc120125afa1ae15">cpl_frame_set_type</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#gab894bdf9aacef0c9eab73a1f93df8fc2">cpl_frame</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__cpl__frame.html#ga3acab0522ad0e77e5f8465d86a620968">cpl_frame_type</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the type of a frame. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A frame. </td></tr>
<tr><td class="paramname">type</td><td>New frame type.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The function returns <code>CPL_ERROR_NONE</code> on success or a CPL error code otherwise.</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">The parameter <em>self</em> is a <code>NULL</code> pointer. </td></tr>
</table>
</dd>
</dl>
<p>The function sets the type of the frame <em>self</em> to <em>type</em>. </p>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 29 2011 09:56:19 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>
|