<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DGtal: DGtal::GenericWriter&lt; TContainer, Tdim, TValue, TFunctor &gt; Struct Template 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DGtal
   &#160;<span id="projectnumber">1.4.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structDGtal_1_1GenericWriter.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">DGtal::GenericWriter&lt; TContainer, Tdim, TValue, TFunctor &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Aim: Provide a mechanism to save image (2D or 3D) into file with the best saver loader according to an filename (by parsing the extension).  
 <a href="structDGtal_1_1GenericWriter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="GenericWriter_8h_source.html">DGtal/io/writers/GenericWriter.h</a>&gt;</code></p>
<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:a42d9c64bfda5b45a397bf7ea14822224"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDGtal_1_1GenericWriter.html#a42d9c64bfda5b45a397bf7ea14822224">BOOST_CONCEPT_ASSERT</a> ((<a class="el" href="structDGtal_1_1concepts_1_1CConstImage.html">concepts::CConstImage</a>&lt; TContainer &gt;))</td></tr>
<tr class="separator:a42d9c64bfda5b45a397bf7ea14822224"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae9f11d212f4136c678a4a5b3b8b6c111"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDGtal_1_1GenericWriter.html#ae9f11d212f4136c678a4a5b3b8b6c111">exportFile</a> (const std::string &amp;filename, const TContainer &amp;anImage, const TFunctor &amp;aFunctor=TFunctor())</td></tr>
<tr class="separator:ae9f11d212f4136c678a4a5b3b8b6c111"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename TContainer, int Tdim = TContainer::Point::dimension, typename TValue = typename TContainer::Value, typename TFunctor = functors::Identity&gt;<br />
struct DGtal::GenericWriter&lt; TContainer, Tdim, TValue, TFunctor &gt;</h3>

<p>Aim: Provide a mechanism to save image (2D or 3D) into file with the best saver loader according to an filename (by parsing the extension). </p>
<p>Description of template class '<a class="el" href="structDGtal_1_1GenericWriter.html" title="Aim: Provide a mechanism to save image (2D or 3D) into file with the best saver loader according to a...">GenericWriter</a>' </p>
<p>The typical use is very simple:</p><ul>
<li>First include the header of the generic reader (and StdDefs) and define image type: <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;DGTal/io/readers/GenericWriter.h&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;DGtal/helpers/StdDefs.h&quot;</span></div>
<div class="line"><span class="keyword">typedef</span> <a class="code" href="classDGtal_1_1ImageContainerBySTLMap.html">DGtal::ImageContainerBySTLMap&lt;DGtal::Z3i::Domain, unsigned char&gt;</a> Image3D;</div>
<div class="line"><span class="keyword">typedef</span> <a class="code" href="classDGtal_1_1ImageContainerBySTLMap.html">DGtal::ImageContainerBySTLMap&lt;DGtal::Z2i::Domain, unsigned char&gt;</a> Image2D;</div>
<div class="ttc" id="aclassDGtal_1_1ImageContainerBySTLMap_html"><div class="ttname"><a href="classDGtal_1_1ImageContainerBySTLMap.html">DGtal::ImageContainerBySTLMap</a></div><div class="ttdef"><b>Definition:</b> <a href="ImageContainerBySTLMap_8h_source.html#l00096">ImageContainerBySTLMap.h:98</a></div></div>
</div><!-- fragment --></li>
<li>After contructing and filling an image (anImage2D or anImage3D), just save it with: <div class="fragment"><div class="line">anImage3D &gt;&gt; <span class="stringliteral">&quot;aFilename.pgm3d&quot;</span>;</div>
<div class="line">anImage3D &gt;&gt; <span class="stringliteral">&quot;aFilename.vol&quot;</span>;</div>
<div class="line">anImage2D &gt;&gt; <span class="stringliteral">&quot;aFilename.pgm&quot;</span>;</div>
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>the stream operator hide a default functor (c++ cast to a given type) and if the user want to control the cast he can used the exportFile function (see below). </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">TContainer</td><td>the container (mainly an ImageContainer like <a class="el" href="classDGtal_1_1ImageContainerBySTLVector.html">ImageContainerBySTLVector</a> or <a class="el" href="classDGtal_1_1ImageContainerBySTLMap.html">ImageContainerBySTLMap</a>). </td></tr>
    <tr><td class="paramname">Tdim</td><td>the dimension of the container (by default given by the container). </td></tr>
    <tr><td class="paramname">TValue</td><td>the value type of data contained in the image (by default given by the container) </td></tr>
    <tr><td class="paramname">TFunctor</td><td>a functor type to apply image transformation before saving the image (by default set to <a class="el" href="structDGtal_1_1functors_1_1Identity.html" title="Aim: Define a simple default functor that just returns its argument.">functors::Identity</a>). </td></tr>
  </table>
  </dd>
</dl>
</li>
</ul>

<p class="definition">Definition at line <a class="el" href="GenericWriter_8h_source.html#l00094">94</a> of file <a class="el" href="GenericWriter_8h_source.html">GenericWriter.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a42d9c64bfda5b45a397bf7ea14822224"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42d9c64bfda5b45a397bf7ea14822224">&#9670;&nbsp;</a></span>BOOST_CONCEPT_ASSERT()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TContainer , int Tdim = TContainer::Point::dimension, typename TValue  = typename TContainer::Value, typename TFunctor  = functors::Identity&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structDGtal_1_1GenericWriter.html">DGtal::GenericWriter</a>&lt; TContainer, Tdim, TValue, TFunctor &gt;::BOOST_CONCEPT_ASSERT </td>
          <td>(</td>
          <td class="paramtype">(<a class="el" href="structDGtal_1_1concepts_1_1CConstImage.html">concepts::CConstImage</a>&lt; TContainer &gt;)&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae9f11d212f4136c678a4a5b3b8b6c111"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f11d212f4136c678a4a5b3b8b6c111">&#9670;&nbsp;</a></span>exportFile()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TContainer , int Tdim = TContainer::Point::dimension, typename TValue  = typename TContainer::Value, typename TFunctor  = functors::Identity&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool <a class="el" href="structDGtal_1_1GenericWriter.html">DGtal::GenericWriter</a>&lt; TContainer, Tdim, TValue, TFunctor &gt;::exportFile </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const TContainer &amp;&#160;</td>
          <td class="paramname"><em>anImage</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const TFunctor &amp;&#160;</td>
          <td class="paramname"><em>aFunctor</em> = <code>TFunctor()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>Export an image. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>the filename of the saved image (with a extension name). </td></tr>
    <tr><td class="paramname">anImage</td><td>the image to be saved. </td></tr>
    <tr><td class="paramname">aFunctor</td><td>to apply image transformation before saving. </td></tr>
  </table>
  </dd>
</dl>

<p class="reference">Referenced by <a class="el" href="Shortcuts_8h_source.html#l00784">DGtal::Shortcuts&lt; TKSpace &gt;::saveGrayScaleImage()</a>, and <a class="el" href="testGenericWriter_8cpp_source.html#l00051">testGenericWriter()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="GenericWriter_8h_source.html">GenericWriter.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceDGtal.html">DGtal</a></li><li class="navelem"><a class="el" href="structDGtal_1_1GenericWriter.html">GenericWriter</a></li>
    <li class="footer">Generated on Mon Dec 23 2024 13:19:04 for DGtal by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>