API

The classes and functions here describe the API for asdf-astropy.

asdf_astropy.testing.helpers Module

Helpers for testing astropy objects in ASDF files.

Functions

assert_bounding_box_roundtrip(bounding_box, ...)	Assert that a bounding_box can be written to an ASDF file and read back in without losing any of its essential properties.
assert_description_equal(a, b)	Assert table descriptions are equal.
assert_earth_location_equal(a, b)	Assert earth location objects are equal.
assert_frame_equal(a, b)	Assert frame objects are equal.
assert_hdu_list_equal(a, b)	Assert fits hdulists are equal.
assert_model_equal(a, b)	Assert that two model instances are equivalent.
assert_model_roundtrip(model, tmp_path[, ...])	Assert that a model can be written to an ASDF file and read back in without losing any of its essential properties.
assert_representation_equal(a, b)	Assert representation objects are equal.
assert_sky_coord_equal(a, b)	Assert sky coordinate objects are equal.
assert_spectral_coord_equal(a, b)	Assert spectral coordinate objects are equal.
assert_table_equal(a, b)	Assert astropy tables are equal.
assert_table_roundtrip(table, tmp_path)	Assert that a table can be written to an ASDF file and read back in without losing any of its essential properties.
assert_time_delta_equal(a, b)	Assert time delta objects are equal
assert_time_equal(a, b)	Assert time objects are equal

asdf_astropy.converters Package

Classes

AngleConverter()
LatitudeConverter()
LongitudeConverter()
EarthLocationConverter()
FrameConverter(tags, frame_type_name)
LegacyICRSConverter()
RepresentationConverter()
SkyCoordConverter()
SpectralCoordConverter()
EquivalencyConverter()
QuantityConverter()
UnitConverter()
MagUnitConverter()
FitsConverter()
AsdfFitsConverter()
AstropyFitsConverter()
ColumnConverter()
AstropyTableConverter()
AsdfTableConverter()
NdarrayMixinConverter()
TimeDeltaConverter()
TimeConverter()
CompoundConverter()	ASDF serialization support for CompoundModel.
TransformConverterBase()	ABC for transform/model converters.
SimpleTransformConverter(tags, model_type_name)	Class for converters that serialize all of a model's parameters and do not require special behavior based on tag version.
ConstantConverter()	ASDF support for serializing the Const1D and Const2D models.
IdentityConverter()	ASDF support for serializing the Identity model.
RemapAxesConverter()	ASDF support for serializing the Mapping model
UnitsMappingConverter()	ASDF support for serializing the UnitsMapping model.
MathFunctionsConverter()	ASDF support for serializing the math functions models, each of which corresponds to a numpy ufunc.
PolynomialConverter()	ASDF support for serializing the 1D and 2D polynomial models.
OrthoPolynomialConverter()	ASDF support for serializing models that inherit OrthoPolyomialBase.
ProjectionConverter(tags, pix2sky_type_name, ...)	ASDF support for serializing most projection models.
ModelBoundingBoxConverter()
CompoundBoundingBoxConverter()
Rotate3DConverter()	ASDF support for serializing rotation models that use the rotate3d tag.
RotationSequenceConverter()	ASDF support for serializing rotation sequence models.
SplineConverter()	ASDF support for serializing 1D spline models
TabularConverter()	ASDF support for serializing tabular models.

Class Inheritance Diagram

asdf_astropy.extensions Module

This module builds all of the ASDF extensions which will be registered by asdf_astropy.integration, via an entry-point in the pyproject.toml file.

Variables

TRANSFORM_CONVERTERS	Built-in mutable sequence.
TRANSFORM_MANIFEST_URIS	Built-in mutable sequence.
TRANSFORM_EXTENSIONS	Built-in mutable sequence.
COORDINATES_CONVERTERS	Built-in mutable sequence.
ASTROPY_CONVERTERS	Built-in mutable sequence.
COORDINATES_EXTENSIONS	Built-in mutable sequence.
ASTROPY_EXTENSIONS	Built-in mutable sequence.
CORE_CONVERTERS	Built-in mutable sequence.
CORE_MANIFEST_URIS	Built-in mutable sequence.
CORE_EXTENSIONS	Built-in mutable sequence.
UNIT_EXTENSIONS	Built-in mutable sequence.

asdf_astropy.integration Module

Functions

get_extensions()	Get the extension instances for the various astropy extensions.
get_resource_mappings()	Get the resource mapping instances for the astropy schemas and manifests.