/usr/share/doc/mia-2.0/libdoc/classC3DImage.html is in libmia-2.0-doc 2.0.13-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 | <!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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>C3DImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">C3DImage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__basic.html">Basic data strctures and functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The generic base type of a 3D image.
<a href="classC3DImage.html#details">More...</a></p>
<p><code>#include <<a class="el" href="3d_2image_8hh_source.html">mia/3d/image.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for C3DImage:</div>
<div class="dyncontent">
<div class="center">
<img src="classC3DImage.png" usemap="#C3DImage_map" alt=""/>
<map id="C3DImage_map" name="C3DImage_map">
<area href="classCAttributedData.html" title="A collection of attributes. " alt="CAttributedData" shape="rect" coords="0,0,101,24"/>
<area href="classT3DImage.html" title="Specific type of the 3D images that hold real pixel data. " alt="T3DImage< T >" shape="rect" coords="0,112,101,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae42af0c48a4d49ef95a74d4aa87dcccb"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="3d_2vector_8hh.html#a34609a389450f4561ebf2b1e61a2b250">C3DBounds</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#ae42af0c48a4d49ef95a74d4aa87dcccb">dimsize_type</a></td></tr>
<tr class="memdesc:ae42af0c48a4d49ef95a74d4aa87dcccb"><td class="mdescLeft"> </td><td class="mdescRight">generic type for the dimension of the image <a href="#ae42af0c48a4d49ef95a74d4aa87dcccb">More...</a><br/></td></tr>
<tr class="separator:ae42af0c48a4d49ef95a74d4aa87dcccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa60c0c0b84a2e7fbc17e9a18cdb0cc7c"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="classC3DImage.html">C3DImage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#aa60c0c0b84a2e7fbc17e9a18cdb0cc7c">Pointer</a></td></tr>
<tr class="memdesc:aa60c0c0b84a2e7fbc17e9a18cdb0cc7c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer type of the image. <a href="#aa60c0c0b84a2e7fbc17e9a18cdb0cc7c">More...</a><br/></td></tr>
<tr class="separator:aa60c0c0b84a2e7fbc17e9a18cdb0cc7c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a75a0490d13a7793a764e9e2ce913a8ec"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classC3DImage.html#aa60c0c0b84a2e7fbc17e9a18cdb0cc7c">Pointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a75a0490d13a7793a764e9e2ce913a8ec">clone</a> () const =0</td></tr>
<tr class="separator:a75a0490d13a7793a764e9e2ce913a8ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a102440249d1cf3a27b07d4ea20301f1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__basic.html#gac301135d3a1ae3d16be1f63b7792f6ec">E3DImageOrientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a102440249d1cf3a27b07d4ea20301f1e">get_orientation</a> () const </td></tr>
<tr class="separator:a102440249d1cf3a27b07d4ea20301f1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a755972ecdb58902615ac6d4b4f9e9bc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a755972ecdb58902615ac6d4b4f9e9bc0">get_pixel_type</a> () const </td></tr>
<tr class="separator:a755972ecdb58902615ac6d4b4f9e9bc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ffc5ecb67f9fb2bceb87b3f84ecf49b"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="3d_2vector_8hh.html#a34609a389450f4561ebf2b1e61a2b250">C3DBounds</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a9ffc5ecb67f9fb2bceb87b3f84ecf49b">get_size</a> () const =0</td></tr>
<tr class="separator:a9ffc5ecb67f9fb2bceb87b3f84ecf49b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dbe519dfbadaa3df4ce0de073f6aaa0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="3d_2vector_8hh.html#ab7cc2a49dcd44008301d0e1e1dd4a8fb">C3DFVector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a1dbe519dfbadaa3df4ce0de073f6aaa0">get_voxel_size</a> () const =0</td></tr>
<tr class="separator:a1dbe519dfbadaa3df4ce0de073f6aaa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65a13f3d252a96873a4ec9a311311013"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a65a13f3d252a96873a4ec9a311311013">set_orientation</a> (<a class="el" href="group__basic.html#gac301135d3a1ae3d16be1f63b7792f6ec">E3DImageOrientation</a> orient)</td></tr>
<tr class="separator:a65a13f3d252a96873a4ec9a311311013"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed47ce85ac94c34797ff16400bc6142e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#aed47ce85ac94c34797ff16400bc6142e">set_voxel_size</a> (const <a class="el" href="3d_2vector_8hh.html#ab7cc2a49dcd44008301d0e1e1dd4a8fb">C3DFVector</a> &voxel)=0</td></tr>
<tr class="memdesc:aed47ce85ac94c34797ff16400bc6142e"><td class="mdescLeft"> </td><td class="mdescRight">set the voxel size on world units <a href="#aed47ce85ac94c34797ff16400bc6142e">More...</a><br/></td></tr>
<tr class="separator:aed47ce85ac94c34797ff16400bc6142e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0f79ee2ca73b92f0b029c96aa3bc7fb"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#ae0f79ee2ca73b92f0b029c96aa3bc7fb">size</a> () const =0</td></tr>
<tr class="separator:ae0f79ee2ca73b92f0b029c96aa3bc7fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e321c28763e4ddd8b9fb87d2cff8e84"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a5e321c28763e4ddd8b9fb87d2cff8e84">~C3DImage</a> ()</td></tr>
<tr class="separator:a5e321c28763e4ddd8b9fb87d2cff8e84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCAttributedData"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCAttributedData')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCAttributedData.html">CAttributedData</a></td></tr>
<tr class="memitem:a1ea5227b383bba1abaa00b6b2d946724 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">CAttributeMap::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a1ea5227b383bba1abaa00b6b2d946724">begin_attributes</a> () const </td></tr>
<tr class="separator:a1ea5227b383bba1abaa00b6b2d946724 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a9d434214ec025614b2575c71fe771c inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a5a9d434214ec025614b2575c71fe771c">delete_attribute</a> (const std::string &key)</td></tr>
<tr class="separator:a5a9d434214ec025614b2575c71fe771c inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2031b4a472766d0843cf248c8e9bb953 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">CAttributeMap::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a2031b4a472766d0843cf248c8e9bb953">end_attributes</a> () const </td></tr>
<tr class="separator:a2031b4a472766d0843cf248c8e9bb953 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6100afd0e13af2b713dc6422cbee2216 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="attributes_8hh.html#a8e2479e95252a094d72da87dff80a068">PAttribute</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a6100afd0e13af2b713dc6422cbee2216">get_attribute</a> (const std::string &key) const </td></tr>
<tr class="separator:a6100afd0e13af2b713dc6422cbee2216 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1064bcfeb10ce2f1ca5ac5a8745593ff inherit pub_methods_classCAttributedData"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a1064bcfeb10ce2f1ca5ac5a8745593ff inherit pub_methods_classCAttributedData"><td class="memTemplItemLeft" align="right" valign="top">const T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a1064bcfeb10ce2f1ca5ac5a8745593ff">get_attribute_as</a> (const std::string &key) const </td></tr>
<tr class="separator:a1064bcfeb10ce2f1ca5ac5a8745593ff inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9e6a1ddc332dafc88e722660fd7d922 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#ad9e6a1ddc332dafc88e722660fd7d922">get_attribute_as_string</a> (const std::string &key) const </td></tr>
<tr class="memdesc:ad9e6a1ddc332dafc88e722660fd7d922 inherit pub_methods_classCAttributedData"><td class="mdescLeft"> </td><td class="mdescRight">returns the requested attribute as string, returns an empty string if attribute doesn't exist <a href="#ad9e6a1ddc332dafc88e722660fd7d922">More...</a><br/></td></tr>
<tr class="separator:ad9e6a1ddc332dafc88e722660fd7d922 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4d12c15fab4bb384c6c77dc6a7163f9 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#aa4d12c15fab4bb384c6c77dc6a7163f9">has_attribute</a> (const std::string &key) const </td></tr>
<tr class="separator:aa4d12c15fab4bb384c6c77dc6a7163f9 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a227b66916e4dfc754d9cdf9077b048e6 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAttributedData.html">CAttributedData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a227b66916e4dfc754d9cdf9077b048e6">operator=</a> (const <a class="el" href="classCAttributedData.html">CAttributedData</a> &org)</td></tr>
<tr class="memdesc:a227b66916e4dfc754d9cdf9077b048e6 inherit pub_methods_classCAttributedData"><td class="mdescLeft"> </td><td class="mdescRight">Assignemt operator. <a href="#a227b66916e4dfc754d9cdf9077b048e6">More...</a><br/></td></tr>
<tr class="separator:a227b66916e4dfc754d9cdf9077b048e6 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58983aa9f3524c8d61843b67dba789d4 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a58983aa9f3524c8d61843b67dba789d4">set_attribute</a> (const std::string &key, <a class="el" href="attributes_8hh.html#a8e2479e95252a094d72da87dff80a068">PAttribute</a> attr)</td></tr>
<tr class="separator:a58983aa9f3524c8d61843b67dba789d4 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58dd2ec6cdafa92a31d33f3157b43571 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a58dd2ec6cdafa92a31d33f3157b43571">set_attribute</a> (const std::string &key, const std::string &value)</td></tr>
<tr class="separator:a58dd2ec6cdafa92a31d33f3157b43571 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad42c74c46b6cebe013b9cf8fee2ee3f0 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#ad42c74c46b6cebe013b9cf8fee2ee3f0">set_attributes</a> (CAttributeMap::const_iterator begin, CAttributeMap::const_iterator end)</td></tr>
<tr class="separator:ad42c74c46b6cebe013b9cf8fee2ee3f0 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05910ef8952494ca14dbf1d9f8a5060b inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a05910ef8952494ca14dbf1d9f8a5060b">CAttributedData</a> ()</td></tr>
<tr class="separator:a05910ef8952494ca14dbf1d9f8a5060b inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabd4ec46a76086332dd29d2aa5a77885 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#aabd4ec46a76086332dd29d2aa5a77885">CAttributedData</a> (const <a class="el" href="classCAttributedData.html">CAttributedData</a> &org)</td></tr>
<tr class="separator:aabd4ec46a76086332dd29d2aa5a77885 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47a05f633f8ed35dccdc305e3510ed53 inherit pub_methods_classCAttributedData"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCAttributedData.html#a47a05f633f8ed35dccdc305e3510ed53">CAttributedData</a> (<a class="el" href="group__basic.html#ga661c9f28fd7ca92427b955041d876156">PAttributeMap</a> attr)</td></tr>
<tr class="separator:a47a05f633f8ed35dccdc305e3510ed53 inherit pub_methods_classCAttributedData"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a15b4c82a1201efbdb651ed94f991890b"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a15b4c82a1201efbdb651ed94f991890b">data_descr</a></td></tr>
<tr class="memdesc:a15b4c82a1201efbdb651ed94f991890b"><td class="mdescLeft"> </td><td class="mdescRight">data type description for the plug-in path component <a href="#a15b4c82a1201efbdb651ed94f991890b">More...</a><br/></td></tr>
<tr class="separator:a15b4c82a1201efbdb651ed94f991890b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aca23d45f9af448915647873d24566c4f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#aca23d45f9af448915647873d24566c4f">C3DImage</a> (const <a class="el" href="classCAttributedData.html">CAttributedData</a> &data, <a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> type)</td></tr>
<tr class="separator:aca23d45f9af448915647873d24566c4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ecaa22e3dd73397b7d2c5907555edca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#a6ecaa22e3dd73397b7d2c5907555edca">C3DImage</a> (<a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> type)</td></tr>
<tr class="separator:a6ecaa22e3dd73397b7d2c5907555edca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef3f32a98401cd75ae98af5aaebfac2d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classC3DImage.html#aef3f32a98401cd75ae98af5aaebfac2d">C3DImage</a> ()</td></tr>
<tr class="memdesc:aef3f32a98401cd75ae98af5aaebfac2d"><td class="mdescLeft"> </td><td class="mdescRight">standard constructor <a href="#aef3f32a98401cd75ae98af5aaebfac2d">More...</a><br/></td></tr>
<tr class="separator:aef3f32a98401cd75ae98af5aaebfac2d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The generic base type of a 3D image. </p>
<p>The base type of a 3D image with is used to move around the images in the code. This type is not prepared to hold actual data. Instead the templated type <a class="el" href="classT3DImage.html" title="Specific type of the 3D images that hold real pixel data. ">T3DImage</a> derived from this class is used to hold image data of a certain voxel type. </p>
<p>Definition at line <a class="el" href="3d_2image_8hh_source.html#l00044">44</a> of file <a class="el" href="3d_2image_8hh_source.html">3d/image.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ae42af0c48a4d49ef95a74d4aa87dcccb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="3d_2vector_8hh.html#a34609a389450f4561ebf2b1e61a2b250">C3DBounds</a> <a class="el" href="classC3DImage.html#ae42af0c48a4d49ef95a74d4aa87dcccb">C3DImage::dimsize_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>generic type for the dimension of the image </p>
<p>Definition at line <a class="el" href="3d_2image_8hh_source.html#l00066">66</a> of file <a class="el" href="3d_2image_8hh_source.html">3d/image.hh</a>.</p>
</div>
</div>
<a class="anchor" id="aa60c0c0b84a2e7fbc17e9a18cdb0cc7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::shared_ptr<<a class="el" href="classC3DImage.html">C3DImage</a> > <a class="el" href="classC3DImage.html#aa60c0c0b84a2e7fbc17e9a18cdb0cc7c">C3DImage::Pointer</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer type of the image. </p>
<p>Definition at line <a class="el" href="3d_2image_8hh_source.html#l00069">69</a> of file <a class="el" href="3d_2image_8hh_source.html">3d/image.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aca23d45f9af448915647873d24566c4f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">C3DImage::C3DImage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCAttributedData.html">CAttributedData</a> & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to create the base sceleton of the image </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>attributes (meta data) that belong to the image but is normally not required for processing </td></tr>
<tr><td class="paramname">type</td><td>pixel type of this image </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6ecaa22e3dd73397b7d2c5907555edca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">C3DImage::C3DImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to create the base sceleton of the image </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>pixel type of this image </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aef3f32a98401cd75ae98af5aaebfac2d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">C3DImage::C3DImage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>standard constructor </p>
</div>
</div>
<a class="anchor" id="a5e321c28763e4ddd8b9fb87d2cff8e84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual C3DImage::~C3DImage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a75a0490d13a7793a764e9e2ce913a8ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classC3DImage.html#aa60c0c0b84a2e7fbc17e9a18cdb0cc7c">Pointer</a> C3DImage::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a clone of the image with shared image data (copy-on-write is employed for iterator access) </dd></dl>
<p>Implemented in <a class="el" href="classT3DImage.html#a8752c1238251c0dc4787444537631cdc">T3DImage< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a102440249d1cf3a27b07d4ea20301f1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__basic.html#gac301135d3a1ae3d16be1f63b7792f6ec">E3DImageOrientation</a> C3DImage::get_orientation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the orientation of the image </dd></dl>
</div>
</div>
<a class="anchor" id="a755972ecdb58902615ac6d4b4f9e9bc0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pixeltype_8hh.html#ac37864f9a600d573902409fbd6fe9e97">EPixelType</a> C3DImage::get_pixel_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the type of the pixels(voxels) in the image </dd></dl>
</div>
</div>
<a class="anchor" id="a9ffc5ecb67f9fb2bceb87b3f84ecf49b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="3d_2vector_8hh.html#a34609a389450f4561ebf2b1e61a2b250">C3DBounds</a>& C3DImage::get_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the 3D size of the image </dd></dl>
<p>Implemented in <a class="el" href="classT3DImage.html#a11740c301c14fae83c49442eb15c975e">T3DImage< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a1dbe519dfbadaa3df4ce0de073f6aaa0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="3d_2vector_8hh.html#ab7cc2a49dcd44008301d0e1e1dd4a8fb">C3DFVector</a> C3DImage::get_voxel_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the voxel size in world units </dd></dl>
<p>Implemented in <a class="el" href="classT3DImage.html#a15978d83b2d9b0af3f7fa3149bcb7e7b">T3DImage< T ></a>.</p>
</div>
</div>
<a class="anchor" id="a65a13f3d252a96873a4ec9a311311013"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void C3DImage::set_orientation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__basic.html#gac301135d3a1ae3d16be1f63b7792f6ec">E3DImageOrientation</a> </td>
<td class="paramname"><em>orient</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the orientation of the image </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">orient</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>orientation is currently not really used </dd></dl>
</div>
</div>
<a class="anchor" id="aed47ce85ac94c34797ff16400bc6142e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void C3DImage::set_voxel_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="3d_2vector_8hh.html#ab7cc2a49dcd44008301d0e1e1dd4a8fb">C3DFVector</a> & </td>
<td class="paramname"><em>voxel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>set the voxel size on world units </p>
<p>Implemented in <a class="el" href="classT3DImage.html#a29640dfde6e8ce82dcf029c78fcdc3aa">T3DImage< T ></a>.</p>
</div>
</div>
<a class="anchor" id="ae0f79ee2ca73b92f0b029c96aa3bc7fb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t C3DImage::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of voxels </dd></dl>
<p>Implemented in <a class="el" href="classT3DImage.html#a58ebd259f39263b36d5b096a53803328">T3DImage< T ></a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a15b4c82a1201efbdb651ed94f991890b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* C3DImage::data_descr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>data type description for the plug-in path component </p>
<p>Definition at line <a class="el" href="3d_2image_8hh_source.html#l00063">63</a> of file <a class="el" href="3d_2image_8hh_source.html">3d/image.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="3d_2image_8hh_source.html">3d/image.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:08 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|