/usr/share/doc/ufo-filters/html/sinks.html is in ufo-filters-doc 0.14.1+dfsg1-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 | <!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/html; charset=utf-8" />
<title>Sinks — UFO Tasks 0.14.1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.14.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/MathJax.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="PIV filters" href="piv.html" />
<link rel="prev" title="Filters" href="filters.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="piv.html" title="PIV filters"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="filters.html" title="Filters"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">UFO Tasks 0.14.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="sinks">
<h1>Sinks<a class="headerlink" href="#sinks" title="Permalink to this headline">¶</a></h1>
<p>Sinks are endpoints and have at least one input but no output.</p>
<div class="section" id="file-writer">
<h2>File writer<a class="headerlink" href="#file-writer" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="write-write">
<em class="property"> class </em><code class="descname">write</code><a class="headerlink" href="#write-write" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes input data to the file system. Support for writing depends on compile
support, however raw (<cite>.raw</cite>) files can always be written. TIFF (<cite>.tif</cite> and
<cite>.tiff</cite>), HDF5 (<cite>.h5</cite>) and JPEG (<cite>.jpg</cite> and <cite>.jpeg</cite>) might be supported
additionally.</p>
<dl class="prop">
<dt id="write-filename">
<code class="descname">"filename"</code><span>: </span>string<a class="headerlink" href="#write-filename" title="Permalink to this definition">¶</a></dt>
<dd><p>Format string specifying the location and filename pattern of the
written data. It must contain at most <em>one</em> integer format specifier
that denotes the current index of a series. For example,
<code class="docutils literal"><span class="pre">"data-%03i.tif"</span></code> produces <code class="docutils literal"><span class="pre">data-001.tif</span></code>, <code class="docutils literal"><span class="pre">data-002.tif</span></code> and so
on. If no specifier is given, the data is written preferably to a single
file (i.e. multi-tiff, HDF5 data set). If no filename is given the data
is written as-is to stdout.</p>
</dd></dl>
<dl class="prop">
<dt id="write-counter-start">
<code class="descname">"counter-start"</code><span>: </span>uint<a class="headerlink" href="#write-counter-start" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the counter that replaces the format specifier. Initially, it is
set to 0.</p>
</dd></dl>
<dl class="prop">
<dt id="write-counter-step">
<code class="descname">"counter-step"</code><span>: </span>uint<a class="headerlink" href="#write-counter-step" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines the number of steps the counter replacing the format
specifier is incremented. Initially, it is set to 1.</p>
</dd></dl>
<dl class="prop">
<dt id="write-append">
<code class="descname">"append"</code><span>: </span>boolean<a class="headerlink" href="#write-append" title="Permalink to this definition">¶</a></dt>
<dd><p>Append rather than overwrite if <code class="docutils literal"><span class="pre">TRUE</span></code>.</p>
</dd></dl>
<dl class="prop">
<dt id="write-bits">
<code class="descname">"bits"</code><span>: </span>uint<a class="headerlink" href="#write-bits" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of bits to store the data if applicable to the file format.
Possible values are 8 and 16 which are saved as integer types and 32 bit
float. By default, the minimum and maximum for scaling is determined
automatically, however depending on the use case you should override
this with the <code class="docutils literal"><span class="pre">minimum</span></code> and <code class="docutils literal"><span class="pre">maximum</span></code> properties.</p>
</dd></dl>
<dl class="prop">
<dt id="write-minimum">
<code class="descname">"minimum"</code><span>: </span>float<a class="headerlink" href="#write-minimum" title="Permalink to this definition">¶</a></dt>
<dd><p>This value will represent zero for discrete bit depths, i.e. 8 and 16
bit.</p>
</dd></dl>
<dl class="prop">
<dt id="write-minimum">
<code class="descname">"minimum"</code><span>: </span>float<a class="headerlink" href="#write-minimum" title="Permalink to this definition">¶</a></dt>
<dd><p>This value will represent the largest possible value for discrete bit
depths, i.e. 8 and 16 bit.</p>
</dd></dl>
<p>For JPEG files the following property applies:</p>
<dl class="prop">
<dt id="write-quality">
<code class="descname">"quality"</code><span>: </span>uint<a class="headerlink" href="#write-quality" title="Permalink to this definition">¶</a></dt>
<dd><p>JPEG quality value between 0 and 100. Higher values correspond to higher
quality and larger file sizes.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="memory-writer">
<h2>Memory writer<a class="headerlink" href="#memory-writer" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="memory-out-memory-out">
<em class="property"> class </em><code class="descname">memory-out</code><a class="headerlink" href="#memory-out-memory-out" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes input to a given memory location. Unlike input and output tasks this
can be used to interface with other code more directly, e.g. to write into a
NumPy buffer:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">gi.repository</span> <span class="k">import</span> <span class="n">Ufo</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">tifffile</span>
<span class="n">ref</span> <span class="o">=</span> <span class="n">tifffile</span><span class="o">.</span><span class="n">imread</span><span class="p">(</span><span class="s1">'data.tif'</span><span class="p">)</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros_like</span><span class="p">(</span><span class="n">ref</span><span class="p">)</span>
<span class="n">pm</span> <span class="o">=</span> <span class="n">Ufo</span><span class="o">.</span><span class="n">PluginManager</span><span class="p">()</span>
<span class="n">g</span> <span class="o">=</span> <span class="n">Ufo</span><span class="o">.</span><span class="n">TaskGraph</span><span class="p">()</span>
<span class="n">sched</span> <span class="o">=</span> <span class="n">Ufo</span><span class="o">.</span><span class="n">Scheduler</span><span class="p">()</span>
<span class="n">read</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">get_task</span><span class="p">(</span><span class="s1">'read'</span><span class="p">)</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">pm</span><span class="o">.</span><span class="n">get_task</span><span class="p">(</span><span class="s1">'memory-out'</span><span class="p">)</span>
<span class="n">read</span><span class="o">.</span><span class="n">props</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="s1">'data.tif'</span>
<span class="n">out</span><span class="o">.</span><span class="n">props</span><span class="o">.</span><span class="n">pointer</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">__array_interface__</span><span class="p">[</span><span class="s1">'data'</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="n">out</span><span class="o">.</span><span class="n">props</span><span class="o">.</span><span class="n">max_size</span> <span class="o">=</span> <span class="n">ref</span><span class="o">.</span><span class="n">nbytes</span>
<span class="n">g</span><span class="o">.</span><span class="n">connect_nodes</span><span class="p">(</span><span class="n">read</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
<span class="n">sched</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">g</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">np</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">a</span> <span class="o">-</span> <span class="n">ref</span><span class="p">)</span> <span class="o">==</span> <span class="mf">0.0</span>
</pre></div>
</div>
<dl class="prop">
<dt id="memory-out-pointer">
<code class="descname">"pointer"</code><span>: </span>ulong<a class="headerlink" href="#memory-out-pointer" title="Permalink to this definition">¶</a></dt>
<dd><p>Pointer to pre-allocated memory.</p>
</dd></dl>
<dl class="prop">
<dt id="memory-out-max-size">
<code class="descname">"max-size"</code><span>: </span>ulong<a class="headerlink" href="#memory-out-max-size" title="Permalink to this definition">¶</a></dt>
<dd><p>Size of the pre-allocated memory area in bytes. Data is written up to
that point only.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="auxiliary-sink">
<h2>Auxiliary sink<a class="headerlink" href="#auxiliary-sink" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="null">
<h2>Null<a class="headerlink" href="#null" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt>
<em class="property"> class </em><code class="descname">null</code></dt>
<dd><p>Eats input and discards it.</p>
<dl class="prop">
<dt id="null-download">
<code class="descname">"download"</code><span>: </span>boolean<a class="headerlink" href="#null-download" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>TRUE</em> force final data transfer from device to host if necessary.</p>
</dd></dl>
<dl class="prop">
<dt id="null-finish">
<code class="descname">"finish"</code><span>: </span>boolean<a class="headerlink" href="#null-finish" title="Permalink to this definition">¶</a></dt>
<dd><p>Call finish on the associated command queue.</p>
</dd></dl>
<dl class="prop">
<dt id="null-durations">
<code class="descname">"durations"</code><span>: </span>boolean<a class="headerlink" href="#null-durations" title="Permalink to this definition">¶</a></dt>
<dd><p>Print durations computed from timestamps on <code class="docutils literal"><span class="pre">stderr</span></code>.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Sinks</a><ul>
<li><a class="reference internal" href="#file-writer">File writer</a></li>
<li><a class="reference internal" href="#memory-writer">Memory writer</a></li>
<li><a class="reference internal" href="#auxiliary-sink">Auxiliary sink</a></li>
<li><a class="reference internal" href="#null">Null</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="filters.html"
title="previous chapter">Filters</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="piv.html"
title="next chapter">PIV filters</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/sinks.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="piv.html" title="PIV filters"
>next</a> |</li>
<li class="right" >
<a href="filters.html" title="Filters"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">UFO Tasks 0.14.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="copyright.html">Copyright</a> 2017, UFO Collaboration.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
</html>
|