/usr/share/doc/python-h5py-doc/api/html/h5t.html is in python-h5py-doc 2.7.1-2.
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 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 | <!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>Module H5T — Low-level API for h5py</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.7.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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Module H5Z" href="h5z.html" />
<link rel="prev" title="Module H5S" href="h5s.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="h5z.html" title="Module H5Z"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="h5s.html" title="Module H5S"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Low-level API for h5py</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-h5py.h5t">
<span id="module-h5t"></span><h1>Module H5T<a class="headerlink" href="#module-h5py.h5t" title="Permalink to this headline">¶</a></h1>
<p>HDF5 “<code class="xref py py-data docutils literal"><span class="pre">H5T</span></code>” data-type API</p>
<p>This module contains the datatype identifier class <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">TypeID</span></code></a>, and its
subclasses which represent things like integer/float/compound identifiers.
The majority of the <code class="xref py py-data docutils literal"><span class="pre">H5T</span></code> API is presented as methods on these identifiers.</p>
<div class="section" id="functions-specific-to-h5py">
<h2>Functions specific to h5py<a class="headerlink" href="#functions-specific-to-h5py" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="h5py.h5t.py_create">
<code class="descclassname">h5py.h5t.</code><code class="descname">py_create</code><span class="sig-paren">(</span><em>OBJECT dtype_in</em>, <em>BOOL logical=False</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.py_create" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a Numpy dtype object, generate a byte-for-byte memory-compatible
HDF5 datatype object. The result is guaranteed to be transient and
unlocked.</p>
<p>Argument dtype_in may be a dtype object, or anything which can be
converted to a dtype, including strings like ‘<i4’.</p>
<dl class="docutils">
<dt>logical</dt>
<dd>If this flag is set, instead of returning a byte-for-byte identical
representation of the type, the function returns the closest logically
appropriate HDF5 type. For example, in the case of a “hinted” dtype
of kind “O” representing a string, it would return an HDF5 variable-
length string type.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.special_dtype">
<code class="descclassname">h5py.h5t.</code><code class="descname">special_dtype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.special_dtype" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new h5py “special” type. Only one keyword may be given.</p>
<p>Legal keywords are:</p>
<dl class="docutils">
<dt>vlen = basetype</dt>
<dd>Base type for HDF5 variable-length datatype. This can be Python
str type or instance of np.dtype.
Example: special_dtype( vlen=str )</dd>
<dt>enum = (basetype, values_dict)</dt>
<dd>Create a NumPy representation of an HDF5 enumerated type. Provide
a 2-tuple containing an (integer) base dtype and a dict mapping
string names to integer values.</dd>
<dt>ref = Reference | RegionReference</dt>
<dd>Create a NumPy representation of an HDF5 object or region reference
type.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.check_dtype">
<code class="descclassname">h5py.h5t.</code><code class="descname">check_dtype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.check_dtype" title="Permalink to this definition">¶</a></dt>
<dd><p>Check a dtype for h5py special type “hint” information. Only one
keyword may be given.</p>
<dl class="docutils">
<dt>vlen = dtype</dt>
<dd>If the dtype represents an HDF5 vlen, returns the Python base class.
Currently only builting string vlens (str) are supported. Returns
None if the dtype does not represent an HDF5 vlen.</dd>
<dt>enum = dtype</dt>
<dd>If the dtype represents an HDF5 enumerated type, returns the dictionary
mapping string names to integer values. Returns None if the dtype does
not represent an HDF5 enumerated type.</dd>
<dt>ref = dtype</dt>
<dd>If the dtype represents an HDF5 reference type, returns the reference
class (either Reference or RegionReference). Returns None if the dtype
does not represent an HDF5 reference type.</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="functional-api">
<h2>Functional API<a class="headerlink" href="#functional-api" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="h5py.h5t.create">
<code class="descclassname">h5py.h5t.</code><code class="descname">create</code><span class="sig-paren">(</span><em>INT classtype</em>, <em>UINT size</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new HDF5 type object. Legal class values are
<code class="xref py py-data docutils literal"><span class="pre">COMPOUND</span></code> and <code class="xref py py-data docutils literal"><span class="pre">OPAQUE</span></code>. Use enum_create for enums.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.open">
<code class="descclassname">h5py.h5t.</code><code class="descname">open</code><span class="sig-paren">(</span><em>ObjectID group</em>, <em>STRING name</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open a named datatype from a file.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.array_create">
<code class="descclassname">h5py.h5t.</code><code class="descname">array_create</code><span class="sig-paren">(</span><em>TypeID base</em>, <em>TUPLE dimensions</em><span class="sig-paren">)</span> → TypeArrayID<a class="headerlink" href="#h5py.h5t.array_create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new array datatype, using and HDF5 parent type and
dimensions given via a tuple of positive integers. “Unlimited”
dimensions are not allowed.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.enum_create">
<code class="descclassname">h5py.h5t.</code><code class="descname">enum_create</code><span class="sig-paren">(</span><em>TypeID base</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.enum_create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new enumerated type based on an (integer) parent type.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.vlen_create">
<code class="descclassname">h5py.h5t.</code><code class="descname">vlen_create</code><span class="sig-paren">(</span><em>TypeID base</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.vlen_create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new variable-length datatype, using any HDF5 type as a base.</p>
<p>Although the Python interface can manipulate these types, there is no
provision for reading/writing vlen data.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.decode">
<code class="descclassname">h5py.h5t.</code><code class="descname">decode</code><span class="sig-paren">(</span><em>STRING buf</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Unserialize an HDF5 type. You can also do this with the native
Python pickling machinery.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.convert">
<code class="descclassname">h5py.h5t.</code><code class="descname">convert</code><span class="sig-paren">(</span><em>TypeID src</em>, <em>TypeID dst</em>, <em>UINT n</em>, <em>NDARRAY buf</em>, <em>NDARRAY bkg=None</em>, <em>PropID dxpl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert n contiguous elements of a buffer in-place. The array dtype
is ignored. The backing buffer is optional; for conversion of compound
types, a temporary copy of conversion buffer will used for backing if
one is not supplied.</p>
</dd></dl>
<dl class="function">
<dt id="h5py.h5t.find">
<code class="descclassname">h5py.h5t.</code><code class="descname">find</code><span class="sig-paren">(</span><em>TypeID src</em>, <em>TypeID dst</em><span class="sig-paren">)</span> → TUPLE or None<a class="headerlink" href="#h5py.h5t.find" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if a conversion path exists from src to dst. Result is None
or a tuple describing the conversion path. Currently tuple entries are:</p>
<ol class="arabic simple">
<li><dl class="first docutils">
<dt>INT need_bkg: Whether this routine requires a backing buffer.</dt>
<dd>Values are <code class="xref py py-data docutils literal"><span class="pre">BKG_NO</span></code>, BKG_TEMP and <code class="xref py py-data docutils literal"><span class="pre">BKG_YES</span></code>.</dd>
</dl>
</li>
</ol>
</dd></dl>
</div>
<div class="section" id="type-classes">
<h2>Type classes<a class="headerlink" href="#type-classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="h5py.h5t.TypeID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeID</code><a class="headerlink" href="#h5py.h5t.TypeID" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for type identifiers (implements common operations)</p>
<ul class="simple">
<li>Hashable: If committed; in HDF5 1.8.X, also if locked</li>
<li>Equality: Logical <code class="xref py py-data docutils literal"><span class="pre">H5T</span></code> comparison</li>
</ul>
<dl class="method">
<dt id="h5py.h5t.TypeID.commit">
<code class="descname">commit</code><span class="sig-paren">(</span><em>ObjectID group</em>, <em>STRING name</em>, <em>PropID lcpl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeID.commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit this (transient) datatype to a named datatype in a file.
If present, lcpl may be a <a class="reference internal" href="h5p.html#h5py.h5p.PropLCID" title="h5py.h5p.PropLCID"><code class="xref py py-class docutils literal"><span class="pre">link</span> <span class="pre">creation</span> <span class="pre">property</span> <span class="pre">list</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.committed">
<code class="descname">committed</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → BOOL is_comitted<a class="headerlink" href="#h5py.h5t.TypeID.committed" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if a given type object is named (T) or transient (F).</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.TypeID.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a copy of this type object.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.detect_class">
<code class="descname">detect_class</code><span class="sig-paren">(</span><em>INT classtype</em><span class="sig-paren">)</span> → BOOL class_is_present<a class="headerlink" href="#h5py.h5t.TypeID.detect_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if a member of the given class exists in a compound
datatype. The search is recursive.</p>
</dd></dl>
<dl class="attribute">
<dt id="h5py.h5t.TypeID.dtype">
<code class="descname">dtype</code><a class="headerlink" href="#h5py.h5t.TypeID.dtype" title="Permalink to this definition">¶</a></dt>
<dd><p>A Numpy-style dtype object representing this object.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.encode">
<code class="descname">encode</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → STRING<a class="headerlink" href="#h5py.h5t.TypeID.encode" title="Permalink to this definition">¶</a></dt>
<dd><p>Serialize an HDF5 type. Bear in mind you can also use the
native Python pickle/unpickle machinery to do this. The
returned string may contain binary values, including NULLs.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.equal">
<code class="descname">equal</code><span class="sig-paren">(</span><em>TypeID typeid</em><span class="sig-paren">)</span> → BOOL<a class="headerlink" href="#h5py.h5t.TypeID.equal" title="Permalink to this definition">¶</a></dt>
<dd><p>Logical comparison between datatypes. Also called by
Python’s “==” operator.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.get_class">
<code class="descname">get_class</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT classcode<a class="headerlink" href="#h5py.h5t.TypeID.get_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the datatype’s class code.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.get_size">
<code class="descname">get_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT size<a class="headerlink" href="#h5py.h5t.TypeID.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the total size of a datatype, in bytes.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.get_super">
<code class="descname">get_super</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.TypeID.get_super" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the parent type of an array, enumeration or vlen datatype.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.lock">
<code class="descname">lock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeID.lock" title="Permalink to this definition">¶</a></dt>
<dd><p>Lock this datatype, which makes it immutable and indestructible.
Once locked, it can’t be unlocked.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeID.set_size">
<code class="descname">set_size</code><span class="sig-paren">(</span><em>UINT size</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeID.set_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the total size of the datatype, in bytes.</p>
</dd></dl>
</dd></dl>
<div class="section" id="atomic-classes">
<h3>Atomic classes<a class="headerlink" href="#atomic-classes" title="Permalink to this headline">¶</a></h3>
<p>Atomic types are integers and floats. Much of the functionality for each is
inherited from the base class <a class="reference internal" href="#h5py.h5t.TypeAtomicID" title="h5py.h5t.TypeAtomicID"><code class="xref py py-class docutils literal"><span class="pre">TypeAtomicID</span></code></a>.</p>
<dl class="class">
<dt id="h5py.h5t.TypeAtomicID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeAtomicID</code><a class="headerlink" href="#h5py.h5t.TypeAtomicID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>Base class for atomic datatypes (float or integer)</p>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT offset<a class="headerlink" href="#h5py.h5t.TypeAtomicID.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the offset of the first significant bit.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.get_order">
<code class="descname">get_order</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT order<a class="headerlink" href="#h5py.h5t.TypeAtomicID.get_order" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain the byte order of the datatype; one of:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">ORDER_LE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">ORDER_BE</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.get_pad">
<code class="descname">get_pad</code><span class="sig-paren">(</span><em>) -> (INT lsb_pad_code</em>, <em>INT msb_pad_code</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeAtomicID.get_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the padding type. Possible values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ZERO</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ONE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_BACKGROUND</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.get_precision">
<code class="descname">get_precision</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → UINT precision<a class="headerlink" href="#h5py.h5t.TypeAtomicID.get_precision" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the number of significant bits (excludes padding).</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.set_offset">
<code class="descname">set_offset</code><span class="sig-paren">(</span><em>UINT offset</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeAtomicID.set_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset of the first significant bit.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.set_order">
<code class="descname">set_order</code><span class="sig-paren">(</span><em>INT order</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeAtomicID.set_order" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the byte order of the datatype; one of:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">ORDER_LE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">ORDER_BE</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.set_pad">
<code class="descname">set_pad</code><span class="sig-paren">(</span><em>INT lsb_pad_code</em>, <em>INT msb_pad_code</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeAtomicID.set_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the padding type. Possible values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ZERO</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ONE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_BACKGROUND</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeAtomicID.set_precision">
<code class="descname">set_precision</code><span class="sig-paren">(</span><em>UINT precision</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeAtomicID.set_precision" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the number of significant bits (excludes padding).</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeIntegerID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeIntegerID</code><a class="headerlink" href="#h5py.h5t.TypeIntegerID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeAtomicID" title="h5py.h5t.TypeAtomicID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeAtomicID</span></code></a></p>
<p>Integer atomic datatypes</p>
<dl class="method">
<dt id="h5py.h5t.TypeIntegerID.get_sign">
<code class="descname">get_sign</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT sign<a class="headerlink" href="#h5py.h5t.TypeIntegerID.get_sign" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the “signedness” of the datatype; one of:</p>
<dl class="docutils">
<dt><code class="xref py py-data docutils literal"><span class="pre">SGN_NONE</span></code></dt>
<dd>Unsigned</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">SGN_2</span></code></dt>
<dd>Signed 2’s complement</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeIntegerID.set_sign">
<code class="descname">set_sign</code><span class="sig-paren">(</span><em>INT sign</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeIntegerID.set_sign" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the “signedness” of the datatype; one of:</p>
<dl class="docutils">
<dt><code class="xref py py-data docutils literal"><span class="pre">SGN_NONE</span></code></dt>
<dd>Unsigned</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">SGN_2</span></code></dt>
<dd>Signed 2’s complement</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeFloatID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeFloatID</code><a class="headerlink" href="#h5py.h5t.TypeFloatID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeAtomicID" title="h5py.h5t.TypeAtomicID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeAtomicID</span></code></a></p>
<p>Floating-point atomic datatypes</p>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.get_ebias">
<code class="descname">get_ebias</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → UINT ebias<a class="headerlink" href="#h5py.h5t.TypeFloatID.get_ebias" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the exponent bias.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.get_fields">
<code class="descname">get_fields</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → TUPLE field_info<a class="headerlink" href="#h5py.h5t.TypeFloatID.get_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about floating-point bit fields. See the HDF5
docs for a full description. Tuple has the following members:</p>
<ol class="arabic simple" start="0">
<li>UINT spos</li>
<li>UINT epos</li>
<li>UINT esize</li>
<li>UINT mpos</li>
<li>UINT msize</li>
</ol>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.get_inpad">
<code class="descname">get_inpad</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT pad_code<a class="headerlink" href="#h5py.h5t.TypeFloatID.get_inpad" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the internal padding strategy. Legal values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ZERO</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ONE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_BACKGROUND</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.get_norm">
<code class="descname">get_norm</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT normalization_code<a class="headerlink" href="#h5py.h5t.TypeFloatID.get_norm" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the normalization strategy. Legal values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_IMPLIED</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_MSBSET</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_NONE</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.set_ebias">
<code class="descname">set_ebias</code><span class="sig-paren">(</span><em>UINT ebias</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeFloatID.set_ebias" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the exponent bias.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.set_fields">
<code class="descname">set_fields</code><span class="sig-paren">(</span><em>UINT spos</em>, <em>UINT epos</em>, <em>UINT esize</em>, <em>UINT mpos</em>, <em>UINT msize</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeFloatID.set_fields" title="Permalink to this definition">¶</a></dt>
<dd><p>Set floating-point bit fields. Refer to the HDF5 docs for
argument definitions.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.set_inpad">
<code class="descname">set_inpad</code><span class="sig-paren">(</span><em>INT pad_code</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeFloatID.set_inpad" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the internal padding strategy. Legal values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ZERO</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_ONE</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">PAD_BACKGROUND</span></code></li>
</ul>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeFloatID.set_norm">
<code class="descname">set_norm</code><span class="sig-paren">(</span><em>INT normalization_code</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeFloatID.set_norm" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the normalization strategy. Legal values are:</p>
<ul class="simple">
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_IMPLIED</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_MSBSET</span></code></li>
<li><code class="xref py py-data docutils literal"><span class="pre">NORM_NONE</span></code></li>
</ul>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="strings">
<h3>Strings<a class="headerlink" href="#strings" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="h5py.h5t.TypeStringID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeStringID</code><a class="headerlink" href="#h5py.h5t.TypeStringID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>String datatypes, both fixed and vlen.</p>
<dl class="method">
<dt id="h5py.h5t.TypeStringID.get_cset">
<code class="descname">get_cset</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT character_set<a class="headerlink" href="#h5py.h5t.TypeStringID.get_cset" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the character set used for a string.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeStringID.get_strpad">
<code class="descname">get_strpad</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT padding_type<a class="headerlink" href="#h5py.h5t.TypeStringID.get_strpad" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the padding type. Legal values are:</p>
<dl class="docutils">
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_NULLTERM</span></code></dt>
<dd>NULL termination only (C style)</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_NULLPAD</span></code></dt>
<dd>Pad buffer with NULLs</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_SPACEPAD</span></code></dt>
<dd>Pad buffer with spaces (FORTRAN style)</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeStringID.is_variable_str">
<code class="descname">is_variable_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → BOOL is_variable<a class="headerlink" href="#h5py.h5t.TypeStringID.is_variable_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if the given string datatype is a variable-length string.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeStringID.set_cset">
<code class="descname">set_cset</code><span class="sig-paren">(</span><em>INT character_set</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeStringID.set_cset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the character set used for a string.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeStringID.set_strpad">
<code class="descname">set_strpad</code><span class="sig-paren">(</span><em>INT pad</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeStringID.set_strpad" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the padding type. Legal values are:</p>
<dl class="docutils">
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_NULLTERM</span></code></dt>
<dd>NULL termination only (C style)</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_NULLPAD</span></code></dt>
<dd>Pad buffer with NULLs</dd>
<dt><code class="xref py py-data docutils literal"><span class="pre">STR_SPACEPAD</span></code></dt>
<dd>Pad buffer with spaces (FORTRAN style)</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="compound-types">
<h3>Compound Types<a class="headerlink" href="#compound-types" title="Permalink to this headline">¶</a></h3>
<p>Traditional compound type (like NumPy record type) and enumerated types share
a base class, <a class="reference internal" href="#h5py.h5t.TypeCompositeID" title="h5py.h5t.TypeCompositeID"><code class="xref py py-class docutils literal"><span class="pre">TypeCompositeID</span></code></a>.</p>
<dl class="class">
<dt id="h5py.h5t.TypeCompositeID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeCompositeID</code><a class="headerlink" href="#h5py.h5t.TypeCompositeID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>Base class for enumerated and compound types.</p>
<dl class="method">
<dt id="h5py.h5t.TypeCompositeID.get_member_index">
<code class="descname">get_member_index</code><span class="sig-paren">(</span><em>STRING name</em><span class="sig-paren">)</span> → INT index<a class="headerlink" href="#h5py.h5t.TypeCompositeID.get_member_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the index of a member of a compound or enumerated datatype
identified by a string name.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompositeID.get_member_name">
<code class="descname">get_member_name</code><span class="sig-paren">(</span><em>INT member</em><span class="sig-paren">)</span> → STRING name<a class="headerlink" href="#h5py.h5t.TypeCompositeID.get_member_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the name of a member of a compound or enumerated type,
identified by its index (0 <= member < nmembers).</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompositeID.get_nmembers">
<code class="descname">get_nmembers</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT number_of_members<a class="headerlink" href="#h5py.h5t.TypeCompositeID.get_nmembers" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the number of members in a compound or enumerated type.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeCompoundID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeCompoundID</code><a class="headerlink" href="#h5py.h5t.TypeCompoundID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeCompositeID" title="h5py.h5t.TypeCompositeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeCompositeID</span></code></a></p>
<p>Represents a compound datatype</p>
<dl class="method">
<dt id="h5py.h5t.TypeCompoundID.get_member_class">
<code class="descname">get_member_class</code><span class="sig-paren">(</span><em>INT member</em><span class="sig-paren">)</span> → INT class<a class="headerlink" href="#h5py.h5t.TypeCompoundID.get_member_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the datatype class of the member of a compound type,
identified by its index (0 <= member < nmembers).</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompoundID.get_member_offset">
<code class="descname">get_member_offset</code><span class="sig-paren">(</span><em>INT member</em><span class="sig-paren">)</span> → INT offset<a class="headerlink" href="#h5py.h5t.TypeCompoundID.get_member_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the offset, in bytes, of the beginning of the specified
member of a compound datatype.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompoundID.get_member_type">
<code class="descname">get_member_type</code><span class="sig-paren">(</span><em>INT member</em><span class="sig-paren">)</span> → TypeID<a class="headerlink" href="#h5py.h5t.TypeCompoundID.get_member_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a copy of a member of a compound datatype, identified by its
index.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompoundID.insert">
<code class="descname">insert</code><span class="sig-paren">(</span><em>STRING name</em>, <em>UINT offset</em>, <em>TypeID field</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeCompoundID.insert" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a named member datatype to a compound datatype. The parameter
offset indicates the offset from the start of the compound datatype,
in bytes.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeCompoundID.pack">
<code class="descname">pack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeCompoundID.pack" title="Permalink to this definition">¶</a></dt>
<dd><p>Recursively removes padding (introduced on account of e.g. compiler
alignment rules) from a compound datatype.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeEnumID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeEnumID</code><a class="headerlink" href="#h5py.h5t.TypeEnumID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeCompositeID" title="h5py.h5t.TypeCompositeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeCompositeID</span></code></a></p>
<p>Represents an enumerated type</p>
<dl class="method">
<dt id="h5py.h5t.TypeEnumID.enum_insert">
<code class="descname">enum_insert</code><span class="sig-paren">(</span><em>STRING name</em>, <em>INT/LONG value</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeEnumID.enum_insert" title="Permalink to this definition">¶</a></dt>
<dd><p>Define a new member of an enumerated type. The value will be
automatically converted to the base type defined for this enum. If
the conversion results in overflow, the value will be silently
clipped.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeEnumID.enum_nameof">
<code class="descname">enum_nameof</code><span class="sig-paren">(</span><em>LONG value</em><span class="sig-paren">)</span> → STRING name<a class="headerlink" href="#h5py.h5t.TypeEnumID.enum_nameof" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the name associated with the given value. Due to a
limitation of the HDF5 library, this can only retrieve names up to
1023 characters in length.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeEnumID.enum_valueof">
<code class="descname">enum_valueof</code><span class="sig-paren">(</span><em>STRING name</em><span class="sig-paren">)</span> → LONG value<a class="headerlink" href="#h5py.h5t.TypeEnumID.enum_valueof" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the value associated with an enum name.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeEnumID.get_member_value">
<code class="descname">get_member_value</code><span class="sig-paren">(</span><em>UINT index</em><span class="sig-paren">)</span> → LONG value<a class="headerlink" href="#h5py.h5t.TypeEnumID.get_member_value" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine the value for the member at the given zero-based index.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="other-types">
<h3>Other types<a class="headerlink" href="#other-types" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="h5py.h5t.TypeArrayID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeArrayID</code><a class="headerlink" href="#h5py.h5t.TypeArrayID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>Represents an array datatype</p>
<dl class="method">
<dt id="h5py.h5t.TypeArrayID.get_array_dims">
<code class="descname">get_array_dims</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → TUPLE dimensions<a class="headerlink" href="#h5py.h5t.TypeArrayID.get_array_dims" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the dimensions of the given array datatype as
a tuple of integers.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeArrayID.get_array_ndims">
<code class="descname">get_array_ndims</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → INT rank<a class="headerlink" href="#h5py.h5t.TypeArrayID.get_array_ndims" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the rank of the given array datatype.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeOpaqueID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeOpaqueID</code><a class="headerlink" href="#h5py.h5t.TypeOpaqueID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>Represents an opaque type</p>
<dl class="method">
<dt id="h5py.h5t.TypeOpaqueID.get_tag">
<code class="descname">get_tag</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → STRING tag<a class="headerlink" href="#h5py.h5t.TypeOpaqueID.get_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the tag associated with an opaque datatype.</p>
</dd></dl>
<dl class="method">
<dt id="h5py.h5t.TypeOpaqueID.set_tag">
<code class="descname">set_tag</code><span class="sig-paren">(</span><em>STRING tag</em><span class="sig-paren">)</span><a class="headerlink" href="#h5py.h5t.TypeOpaqueID.set_tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a string describing the contents of an opaque datatype.
Limited to 256 characters.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeVlenID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeVlenID</code><a class="headerlink" href="#h5py.h5t.TypeVlenID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>Non-string vlen datatypes.</p>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeBitfieldID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeBitfieldID</code><a class="headerlink" href="#h5py.h5t.TypeBitfieldID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>HDF5 bitfield type</p>
</dd></dl>
<dl class="class">
<dt id="h5py.h5t.TypeReferenceID">
<em class="property">class </em><code class="descclassname">h5py.h5t.</code><code class="descname">TypeReferenceID</code><a class="headerlink" href="#h5py.h5t.TypeReferenceID" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#h5py.h5t.TypeID" title="h5py.h5t.TypeID"><code class="xref py py-class docutils literal"><span class="pre">h5py.h5t.TypeID</span></code></a></p>
<p>HDF5 object or region reference</p>
</dd></dl>
</div>
</div>
<div class="section" id="predefined-datatypes">
<h2>Predefined Datatypes<a class="headerlink" href="#predefined-datatypes" title="Permalink to this headline">¶</a></h2>
<p>These locked types are pre-allocated by the library.</p>
<div class="section" id="floating-point">
<h3>Floating-point<a class="headerlink" href="#floating-point" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.IEEE_F32LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">IEEE_F32LE</code><a class="headerlink" href="#h5py.h5t.IEEE_F32LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.IEEE_F32BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">IEEE_F32BE</code><a class="headerlink" href="#h5py.h5t.IEEE_F32BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.IEEE_F64LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">IEEE_F64LE</code><a class="headerlink" href="#h5py.h5t.IEEE_F64LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.IEEE_F64BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">IEEE_F64BE</code><a class="headerlink" href="#h5py.h5t.IEEE_F64BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="integer-types">
<h3>Integer types<a class="headerlink" href="#integer-types" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.STD_I8LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I8LE</code><a class="headerlink" href="#h5py.h5t.STD_I8LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I16LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I16LE</code><a class="headerlink" href="#h5py.h5t.STD_I16LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I32LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I32LE</code><a class="headerlink" href="#h5py.h5t.STD_I32LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I64LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I64LE</code><a class="headerlink" href="#h5py.h5t.STD_I64LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I8BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I8BE</code><a class="headerlink" href="#h5py.h5t.STD_I8BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I16BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I16BE</code><a class="headerlink" href="#h5py.h5t.STD_I16BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I32BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I32BE</code><a class="headerlink" href="#h5py.h5t.STD_I32BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_I64BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_I64BE</code><a class="headerlink" href="#h5py.h5t.STD_I64BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U8LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U8LE</code><a class="headerlink" href="#h5py.h5t.STD_U8LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U16LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U16LE</code><a class="headerlink" href="#h5py.h5t.STD_U16LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U32LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U32LE</code><a class="headerlink" href="#h5py.h5t.STD_U32LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U64LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U64LE</code><a class="headerlink" href="#h5py.h5t.STD_U64LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U8BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U8BE</code><a class="headerlink" href="#h5py.h5t.STD_U8BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U16BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U16BE</code><a class="headerlink" href="#h5py.h5t.STD_U16BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U32BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U32BE</code><a class="headerlink" href="#h5py.h5t.STD_U32BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_U64BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_U64BE</code><a class="headerlink" href="#h5py.h5t.STD_U64BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_INT8">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_INT8</code><a class="headerlink" href="#h5py.h5t.NATIVE_INT8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_UINT8">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_UINT8</code><a class="headerlink" href="#h5py.h5t.NATIVE_UINT8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_INT16">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_INT16</code><a class="headerlink" href="#h5py.h5t.NATIVE_INT16" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_UINT16">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_UINT16</code><a class="headerlink" href="#h5py.h5t.NATIVE_UINT16" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_INT32">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_INT32</code><a class="headerlink" href="#h5py.h5t.NATIVE_INT32" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_UINT32">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_UINT32</code><a class="headerlink" href="#h5py.h5t.NATIVE_UINT32" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_INT64">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_INT64</code><a class="headerlink" href="#h5py.h5t.NATIVE_INT64" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_UINT64">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_UINT64</code><a class="headerlink" href="#h5py.h5t.NATIVE_UINT64" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_FLOAT">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_FLOAT</code><a class="headerlink" href="#h5py.h5t.NATIVE_FLOAT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NATIVE_DOUBLE">
<code class="descclassname">h5py.h5t.</code><code class="descname">NATIVE_DOUBLE</code><a class="headerlink" href="#h5py.h5t.NATIVE_DOUBLE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="reference-types">
<h3>Reference types<a class="headerlink" href="#reference-types" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.STD_REF_OBJ">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_REF_OBJ</code><a class="headerlink" href="#h5py.h5t.STD_REF_OBJ" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STD_REF_DSETREG">
<code class="descclassname">h5py.h5t.</code><code class="descname">STD_REF_DSETREG</code><a class="headerlink" href="#h5py.h5t.STD_REF_DSETREG" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="string-types">
<h3>String types<a class="headerlink" href="#string-types" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.C_S1">
<code class="descclassname">h5py.h5t.</code><code class="descname">C_S1</code><a class="headerlink" href="#h5py.h5t.C_S1" title="Permalink to this definition">¶</a></dt>
<dd><p>Null-terminated fixed-length string</p>
</dd></dl>
<dl class="data">
<dt id="h5py.h5t.FORTRAN_S1">
<code class="descclassname">h5py.h5t.</code><code class="descname">FORTRAN_S1</code><a class="headerlink" href="#h5py.h5t.FORTRAN_S1" title="Permalink to this definition">¶</a></dt>
<dd><p>Zero-padded fixed-length string</p>
</dd></dl>
<dl class="data">
<dt id="h5py.h5t.VARIABLE">
<code class="descclassname">h5py.h5t.</code><code class="descname">VARIABLE</code><a class="headerlink" href="#h5py.h5t.VARIABLE" title="Permalink to this definition">¶</a></dt>
<dd><p>Variable-length string</p>
</dd></dl>
</div>
<div class="section" id="python-object-type">
<h3>Python object type<a class="headerlink" href="#python-object-type" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.PYTHON_OBJECT">
<code class="descclassname">h5py.h5t.</code><code class="descname">PYTHON_OBJECT</code><a class="headerlink" href="#h5py.h5t.PYTHON_OBJECT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
<div class="section" id="module-constants">
<h2>Module constants<a class="headerlink" href="#module-constants" title="Permalink to this headline">¶</a></h2>
<div class="section" id="datatype-class-codes">
<h3>Datatype class codes<a class="headerlink" href="#datatype-class-codes" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.NO_CLASS">
<code class="descclassname">h5py.h5t.</code><code class="descname">NO_CLASS</code><a class="headerlink" href="#h5py.h5t.NO_CLASS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.INTEGER">
<code class="descclassname">h5py.h5t.</code><code class="descname">INTEGER</code><a class="headerlink" href="#h5py.h5t.INTEGER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.FLOAT">
<code class="descclassname">h5py.h5t.</code><code class="descname">FLOAT</code><a class="headerlink" href="#h5py.h5t.FLOAT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.TIME">
<code class="descclassname">h5py.h5t.</code><code class="descname">TIME</code><a class="headerlink" href="#h5py.h5t.TIME" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STRING">
<code class="descclassname">h5py.h5t.</code><code class="descname">STRING</code><a class="headerlink" href="#h5py.h5t.STRING" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.BITFIELD">
<code class="descclassname">h5py.h5t.</code><code class="descname">BITFIELD</code><a class="headerlink" href="#h5py.h5t.BITFIELD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.OPAQUE">
<code class="descclassname">h5py.h5t.</code><code class="descname">OPAQUE</code><a class="headerlink" href="#h5py.h5t.OPAQUE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.COMPOUND">
<code class="descclassname">h5py.h5t.</code><code class="descname">COMPOUND</code><a class="headerlink" href="#h5py.h5t.COMPOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.REFERENCE">
<code class="descclassname">h5py.h5t.</code><code class="descname">REFERENCE</code><a class="headerlink" href="#h5py.h5t.REFERENCE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ENUM">
<code class="descclassname">h5py.h5t.</code><code class="descname">ENUM</code><a class="headerlink" href="#h5py.h5t.ENUM" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.VLEN">
<code class="descclassname">h5py.h5t.</code><code class="descname">VLEN</code><a class="headerlink" href="#h5py.h5t.VLEN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ARRAY">
<code class="descclassname">h5py.h5t.</code><code class="descname">ARRAY</code><a class="headerlink" href="#h5py.h5t.ARRAY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="api-constants">
<h3>API Constants<a class="headerlink" href="#api-constants" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="h5py.h5t.SGN_NONE">
<code class="descclassname">h5py.h5t.</code><code class="descname">SGN_NONE</code><a class="headerlink" href="#h5py.h5t.SGN_NONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.SGN_2">
<code class="descclassname">h5py.h5t.</code><code class="descname">SGN_2</code><a class="headerlink" href="#h5py.h5t.SGN_2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ORDER_LE">
<code class="descclassname">h5py.h5t.</code><code class="descname">ORDER_LE</code><a class="headerlink" href="#h5py.h5t.ORDER_LE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ORDER_BE">
<code class="descclassname">h5py.h5t.</code><code class="descname">ORDER_BE</code><a class="headerlink" href="#h5py.h5t.ORDER_BE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ORDER_VAX">
<code class="descclassname">h5py.h5t.</code><code class="descname">ORDER_VAX</code><a class="headerlink" href="#h5py.h5t.ORDER_VAX" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ORDER_NONE">
<code class="descclassname">h5py.h5t.</code><code class="descname">ORDER_NONE</code><a class="headerlink" href="#h5py.h5t.ORDER_NONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.ORDER_NATIVE">
<code class="descclassname">h5py.h5t.</code><code class="descname">ORDER_NATIVE</code><a class="headerlink" href="#h5py.h5t.ORDER_NATIVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.DIR_DEFAULT">
<code class="descclassname">h5py.h5t.</code><code class="descname">DIR_DEFAULT</code><a class="headerlink" href="#h5py.h5t.DIR_DEFAULT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.DIR_ASCEND">
<code class="descclassname">h5py.h5t.</code><code class="descname">DIR_ASCEND</code><a class="headerlink" href="#h5py.h5t.DIR_ASCEND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.DIR_DESCEND">
<code class="descclassname">h5py.h5t.</code><code class="descname">DIR_DESCEND</code><a class="headerlink" href="#h5py.h5t.DIR_DESCEND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STR_NULLTERM">
<code class="descclassname">h5py.h5t.</code><code class="descname">STR_NULLTERM</code><a class="headerlink" href="#h5py.h5t.STR_NULLTERM" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STR_NULLPAD">
<code class="descclassname">h5py.h5t.</code><code class="descname">STR_NULLPAD</code><a class="headerlink" href="#h5py.h5t.STR_NULLPAD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.STR_SPACEPAD">
<code class="descclassname">h5py.h5t.</code><code class="descname">STR_SPACEPAD</code><a class="headerlink" href="#h5py.h5t.STR_SPACEPAD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NORM_IMPLIED">
<code class="descclassname">h5py.h5t.</code><code class="descname">NORM_IMPLIED</code><a class="headerlink" href="#h5py.h5t.NORM_IMPLIED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NORM_MSBSET">
<code class="descclassname">h5py.h5t.</code><code class="descname">NORM_MSBSET</code><a class="headerlink" href="#h5py.h5t.NORM_MSBSET" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.NORM_NONE">
<code class="descclassname">h5py.h5t.</code><code class="descname">NORM_NONE</code><a class="headerlink" href="#h5py.h5t.NORM_NONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.CSET_ASCII">
<code class="descclassname">h5py.h5t.</code><code class="descname">CSET_ASCII</code><a class="headerlink" href="#h5py.h5t.CSET_ASCII" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.CSET_UTF8">
<code class="descclassname">h5py.h5t.</code><code class="descname">CSET_UTF8</code><a class="headerlink" href="#h5py.h5t.CSET_UTF8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.PAD_ZERO">
<code class="descclassname">h5py.h5t.</code><code class="descname">PAD_ZERO</code><a class="headerlink" href="#h5py.h5t.PAD_ZERO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.PAD_ONE">
<code class="descclassname">h5py.h5t.</code><code class="descname">PAD_ONE</code><a class="headerlink" href="#h5py.h5t.PAD_ONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.PAD_BACKGROUND">
<code class="descclassname">h5py.h5t.</code><code class="descname">PAD_BACKGROUND</code><a class="headerlink" href="#h5py.h5t.PAD_BACKGROUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.BKG_NO">
<code class="descclassname">h5py.h5t.</code><code class="descname">BKG_NO</code><a class="headerlink" href="#h5py.h5t.BKG_NO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.BKG_TEMP">
<code class="descclassname">h5py.h5t.</code><code class="descname">BKG_TEMP</code><a class="headerlink" href="#h5py.h5t.BKG_TEMP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="h5py.h5t.BKG_YES">
<code class="descclassname">h5py.h5t.</code><code class="descname">BKG_YES</code><a class="headerlink" href="#h5py.h5t.BKG_YES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</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="#">Module H5T</a><ul>
<li><a class="reference internal" href="#functions-specific-to-h5py">Functions specific to h5py</a></li>
<li><a class="reference internal" href="#functional-api">Functional API</a></li>
<li><a class="reference internal" href="#type-classes">Type classes</a><ul>
<li><a class="reference internal" href="#atomic-classes">Atomic classes</a></li>
<li><a class="reference internal" href="#strings">Strings</a></li>
<li><a class="reference internal" href="#compound-types">Compound Types</a></li>
<li><a class="reference internal" href="#other-types">Other types</a></li>
</ul>
</li>
<li><a class="reference internal" href="#predefined-datatypes">Predefined Datatypes</a><ul>
<li><a class="reference internal" href="#floating-point">Floating-point</a></li>
<li><a class="reference internal" href="#integer-types">Integer types</a></li>
<li><a class="reference internal" href="#reference-types">Reference types</a></li>
<li><a class="reference internal" href="#string-types">String types</a></li>
<li><a class="reference internal" href="#python-object-type">Python object type</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-constants">Module constants</a><ul>
<li><a class="reference internal" href="#datatype-class-codes">Datatype class codes</a></li>
<li><a class="reference internal" href="#api-constants">API Constants</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="h5s.html"
title="previous chapter">Module H5S</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="h5z.html"
title="next chapter">Module H5Z</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/h5t.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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="h5z.html" title="Module H5Z"
>next</a> |</li>
<li class="right" >
<a href="h5s.html" title="Module H5S"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Low-level API for h5py</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Andrew Collette and contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
|