LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
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.