|
lsst.daf.persistence g6a31054a6e+48648d4d98
|
Classes | |
| class | PosixStorage |
Functions | |
| def | readConfigStorage (butlerLocation) |
| def | writeConfigStorage (butlerLocation, obj) |
| def | readFitsStorage (butlerLocation) |
| def | writeFitsStorage (butlerLocation, obj) |
| def | readParquetStorage (butlerLocation) |
| def | writeParquetStorage (butlerLocation, obj) |
| def | writeYamlStorage (butlerLocation, obj) |
| def | readPickleStorage (butlerLocation) |
| def | writePickleStorage (butlerLocation, obj) |
| def | readFitsCatalogStorage (butlerLocation) |
| def | writeFitsCatalogStorage (butlerLocation, obj) |
| def | readMatplotlibStorage (butlerLocation) |
| def | writeMatplotlibStorage (butlerLocation, obj) |
| def | readYamlStorage (butlerLocation) |
| def lsst.daf.persistence.posixStorage.readConfigStorage | ( | butlerLocation | ) |
Read an lsst.pex.config.Config from a butlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 512 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readFitsCatalogStorage | ( | butlerLocation | ) |
Read a catalog from a FITS table specified by ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 776 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readFitsStorage | ( | butlerLocation | ) |
Read objects from a FITS file specified by ButlerLocation.
The object is read using class or static method
``readFitsWithOptions(path, options)``, if it exists, else
``readFits(path)``. The ``options`` argument is the data returned by
``butlerLocation.getAdditionalData()``.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 565 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readMatplotlibStorage | ( | butlerLocation | ) |
Read from a butlerLocation (always fails for this storage type).
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 831 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readParquetStorage | ( | butlerLocation | ) |
Read a catalog from a Parquet file specified by ButlerLocation.
The object returned by this is expected to be a subtype
of `ParquetTable`, which is a thin wrapper to `pyarrow.ParquetFile`
that allows for lazy loading of the data.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 648 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readPickleStorage | ( | butlerLocation | ) |
Read an object from a pickle file specified by ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 725 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.readYamlStorage | ( | butlerLocation | ) |
Read an object from a YAML file specified by a butlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
Returns
-------
A list of objects as described by the butler location. One item for
each location in butlerLocation.getLocations()
Definition at line 876 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeConfigStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes an lsst.pex.config.Config object to a location specified by
ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : object instance
The object to be written.
Definition at line 548 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeFitsCatalogStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes a catalog to a FITS table specified by ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : object instance
The object to be written.
Definition at line 810 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeFitsStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes an object to a FITS file specified by ButlerLocation.
The object is written using method
``writeFitsWithOptions(path, options)``, if it exists, else
``writeFits(path)``. The ``options`` argument is the data returned by
``butlerLocation.getAdditionalData()``.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : object instance
The object to be written.
Definition at line 622 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeMatplotlibStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes a matplotlib.figure.Figure to a location, using the template's
filename suffix to infer the file format.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : matplotlib.figure.Figure
The object to be written.
Definition at line 847 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeParquetStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes pandas dataframe to parquet file.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object(s) to be read.
obj : `lsst.qa.explorer.parquetTable.ParquetTable`
Wrapped DataFrame to write.
Definition at line 688 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writePickleStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes an object to a pickle file specified by ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : object instance
The object to be written.
Definition at line 758 of file posixStorage.py.
| def lsst.daf.persistence.posixStorage.writeYamlStorage | ( | butlerLocation, | |
| obj | |||
| ) |
Writes an object to a YAML file specified by ButlerLocation.
Parameters
----------
butlerLocation : ButlerLocation
The location for the object to be written.
obj : object instance
The object to be written.
Definition at line 707 of file posixStorage.py.