User API

asdf Package

asdf: Python library for reading and writing Advanced Scientific Data Format (ASDF) files

Functions

open(fd[, uri, mode, validate_checksums, ...])	Open an existing ASDF file.
info(node_or_path[, max_rows, max_cols, ...])	Print a rendering of an ASDF tree or sub-tree to stdout.
get_config()	Get the current config, which may have been altered by one or more surrounding calls to asdf.config_context.
config_context()	Context manager that temporarily overrides asdf configuration.

Classes

AsdfFile([tree, uri, extensions, version, ...])	The main class that represents an ASDF file object.
CustomType()	Base class for all user-defined types.
Stream(shape, dtype[, strides])	Used to put a streamed array into the tree.
IntegerType(value[, storage_type])	Enables the storage of arbitrarily large integer values
ExternalArrayReference(fileuri, target, ...)	Store a reference to an array in an external File.

Variables

__version__

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Class Inheritance Diagram

digraph inheritance5e841e2dcc { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AsdfFile" [URL="../../api/asdf.AsdfFile.html#asdf.AsdfFile",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The main class that represents an ASDF file object."]; "AsdfType" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for all built-in ASDF types. Types that inherit this class will"]; "ExtensionType" -> "AsdfType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CustomType" [URL="../../api/asdf.types.CustomType.html#asdf.types.CustomType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all user-defined types."]; "ExtensionType" -> "CustomType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ExtensionType" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="The base class of all custom types in the tree."]; "ExternalArrayReference" [URL="../../api/asdf.ExternalArrayReference.html#asdf.ExternalArrayReference",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Store a reference to an array in an external File."]; "AsdfType" -> "ExternalArrayReference" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IntegerType" [URL="../../api/asdf.IntegerType.html#asdf.IntegerType",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Enables the storage of arbitrarily large integer values"]; "AsdfType" -> "IntegerType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NDArrayType" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "AsdfType" -> "NDArrayType" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Stream" [URL="../../api/asdf.Stream.html#asdf.Stream",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Used to put a streamed array into the tree."]; "NDArrayType" -> "Stream" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

asdf.search Module

Utilities for searching ASDF trees.

Classes

AsdfSearchResult(identifiers, node[, ...])

Result of a call to AsdfFile.search.

Class Inheritance Diagram

digraph inheritance601a02aa5a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AsdfSearchResult" [URL="../../api/asdf.search.AsdfSearchResult.html#asdf.search.AsdfSearchResult",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Result of a call to AsdfFile.search."]; }

asdf.config Module

Methods for getting and setting asdf global configuration options.

Functions

get_config()	Get the current config, which may have been altered by one or more surrounding calls to asdf.config_context.
config_context()	Context manager that temporarily overrides asdf configuration.

Classes

AsdfConfig()

Container for ASDF configuration options.

Class Inheritance Diagram

digraph inheritance44a1a44b3e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AsdfConfig" [URL="../../api/asdf.config.AsdfConfig.html#asdf.config.AsdfConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Container for ASDF configuration options. Users are not intended to"]; }