<!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>tables.parameters — PyTables 3.0.0 documentation</title>
<link rel="stylesheet" href="../../_static/cloud.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '3.0.0',
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/jquery.cookie.js"></script>
<script type="text/javascript" src="../../_static/toggle_sections.js"></script>
<script type="text/javascript" src="../../_static/toggle_sidebar.js"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="top" title="PyTables 3.0.0 documentation" href="../../index.html" />
<link rel="up" title="tables" href="../tables.html" />
</head>
<body>
<div class="relbar-top">
<div class="related">
<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="../../np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li><a href="../../index.html">PyTables 3.0.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../tables.html" accesskey="U">tables</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for tables.parameters</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="c">########################################################################</span>
<span class="c">#</span>
<span class="c"># License: BSD</span>
<span class="c"># Created: February 25, 2005</span>
<span class="c"># Author: Ivan Vilata - reverse:net.selidor@ivan</span>
<span class="c">#</span>
<span class="c"># $Id$</span>
<span class="c">#</span>
<span class="c">########################################################################</span>
<span class="sd">"""Parameters for PyTables."""</span>
<span class="n">__docformat__</span> <span class="o">=</span> <span class="s">'reStructuredText'</span>
<span class="sd">"""The format of documentation strings in this module."""</span>
<span class="n">_KB</span> <span class="o">=</span> <span class="mi">1024</span>
<span class="sd">"""The size of a Kilobyte in bytes"""</span>
<span class="n">_MB</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""The size of a Megabyte in bytes"""</span>
<span class="c"># Tunable parameters</span>
<span class="c"># ==================</span>
<span class="c"># Be careful when touching these!</span>
<span class="c"># Parameters for different internal caches</span>
<span class="c"># ----------------------------------------</span>
<span class="n">BOUNDS_MAX_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The maximum size for bounds values cached during index lookups."""</span>
<span class="n">BOUNDS_MAX_SLOTS</span> <span class="o">=</span> <span class="mi">4</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""The maximum number of slots for the BOUNDS cache."""</span>
<span class="n">ITERSEQ_MAX_ELEMENTS</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""The maximum number of iterator elements cached in data lookups."""</span>
<span class="n">ITERSEQ_MAX_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The maximum space that will take ITERSEQ cache (in bytes)."""</span>
<span class="n">ITERSEQ_MAX_SLOTS</span> <span class="o">=</span> <span class="mi">128</span>
<span class="sd">"""The maximum number of slots in ITERSEQ cache."""</span>
<span class="n">LIMBOUNDS_MAX_SIZE</span> <span class="o">=</span> <span class="mi">256</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""The maximum size for the query limits (for example, ``(lim1, lim2)``</span>
<span class="sd">in conditions like ``lim1 <= col < lim2``) cached during index lookups</span>
<span class="sd">(in bytes)."""</span>
<span class="n">LIMBOUNDS_MAX_SLOTS</span> <span class="o">=</span> <span class="mi">128</span>
<span class="sd">"""The maximum number of slots for LIMBOUNDS cache."""</span>
<span class="n">TABLE_MAX_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The maximum size for table chunks cached during index queries."""</span>
<span class="n">SORTED_MAX_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The maximum size for sorted values cached during index lookups."""</span>
<span class="n">SORTEDLR_MAX_SIZE</span> <span class="o">=</span> <span class="mi">8</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The maximum size for chunks in last row cached in index lookups (in</span>
<span class="sd">bytes)."""</span>
<span class="n">SORTEDLR_MAX_SLOTS</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""The maximum number of chunks for SORTEDLR cache."""</span>
<span class="c"># Parameters for general cache behaviour</span>
<span class="c"># --------------------------------------</span>
<span class="c">#</span>
<span class="c"># The next parameters will not be effective if passed to the</span>
<span class="c"># `open_file()` function (so, they can only be changed in a *global*</span>
<span class="c"># way). You can change them in the file, but this is strongly</span>
<span class="c"># discouraged unless you know well what you are doing.</span>
<span class="n">DISABLE_EVERY_CYCLES</span> <span class="o">=</span> <span class="mi">10</span>
<span class="sd">"""The number of cycles in which a cache will be forced to be disabled</span>
<span class="sd">if the hit ratio is lower than the LOWEST_HIT_RATIO (see below). This</span>
<span class="sd">value should provide time enough to check whether the cache is being</span>
<span class="sd">efficient or not."""</span>
<span class="n">ENABLE_EVERY_CYCLES</span> <span class="o">=</span> <span class="mi">50</span>
<span class="sd">"""The number of cycles in which a cache will be forced to be</span>
<span class="sd">(re-)enabled, irregardingly of the hit ratio. This will provide a chance</span>
<span class="sd">for checking if we are in a better scenario for doing caching again."""</span>
<span class="n">LOWEST_HIT_RATIO</span> <span class="o">=</span> <span class="mf">0.6</span>
<span class="sd">"""The minimum acceptable hit ratio for a cache to avoid disabling (and</span>
<span class="sd">freeing) it."""</span>
<span class="c"># Tunable parameters</span>
<span class="c"># ==================</span>
<span class="c"># Be careful when touching these!</span>
<span class="c"># Recommended maximum values</span>
<span class="c"># --------------------------</span>
<span class="c"># Following are the recommended values for several limits. However,</span>
<span class="c"># these limits are somewhat arbitrary and can be increased if you have</span>
<span class="c"># enough resources.</span>
<span class="n">MAX_COLUMNS</span> <span class="o">=</span> <span class="mi">512</span>
<span class="sd">"""Maximum number of columns in :class:`tables.Table` objects before a</span>
<span class="sd">:exc:`tables.PerformanceWarning` is issued. This limit is somewhat</span>
<span class="sd">arbitrary and can be increased.</span>
<span class="sd">"""</span>
<span class="n">MAX_NODE_ATTRS</span> <span class="o">=</span> <span class="mi">4</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""Maximum allowed number of attributes in a node."""</span>
<span class="n">MAX_GROUP_WIDTH</span> <span class="o">=</span> <span class="mi">16</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""Maximum allowed number of children hanging from a group."""</span>
<span class="n">MAX_TREE_DEPTH</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""Maximum depth in object tree allowed."""</span>
<span class="n">MAX_UNDO_PATH_LENGTH</span> <span class="o">=</span> <span class="mi">10</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""Maximum length of paths allowed in undo/redo operations."""</span>
<span class="c"># Cache limits</span>
<span class="c"># ------------</span>
<span class="n">COND_CACHE_SLOTS</span> <span class="o">=</span> <span class="mi">128</span>
<span class="sd">"""Maximum number of conditions for table queries to be kept in memory."""</span>
<span class="n">CHUNK_CACHE_NELMTS</span> <span class="o">=</span> <span class="mi">521</span>
<span class="sd">"""Number of elements for HDF5 chunk cache."""</span>
<span class="n">CHUNK_CACHE_PREEMPT</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="sd">"""Chunk preemption policy. This value should be between 0 and 1</span>
<span class="sd">inclusive and indicates how much chunks that have been fully read are</span>
<span class="sd">favored for preemption. A value of zero means fully read chunks are</span>
<span class="sd">treated no differently than other chunks (the preemption is strictly</span>
<span class="sd">LRU) while a value of one means fully read chunks are always preempted</span>
<span class="sd">before other chunks."""</span>
<span class="n">CHUNK_CACHE_SIZE</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""Size (in bytes) for HDF5 chunk cache."""</span>
<span class="c"># Size for new metadata cache system</span>
<span class="n">METADATA_CACHE_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span> <span class="c"># 1 MB is the default for HDF5</span>
<span class="sd">"""Size (in bytes) of the HDF5 metadata cache."""</span>
<span class="c"># NODE_CACHE_SLOTS tells the number of nodes that fits in the cache.</span>
<span class="c">#</span>
<span class="c"># There are several forces driving the election of this number:</span>
<span class="c"># 1.- As more nodes, better chances to re-use nodes</span>
<span class="c"># --> better performance</span>
<span class="c"># 2.- As more nodes, the re-ordering of the LRU cache takes more time</span>
<span class="c"># --> less performance</span>
<span class="c"># 3.- As more nodes, the memory needs for PyTables grows, specially for table</span>
<span class="c"># writings (that could take double of memory than table reads!).</span>
<span class="c">#</span>
<span class="c"># The default value here is quite conservative. If you have a system</span>
<span class="c"># with tons of memory, and if you are touching regularly a very large</span>
<span class="c"># number of leaves, try increasing this value and see if it fits better</span>
<span class="c"># for you. Please report back your feedback.</span>
<span class="n">NODE_CACHE_SLOTS</span> <span class="o">=</span> <span class="mi">64</span>
<span class="sd">"""Maximum number of unreferenced nodes to be kept in memory.</span>
<span class="sd">If positive, this is the number of *unreferenced* nodes to be kept in</span>
<span class="sd">the metadata cache. Least recently used nodes are unloaded from memory</span>
<span class="sd">when this number of loaded nodes is reached. To load a node again,</span>
<span class="sd">simply access it as usual. Nodes referenced by user variables are not</span>
<span class="sd">taken into account nor unloaded.</span>
<span class="sd">Negative value means that all the touched nodes will be kept in an</span>
<span class="sd">internal dictionary. This is the faster way to load/retrieve nodes.</span>
<span class="sd">However, and in order to avoid a large memory comsumption, the user will</span>
<span class="sd">be warned when the number of loaded nodes will reach the</span>
<span class="sd">``-NODE_CACHE_SLOTS`` value.</span>
<span class="sd">Finally, a value of zero means that any cache mechanism is disabled.</span>
<span class="sd">"""</span>
<span class="c"># Parameters for the I/O buffer in `Leaf` objects</span>
<span class="c"># -----------------------------------------------</span>
<span class="n">IO_BUFFER_SIZE</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">*</span> <span class="n">_MB</span>
<span class="sd">"""The PyTables internal buffer size for I/O purposes. Should not</span>
<span class="sd">exceed the amount of highest level cache size in your CPU."""</span>
<span class="n">BUFFER_TIMES</span> <span class="o">=</span> <span class="mi">100</span>
<span class="sd">"""The maximum buffersize/rowsize ratio before issuing a</span>
<span class="sd">:exc:`tables.PerformanceWarning`."""</span>
<span class="c"># Miscellaneous</span>
<span class="c"># -------------</span>
<span class="n">EXPECTED_ROWS_EARRAY</span> <span class="o">=</span> <span class="mi">1000</span>
<span class="sd">"""Default expected number of rows for :class:`EArray` objects."""</span>
<span class="n">EXPECTED_ROWS_VLARRAY</span> <span class="o">=</span> <span class="mi">1000</span>
<span class="sd">"""Default expected number of rows for :class:`VLArray` objects.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="n">EXPECTED_ROWS_TABLE</span> <span class="o">=</span> <span class="mi">10000</span>
<span class="sd">"""Default expected number of rows for :class:`Table` objects."""</span>
<span class="n">PYTABLES_SYS_ATTRS</span> <span class="o">=</span> <span class="bp">True</span>
<span class="sd">"""Set this to ``False`` if you don't want to create PyTables system</span>
<span class="sd">attributes in datasets. Also, if set to ``False`` the possible existing</span>
<span class="sd">system attributes are not considered for guessing the class of the node</span>
<span class="sd">during its loading from disk (this work is delegated to the PyTables'</span>
<span class="sd">class discoverer function for general HDF5 files)."""</span>
<span class="n">MAX_NUMEXPR_THREADS</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The maximum number of threads that PyTables should use internally in</span>
<span class="sd">Numexpr. If `None`, it is automatically set to the number of cores in</span>
<span class="sd">your machine. In general, it is a good idea to set this to the number of</span>
<span class="sd">cores in your machine or, when your machine has many of them (e.g. > 4),</span>
<span class="sd">perhaps one less than this."""</span>
<span class="n">MAX_BLOSC_THREADS</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The maximum number of threads that PyTables should use internally in</span>
<span class="sd">Blosc. If `None`, it is automatically set to the number of cores in</span>
<span class="sd">your machine. In general, it is a good idea to set this to the number of</span>
<span class="sd">cores in your machine or, when your machine has many of them (e.g. > 4),</span>
<span class="sd">perhaps one less than this."""</span>
<span class="n">USER_BLOCK_SIZE</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""Sets the user block size of a file.</span>
<span class="sd">The default user block size is 0; it may be set to any power of 2 equal</span>
<span class="sd">to 512 or greater (512, 1024, 2048, etc.).</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="c"># HDF5 driver management</span>
<span class="c"># ----------------------</span>
<span class="n">DRIVER</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""The HDF5 driver that should be used for reading/writing to the file.</span>
<span class="sd">Following drivers are supported:</span>
<span class="sd"> * H5FD_SEC2: this driver uses POSIX file-system functions like read</span>
<span class="sd"> and write to perform I/O to a single, permanent file on local</span>
<span class="sd"> disk with no system buffering.</span>
<span class="sd"> This driver is POSIX-compliant and is the default file driver for</span>
<span class="sd"> all systems.</span>
<span class="sd"> * H5FD_DIRECT: this is the H5FD_SEC2 driver except data is written</span>
<span class="sd"> to or read from the file synchronously without being cached by</span>
<span class="sd"> the system.</span>
<span class="sd"> * H5FD_WINDOWS: this driver was modified in HDF5-1.8.8 to be a</span>
<span class="sd"> wrapper of the POSIX driver, H5FD_SEC2. This change should not</span>
<span class="sd"> affect user applications.</span>
<span class="sd"> * H5FD_STDIO: this driver uses functions from the standard C</span>
<span class="sd"> stdio.h to perform I/O to a single, permanent file on local disk</span>
<span class="sd"> with additional system buffering.</span>
<span class="sd"> * H5FD_CORE: with this driver, an application can work with a file</span>
<span class="sd"> in memory for faster reads and writes. File contents are kept in</span>
<span class="sd"> memory until the file is closed. At closing, the memory version</span>
<span class="sd"> of the file can be written back to disk or abandoned.</span>
<span class="sd">The following drivers are not currently supported:</span>
<span class="sd"> * H5FD_LOG: this is the H5FD_SEC2 driver with logging capabilities.</span>
<span class="sd"> * H5FD_FAMILY: with this driver, the HDF5 file’s address space is</span>
<span class="sd"> partitioned into pieces and sent to separate storage files using</span>
<span class="sd"> an underlying driver of the user’s choice.</span>
<span class="sd"> This driver is for systems that do not support files larger than</span>
<span class="sd"> 2 gigabytes.</span>
<span class="sd"> * H5FD_MULTI: with this driver, data can be stored in multiple</span>
<span class="sd"> files according to the type of the data. I/O might work better if</span>
<span class="sd"> data is stored in separate files based on the type of data.</span>
<span class="sd"> The Split driver is a special case of this driver.</span>
<span class="sd"> * H5FD_SPLIT: this file driver splits a file into two parts.</span>
<span class="sd"> One part stores metadata, and the other part stores raw data.</span>
<span class="sd"> This splitting a file into two parts is a limited case of the</span>
<span class="sd"> Multi driver.</span>
<span class="sd"> * H5FD_MPIO: this is the standard HDF5 file driver for parallel</span>
<span class="sd"> file systems. This driver uses the MPI standard for both</span>
<span class="sd"> communication and file I/O.</span>
<span class="sd"> * H5FD_MPIPOSIX: this parallel file system driver uses MPI for</span>
<span class="sd"> communication and POSIX file-system calls for file I/O.</span>
<span class="sd"> * H5FD_STREAM: this driver is no longer available.</span>
<span class="sd">.. seealso:: the `Drivers section`_ of the `HDF5 User's Guide`_ for</span>
<span class="sd"> more information.</span>
<span class="sd">.. note::</span>
<span class="sd"> not all supported drivers are always available. For example the</span>
<span class="sd"> H5FD_WINDOWS driver is not available on non Windows platforms.</span>
<span class="sd"> If the user try to use a driver that is not available on the target</span>
<span class="sd"> platform a :exc:`RuntimeError` is raised.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">.. _`Drivers section`:</span>
<span class="sd"> http://www.hdfgroup.org/HDF5/doc/UG/08_TheFile.html#Drivers</span>
<span class="sd">.. _`HDF5 User's Guide`: http://www.hdfgroup.org/HDF5/doc/UG/index.html</span>
<span class="sd">"""</span>
<span class="n">DRIVER_DIRECT_ALIGNMENT</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""Specifies the required alignment boundary in memory.</span>
<span class="sd">A value of 0 (zero) means to use HDF5 Library’s default value.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="n">DRIVER_DIRECT_BLOCK_SIZE</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""Specifies the file system block size.</span>
<span class="sd">A value of 0 (zero) means to use HDF5 Library’s default value of 4KB.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="n">DRIVER_DIRECT_CBUF_SIZE</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">"""Specifies the copy buffer size.</span>
<span class="sd">A value of 0 (zero) means to use HDF5 Library’s default value.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="c"># DRIVER_LOG_FLAGS = 0x0001ffff</span>
<span class="c">#"""Flags specifying the types of logging activity.</span>
<span class="c">#</span>
<span class="c">#.. versionadded:: 3.0</span>
<span class="c">#</span>
<span class="c">#.. seeealso::</span>
<span class="c"># http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplLog</span>
<span class="c">#</span>
<span class="c">#"""</span>
<span class="c">#</span>
<span class="c"># DRIVER_LOG_BUF_SIZE = 4 * _KB</span>
<span class="c">#"""The size of the logging buffers, in bytes.</span>
<span class="c">#</span>
<span class="c"># One buffer of size DRIVER_LOG_BUF_SIZE will be created for each of</span>
<span class="c"># H5FD_LOG_FILE_READ, H5FD_LOG_FILE_WRITE and H5FD_LOG_FLAVOR when those</span>
<span class="c"># flags are set; these buffers will not grow as the file increases in</span>
<span class="c"># size.</span>
<span class="c">#</span>
<span class="c">#.. versionadded:: 3.0</span>
<span class="c">#</span>
<span class="c">#"""</span>
<span class="n">DRIVER_CORE_INCREMENT</span> <span class="o">=</span> <span class="mi">64</span> <span class="o">*</span> <span class="n">_KB</span>
<span class="sd">"""Core driver memory increment.</span>
<span class="sd">Specifies the increment by which allocated memory is to be increased</span>
<span class="sd">each time more memory is required.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="n">DRIVER_CORE_BACKING_STORE</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">"""Enables backing store for the core driver.</span>
<span class="sd">With the H5FD_CORE driver, if the DRIVER_CORE_BACKING_STORE is set</span>
<span class="sd">to 1 (True), the file contents are flushed to a file with the same name</span>
<span class="sd">as this core file when the file is closed or access to the file is</span>
<span class="sd">terminated in memory.</span>
<span class="sd">The application is allowed to open an existing file with H5FD_CORE</span>
<span class="sd">driver. In that case, if the DRIVER_CORE_BACKING_STORE is set to 1 and</span>
<span class="sd">the flags for :func:`tables.open_file` is set to H5F_ACC_RDWR, any change</span>
<span class="sd">to the file contents are saved to the file when the file is closed.</span>
<span class="sd">If backing_store is set to 0 and the flags for :func:`tables.open_file`</span>
<span class="sd">is set to H5F_ACC_RDWR, any change to the file contents will be lost</span>
<span class="sd">when the file is closed. If the flags for :func:`tables.open_file` is</span>
<span class="sd">set to H5F_ACC_RDONLY, no change to the file is allowed either in</span>
<span class="sd">memory or on file.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="n">DRIVER_CORE_IMAGE</span> <span class="o">=</span> <span class="bp">None</span>
<span class="sd">"""String containing an HDF5 file image.</span>
<span class="sd">If this oprion is passed to the :func:`tables.open_file` function then the</span>
<span class="sd">returned file object is set up using the specified image.</span>
<span class="sd">A file image can be retrieved from an existing (and opened) file object</span>
<span class="sd">using the :meth:`tables.File.get_file_image` method.</span>
<span class="sd">.. note:: requires HDF5 >= 1.8.9.</span>
<span class="sd">.. versionadded:: 3.0</span>
<span class="sd">"""</span>
<span class="c">## Local Variables:</span>
<span class="c">## mode: python</span>
<span class="c">## py-indent-offset: 4</span>
<span class="c">## tab-width: 4</span>
<span class="c">## fill-column: 72</span>
<span class="c">## End:</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/logo-pytables-small.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related">
<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="../../np-modindex.html" title="Python Module Index"
>modules</a> </li>
<li><a href="../../index.html">PyTables 3.0.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../tables.html" >tables</a> »</li>
</ul>
</div>
</div>
<div class="footer">
© Copyright 2011-2013, PyTables maintainers.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<!-- cloud_sptheme 1.3 -->
</body>
</html>
