/usr/share/doc/python-hdf5storage-doc/html/hdf5storage.lowlevel.html is in python-hdf5storage-doc 0.1.14-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 | <!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>hdf5storage.lowlevel — hdf5storage 0.1.14 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.1.14',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="hdf5storage 0.1.14 documentation" href="index.html" />
<link rel="up" title="API" href="api.html" />
<link rel="next" title="hdf5storage.Marshallers" href="hdf5storage.Marshallers.html" />
</head>
<body role="document">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="hdf5storage.Marshallers.html" title="hdf5storage.Marshallers"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hdf5storage 0.1.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="api.html" accesskey="U">API</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-hdf5storage.lowlevel">
<span id="hdf5storage-lowlevel"></span><h1>hdf5storage.lowlevel<a class="headerlink" href="#module-hdf5storage.lowlevel" title="Permalink to this headline">¶</a></h1>
<p>Module of Exceptions and low level read and write functions.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#hdf5storage.lowlevel.Hdf5storageError" title="hdf5storage.lowlevel.Hdf5storageError"><code class="xref py py-obj docutils literal"><span class="pre">Hdf5storageError</span></code></a></td>
<td>Base class of hdf5storage package exceptions.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#hdf5storage.lowlevel.CantReadError" title="hdf5storage.lowlevel.CantReadError"><code class="xref py py-obj docutils literal"><span class="pre">CantReadError</span></code></a></td>
<td>Exception for a failure to read the desired data.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#hdf5storage.lowlevel.TypeNotMatlabCompatibleError" title="hdf5storage.lowlevel.TypeNotMatlabCompatibleError"><code class="xref py py-obj docutils literal"><span class="pre">TypeNotMatlabCompatibleError</span></code></a></td>
<td>Exception for trying to write non-MATLAB compatible data.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#hdf5storage.lowlevel.write_data" title="hdf5storage.lowlevel.write_data"><code class="xref py py-obj docutils literal"><span class="pre">write_data</span></code></a>(f, grp, name, data, type_string, ...)</td>
<td>Writes a piece of data into an open HDF5 file.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#hdf5storage.lowlevel.read_data" title="hdf5storage.lowlevel.read_data"><code class="xref py py-obj docutils literal"><span class="pre">read_data</span></code></a>(f, grp, name, options)</td>
<td>Writes a piece of data into an open HDF5 file.</td>
</tr>
</tbody>
</table>
<div class="section" id="hdf5storageerror">
<h2>Hdf5storageError<a class="headerlink" href="#hdf5storageerror" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="hdf5storage.lowlevel.Hdf5storageError">
<em class="property">exception </em><code class="descclassname">hdf5storage.lowlevel.</code><code class="descname">Hdf5storageError</code><a class="reference internal" href="_modules/hdf5storage/lowlevel.html#Hdf5storageError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hdf5storage.lowlevel.Hdf5storageError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.IOError</span></code></p>
<p>Base class of hdf5storage package exceptions.</p>
</dd></dl>
</div>
<div class="section" id="cantreaderror">
<h2>CantReadError<a class="headerlink" href="#cantreaderror" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="hdf5storage.lowlevel.CantReadError">
<em class="property">exception </em><code class="descclassname">hdf5storage.lowlevel.</code><code class="descname">CantReadError</code><a class="reference internal" href="_modules/hdf5storage/lowlevel.html#CantReadError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hdf5storage.lowlevel.CantReadError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#hdf5storage.lowlevel.Hdf5storageError" title="hdf5storage.lowlevel.Hdf5storageError"><code class="xref py py-class docutils literal"><span class="pre">hdf5storage.lowlevel.Hdf5storageError</span></code></a></p>
<p>Exception for a failure to read the desired data.</p>
</dd></dl>
</div>
<div class="section" id="typenotmatlabcompatibleerror">
<h2>TypeNotMatlabCompatibleError<a class="headerlink" href="#typenotmatlabcompatibleerror" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="hdf5storage.lowlevel.TypeNotMatlabCompatibleError">
<em class="property">exception </em><code class="descclassname">hdf5storage.lowlevel.</code><code class="descname">TypeNotMatlabCompatibleError</code><a class="reference internal" href="_modules/hdf5storage/lowlevel.html#TypeNotMatlabCompatibleError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hdf5storage.lowlevel.TypeNotMatlabCompatibleError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#hdf5storage.lowlevel.Hdf5storageError" title="hdf5storage.lowlevel.Hdf5storageError"><code class="xref py py-class docutils literal"><span class="pre">hdf5storage.lowlevel.Hdf5storageError</span></code></a></p>
<p>Exception for trying to write non-MATLAB compatible data.</p>
<p>In the event that MATLAB compatibility is being done
(<code class="docutils literal"><span class="pre">Options.matlab_compatible</span></code>) and a Python type is not importable
by MATLAB, the data is either not written or this exception is
thrown depending on the value of
<code class="docutils literal"><span class="pre">Options.action_for_matlab_incompatible</span></code>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="hdf5storage.html#hdf5storage.Options.matlab_compatible" title="hdf5storage.Options.matlab_compatible"><code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.Options.matlab_compatible</span></code></a>, <a class="reference internal" href="hdf5storage.html#hdf5storage.Options.action_for_matlab_incompatible" title="hdf5storage.Options.action_for_matlab_incompatible"><code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.Options.action_for_matlab_incompatible</span></code></a></p>
</div>
</dd></dl>
</div>
<div class="section" id="write-data">
<h2>write_data<a class="headerlink" href="#write-data" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="hdf5storage.lowlevel.write_data">
<code class="descclassname">hdf5storage.lowlevel.</code><code class="descname">write_data</code><span class="sig-paren">(</span><em>f</em>, <em>grp</em>, <em>name</em>, <em>data</em>, <em>type_string</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hdf5storage/lowlevel.html#write_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hdf5storage.lowlevel.write_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes a piece of data into an open HDF5 file.</p>
<p>Low level function to store a Python type (<cite>data</cite>) into the
specified Group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>f</strong> : h5py.File</p>
<blockquote>
<div><p>The open HDF5 file.</p>
</div></blockquote>
<p><strong>grp</strong> : h5py.Group or h5py.File</p>
<blockquote>
<div><p>The Group to place the data in.</p>
</div></blockquote>
<p><strong>name</strong> : str</p>
<blockquote>
<div><p>The name to write the data to.</p>
</div></blockquote>
<p><strong>data</strong> : any</p>
<blockquote>
<div><p>The data to write.</p>
</div></blockquote>
<p><strong>type_string</strong> : str or None</p>
<blockquote>
<div><p>The type string of the data, or <code class="docutils literal"><span class="pre">None</span></code> to deduce
automatically.</p>
</div></blockquote>
<p><strong>options</strong> : hdf5storage.core.Options</p>
<blockquote>
<div><p>The options to use when writing.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>NotImplementedError</strong></p>
<blockquote>
<div><p>If writing <cite>data</cite> is not supported.</p>
</div></blockquote>
<p><strong>TypeNotMatlabCompatibleError</strong></p>
<blockquote class="last">
<div><p>If writing a type not compatible with MATLAB and
<cite>options.action_for_matlab_incompatible</cite> is set to <code class="docutils literal"><span class="pre">'error'</span></code>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="docutils">
<dt><code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.core.write</span></code></dt>
<dd>Higher level version.</dd>
</dl>
<p class="last"><a class="reference internal" href="#hdf5storage.lowlevel.read_data" title="hdf5storage.lowlevel.read_data"><code class="xref py py-obj docutils literal"><span class="pre">read_data</span></code></a>, <code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.core.Options</span></code></p>
</div>
</dd></dl>
</div>
<div class="section" id="read-data">
<h2>read_data<a class="headerlink" href="#read-data" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="hdf5storage.lowlevel.read_data">
<code class="descclassname">hdf5storage.lowlevel.</code><code class="descname">read_data</code><span class="sig-paren">(</span><em>f</em>, <em>grp</em>, <em>name</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hdf5storage/lowlevel.html#read_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hdf5storage.lowlevel.read_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes a piece of data into an open HDF5 file.</p>
<p>Low level function to read a Python type of the specified name from
specified Group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>f</strong> : h5py.File</p>
<blockquote>
<div><p>The open HDF5 file.</p>
</div></blockquote>
<p><strong>grp</strong> : h5py.Group or h5py.File</p>
<blockquote>
<div><p>The Group to read the data from.</p>
</div></blockquote>
<p><strong>name</strong> : str</p>
<blockquote>
<div><p>The name of the data to read.</p>
</div></blockquote>
<p><strong>options</strong> : hdf5storage.core.Options</p>
<blockquote>
<div><p>The options to use when reading.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">data</p>
<blockquote>
<div><p>The data named <cite>name</cite> in Group <cite>grp</cite>.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>CantReadError</strong></p>
<blockquote class="last">
<div><p>If the data cannot be read successfully.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="docutils">
<dt><code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.core.read</span></code></dt>
<dd>Higher level version.</dd>
</dl>
<p class="last"><a class="reference internal" href="#hdf5storage.lowlevel.write_data" title="hdf5storage.lowlevel.write_data"><code class="xref py py-obj docutils literal"><span class="pre">write_data</span></code></a>, <code class="xref py py-obj docutils literal"><span class="pre">hdf5storage.core.Options</span></code></p>
</div>
</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="#">hdf5storage.lowlevel</a><ul>
<li><a class="reference internal" href="#hdf5storageerror">Hdf5storageError</a></li>
<li><a class="reference internal" href="#cantreaderror">CantReadError</a></li>
<li><a class="reference internal" href="#typenotmatlabcompatibleerror">TypeNotMatlabCompatibleError</a></li>
<li><a class="reference internal" href="#write-data">write_data</a></li>
<li><a class="reference internal" href="#read-data">read_data</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="hdf5storage.Marshallers.html"
title="next chapter">hdf5storage.Marshallers</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/hdf5storage.lowlevel.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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="hdf5storage.Marshallers.html" title="hdf5storage.Marshallers"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">hdf5storage 0.1.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="api.html" >API</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013-2016, Freja Nordsiek.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
</div>
</body>
</html>
|