CosmologyFromFormat¶
- class astropy.cosmology.connect.CosmologyFromFormat(instance, cosmo_cls)[source]¶
Bases:
astropy.io.registry.interface.UnifiedReadWrite
Transform object to a
Cosmology
.This function provides the Cosmology interface to the Astropy unified I/O layer. This allows easily parsing supported data formats using syntax such as:
>>> from astropy.cosmology import Cosmology >>> cosmo1 = Cosmology.from_format(cosmo_mapping, format='mapping')
When the
from_format
method is called from a subclass the subclass will provide a keyword argumentcosmology=<class>
to the registered parser. The method uses this cosmology class, regardless of the class indicated in the data, and sets parameters’ default values from the class’ signature.Get help on the available readers using the
help()
method:>>> Cosmology.from_format.help() # Get help and list supported formats >>> Cosmology.from_format.help('<format>') # Get detailed help on a format >>> Cosmology.from_format.list_formats() # Print list of available formats
See also: https://docs.astropy.org/en/stable/io/unified.html
Note
from_format()
andread()
currently access the same registry. This will be deprecated and formats intended forread
should not be used here. UseCosmology.to_format.help()
to confirm that the format may be used to convert to a Cosmology.- Parameters
- obj
object
The object to parse according to ‘format’
- *args
Positional arguments passed through to data parser.
- format
python:str
(optional, keyword-only) Object format specifier.
- **kwargs
Keyword arguments passed through to data parser.
- obj
- Returns
Methods Summary
__call__
(obj, *args, **kwargs)Call self as a function.
Methods Documentation