lsst.daf.persistence  16.0-3-g3806c63+1
Classes | Functions
lsst.daf.persistence.posixStorage Namespace Reference

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 readPafStorage (butlerLocation)
 
def readYamlStorage (butlerLocation)
 
def readBoostStorage (butlerLocation)
 
def writeBoostStorage (butlerLocation, obj)
 

Function Documentation

◆ readBoostStorage()

def lsst.daf.persistence.posixStorage.readBoostStorage (   butlerLocation)
Read an object from a boost::serialization file.

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 896 of file posixStorage.py.

◆ readConfigStorage()

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 519 of file posixStorage.py.

◆ readFitsCatalogStorage()

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 745 of file posixStorage.py.

◆ readFitsStorage()

def lsst.daf.persistence.posixStorage.readFitsStorage (   butlerLocation)
Read a FITS image 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 565 of file posixStorage.py.

◆ readMatplotlibStorage()

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 800 of file posixStorage.py.

◆ readPafStorage()

def lsst.daf.persistence.posixStorage.readPafStorage (   butlerLocation)
Read a policy from a PAF 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 845 of file posixStorage.py.

◆ readParquetStorage()

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 617 of file posixStorage.py.

◆ readPickleStorage()

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 694 of file posixStorage.py.

◆ readYamlStorage()

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 867 of file posixStorage.py.

◆ writeBoostStorage()

def lsst.daf.persistence.posixStorage.writeBoostStorage (   butlerLocation,
  obj 
)
Writes an object via boost::serialization.

Parameters
----------
butlerLocation : ButlerLocation
    The location for the object to be written.
obj : object instance
    The object to be written.

Definition at line 923 of file posixStorage.py.

◆ writeConfigStorage()

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.

◆ writeFitsCatalogStorage()

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 779 of file posixStorage.py.

◆ writeFitsStorage()

def lsst.daf.persistence.posixStorage.writeFitsStorage (   butlerLocation,
  obj 
)
Writes an object to a FITS 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 592 of file posixStorage.py.

◆ writeMatplotlibStorage()

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 816 of file posixStorage.py.

◆ writeParquetStorage()

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 657 of file posixStorage.py.

◆ writePickleStorage()

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 727 of file posixStorage.py.

◆ writeYamlStorage()

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 676 of file posixStorage.py.