Search.setIndex({"docnames": ["api", "compression", "development", "hdf5storage", "hdf5storage.Marshallers", "hdf5storage.lowlevel", "hdf5storage.utilities", "index", "information", "introduction", "storage_format"], "filenames": ["api.rst", "compression.rst", "development.rst", "hdf5storage.rst", "hdf5storage.Marshallers.rst", "hdf5storage.lowlevel.rst", "hdf5storage.utilities.rst", "index.rst", "information.rst", "introduction.rst", "storage_format.rst"], "titles": ["API", "Compression", "Development Information", "hdf5storage", "hdf5storage.Marshallers", "hdf5storage.lowlevel", "hdf5storage.utilities", "Welcome to hdf5storage\u2019s documentation!", "hdf5storage", "Introduction", "Storage Format"], "terms": {"hdf5storag": [0, 2, 9], "write": [0, 1, 2, 4, 5, 6, 7, 8, 10], "read": [0, 2, 4, 5, 6, 7, 8], "savemat": [0, 1, 8, 9], "loadmat": [0, 8, 9], "option": [0, 1, 2, 4, 5, 6, 7, 8], "marshallercollect": [0, 2], "lowlevel": [0, 2, 3, 4, 7, 9], "hdf5storageerror": 0, "cantreaderror": [0, 3], "typenotmatlabcompatibleerror": [0, 3, 4, 9], "write_data": [0, 2, 3, 4], "read_data": [0, 2, 3, 4], "marshal": [0, 2, 3, 7, 8], "write_object_arrai": 0, "read_object_arrai": 0, "typemarshal": [0, 2, 3], "numpyscalararraymarshal": [0, 2], "pythonscalarmarshal": 0, "pythonstringmarshal": 0, "pythonnonemarshal": 0, "pythondictmarshal": [0, 2], "pythonlistmarshal": 0, "pythontuplesetdequemarshal": 0, "util": [0, 1, 2, 7, 8], "numpy_to_byt": 0, "does_dtype_have_a_zero_shap": 0, "next_unused_name_in_group": [0, 2], "convert_numpy_str_to_uint16": 0, "convert_numpy_str_to_uint32": 0, "convert_to_str": 0, "convert_to_numpy_str": 0, "convert_to_numpy_byt": 0, "decode_complex": 0, "encode_complex": 0, "get_attribut": 0, "get_attribute_str": 0, "get_attribute_string_arrai": 0, "read_all_attributes_into": 0, "read_matlab_fields_attribut": 0, "set_attribut": 0, "set_attribute_str": 0, "set_attribute_string_arrai": 0, "del_attribut": 0, "hdf5": [1, 2, 3, 4, 5, 6, 7, 9, 10], "librari": [1, 8], "h5py": [1, 2, 3, 4, 5, 6, 8, 10], "modul": [1, 2, 3, 4, 5, 6, 7, 9], "support": [1, 2, 3, 4, 5, 6, 7, 9, 10], "transpar": [1, 9], "file": [1, 2, 3, 4, 5, 6, 7], "can": [1, 2, 3, 4, 6, 8, 9, 10], "sometim": [1, 9], "drastic": 1, "reduc": [1, 8], "often": 1, "make": [1, 2, 3, 4, 6, 10], "faster": [1, 3], "from": [1, 2, 3, 4, 5, 6, 7, 9], "though": [1, 9, 10], "all": [1, 2, 3, 4, 6, 8, 9, 10], "veri": [1, 3, 8], "well": [1, 2, 3, 8, 10], "occassion": 1, "end": [1, 3, 8, 10], "up": [1, 3, 4, 10], "larger": [1, 3, 8, 9], "after": [1, 2, 3, 8, 9, 10], "than": [1, 2, 3, 6, 8, 9, 10], "wa": [1, 3, 8, 9, 10], "uncompress": [1, 3], "doe": [1, 2, 6, 8, 9, 10], "cost": 1, "cpu": 1, "time": [1, 2, 8, 9], "both": [1, 8, 10], "when": [1, 2, 3, 4, 5, 6, 8, 9, 10], "decompress": 1, "reason": [1, 3, 6, 10], "thi": [1, 2, 3, 4, 5, 6, 8, 9, 10], "lead": [1, 3], "i": [1, 2, 3, 4, 5, 6, 7, 8, 9], "becaus": [1, 2, 4, 6, 8, 9, 10], "disk": [1, 3, 4, 9], "ar": [1, 2, 3, 4, 6, 8, 9, 10], "slow": 1, "space": [1, 10], "save": [1, 2, 3, 8], "enough": [1, 3, 6, 8, 10], "access": 1, "version": [1, 2, 3, 4, 5, 6, 7, 9, 10], "packag": [1, 3, 5, 7, 8, 9, 10], "new": [1, 6, 8, 9], "0": [1, 2, 3, 6, 8, 9, 10], "1": [1, 2, 3, 6, 8, 9, 10], "9": [1, 3, 8, 9, 10], "featur": [1, 8], "ad": [1, 2, 3, 8, 9, 10], "along": [1, 3, 6], "sever": [1, 2, 3, 4, 7, 8], "7": [1, 3, 8, 9, 10], "take": [1, 2, 8, 9], "ignor": [1, 2, 3, 6, 8, 9, 10], "them": [1, 2, 3, 4, 6, 8, 9, 10], "pass": [1, 3, 8, 9], "earlier": [1, 3, 8], "result": [1, 3, 6, 8, 9, 10], "an": [1, 2, 3, 4, 5, 6, 8, 9, 10], "error": [1, 3, 4, 5, 8, 9, 10], "which": [1, 2, 3, 4, 6, 8, 9, 10], "default": [1, 3, 4, 9, 10], "true": [1, 3, 4, 9, 10], "x": [1, 6, 8, 10], "where": [1, 3, 6, 8, 9, 10], "fals": [1, 3, 4, 8, 9, 10], "Not": [1, 8], "python": [1, 2, 3, 4, 5, 6, 7], "object": [1, 2, 3, 4, 6, 8, 9, 10], "written": [1, 2, 3, 4, 5, 6, 8, 9, 10], "even": [1, 9], "For": [1, 3, 4, 6, 8, 10], "one": [1, 2, 3, 4, 6, 8, 9, 10], "numpi": [1, 2, 3, 4, 6, 8, 9], "scalar": [1, 3, 6, 8, 10], "ani": [1, 2, 3, 4, 5, 6, 8, 10], "type": [1, 2, 3, 4, 5, 6, 7, 9], "store": [1, 3, 4, 5, 6, 7, 8, 9], "do": [1, 2, 3, 4, 6, 8, 9, 10], "due": [1, 3, 8, 10], "limit": [1, 8], "would": [1, 2, 3, 4, 6, 8, 9, 10], "wast": 1, "henc": 1, "lack": 1, "small": [1, 3, 8, 9, 10], "piec": [1, 3, 5, 8, 9, 10], "have": [1, 2, 3, 4, 6, 8, 9, 10], "particular": [1, 10], "befor": [1, 3, 8, 9, 10], "threshold": 1, "byte": [1, 3, 4, 6, 8, 10], "compress_size_threshold": [1, 3], "non": [1, 3, 4, 5, 8, 9, 10], "neg": [1, 3], "integ": [1, 3, 6, 8, 10], "valu": [1, 3, 4, 5, 6, 8, 9, 10], "16": [1, 3, 6, 8, 9, 10], "kb": [1, 9], "mani": [1, 2, 3, 6, 8, 9, 10], "onli": [1, 2, 3, 6, 8, 9, 10], "three": [1, 9], "common": [1, 3, 6], "deflat": [1, 3, 9], "known": [1, 3], "gzip": [1, 3, 9], "lzf": [1, 3], "szip": [1, 3], "explicitli": [1, 6, 8, 9], "setup": [1, 3, 8], "ha": [1, 3, 6, 8, 9, 10], "mechan": 1, "addit": [1, 2, 3, 4, 8, 10], "popular": 1, "ones": [1, 2, 3, 10], "includ": [1, 3, 4, 6, 7, 8, 10], "bzip2": 1, "blosc": 1, "compression_algorithm": [1, 3], "str": [1, 3, 4, 5, 6, 8, 9, 10], "name": [1, 2, 3, 4, 5, 6, 8, 9, 10], "correspond": [1, 3, 10], "As": [1, 3, 6, 8, 9], "2": [1, 2, 3, 6, 7, 10], "If": [1, 2, 3, 4, 5, 6, 8, 9, 10], "matlab": [1, 2, 3, 4, 5, 7], "compat": [1, 3, 4, 5, 8, 9, 10], "matlab_compat": [1, 3, 4, 5, 8, 10], "more": [1, 2, 3, 6, 8, 9], "detail": [1, 10], "seen": 1, "unix": [1, 8, 9], "linux": 1, "most": [1, 2, 3, 9, 10], "zip": [1, 3], "It": [1, 2, 3, 8, 9, 10], "achiev": 1, "good": [1, 3], "fast": [1, 3], "patent": [1, 3], "licens": [1, 3, 8], "restrict": [1, 3], "A": [1, 2, 3, 4, 6, 9, 10], "inferior": 1, "less": [1, 3, 10], "commonli": [1, 3, 8], "similarli": 1, "isn": [1, 6, 9], "t": [1, 2, 3, 4, 6, 8, 9, 10], "alwai": [1, 3, 8, 10], "avail": [1, 3, 6, 8, 10], "see": [1, 3, 8, 9, 10], "being": [1, 3, 4, 5, 6, 8, 9, 10], "adjust": 1, "gzip_compression_level": [1, 3], "between": [1, 2, 3], "inclus": [1, 3], "lowest": 1, "fastest": 1, "give": [1, 2, 3, 6, 8, 9, 10], "best": 1, "slowest": 1, "filter": [1, 3, 8], "help": [1, 2], "better": [1, 3], "rel": 1, "low": [1, 2, 3, 5], "shuffl": [1, 3], "shuffle_filt": [1, 3], "fletcher32": [1, 3], "calcul": 1, "These": [1, 4, 8, 9], "check": [1, 6, 8, 10], "catch": 1, "corrupt": [1, 3], "caus": [1, 8, 9, 10], "inform": [1, 3, 4, 7, 8, 9], "user": [1, 2, 3], "disabl": 1, "separ": [1, 9], "e": [1, 3, 9, 10], "g": [1, 3, 9, 10], "": [1, 2, 3, 4, 6, 8, 9, 10], "smaller": 1, "compressed_fletcher32_filt": [1, 3], "uncompressed_fletcher32_filt": [1, 3], "comput": [1, 10], "anyth": [1, 3, 10], "contigu": 1, "manner": 1, "requir": [1, 2, 3, 4, 8, 10], "storag": [1, 7, 8], "determin": [1, 3, 6, 8], "automat": [1, 3, 5, 9, 10], "autochunk": 1, "speed": 1, "differ": [1, 2, 3, 4, 6, 7, 8, 10], "affect": 1, "ratio": 1, "dataset": [1, 2, 3, 4, 6, 8, 9, 10], "pipelin": 1, "descript": 1, "faq": 1, "hdf": 1, "group": [1, 2, 3, 4, 5, 6, 8, 9, 10], "tutori": 1, "learn": 1, "basic": 1, "layout": 1, "format": [1, 2, 3, 6, 7, 9], "IN": 1, "product": 1, "3rd": 1, "parti": 1, "list": [1, 3, 4, 6, 8, 9, 10], "The": [2, 3, 4, 5, 6, 7, 8, 10], "sourc": [2, 3, 4, 5, 6, 10], "code": [2, 8, 10], "found": [2, 3, 8, 10], "github": [2, 8], "http": [2, 8], "com": [2, 8], "frejanordsiek": [2, 8], "current": [2, 4, 6, 9, 10], "pure": 2, "us": [2, 3, 4, 5, 6, 7, 8, 10], "cython": 2, "c": [2, 3, 9, 10], "other": [2, 3, 4, 6, 8, 9, 10], "languag": [2, 9], "also": [2, 3, 8, 9, 10], "pickl": [2, 8, 10], "should": [2, 3, 4, 6, 9, 10], "secur": [2, 8, 10], "risk": [2, 10], "sinc": [2, 8, 9, 10], "data": [2, 3, 4, 5, 6, 7], "through": [2, 3, 10], "interpret": [2, 8, 10], "allow": [2, 3, 8, 9, 10], "arbitrari": [2, 6, 8, 10], "could": [2, 3, 8, 9, 10], "malici": [2, 10], "execut": [2, 8, 10], "One": [2, 8, 10], "want": [2, 3, 8, 9, 10], "abl": [2, 4, 8, 9, 10], "possibli": [2, 6, 8, 10], "mat": [2, 3, 4, 7], "untrust": [2, 8, 10], "so": [2, 3, 4, 6, 8, 9, 10], "avoid": [2, 8, 10], "contain": [2, 3, 4, 8, 9], "high": [2, 3, 8], "level": [2, 3, 5, 7, 8, 9], "function": [2, 3, 4, 5, 6, 7, 8], "class": [2, 3, 4, 5, 8, 9, 10], "encapsul": 2, "variou": [2, 3, 6, 9], "govern": [2, 3], "how": [2, 3, 6, 7, 9], "either": [2, 5, 8, 9, 10], "given": [2, 3, 4, 6, 8, 9, 10], "keyword": [2, 3, 8, 9], "argument": [2, 3, 6, 8, 9], "its": [2, 3, 4, 6, 8, 9, 10], "constructur": 2, "thei": [2, 3, 4, 6, 8, 9, 10], "those": [2, 4, 6, 8, 10], "There": [2, 3, 8, 9], "hold": [2, 3, 8, 10], "below": [2, 3, 8, 10], "provid": [2, 3, 4, 8, 9], "find": [2, 4, 10], "appropri": [2, 3, 4, 9], "string": [2, 3, 4, 5, 6, 8, 9, 10], "attribut": [2, 3, 4, 6, 7, 8], "matlab_class": [2, 3, 4, 8, 10], "collect": [2, 3, 4, 8, 10], "work": [2, 4, 8, 9], "alreadi": [2, 3, 6], "open": [2, 3, 4, 5, 8, 9], "handl": [2, 3, 4, 6, 8, 10], "creation": 2, "individu": [2, 9, 10], "need": [2, 3, 4, 6, 9, 10], "nest": 2, "within": [2, 10], "must": [2, 3, 4, 6, 8, 9, 10], "call": [2, 3, 4, 6, 8, 9], "automit": 2, "inspect": 2, "grab": [2, 9], "modifi": 2, "same": [2, 3, 6, 8, 9, 10], "interfac": [2, 3, 4, 8], "base": [2, 3, 4, 5, 8, 9], "probabl": [2, 3, 4], "inherit": [2, 3, 4], "custom": 2, "while": [2, 3, 9], "some": [2, 3, 6, 8, 9, 10], "built": [2, 8], "main": [2, 7, 8], "convert": [2, 3, 4, 6, 8, 9, 10], "actual": [2, 3, 4, 9], "throughout": 2, "pacakg": 2, "especi": [2, 8, 9], "get": [2, 3, 4, 6, 7, 8], "set": [2, 3, 4, 5, 6, 7, 8, 9, 10], "delet": [2, 3, 4, 6, 10], "kind": [2, 3], "thing": [2, 4, 8, 9, 10], "exist": [2, 3, 4, 6, 10], "etc": [2, 3, 8, 10], "Then": [2, 8, 9, 10], "represent": [2, 6, 8], "encod": [2, 6, 8, 10], "decod": [2, 6, 8], "complex": [2, 3, 4, 6, 8], "And": [2, 7], "produc": [2, 8, 10], "random": [2, 10], "unus": [2, 6], "fix": [2, 8, 10], "structur": [2, 3, 8, 9], "np": [2, 4, 8, 9], "ndarrai": [2, 3, 4, 6, 8, 9, 10], "element": [2, 3, 4, 6, 8, 10], "structured_numpy_ndarray_as_struct": [2, 3, 8], "wai": [2, 3, 6, 9], "dtype": [2, 3, 6, 8, 9, 10], "field": [2, 3, 4, 6, 8], "restor": 2, "back": [2, 3, 4, 8, 9, 10], "matlab_field": [2, 4, 6, 8], "3": [2, 3, 6, 7, 10], "newer": [2, 3, 10], "But": [2, 6], "older": [2, 3, 8, 10], "import": [2, 3, 5, 8, 9, 10], "cannot": [2, 3, 5, 6, 8, 9, 10], "cd": [2, 10], "look": [2, 4, 6, 8, 9, 10], "like": [2, 3, 6, 8, 9], "follow": [2, 3, 6, 8, 10], "h5dump": 2, "datatyp": [2, 9, 10], "h5t_vlen": 2, "h5t_string": 2, "strsize": 2, "strpad": 2, "h5t_str_nullterm": 2, "cset": 2, "h5t_cset_ascii": 2, "ctype": 2, "h5t_c_s1": 2, "dataspac": 2, "simpl": 2, "d": [2, 9, 10], "In": [2, 3, 5, 8, 9, 10], "arrai": [2, 3, 4, 6, 8, 9, 10], "variabl": [2, 3, 7, 8, 10], "length": [2, 6, 10], "singl": [2, 3, 4, 8, 9, 10], "charact": [2, 3, 6, 8, 10], "ascii": [2, 6, 8, 10], "vlen": [2, 6, 10], "s1": [2, 10], "creat": [2, 6, 10], "dt": [2, 6, 10], "special_dtyp": [2, 10], "f": [2, 4, 5, 9, 10], "empti": [2, 3, 4, 8], "shape": [2, 3, 4, 6, 8, 9], "len": [2, 10], "enumer": [2, 10], "b": [2, 6, 9, 10], "doesn": [2, 3, 6, 8, 10], "strictli": 2, "struct": [2, 3, 8, 10], "lose": [2, 8, 10], "verion": 2, "port": 2, "categor": 2, "tabl": [2, 3, 8, 10], "map": [2, 8], "seri": [2, 8, 10], "hard": 2, "don": [2, 3, 4, 9], "wouldn": [2, 8], "run": [2, 3, 4, 9], "least": [2, 4, 6, 9, 10], "manipul": 2, "whosmat": 2, "scipi": [2, 3, 8, 9], "io": [2, 3, 8, 9], "insid": [2, 10], "group_for_refer": [2, 3, 4, 10], "referenc": [2, 9], "heirarch": [3, 8], "beyond": [3, 8, 10], "just": [3, 4, 8, 9, 10], "19": [3, 8], "path": [3, 8, 9, 10], "filenam": [3, 9], "h5": [3, 9], "truncate_exist": 3, "truncate_invalid_matlab": 3, "none": [3, 4, 5, 6, 8, 9, 10], "wrapper": [3, 9], "around": [3, 9], "locat": [3, 9, 10], "specifi": [3, 4, 5, 6, 8, 9], "posix": [3, 9], "style": [3, 9], "directori": [3, 8, 9], "put": [3, 4, 8, 9, 10], "basenam": 3, "influenc": 3, "construct": [3, 4], "two": [3, 8, 9, 10], "store_python_metadata": [3, 4, 10], "bool": [3, 4, 6, 8, 9, 10], "first": [3, 4, 6, 8, 10], "metadata": [3, 4, 7, 8, 10], "accur": [3, 9, 10], "without": [3, 8, 9, 10], "content": [3, 7, 9, 10], "transpos": [3, 8, 9, 10], "case": [3, 6, 8, 10], "latter": 3, "properli": [3, 8, 10], "sure": 3, "correctli": [3, 4, 8], "header": [3, 7, 8], "recogn": [3, 9], "paramet": [3, 4, 5, 6, 8], "whether": [3, 6, 8, 9, 10], "truncat": 3, "done": [3, 5, 6, 8, 9, 10], "proper": [3, 4, 6, 8, 10], "userblock": [3, 8, 10], "term": [3, 8, 10], "place": [3, 4, 5, 6, 10], "mutual": 3, "exclus": 3, "rais": [3, 4, 5, 6, 8, 10], "notimplementederror": [3, 4, 5, 8, 10], "action_for_matlab_incompat": [3, 4, 5, 10], "onc": [3, 7], "mdict": 3, "dict": [3, 4, 6, 8, 9, 10], "dictionari": [3, 8, 9], "kei": [3, 8, 9, 10], "return": [3, 4, 5, 6, 9], "each": [3, 4, 6, 8, 9, 10], "iter": 3, "order": [3, 4, 6, 8, 9, 10], "file_nam": 3, "appendmat": 3, "oned_a": 3, "row": [3, 6, 9, 10], "marshaller_collect": 3, "vesion": 3, "4": [3, 8, 9, 10], "5": [3, 6, 7, 9, 10], "everyth": [3, 9], "dispatch": [3, 8, 9], "model": [3, 8, 9], "specif": [3, 8, 9, 10], "extens": [3, 8], "present": [3, 6, 8, 10], "append": 3, "column": [3, 6, 9, 10], "1d": [3, 6, 8, 9], "turn": [3, 6, 8, 9, 10], "vector": [3, 9], "perfectli": 3, "applic": 3, "action": [3, 9], "perform": [3, 8, 9], "anywai": [3, 9], "incompat": [3, 7, 9, 10], "discard": [3, 9, 10], "throw": [3, 6, 8, 9], "except": [3, 5, 6, 8, 9], "onto": 3, "importerror": 3, "equivel": 3, "note": [3, 4, 6, 8], "variable_nam": [3, 9], "load": 3, "later": [3, 8], "insert": 3, "sequenc": [3, 10], "select": [3, 8, 10], "miss": [3, 8, 10], "here": [3, 9], "equival": [3, 6, 8], "delete_unused_vari": 3, "make_atleast_2d": [3, 10], "convert_numpy_bytes_to_utf16": [3, 8], "convert_numpy_str_to_utf16": [3, 8], "convert_bools_to_uint8": 3, "reverse_dimension_ord": 3, "store_shape_for_empti": [3, 8], "complex_nam": [3, 6, 10], "r": [3, 6, 8, 10], "ref": [3, 10], "compress": [3, 7, 8], "16384": 3, "transform": [3, 7, 9], "describ": 3, "depend": [3, 4, 5, 9, 10], "effect": 3, "overrid": [3, 4, 10], "real": [3, 6, 8, 10], "imag": [3, 6, 10], "special": [3, 6, 7], "block": 3, "front": 3, "valid": [3, 8], "tupl": [3, 4, 6, 8, 10], "int": [3, 4, 6, 8], "futur": [3, 8], "2d": [3, 9, 10], "bytes_": [3, 4, 6, 8, 9, 10], "utf": [3, 6, 8, 9, 10], "str_": [3, 4, 6, 8, 9, 10], "uint8": [3, 4, 6, 8, 9, 10], "revers": [3, 6, 8, 9, 10], "dimens": [3, 6, 8, 10], "imaginari": [3, 6, 8, 10], "point": [3, 4, 8], "refer": [3, 4, 8, 10], "becom": [3, 8, 9, 10], "larg": [3, 6, 8, 9, 10], "minimum": [3, 7, 8], "size": [3, 6, 7, 8, 10], "algorithm": [3, 7, 9], "scalar_opt": 3, "create_dataset": 3, "array_opt": 3, "properti": 3, "number": [3, 6, 8], "part": [3, 6, 8, 10], "unless": [3, 8, 10], "checksum": [3, 7, 8], "chunk": [3, 7], "easili": [3, 6], "detect": 3, "uncompressed_flether32_filt": 3, "tarbal": 3, "Its": 3, "moder": 3, "issu": [3, 8, 10], "enum": [3, 8, 10], "intead": 3, "int8": [3, 4, 8, 9, 10], "bytearrai": [3, 4, 8, 10], "uint16": [3, 4, 6, 8, 10], "possibl": [3, 4, 6, 10], "loss": [3, 8], "translat": [3, 8, 9], "chang": [3, 8, 9, 10], "pair": [3, 10], "convers": [3, 6, 8, 9, 10], "made": [3, 8, 9, 10], "32": [3, 6, 8, 10], "form": [3, 6, 8, 9, 10], "uint32": [3, 4, 6, 8, 9, 10], "start": [3, 7], "absolut": 3, "anoth": 3, "object_": [3, 4, 8, 9], "similar": [3, 8], "exclud": 3, "parent": [3, 4], "lower": [3, 9], "higher": [3, 5, 6, 9], "dimension": [3, 6, 8, 9], "forc": [3, 8], "implicitli": [3, 8, 10], "control": [3, 7, 8, 10], "matrix": [3, 4, 8, 10], "switch": 3, "fortran": [3, 9, 10], "essenti": [3, 4, 9, 10], "reversibli": [3, 9], "rearrang": 3, "improv": [3, 8, 9], "0x0x2": 3, "axi": 3, "noth": 3, "otherwis": [3, 6, 8, 10], "matlab_empti": [3, 4], "flag": 3, "compound": [3, 8, 10], "NOT": 3, "chunck": 3, "regardless": [3, 8], "increas": [3, 8], "compressed_flether32_filt": 3, "repres": [3, 8, 10], "maintain": 3, "retreiv": 3, "builtin": [3, 4, 10], "suppli": 3, "remov": [3, 8], "type_str": [3, 4, 5], "add": 3, "frozenset": [3, 4, 8, 10], "method": [3, 4, 6, 8, 9], "add_marshal": 3, "clear_marshal": 3, "clear": 3, "get_marshaller_for_matlab_class": 3, "retriev": 3, "associ": [3, 4, 10], "python_type_str": [3, 4], "get_marshaller_for_typ": 3, "tp": 3, "get_marshaller_for_type_str": 3, "remove_marshal": 3, "recurs": [4, 6], "core": [4, 5], "couldn": 4, "respect": [4, 10], "canon": [4, 8, 10], "item": [4, 8], "replic": 4, "know": 4, "subclass": 4, "__init__": 4, "section": [4, 10], "gener": [4, 6, 10], "write_metadata": 4, "overridden": 4, "attributemanag": [4, 6], "python_attribut": 4, "matlab_attribut": 4, "readabl": 4, "h5path": 4, "mainta": 4, "gotten": 4, "identifi": 4, "get_type_str": 4, "whatev": 4, "easier": 4, "someth": [4, 9, 10], "still": [4, 8, 9], "right": [4, 6, 8], "mean": [4, 6, 8], "Will": 4, "grp": [4, 5, 6], "thrown": [4, 5, 8], "immedi": 4, "writ": 4, "baseclass": 4, "underlyingtyp": [4, 10], "matlab_int_decod": [4, 10], "chararrai": [4, 8, 10], "record": 4, "recarrai": [4, 8, 10], "bool_": [4, 8, 9, 10], "void": [4, 8, 10], "uint64": [4, 8, 10], "int16": [4, 8, 10], "int32": [4, 6, 8, 9, 10], "int64": [4, 8, 10], "float16": [4, 6, 8, 10], "float32": [4, 8, 9, 10], "float64": [4, 8, 10], "complex64": [4, 6, 8, 10], "complex128": [4, 8, 9, 10], "logic": [4, 8, 10], "char": [4, 8, 10], "doubl": [4, 8, 10], "cell": [4, 8, 10], "wrote_as_struct": 4, "float": [4, 8, 10], "nonetyp": [4, 10], "dequ": [4, 8, 10], "oserror": 5, "failur": 5, "desir": [5, 6], "try": [5, 10], "event": 5, "deduc": 5, "successfulli": 5, "obj": 6, "raw": 6, "tobyt": [6, 8], "tostr": [6, 8], "old": [6, 8], "zero": [6, 9, 10], "blah": 6, "yesno": 6, "typeerror": 6, "full": [6, 8], "mai": [6, 8, 10], "hang": 6, "unicode_": [6, 8], "expand": 6, "across": 6, "2x3x4": 6, "10": [6, 8, 9, 10], "2x30x4": 6, "everi": [6, 9, 10], "singlet": 6, "oppos": [6, 8], "doublet": [6, 8, 9, 10], "unicodeencodeerror": 6, "ident": [6, 9], "decode_to_numpy_str": 6, "unicod": [6, 8, 9, 10], "unsign": [6, 10], "assum": [6, 8, 10], "8": [6, 8, 9, 10], "unchang": 6, "natur": 6, "aris": 6, "togeth": 6, "3x10x5": 6, "input": 6, "uint": 6, "output": [6, 9], "3x2x5": 6, "consecut": 6, "compos": 6, "indic": 6, "amount": 6, "econd": 6, "instead": [6, 8, 9, 10], "nativ": [6, 9], "h5t_compound": 6, "standard": [6, 10], "fieldnam": [6, 10], "analyz": 6, "figur": 6, "out": [6, 8, 9], "varieti": [6, 8], "expect": [6, 8, 9, 10], "combin": [6, 10], "arraylik": 6, "might": 6, "tri": 6, "re": [6, 8], "im": 6, "complex_numb": 6, "target": [6, 8], "attr": 6, "mutablemap": 6, "fashion": [6, 8, 10], "manag": 6, "wrong": [6, 8, 10], "On": [6, 10], "manual": 6, "invalid": [6, 8], "yet": 6, "overwritten": 6, "sort": [6, 9], "string_list": 6, "overview": 7, "instal": [7, 9], "hierarch": 7, "v7": [7, 9, 10], "introduct": 7, "conveni": 7, "exampl": [7, 8], "readback": 7, "enabl": [7, 8, 9], "further": [7, 8], "develop": 7, "todo": 7, "api": [7, 8], "index": 7, "search": 7, "page": [7, 9, 10], "extra": 8, "meta": 8, "bad": 8, "documet": 8, "pythonhost": 8, "org": 8, "under": [8, 10], "claus": 8, "bsd": 8, "blob": 8, "master": 8, "copi": 8, "txt": 8, "6": [8, 10], "pypi": 8, "To": [8, 9], "command": 8, "download": 8, "py": 8, "nose": 8, "unittest2": 8, "skip": 8, "requirements_test": 8, "nosetest": 8, "addition": 8, "sphinx": 8, "requirements_doc": 8, "build_sphinx": 8, "design": 8, "few": 8, "littl": 8, "clunki": 8, "long": 8, "familiar": 8, "standpoint": 8, "syntax": 8, "primarili": 8, "direct": 8, "www": 8, "hdfgroup": 8, "exchang": 8, "numer": [8, 10], "un": 8, "sign": 8, "hardwar": 8, "platform": [8, 10], "endian": 8, "imagin": 8, "filesystem": [8, 9], "link": 8, "pytabl": 8, "mathwork": 8, "convent": [8, 10], "cl": [8, 10], "what": [8, 9, 10], "11": [8, 10], "compatibl": 8, "fit": [8, 10], "unifi": [8, 10], "explic": 8, "null": [8, 10], "x00": [8, 9, 10], "forward": [8, 9, 10], "slash": [8, 9, 10], "underli": 8, "directli": 8, "12": [8, 10], "branch": 8, "2021": [8, 10], "07": [8, 10], "bug": [8, 10], "114": [8, 9, 10], "break": [8, 10], "thu": [8, 9, 10], "howev": 8, "bugfix": 8, "releas": 8, "122": 8, "124": 8, "replac": [8, 10], "deprec": 8, "asscalar": 8, "123": 8, "english": 8, "month": 8, "dai": 8, "week": 8, "125": 8, "accident": 8, "pkg_resourc": 8, "parse_vers": 8, "setuptool": 8, "now": [8, 9], "18": 8, "pull": 8, "request": 8, "111": [8, 9], "daniel": 8, "hrisca": 8, "repeat": 8, "__getitem__": 8, "were": [8, 9, 10], "reduciont": 8, "spirit": 8, "pr": 8, "17": 8, "workaround": 8, "109": 8, "102": 8, "bit": [8, 10], "previou": [8, 10], "segfault": 8, "move": 8, "distutil": 8, "fallback": 8, "prepar": 8, "pep": 8, "632": 8, "prevent": 8, "warn": 8, "mark": 8, "110": [8, 9], "81": 8, "82": 8, "mode": 8, "73": 8, "think": 8, "pre": 8, "fall": 8, "won": 8, "docstr": 8, "15": [8, 9], "68": 8, "70": [8, 9], "updat": 8, "maximum": 8, "drop": 8, "71": 8, "python_field": 8, "preserv": 8, "assert": 8, "72": 8, "fill": 8, "multi": [8, 10], "14": [8, 10], "coupl": [8, 9], "45": 8, "44": 8, "47": 8, "46": 8, "runtimewarn": 8, "signal": 8, "nan": 8, "13": [8, 10], "36": 8, "system": [8, 9, 10], "copyright": 8, "year": 8, "notic": [8, 9], "reshap": 8, "33": 8, "34": 8, "30": [8, 9], "minor": [8, 9, 10], "29": [8, 10], "previous": 8, "close": [8, 9], "impact": 8, "23": 8, "o": [8, 9], "never": 8, "thought": 8, "21": 8, "22": 8, "problem": 8, "did": 8, "gb": 8, "explicit": 8, "memori": 8, "consumpt": 8, "process": 8, "unneed": 8, "accept": 8, "been": [8, 9], "had": 8, "appli": 8, "too": [8, 10], "big": [8, 10], "incorrectli": 8, "thank": 8, "goe": 8, "mrdomino": 8, "astyp": 8, "posit": 8, "__version__": 8, "absent": 8, "ubuntu": 8, "04": 8, "broken": 8, "abil": [8, 9], "mistaken": 8, "introduc": 8, "greater": 8, "middl": 8, "begin": 8, "crash": 8, "initi": [8, 9], "mostli": 9, "extend": 9, "submodul": 9, "much": 9, "pyth": 9, "hf": 9, "unlik": 9, "window": 9, "we": [9, 10], "foo": 9, "bar": 9, "incur": 9, "major": [9, 10], "penalti": 9, "fact": [9, 10], "constructor": 9, "mix": 9, "preced": 9, "origin": [9, 10], "resembl": 9, "consist": [9, 10], "certain": [9, 10], "els": [9, 10], "off": 9, "relev": 9, "instruct": 9, "advantag": 9, "you": 9, "2j": 9, "3j": 9, "hello": 9, "goodby": 9, "h": 9, "stuff": 9, "bi": 9, "j": 9, "aa": 9, "bb": 9, "cc": 9, "dd": 9, "ee": 9, "3e3": 9, "ff": 9, "gg": 9, "hh": 9, "ii": 9, "text": 9, "rest": 9, "u": 9, "come": 9, "quit": 9, "happen": [9, 10], "extract": 9, "s4": 9, "s2": 9, "s5": 9, "29999995e": 9, "00": [9, 10], "30000000e": 9, "03": 9, "101": 9, "116": [9, 10], "119": 9, "104": 9, "f8": 9, "i8": 9, "c16": 9, "s7": 9, "u1": 9, "u4": 9, "i4": 9, "f4": 9, "s9": 9, "data_typeinfo": 9, "u5": 9, "biggest": 9, "got": 9, "subset": 9, "u2": 9, "x00two": 9, "x00three": 9, "u15": 9, "u9": 9, "u7": 9, "adopt": 10, "512": 10, "128": 10, "pad": 10, "magic": 10, "date": 10, "glnxa64": 10, "fri": 10, "feb": 10, "02": 10, "2014": 10, "schema": 10, "cpython": 10, "micro": 10, "hexidecim": 10, "00000000": 10, "0002494d": 10, "neither": 10, "definit": 10, "taken": 10, "per": 10, "compar": 10, "root": 10, "seem": 10, "upon": 10, "care": 10, "width": 10, "arbitrarili": 10, "64": 10, "attempt": 10, "partd": 10, "softwar": 10, "unfortun": 10, "elsewher": 10, "keep": 10, "till": 10, "othewis": 10, "shown": 10, "transfom": 10, "explain": 10, "treat": 10, "satisfi": 10, "criterion": 10, "rather": 10, "outsid": 10, "necessari": 10, "opposit": 10, "scheme": 10, "fortan": 10, "attach": 10}, "objects": {"": [[3, 0, 0, "-", "hdf5storage"]], "hdf5storage": [[3, 1, 1, "", "MarshallerCollection"], [4, 0, 0, "-", "Marshallers"], [3, 1, 1, "", "Options"], [3, 4, 1, "", "loadmat"], [5, 0, 0, "-", "lowlevel"], [3, 4, 1, "", "read"], [3, 4, 1, "", "reads"], [3, 4, 1, "", "savemat"], [6, 0, 0, "-", "utilities"], [3, 4, 1, "", "write"], [3, 4, 1, "", "writes"]], "hdf5storage.MarshallerCollection": [[3, 2, 1, "", "add_marshaller"], [3, 2, 1, "", "clear_marshallers"], [3, 2, 1, "", "get_marshaller_for_matlab_class"], [3, 2, 1, "", "get_marshaller_for_type"], [3, 2, 1, "", "get_marshaller_for_type_string"], [3, 2, 1, "", "remove_marshaller"]], "hdf5storage.Marshallers": [[4, 1, 1, "", "NumpyScalarArrayMarshaller"], [4, 1, 1, "", "PythonDictMarshaller"], [4, 1, 1, "", "PythonListMarshaller"], [4, 1, 1, "", "PythonNoneMarshaller"], [4, 1, 1, "", "PythonScalarMarshaller"], [4, 1, 1, "", "PythonStringMarshaller"], [4, 1, 1, "", "PythonTupleSetDequeMarshaller"], [4, 1, 1, "", "TypeMarshaller"], [4, 4, 1, "", "read_object_array"], [4, 4, 1, "", "write_object_array"]], "hdf5storage.Marshallers.NumpyScalarArrayMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"], [4, 2, 1, "", "write_metadata"]], "hdf5storage.Marshallers.PythonDictMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"], [4, 2, 1, "", "write_metadata"]], "hdf5storage.Marshallers.PythonListMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"]], "hdf5storage.Marshallers.PythonNoneMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"]], "hdf5storage.Marshallers.PythonScalarMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"]], "hdf5storage.Marshallers.PythonStringMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"]], "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller": [[4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"]], "hdf5storage.Marshallers.TypeMarshaller": [[4, 2, 1, "", "get_type_string"], [4, 3, 1, "", "matlab_attributes"], [4, 3, 1, "", "matlab_classes"], [4, 3, 1, "", "python_attributes"], [4, 3, 1, "", "python_type_strings"], [4, 2, 1, "", "read"], [4, 3, 1, "", "types"], [4, 2, 1, "", "write"], [4, 2, 1, "", "write_metadata"]], "hdf5storage.Options": [[3, 5, 1, "", "action_for_matlab_incompatible"], [3, 5, 1, "", "complex_names"], [3, 5, 1, "", "compress"], [3, 5, 1, "", "compress_size_threshold"], [3, 5, 1, "", "compressed_fletcher32_filter"], [3, 5, 1, "", "compression_algorithm"], [3, 5, 1, "", "convert_bools_to_uint8"], [3, 5, 1, "", "convert_numpy_bytes_to_utf16"], [3, 5, 1, "", "convert_numpy_str_to_utf16"], [3, 5, 1, "", "delete_unused_variables"], [3, 5, 1, "", "group_for_references"], [3, 5, 1, "", "gzip_compression_level"], [3, 5, 1, "", "make_atleast_2d"], [3, 3, 1, "", "marshaller_collection"], [3, 5, 1, "", "matlab_compatible"], [3, 5, 1, "", "oned_as"], [3, 5, 1, "", "reverse_dimension_order"], [3, 5, 1, "", "shuffle_filter"], [3, 5, 1, "", "store_python_metadata"], [3, 5, 1, "", "store_shape_for_empty"], [3, 5, 1, "", "structured_numpy_ndarray_as_struct"], [3, 5, 1, "", "uncompressed_fletcher32_filter"]], "hdf5storage.lowlevel": [[5, 6, 1, "", "CantReadError"], [5, 6, 1, "", "Hdf5storageError"], [5, 6, 1, "", "TypeNotMatlabCompatibleError"], [5, 4, 1, "", "read_data"], [5, 4, 1, "", "write_data"]], "hdf5storage.utilities": [[6, 4, 1, "", "convert_numpy_str_to_uint16"], [6, 4, 1, "", "convert_numpy_str_to_uint32"], [6, 4, 1, "", "convert_to_numpy_bytes"], [6, 4, 1, "", "convert_to_numpy_str"], [6, 4, 1, "", "convert_to_str"], [6, 4, 1, "", "decode_complex"], [6, 4, 1, "", "del_attribute"], [6, 4, 1, "", "does_dtype_have_a_zero_shape"], [6, 4, 1, "", "encode_complex"], [6, 4, 1, "", "get_attribute"], [6, 4, 1, "", "get_attribute_string"], [6, 4, 1, "", "get_attribute_string_array"], [6, 4, 1, "", "next_unused_name_in_group"], [6, 4, 1, "", "numpy_to_bytes"], [6, 4, 1, "", "read_all_attributes_into"], [6, 4, 1, "", "read_matlab_fields_attribute"], [6, 4, 1, "", "set_attribute"], [6, 4, 1, "", "set_attribute_string"], [6, 4, 1, "", "set_attribute_string_array"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function", "5": "py:property", "6": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"], "5": ["py", "property", "Python property"], "6": ["py", "exception", "Python exception"]}, "titleterms": {"api": 0, "compress": [1, 9], "enabl": 1, "set": 1, "The": [1, 9], "minimum": 1, "data": [1, 8, 9, 10], "size": 1, "control": [1, 9], "algorithm": 1, "And": [1, 9], "level": 1, "us": [1, 9], "checksum": 1, "chunk": 1, "further": 1, "read": [1, 3, 9, 10], "develop": 2, "inform": 2, "packag": 2, "overview": [2, 8], "todo": 2, "stand": 2, "bug": 2, "featur": 2, "add": 2, "hdf5storag": [3, 4, 5, 6, 7, 8], "write": [3, 9], "savemat": 3, "loadmat": 3, "option": [3, 9, 10], "marshallercollect": 3, "marshal": 4, "write_object_arrai": 4, "read_object_arrai": 4, "typemarshal": 4, "numpyscalararraymarshal": 4, "pythonscalarmarshal": 4, "pythonstringmarshal": 4, "pythonnonemarshal": 4, "pythondictmarshal": 4, "pythonlistmarshal": 4, "pythontuplesetdequemarshal": 4, "lowlevel": 5, "hdf5storageerror": 5, "cantreaderror": 5, "typenotmatlabcompatibleerror": 5, "write_data": 5, "read_data": 5, "util": 6, "numpy_to_byt": 6, "does_dtype_have_a_zero_shap": 6, "next_unused_name_in_group": 6, "convert_numpy_str_to_uint16": 6, "convert_numpy_str_to_uint32": 6, "convert_to_str": 6, "convert_to_numpy_str": 6, "convert_to_numpy_byt": 6, "decode_complex": 6, "encode_complex": 6, "get_attribut": 6, "get_attribute_str": 6, "get_attribute_string_arrai": 6, "read_all_attributes_into": 6, "read_matlab_fields_attribut": 6, "set_attribut": 6, "set_attribute_str": 6, "set_attribute_string_arrai": 6, "del_attribut": 6, "welcom": 7, "": 7, "document": [7, 8], "indic": 7, "tabl": 7, "instal": 8, "depend": 8, "pip": 8, "from": [8, 10], "sourc": 8, "run": 8, "test": 8, "build": 8, "python": [8, 9, 10], "2": [8, 9], "hierarch": 8, "format": [8, 10], "5": 8, "hdf5": 8, "matlab": [8, 9, 10], "mat": [8, 9, 10], "v7": 8, "3": [8, 9], "file": [8, 9, 10], "support": 8, "type": [8, 10], "incompat": 8, "version": 8, "introduct": 9, "get": 9, "start": 9, "sever": 9, "variabl": 9, "onc": 9, "main": 9, "store_python_metadata": 9, "matlab_compat": 9, "action_for_matlab_incompat": 9, "oned_a": 9, "conveni": 9, "function": 9, "exampl": 9, "readback": 9, "includ": 9, "differ": 9, "metadata": 9, "make": 9, "No": 9, "both": 9, "storag": 10, "header": 10, "how": 10, "i": 10, "store": 10, "attribut": 10, "shape": 10, "numpi": 10, "contain": 10, "field": 10, "empti": 10, "matlab_empti": 10, "h5path": 10, "matlab_field": 10, "special": 10, "int": 10, "long": 10, "complex": 10, "number": 10, "np": 10, "object_": 10, "structur": 10, "like": 10, "transform": 10, "delete_unused_vari": 10, "structured_numpy_ndarray_as_struct": 10, "make_at_least_2d": 10, "convert_numpy_bytes_to_utf16": 10, "convert_numpy_str_to_utf16": 10, "convert_bools_to_uint8": 10, "reverse_dimension_ord": 10, "store_shape_for_empti": 10}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"API": [[0, "api"]], "Compression": [[1, "compression"]], "Enabling Compression": [[1, "enabling-compression"]], "Setting The Minimum Data Size for Compression": [[1, "setting-the-minimum-data-size-for-compression"]], "Controlling The Compression Algorithm And Level": [[1, "controlling-the-compression-algorithm-and-level"]], "Using Checksums": [[1, "using-checksums"]], "Chunking": [[1, "chunking"]], "Further Reading": [[1, "further-reading"]], "Development Information": [[2, "development-information"]], "Package Overview": [[2, "package-overview"]], "TODO": [[2, "todo"]], "Standing Bugs": [[2, "standing-bugs"]], "Features to Add": [[2, "features-to-add"]], "hdf5storage": [[3, "module-hdf5storage"], [8, "hdf5storage"]], "write": [[3, "write"]], "writes": [[3, "writes"]], "read": [[3, "read"]], "reads": [[3, "reads"]], "savemat": [[3, "savemat"]], "loadmat": [[3, "loadmat"]], "Options": [[3, "options"]], "MarshallerCollection": [[3, "marshallercollection"]], "hdf5storage.Marshallers": [[4, "module-hdf5storage.Marshallers"]], "write_object_array": [[4, "write-object-array"]], "read_object_array": [[4, "read-object-array"]], "TypeMarshaller": [[4, "typemarshaller"]], "NumpyScalarArrayMarshaller": [[4, "numpyscalararraymarshaller"]], "PythonScalarMarshaller": [[4, "pythonscalarmarshaller"]], "PythonStringMarshaller": [[4, "pythonstringmarshaller"]], "PythonNoneMarshaller": [[4, "pythonnonemarshaller"]], "PythonDictMarshaller": [[4, "pythondictmarshaller"]], "PythonListMarshaller": [[4, "pythonlistmarshaller"]], "PythonTupleSetDequeMarshaller": [[4, "pythontuplesetdequemarshaller"]], "hdf5storage.lowlevel": [[5, "module-hdf5storage.lowlevel"]], "Hdf5storageError": [[5, "hdf5storageerror"]], "CantReadError": [[5, "cantreaderror"]], "TypeNotMatlabCompatibleError": [[5, "typenotmatlabcompatibleerror"]], "write_data": [[5, "write-data"]], "read_data": [[5, "read-data"]], "hdf5storage.utilities": [[6, "module-hdf5storage.utilities"]], "numpy_to_bytes": [[6, "numpy-to-bytes"]], "does_dtype_have_a_zero_shape": [[6, "does-dtype-have-a-zero-shape"]], "next_unused_name_in_group": [[6, "next-unused-name-in-group"]], "convert_numpy_str_to_uint16": [[6, "convert-numpy-str-to-uint16"]], "convert_numpy_str_to_uint32": [[6, "convert-numpy-str-to-uint32"]], "convert_to_str": [[6, "convert-to-str"]], "convert_to_numpy_str": [[6, "convert-to-numpy-str"]], "convert_to_numpy_bytes": [[6, "convert-to-numpy-bytes"]], "decode_complex": [[6, "decode-complex"]], "encode_complex": [[6, "encode-complex"]], "get_attribute": [[6, "get-attribute"]], "get_attribute_string": [[6, "get-attribute-string"]], "get_attribute_string_array": [[6, "get-attribute-string-array"]], "read_all_attributes_into": [[6, "read-all-attributes-into"]], "read_matlab_fields_attribute": [[6, "read-matlab-fields-attribute"]], "set_attribute": [[6, "set-attribute"]], "set_attribute_string": [[6, "set-attribute-string"]], "set_attribute_string_array": [[6, "set-attribute-string-array"]], "del_attribute": [[6, "del-attribute"]], "Welcome to hdf5storage\u2019s documentation!": [[7, "welcome-to-hdf5storage-s-documentation"]], "Indices and tables": [[7, "indices-and-tables"]], "Overview": [[8, "overview"]], "Installation": [[8, "installation"]], "Dependencies": [[8, "dependencies"]], "Installing by pip": [[8, "installing-by-pip"]], "Installing from Source": [[8, "installing-from-source"]], "Running Tests": [[8, "running-tests"]], "Building Documentation": [[8, "building-documentation"]], "Python 2": [[8, "python-2"], [9, "python-2"]], "Hierarchal Data Format 5 (HDF5)": [[8, "hierarchal-data-format-5-hdf5"]], "MATLAB MAT v7.3 file support": [[8, "matlab-mat-v7-3-file-support"]], "Supported Types": [[8, "supported-types"]], "File Incompatibilities": [[8, "file-incompatibilities"]], "Versions": [[8, "versions"]], "Introduction": [[9, "introduction"]], "Getting Started": [[9, "getting-started"]], "Writing And Reading Several Python Variables at Once": [[9, "writing-and-reading-several-python-variables-at-once"]], "Main Options Controlling Writing/Reading Data": [[9, "main-options-controlling-writing-reading-data"]], "store_python_metadata": [[9, "store-python-metadata"]], "matlab_compatible": [[9, "matlab-compatible"]], "action_for_matlab_incompatible": [[9, "action-for-matlab-incompatible"]], "oned_as": [[9, "oned-as"]], "compress": [[9, "compress"]], "Convenience Functions for MATLAB MAT Files": [[9, "convenience-functions-for-matlab-mat-files"]], "Example: Write And Readback Including Different Metadata": [[9, "example-write-and-readback-including-different-metadata"]], "Making The Data": [[9, "making-the-data"]], "Python 3": [[9, "python-3"]], "Using No Metadata": [[9, "using-no-metadata"]], "Including Python Metadata": [[9, "including-python-metadata"]], "Including MATLAB Metadata": [[9, "including-matlab-metadata"]], "Including both Python And MATLAB Metadata": [[9, "including-both-python-and-matlab-metadata"]], "Storage Format": [[10, "storage-format"]], "MATLAB File Header": [[10, "matlab-file-header"]], "How Data Is Stored": [[10, "how-data-is-stored"]], "Attributes": [[10, "attributes"]], "Python.Shape": [[10, "python-shape"]], "Python.numpy.Container": [[10, "python-numpy-container"]], "Python.Fields": [[10, "python-fields"]], "Python.Empty and MATLAB_empty": [[10, "python-empty-and-matlab-empty"]], "H5PATH": [[10, "h5path"]], "MATLAB_fields": [[10, "matlab-fields"]], "Storage of Special Types": [[10, "storage-of-special-types"]], "int and long": [[10, "int-and-long"]], "Complex Numbers": [[10, "complex-numbers"]], "np.object_": [[10, "np-object"]], "Structure Like Data": [[10, "structure-like-data"]], "Optional Data Transformations": [[10, "optional-data-transformations"]], "delete_unused_variables": [[10, "delete-unused-variables"]], "structured_numpy_ndarray_as_struct": [[10, "structured-numpy-ndarray-as-struct"]], "make_at_least_2d": [[10, "make-at-least-2d"]], "convert_numpy_bytes_to_utf16": [[10, "convert-numpy-bytes-to-utf16"]], "convert_numpy_str_to_utf16": [[10, "convert-numpy-str-to-utf16"]], "convert_bools_to_uint8": [[10, "convert-bools-to-uint8"]], "reverse_dimension_order": [[10, "reverse-dimension-order"]], "store_shape_for_empty": [[10, "store-shape-for-empty"]], "How Data Is Read from MATLAB MAT Files": [[10, "how-data-is-read-from-matlab-mat-files"]]}, "indexentries": {"marshallercollection (class in hdf5storage)": [[3, "hdf5storage.MarshallerCollection"]], "options (class in hdf5storage)": [[3, "hdf5storage.Options"]], "action_for_matlab_incompatible (hdf5storage.options property)": [[3, "hdf5storage.Options.action_for_matlab_incompatible"]], "add_marshaller() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.add_marshaller"]], "clear_marshallers() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.clear_marshallers"]], "complex_names (hdf5storage.options property)": [[3, "hdf5storage.Options.complex_names"]], "compress (hdf5storage.options property)": [[3, "hdf5storage.Options.compress"]], "compress_size_threshold (hdf5storage.options property)": [[3, "hdf5storage.Options.compress_size_threshold"]], "compressed_fletcher32_filter (hdf5storage.options property)": [[3, "hdf5storage.Options.compressed_fletcher32_filter"]], "compression_algorithm (hdf5storage.options property)": [[3, "hdf5storage.Options.compression_algorithm"]], "convert_bools_to_uint8 (hdf5storage.options property)": [[3, "hdf5storage.Options.convert_bools_to_uint8"]], "convert_numpy_bytes_to_utf16 (hdf5storage.options property)": [[3, "hdf5storage.Options.convert_numpy_bytes_to_utf16"]], "convert_numpy_str_to_utf16 (hdf5storage.options property)": [[3, "hdf5storage.Options.convert_numpy_str_to_utf16"]], "delete_unused_variables (hdf5storage.options property)": [[3, "hdf5storage.Options.delete_unused_variables"]], "get_marshaller_for_matlab_class() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.get_marshaller_for_matlab_class"]], "get_marshaller_for_type() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.get_marshaller_for_type"]], "get_marshaller_for_type_string() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.get_marshaller_for_type_string"]], "group_for_references (hdf5storage.options property)": [[3, "hdf5storage.Options.group_for_references"]], "gzip_compression_level (hdf5storage.options property)": [[3, "hdf5storage.Options.gzip_compression_level"]], "hdf5storage": [[3, "module-hdf5storage"]], "loadmat() (in module hdf5storage)": [[3, "hdf5storage.loadmat"]], "make_atleast_2d (hdf5storage.options property)": [[3, "hdf5storage.Options.make_atleast_2d"]], "marshaller_collection (hdf5storage.options attribute)": [[3, "hdf5storage.Options.marshaller_collection"]], "matlab_compatible (hdf5storage.options property)": [[3, "hdf5storage.Options.matlab_compatible"]], "module": [[3, "module-hdf5storage"], [4, "module-hdf5storage.Marshallers"], [5, "module-hdf5storage.lowlevel"], [6, "module-hdf5storage.utilities"]], "oned_as (hdf5storage.options property)": [[3, "hdf5storage.Options.oned_as"]], "read() (in module hdf5storage)": [[3, "hdf5storage.read"]], "reads() (in module hdf5storage)": [[3, "hdf5storage.reads"]], "remove_marshaller() (hdf5storage.marshallercollection method)": [[3, "hdf5storage.MarshallerCollection.remove_marshaller"]], "reverse_dimension_order (hdf5storage.options property)": [[3, "hdf5storage.Options.reverse_dimension_order"]], "savemat() (in module hdf5storage)": [[3, "hdf5storage.savemat"]], "shuffle_filter (hdf5storage.options property)": [[3, "hdf5storage.Options.shuffle_filter"]], "store_python_metadata (hdf5storage.options property)": [[3, "hdf5storage.Options.store_python_metadata"]], "store_shape_for_empty (hdf5storage.options property)": [[3, "hdf5storage.Options.store_shape_for_empty"]], "structured_numpy_ndarray_as_struct (hdf5storage.options property)": [[3, "hdf5storage.Options.structured_numpy_ndarray_as_struct"]], "uncompressed_fletcher32_filter (hdf5storage.options property)": [[3, "hdf5storage.Options.uncompressed_fletcher32_filter"]], "write() (in module hdf5storage)": [[3, "hdf5storage.write"]], "writes() (in module hdf5storage)": [[3, "hdf5storage.writes"]], "numpyscalararraymarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller"]], "pythondictmarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller"]], "pythonlistmarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonListMarshaller"]], "pythonnonemarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller"]], "pythonscalarmarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller"]], "pythonstringmarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller"]], "pythontuplesetdequemarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller"]], "typemarshaller (class in hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.TypeMarshaller"]], "get_type_string() (hdf5storage.marshallers.typemarshaller method)": [[4, "hdf5storage.Marshallers.TypeMarshaller.get_type_string"]], "hdf5storage.marshallers": [[4, "module-hdf5storage.Marshallers"]], "matlab_attributes (hdf5storage.marshallers.numpyscalararraymarshaller attribute)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythondictmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythonlistmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythonnonemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythonscalarmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythonstringmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.pythontuplesetdequemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.matlab_attributes"]], "matlab_attributes (hdf5storage.marshallers.typemarshaller attribute)": [[4, "hdf5storage.Marshallers.TypeMarshaller.matlab_attributes"]], "matlab_classes (hdf5storage.marshallers.numpyscalararraymarshaller attribute)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythondictmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythonlistmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythonnonemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythonscalarmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythonstringmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.pythontuplesetdequemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.matlab_classes"]], "matlab_classes (hdf5storage.marshallers.typemarshaller attribute)": [[4, "hdf5storage.Marshallers.TypeMarshaller.matlab_classes"]], "python_attributes (hdf5storage.marshallers.numpyscalararraymarshaller attribute)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythondictmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythonlistmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythonnonemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythonscalarmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythonstringmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.pythontuplesetdequemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.python_attributes"]], "python_attributes (hdf5storage.marshallers.typemarshaller attribute)": [[4, "hdf5storage.Marshallers.TypeMarshaller.python_attributes"]], "python_type_strings (hdf5storage.marshallers.numpyscalararraymarshaller attribute)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythondictmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythonlistmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythonnonemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythonscalarmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythonstringmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.pythontuplesetdequemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.python_type_strings"]], "python_type_strings (hdf5storage.marshallers.typemarshaller attribute)": [[4, "hdf5storage.Marshallers.TypeMarshaller.python_type_strings"]], "read() (hdf5storage.marshallers.numpyscalararraymarshaller method)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.read"]], "read() (hdf5storage.marshallers.pythondictmarshaller method)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.read"]], "read() (hdf5storage.marshallers.pythonlistmarshaller method)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.read"]], "read() (hdf5storage.marshallers.pythonnonemarshaller method)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.read"]], "read() (hdf5storage.marshallers.pythonscalarmarshaller method)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.read"]], "read() (hdf5storage.marshallers.pythonstringmarshaller method)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.read"]], "read() (hdf5storage.marshallers.pythontuplesetdequemarshaller method)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.read"]], "read() (hdf5storage.marshallers.typemarshaller method)": [[4, "hdf5storage.Marshallers.TypeMarshaller.read"]], "read_object_array() (in module hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.read_object_array"]], "types (hdf5storage.marshallers.numpyscalararraymarshaller attribute)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.types"]], "types (hdf5storage.marshallers.pythondictmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.types"]], "types (hdf5storage.marshallers.pythonlistmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.types"]], "types (hdf5storage.marshallers.pythonnonemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.types"]], "types (hdf5storage.marshallers.pythonscalarmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.types"]], "types (hdf5storage.marshallers.pythonstringmarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.types"]], "types (hdf5storage.marshallers.pythontuplesetdequemarshaller attribute)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.types"]], "types (hdf5storage.marshallers.typemarshaller attribute)": [[4, "hdf5storage.Marshallers.TypeMarshaller.types"]], "write() (hdf5storage.marshallers.numpyscalararraymarshaller method)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.write"]], "write() (hdf5storage.marshallers.pythondictmarshaller method)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.write"]], "write() (hdf5storage.marshallers.pythonlistmarshaller method)": [[4, "hdf5storage.Marshallers.PythonListMarshaller.write"]], "write() (hdf5storage.marshallers.pythonnonemarshaller method)": [[4, "hdf5storage.Marshallers.PythonNoneMarshaller.write"]], "write() (hdf5storage.marshallers.pythonscalarmarshaller method)": [[4, "hdf5storage.Marshallers.PythonScalarMarshaller.write"]], "write() (hdf5storage.marshallers.pythonstringmarshaller method)": [[4, "hdf5storage.Marshallers.PythonStringMarshaller.write"]], "write() (hdf5storage.marshallers.pythontuplesetdequemarshaller method)": [[4, "hdf5storage.Marshallers.PythonTupleSetDequeMarshaller.write"]], "write() (hdf5storage.marshallers.typemarshaller method)": [[4, "hdf5storage.Marshallers.TypeMarshaller.write"]], "write_metadata() (hdf5storage.marshallers.numpyscalararraymarshaller method)": [[4, "hdf5storage.Marshallers.NumpyScalarArrayMarshaller.write_metadata"]], "write_metadata() (hdf5storage.marshallers.pythondictmarshaller method)": [[4, "hdf5storage.Marshallers.PythonDictMarshaller.write_metadata"]], "write_metadata() (hdf5storage.marshallers.typemarshaller method)": [[4, "hdf5storage.Marshallers.TypeMarshaller.write_metadata"]], "write_object_array() (in module hdf5storage.marshallers)": [[4, "hdf5storage.Marshallers.write_object_array"]], "cantreaderror": [[5, "hdf5storage.lowlevel.CantReadError"]], "hdf5storageerror": [[5, "hdf5storage.lowlevel.Hdf5storageError"]], "typenotmatlabcompatibleerror": [[5, "hdf5storage.lowlevel.TypeNotMatlabCompatibleError"]], "hdf5storage.lowlevel": [[5, "module-hdf5storage.lowlevel"]], "read_data() (in module hdf5storage.lowlevel)": [[5, "hdf5storage.lowlevel.read_data"]], "write_data() (in module hdf5storage.lowlevel)": [[5, "hdf5storage.lowlevel.write_data"]], "convert_numpy_str_to_uint16() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.convert_numpy_str_to_uint16"]], "convert_numpy_str_to_uint32() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.convert_numpy_str_to_uint32"]], "convert_to_numpy_bytes() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.convert_to_numpy_bytes"]], "convert_to_numpy_str() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.convert_to_numpy_str"]], "convert_to_str() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.convert_to_str"]], "decode_complex() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.decode_complex"]], "del_attribute() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.del_attribute"]], "does_dtype_have_a_zero_shape() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.does_dtype_have_a_zero_shape"]], "encode_complex() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.encode_complex"]], "get_attribute() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.get_attribute"]], "get_attribute_string() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.get_attribute_string"]], "get_attribute_string_array() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.get_attribute_string_array"]], "hdf5storage.utilities": [[6, "module-hdf5storage.utilities"]], "next_unused_name_in_group() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.next_unused_name_in_group"]], "numpy_to_bytes() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.numpy_to_bytes"]], "read_all_attributes_into() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.read_all_attributes_into"]], "read_matlab_fields_attribute() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.read_matlab_fields_attribute"]], "set_attribute() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.set_attribute"]], "set_attribute_string() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.set_attribute_string"]], "set_attribute_string_array() (in module hdf5storage.utilities)": [[6, "hdf5storage.utilities.set_attribute_string_array"]]}})