doxygen/group___i_m_a_g_e.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.11"/>
   7 <title>OpenJPEG: IMAGE - Implementation of operations on images</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td id="projectalign" style="padding-left: 0.5em;">
  20    <div id="projectname">OpenJPEG
  21    &#160;<span id="projectnumber">2.4.0</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.11 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34       <li class="current"><a href="modules.html"><span>Modules</span></a></li>
  35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  36       <li><a href="files.html"><span>Files</span></a></li>
  37     </ul>
  38   </div>
  39 </div><!-- top -->
  40 <div class="header">
  41   <div class="summary">
  42 <a href="#func-members">Functions</a>  </div>
  43   <div class="headertitle">
  44 <div class="title">IMAGE - Implementation of operations on images</div>  </div>
  45 </div><!--header-->
  46 <div class="contents">
  47 <table class="memberdecls">
  48 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49 Functions</h2></td></tr>
  50 <tr class="memitem:ga83035109ca4e81f9d90451adf6d975b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#ga83035109ca4e81f9d90451adf6d975b4">opj_image_create0</a> (void)</td></tr>
  51 <tr class="memdesc:ga83035109ca4e81f9d90451adf6d975b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty image.  <a href="#ga83035109ca4e81f9d90451adf6d975b4">More...</a><br /></td></tr>
  52 <tr class="separator:ga83035109ca4e81f9d90451adf6d975b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53 <tr class="memitem:gaa7b8e2985cd630021497528669063b7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#gaa7b8e2985cd630021497528669063b7c">opj_image_comp_header_update</a> (<a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image, const struct <a class="el" href="structopj__cp.html">opj_cp</a> *p_cp)</td></tr>
  54 <tr class="memdesc:gaa7b8e2985cd630021497528669063b7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the components characteristics of the image from the coding parameters.  <a href="#gaa7b8e2985cd630021497528669063b7c">More...</a><br /></td></tr>
  55 <tr class="separator:gaa7b8e2985cd630021497528669063b7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56 <tr class="memitem:ga3802de36855e5331f4d6c04bc1b732a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_a_g_e.html#ga3802de36855e5331f4d6c04bc1b732a3">opj_copy_image_header</a> (const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image_src, <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *p_image_dest)</td></tr>
  57 <tr class="memdesc:ga3802de36855e5331f4d6c04bc1b732a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy only header of image and its component header (no data are copied) if dest image have data, they will be freed.  <a href="#ga3802de36855e5331f4d6c04bc1b732a3">More...</a><br /></td></tr>
  58 <tr class="separator:ga3802de36855e5331f4d6c04bc1b732a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 </table>
  60 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  61 <h2 class="groupheader">Function Documentation</h2>
  62 <a class="anchor" id="ga3802de36855e5331f4d6c04bc1b732a3"></a>
  63 <div class="memitem">
  64 <div class="memproto">
  65       <table class="memname">
  66         <tr>
  67           <td class="memname">void opj_copy_image_header </td>
  68           <td>(</td>
  69           <td class="paramtype">const <a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td>
  70           <td class="paramname"><em>p_image_src</em>, </td>
  71         </tr>
  72         <tr>
  73           <td class="paramkey"></td>
  74           <td></td>
  75           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td>
  76           <td class="paramname"><em>p_image_dest</em>&#160;</td>
  77         </tr>
  78         <tr>
  79           <td></td>
  80           <td>)</td>
  81           <td></td><td></td>
  82         </tr>
  83       </table>
  84 </div><div class="memdoc">
  85
  86 <p>Copy only header of image and its component header (no data are copied) if dest image have data, they will be freed. </p>
  87 <dl class="params"><dt>Parameters</dt><dd>
  88   <table class="params">
  89     <tr><td class="paramname">p_image_src</td><td>the src image </td></tr>
  90     <tr><td class="paramname">p_image_dest</td><td>the dest image </td></tr>
  91   </table>
  92   </dd>
  93 </dl>
  94
  95 <p>References <a class="el" href="structopj__image.html#a0a905c725270c4a7085fbe1edea994c2">opj_image::color_space</a>, <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#ad676bf364b0c8fc889e97cc684ce95d0">opj_image_comp::data</a>, <a class="el" href="structopj__image.html#a1b62a25bd7603c6747aa3edd036401c1">opj_image::icc_profile_buf</a>, <a class="el" href="structopj__image.html#a0412d0a6696e7b6ace224c5111cf6be2">opj_image::icc_profile_len</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, <a class="el" href="openjpeg_8c.html#a53a2908ba063e90755b9449001194f88">opj_image_data_free()</a>, <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>, <a class="el" href="structopj__image.html#a0d01041cfbba0d40ab38836a35544e09">opj_image::x0</a>, <a class="el" href="structopj__image.html#a7a27deb6bf174dd57ee473d1d514f8ef">opj_image::x1</a>, <a class="el" href="structopj__image.html#a9813bacf1939346629c07262c61c8e74">opj_image::y0</a>, and <a class="el" href="structopj__image.html#a80fd916819080f959a601b0089c4c69a">opj_image::y1</a>.</p>
  96
  97 <p>Referenced by <a class="el" href="j2k_8h.html#a09f2c6c83d8066e1db9ab66fed58d9c8">opj_j2k_decode()</a>, <a class="el" href="j2k_8h.html#a60371d3609364bf033e8c244599abf6f">opj_j2k_get_tile()</a>, <a class="el" href="j2k_8h.html#a34c49b256edcdbf036492dfa635284d7">opj_j2k_read_header()</a>, and <a class="el" href="j2k_8h.html#accea6429e4f466250b095ee3fb94805c">opj_j2k_start_compress()</a>.</p>
  98
  99 </div>
 100 </div>
 101 <a class="anchor" id="gaa7b8e2985cd630021497528669063b7c"></a>
 102 <div class="memitem">
 103 <div class="memproto">
 104       <table class="memname">
 105         <tr>
 106           <td class="memname">void opj_image_comp_header_update </td>
 107           <td>(</td>
 108           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a> *&#160;</td>
 109           <td class="paramname"><em>p_image_header</em>, </td>
 110         </tr>
 111         <tr>
 112           <td class="paramkey"></td>
 113           <td></td>
 114           <td class="paramtype">const struct <a class="el" href="structopj__cp.html">opj_cp</a> *&#160;</td>
 115           <td class="paramname"><em>p_cp</em>&#160;</td>
 116         </tr>
 117         <tr>
 118           <td></td>
 119           <td>)</td>
 120           <td></td><td></td>
 121         </tr>
 122       </table>
 123 </div><div class="memdoc">
 124
 125 <p>Updates the components characteristics of the image from the coding parameters. </p>
 126 <dl class="params"><dt>Parameters</dt><dd>
 127   <table class="params">
 128     <tr><td class="paramname">p_image_header</td><td>the image header to update. </td></tr>
 129     <tr><td class="paramname">p_cp</td><td>the coding parameters from which to update the image. </td></tr>
 130   </table>
 131   </dd>
 132 </dl>
 133
 134 <p>References <a class="el" href="structopj__image.html#a6b52b100c934697a29446af5c3e0fa00">opj_image::comps</a>, <a class="el" href="structopj__image__comp.html#a0805d2f69bb770ff022c164aeda22685">opj_image_comp::dx</a>, <a class="el" href="structopj__image__comp.html#af9d6fd62a2b8bdd9fd162ce403eb0f10">opj_image_comp::dy</a>, <a class="el" href="structopj__image__comp.html#ab0353b06d4f8e707fc0fb85237537e82">opj_image_comp::factor</a>, <a class="el" href="structopj__image__comp.html#a11ecb361a0c49b482c90573a868cc8dc">opj_image_comp::h</a>, <a class="el" href="structopj__image.html#ac63093741ed0c70b9c0a8ee3070cbce6">opj_image::numcomps</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#gab9aad885f5c9bc9e39420003b2b32fe5">opj_uint_adds()</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#gae4b2e5a7c8b8f09faacc4a895f866ea1">opj_uint_ceildiv()</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#gae592eb75f221decddec51834b6c4177d">opj_uint_ceildivpow2()</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#ga2c3eb35fddab83fef25256485b926fc0">opj_uint_max()</a>, <a class="el" href="group___o_p_j___i_n_t_m_a_t_h.html#ga06c1c4470f9765a3ed04963b0daa111a">opj_uint_min()</a>, <a class="el" href="structopj__cp.html#aae555943d0b5aeb0c6b9a5d1e25f448b">opj_cp::tdx</a>, <a class="el" href="structopj__cp.html#a0fd9a036bf63787fe10a26f9d51a9da2">opj_cp::tdy</a>, <a class="el" href="structopj__cp.html#a30a7cf50ba11fe5524888d3b38bd4a09">opj_cp::th</a>, <a class="el" href="structopj__cp.html#abacc172096044123cfa0a7b027cd457f">opj_cp::tw</a>, <a class="el" href="structopj__cp.html#aeed9ee798ec24aaa27baa3088b3b3f14">opj_cp::tx0</a>, <a class="el" href="structopj__cp.html#a59415df77f13078e76678123415f403e">opj_cp::ty0</a>, <a class="el" href="structopj__image__comp.html#a59225121158d5bc911838e5b05779cdb">opj_image_comp::w</a>, <a class="el" href="structopj__image__comp.html#a1f897a8932374ca64cd4d7a256008ea3">opj_image_comp::x0</a>, <a class="el" href="structopj__image.html#a0d01041cfbba0d40ab38836a35544e09">opj_image::x0</a>, <a class="el" href="structopj__image.html#a7a27deb6bf174dd57ee473d1d514f8ef">opj_image::x1</a>, <a class="el" href="structopj__image__comp.html#aa8dff1eb1f11e9f21b0ddefe14ad3fc6">opj_image_comp::y0</a>, <a class="el" href="structopj__image.html#a9813bacf1939346629c07262c61c8e74">opj_image::y0</a>, and <a class="el" href="structopj__image.html#a80fd916819080f959a601b0089c4c69a">opj_image::y1</a>.</p>
 135
 136 <p>Referenced by <a class="el" href="group___j2_k.html#gaa91c21b73fc17028a77ba44d3987f17a">opj_j2k_read_siz()</a>.</p>
 137
 138 </div>
 139 </div>
 140 <a class="anchor" id="ga83035109ca4e81f9d90451adf6d975b4"></a>
 141 <div class="memitem">
 142 <div class="memproto">
 143       <table class="memname">
 144         <tr>
 145           <td class="memname"><a class="el" href="openjpeg_8h.html#a5c557180c59d54a2f1d29e8639687aa4">opj_image_t</a>* opj_image_create0 </td>
 146           <td>(</td>
 147           <td class="paramtype">void&#160;</td>
 148           <td class="paramname"></td><td>)</td>
 149           <td></td>
 150         </tr>
 151       </table>
 152 </div><div class="memdoc">
 153
 154 <p>Create an empty image. </p>
 155 <dl class="section return"><dt>Returns</dt><dd>returns an empty image if successful, returns NULL otherwise </dd></dl>
 156
 157 <p>References <a class="el" href="group___m_i_s_c.html#ga7fe6dfcb0a623dbec30daf0f48624bf7">opj_calloc()</a>.</p>
 158
 159 <p>Referenced by <a class="el" href="j2k_8h.html#a09f2c6c83d8066e1db9ab66fed58d9c8">opj_j2k_decode()</a>, <a class="el" href="j2k_8h.html#a60371d3609364bf033e8c244599abf6f">opj_j2k_get_tile()</a>, <a class="el" href="j2k_8h.html#a34c49b256edcdbf036492dfa635284d7">opj_j2k_read_header()</a>, and <a class="el" href="j2k_8h.html#accea6429e4f466250b095ee3fb94805c">opj_j2k_start_compress()</a>.</p>
 160
 161 </div>
 162 </div>
 163 </div><!-- contents -->
 164 <!-- start footer part -->
 165 <hr class="footer"/><address class="footer"><small>
 166 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 167 <img class="footer" src="doxygen.png" alt="doxygen"/>
 168 </a> 1.8.11
 169 </small></address>
 170 </body>
 171 </html>