Update doxygen for release 2.3.1
[openjpeg.git] / doxygen / structindex__param.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: index_param Struct Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="summary">
42 <a href="#pub-attribs">Data Fields</a>  </div>
43   <div class="headertitle">
44 <div class="title">index_param Struct Reference</div>  </div>
45 </div><!--header-->
46 <div class="contents">
47
48 <p>index parameters  
49  <a href="structindex__param.html#details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="index__manager_8h_source.html">index_manager.h</a>&gt;</code></p>
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
54 Data Fields</h2></td></tr>
55 <tr class="memitem:aff731fe41300090d3dce7fb28d6cb245"><td class="memItemLeft" align="right" valign="top"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#aff731fe41300090d3dce7fb28d6cb245">metadatalist</a></td></tr>
56 <tr class="memdesc:aff731fe41300090d3dce7fb28d6cb245"><td class="mdescLeft">&#160;</td><td class="mdescRight">metadata-bin list  <a href="#aff731fe41300090d3dce7fb28d6cb245">More...</a><br /></td></tr>
57 <tr class="separator:aff731fe41300090d3dce7fb28d6cb245"><td class="memSeparator" colspan="2">&#160;</td></tr>
58 <tr class="memitem:a923a5652592c70120e7e85e865063dae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a923a5652592c70120e7e85e865063dae">offset</a></td></tr>
59 <tr class="memdesc:a923a5652592c70120e7e85e865063dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream offset  <a href="#a923a5652592c70120e7e85e865063dae">More...</a><br /></td></tr>
60 <tr class="separator:a923a5652592c70120e7e85e865063dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 <tr class="memitem:af732c1871097cef89530934204d4823b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#af732c1871097cef89530934204d4823b">length</a></td></tr>
62 <tr class="memdesc:af732c1871097cef89530934204d4823b"><td class="mdescLeft">&#160;</td><td class="mdescRight">codestream length  <a href="#af732c1871097cef89530934204d4823b">More...</a><br /></td></tr>
63 <tr class="separator:af732c1871097cef89530934204d4823b"><td class="memSeparator" colspan="2">&#160;</td></tr>
64 <tr class="memitem:a43ec7f75fe5fc903531e69de5737658d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a43ec7f75fe5fc903531e69de5737658d">mhead_length</a></td></tr>
65 <tr class="memdesc:a43ec7f75fe5fc903531e69de5737658d"><td class="mdescLeft">&#160;</td><td class="mdescRight">main header length  <a href="#a43ec7f75fe5fc903531e69de5737658d">More...</a><br /></td></tr>
66 <tr class="separator:a43ec7f75fe5fc903531e69de5737658d"><td class="memSeparator" colspan="2">&#160;</td></tr>
67 <tr class="memitem:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#ac0cfeb5e5e37084dbf91cd4df98948be">SIZ</a></td></tr>
68 <tr class="memdesc:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="mdescLeft">&#160;</td><td class="mdescRight">SIZ marker information.  <a href="#ac0cfeb5e5e37084dbf91cd4df98948be">More...</a><br /></td></tr>
69 <tr class="separator:ac0cfeb5e5e37084dbf91cd4df98948be"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:afa72b843bc8f565df4952f6c32c719c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#afa72b843bc8f565df4952f6c32c719c9">COD</a></td></tr>
71 <tr class="memdesc:afa72b843bc8f565df4952f6c32c719c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">COD marker information.  <a href="#afa72b843bc8f565df4952f6c32c719c9">More...</a><br /></td></tr>
72 <tr class="separator:afa72b843bc8f565df4952f6c32c719c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
73 <tr class="memitem:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="memItemLeft" align="right" valign="top"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#abbf2b7d27ed7e860fd67ba9a58af1514">tilepart</a></td></tr>
74 <tr class="memdesc:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="mdescLeft">&#160;</td><td class="mdescRight">tile part information from tpix box  <a href="#abbf2b7d27ed7e860fd67ba9a58af1514">More...</a><br /></td></tr>
75 <tr class="separator:abbf2b7d27ed7e860fd67ba9a58af1514"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:a91e41933bf853c2a6cab52b41aa807a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a91e41933bf853c2a6cab52b41aa807a1">tileheader</a></td></tr>
77 <tr class="memdesc:a91e41933bf853c2a6cab52b41aa807a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">dynamic array of tile header information from thix box  <a href="#a91e41933bf853c2a6cab52b41aa807a1">More...</a><br /></td></tr>
78 <tr class="separator:a91e41933bf853c2a6cab52b41aa807a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:a7400fd13418cd272c8049388721688aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structindex__param.html#a7400fd13418cd272c8049388721688aa">precpacket</a></td></tr>
80 <tr class="memdesc:a7400fd13418cd272c8049388721688aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">dynamic array of precint packet information from ppix box  <a href="#a7400fd13418cd272c8049388721688aa">More...</a><br /></td></tr>
81 <tr class="separator:a7400fd13418cd272c8049388721688aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 </table>
83 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
84 <div class="textblock"><p>index parameters </p>
85 </div><h2 class="groupheader">Field Documentation</h2>
86 <a id="afa72b843bc8f565df4952f6c32c719c9"></a>
87 <h2 class="memtitle"><span class="permalink"><a href="#afa72b843bc8f565df4952f6c32c719c9">&#9670;&nbsp;</a></span>COD</h2>
88
89 <div class="memitem">
90 <div class="memproto">
91       <table class="memname">
92         <tr>
93           <td class="memname"><a class="el" href="index__manager_8h.html#a4b304973391a206d69d52931370350c3">CODmarker_param_t</a> index_param::COD</td>
94         </tr>
95       </table>
96 </div><div class="memdoc">
97
98 <p>COD marker information. </p>
99
100 <p class="reference">Referenced by <a class="el" href="jpip__parser_8c.html#aca2006bf1afcda0f917aa7794bb6f287">enqueue_allprecincts()</a>, <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="jpip__parser_8c.html#aebe387634751d8d7d253ec5b9273f093">enqueue_precincts()</a>, <a class="el" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
101
102 </div>
103 </div>
104 <a id="af732c1871097cef89530934204d4823b"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#af732c1871097cef89530934204d4823b">&#9670;&nbsp;</a></span>length</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109       <table class="memname">
110         <tr>
111           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> index_param::length</td>
112         </tr>
113       </table>
114 </div><div class="memdoc">
115
116 <p>codestream length </p>
117
118 <p class="reference">Referenced by <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, and <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>.</p>
119
120 </div>
121 </div>
122 <a id="aff731fe41300090d3dce7fb28d6cb245"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#aff731fe41300090d3dce7fb28d6cb245">&#9670;&nbsp;</a></span>metadatalist</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname"><a class="el" href="metadata__manager_8h.html#aaa78ced398f149ca92b47e0acddf05e5">metadatalist_param_t</a>* index_param::metadatalist</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <p>metadata-bin list </p>
135
136 <p class="reference">Referenced by <a class="el" href="msgqueue__manager_8h.html#a8b6b00d2ba2bad2a483aed202cf25610">enqueue_metadata()</a>, <a class="el" href="jpip__parser_8h.html#a81aa485be8deb8d4878b30486c0006cd">gene_JPIPstream()</a>, <a class="el" href="index__manager_8h.html#aeda761f27ce8cb0ed202d0ea2aa64c7e">parse_jp2file()</a>, and <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>.</p>
137
138 </div>
139 </div>
140 <a id="a43ec7f75fe5fc903531e69de5737658d"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#a43ec7f75fe5fc903531e69de5737658d">&#9670;&nbsp;</a></span>mhead_length</h2>
142
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname"><a class="el" href="byte__manager_8h.html#a89544bfd8f79b949793e43e323e1ace1">Byte8_t</a> index_param::mhead_length</td>
148         </tr>
149       </table>
150 </div><div class="memdoc">
151
152 <p>main header length </p>
153
154 <p class="reference">Referenced by <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>.</p>
155
156 </div>
157 </div>
158 <a id="a923a5652592c70120e7e85e865063dae"></a>
159 <h2 class="memtitle"><span class="permalink"><a href="#a923a5652592c70120e7e85e865063dae">&#9670;&nbsp;</a></span>offset</h2>
160
161 <div class="memitem">
162 <div class="memproto">
163       <table class="memname">
164         <tr>
165           <td class="memname"><a class="el" href="openjpeg_8h.html#a64948c8a524dee101c5a4d7293e6158c">OPJ_OFF_T</a> index_param::offset</td>
166         </tr>
167       </table>
168 </div><div class="memdoc">
169
170 <p>codestream offset </p>
171
172 <p class="reference">Referenced by <a class="el" href="msgqueue__manager_8h.html#a0a6f0ae1b724d1ccb7852f3e4ef1fd32">enqueue_mainheader()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a1bca84a98c266c9da610ebbb5d17e83c">set_cidxdata()</a>, and <a class="el" href="index__manager_8c.html#a1050f654e8e86c3b4a72fb30dc8b034a">set_cptrdata()</a>.</p>
173
174 </div>
175 </div>
176 <a id="a7400fd13418cd272c8049388721688aa"></a>
177 <h2 class="memtitle"><span class="permalink"><a href="#a7400fd13418cd272c8049388721688aa">&#9670;&nbsp;</a></span>precpacket</h2>
178
179 <div class="memitem">
180 <div class="memproto">
181       <table class="memname">
182         <tr>
183           <td class="memname"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a>** index_param::precpacket</td>
184         </tr>
185       </table>
186 </div><div class="memdoc">
187
188 <p>dynamic array of precint packet information from ppix box </p>
189
190 <p class="reference">Referenced by <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>.</p>
191
192 </div>
193 </div>
194 <a id="ac0cfeb5e5e37084dbf91cd4df98948be"></a>
195 <h2 class="memtitle"><span class="permalink"><a href="#ac0cfeb5e5e37084dbf91cd4df98948be">&#9670;&nbsp;</a></span>SIZ</h2>
196
197 <div class="memitem">
198 <div class="memproto">
199       <table class="memname">
200         <tr>
201           <td class="memname"><a class="el" href="index__manager_8h.html#aad063c864473ce7ae7a16d9955594f3a">SIZmarker_param_t</a> index_param::SIZ</td>
202         </tr>
203       </table>
204 </div><div class="memdoc">
205
206 <p>SIZ marker information. </p>
207
208 <p class="reference">Referenced by <a class="el" href="jpip__parser_8c.html#aca2006bf1afcda0f917aa7794bb6f287">enqueue_allprecincts()</a>, <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#afd5f028cafe553d84aa7545ee5837d66">enqueue_precinct()</a>, <a class="el" href="jpip__parser_8c.html#aebe387634751d8d7d253ec5b9273f093">enqueue_precincts()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, <a class="el" href="index__manager_8c.html#a73ddf4f40d7da955735a4fdb9b2c1d80">set_mainmhixdata()</a>, <a class="el" href="index__manager_8c.html#a781af2c59898ceecdffb70004cfaf018">set_ppixdata()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
209
210 </div>
211 </div>
212 <a id="a91e41933bf853c2a6cab52b41aa807a1"></a>
213 <h2 class="memtitle"><span class="permalink"><a href="#a91e41933bf853c2a6cab52b41aa807a1">&#9670;&nbsp;</a></span>tileheader</h2>
214
215 <div class="memitem">
216 <div class="memproto">
217       <table class="memname">
218         <tr>
219           <td class="memname"><a class="el" href="mhixbox__manager_8h.html#affa3bc2302f0306a416f721b6c29f296">mhixbox_param_t</a>** index_param::tileheader</td>
220         </tr>
221       </table>
222 </div><div class="memdoc">
223
224 <p>dynamic array of tile header information from thix box </p>
225
226 <p class="reference">Referenced by <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#a5d8213c96df9c2e64b42bfc0f3003141">set_thixdata()</a>.</p>
227
228 </div>
229 </div>
230 <a id="abbf2b7d27ed7e860fd67ba9a58af1514"></a>
231 <h2 class="memtitle"><span class="permalink"><a href="#abbf2b7d27ed7e860fd67ba9a58af1514">&#9670;&nbsp;</a></span>tilepart</h2>
232
233 <div class="memitem">
234 <div class="memproto">
235       <table class="memname">
236         <tr>
237           <td class="memname"><a class="el" href="faixbox__manager_8h.html#a9f95011aacbf1a72e52592bc7856fb33">faixbox_param_t</a>* index_param::tilepart</td>
238         </tr>
239       </table>
240 </div><div class="memdoc">
241
242 <p>tile part information from tpix box </p>
243
244 <p class="reference">Referenced by <a class="el" href="jpip__parser_8c.html#a72490e3e8ccd2d8d102a15affea987ec">enqueue_imagedata()</a>, <a class="el" href="msgqueue__manager_8h.html#a4982e5cda507b39bfc074b4c4b60e3ae">enqueue_tile()</a>, <a class="el" href="msgqueue__manager_8h.html#a3280c3cd4e26ac1e3bdd27d6f5bbf999">enqueue_tileheader()</a>, <a class="el" href="cachemodel__manager_8h.html#a8536ce465d342e4cd99e618c4c20e6d7">gene_cachemodel()</a>, <a class="el" href="cachemodel__manager_8h.html#a100d5835680e609531af22213616ce97">is_allsent()</a>, <a class="el" href="index__manager_8h.html#ae9e9b509e0078e503da1c0564644a193">isJPTfeasible()</a>, <a class="el" href="cachemodel__manager_8h.html#a269ce98f85275b2b6348aae150108c5b">print_cachemodel()</a>, <a class="el" href="index__manager_8h.html#acba4fd559491e3b10a80e0d14839c8bf">print_index()</a>, and <a class="el" href="index__manager_8c.html#ab16c783f41458fea838b5a8ebd892798">set_tpixdata()</a>.</p>
245
246 </div>
247 </div>
248 <hr/>The documentation for this struct was generated from the following file:<ul>
249 <li><a class="el" href="index__manager_8h_source.html">index_manager.h</a></li>
250 </ul>
251 </div><!-- contents -->
252 <!-- start footer part -->
253 <hr class="footer"/><address class="footer"><small>
254 Generated by &#160;<a href="http://www.doxygen.org/index.html">
255 <img class="footer" src="doxygen.png" alt="doxygen"/>
256 </a> 1.8.13
257 </small></address>
258 </body>
259 </html>