ExternalArrayReference¶
-
class
asdf.
ExternalArrayReference
(fileuri, target, dtype, shape)[source]¶ Bases:
asdf.asdftypes.AsdfType
Store a reference to an array in an external File.
This class is a simple way of referring to an array in another file. It provides no way to resolve these references, that is left to the user. It also performs no checking to see if any of the arguments are correct. e.g. if the file exits.
Parameters: fileuri: `str`
The path to the path to be referenced. Can be relative to the file containing the reference.
target: `object`
Some internal target to the data in the file. Examples may include a HDU index, a HDF path or an asdf fragment.
dtype: `str`
The (numpy) dtype of the contained array.
shape: `tuple`
The shape of the array to be loaded.
Examples
>>> import asdf >>> ref = asdf.ExternalArrayReference("myfitsfile.fits", 1, "float64", (100, 100)) >>> tree = {'reference': ref} >>> with asdf.AsdfFile(tree) as ff: ... ff.write_to("test.asdf")
Attributes Summary
handle_dynamic_subclasses
has_required_modules
name
organization
requires
standard
supported_versions
types
validators
version
yaml_tag
Methods Summary
from_tree
(tree, ctx)from_tree_tagged
(tree, ctx)Converts from tagged tree into custom type. incompatible_version
(version)Indicates if given version is known to be incompatible with this type. make_yaml_tag
(name[, versioned])Given the name of a type, returns a string representing its YAML tag. names
()Returns the name(s) represented by this tag type as a list. tag_base
()Returns the base of the YAML tag for types represented by this class. to_tree
(data, ctx)to_tree_tagged
(node, ctx)Converts instances of custom types into tagged objects. Attributes Documentation
-
handle_dynamic_subclasses
= False¶
-
has_required_modules
= True¶
-
name
= 'core/externalarray'¶
-
organization
= 'stsci.edu'¶
-
requires
= []¶
-
standard
= 'asdf'¶
-
supported_versions
= []¶
-
types
= []¶
-
validators
= {}¶
-
version
= Version('1.0.0')¶
-
yaml_tag
= 'tag:stsci.edu:asdf/core/externalarray-1.0.0'¶
Methods Documentation
-
from_tree_tagged
(tree, ctx)¶ Converts from tagged tree into custom type.
It is more common for extension classes to override
from_tree
instead of this method. This method should only be overridden if it is necessary to access the_tag
property of theTagged
object directly.Parameters: tree :
asdf.tagged.Tagged
object representing YAML treectx :
AsdfFile
An instance of the
AsdfFile
object that is being constructed.Returns: An instance of the custom type represented by this extension class.
-
incompatible_version
(version)¶ Indicates if given version is known to be incompatible with this type.
If this tag class explicitly identifies compatible versions then this checks whether a given version is compatible or not (see
supported_versions
). Otherwise, all versions are assumed to be compatible.Child classes can override this method to affect how version compatiblity for this type is determined.
Parameters: version :
str
orAsdfVersion
The version to test for compatibility.
-
make_yaml_tag
(name, versioned=True)¶ Given the name of a type, returns a string representing its YAML tag.
Parameters: name : str
The name of the type. In most cases this will correspond to the
name
attribute of the tag type. However, it is passed as a parameter since some tag types represent multiple custom types.versioned : bool
If
True
, the tag will be versioned. Otherwise, a YAML tag without a version will be returned.Returns: str
representing the YAML tag
-
names
()¶ Returns the name(s) represented by this tag type as a list.
While some tag types represent only a single custom type, others represent multiple types. In the latter case, the
name
attribute of the extension is actually a list, not simply a string. This method normalizes the value ofname
by returning a list in all cases.Returns: list
of names represented by this tag type
-
tag_base
()¶ Returns the base of the YAML tag for types represented by this class.
This method returns the portion of the tag that represents the standard and the organization of any type represented by this class.
Returns: str
representing the base of the YAML tag
-
to_tree_tagged
(node, ctx)¶ Converts instances of custom types into tagged objects.
It is more common for custom tag types to override
to_tree
instead of this method. This method should only be overridden if it is necessary to modify the YAML tag that will be used to tag this object.Parameters: node :
object
Instance of a custom type to be serialized. Will be an instance (or an instance of a subclass) of one of the types listed in the
types
attribute of this class.ctx :
AsdfFile
An instance of the
AsdfFile
object that is being written out.Returns: An instance of
asdf.tagged.Tagged
.
-