lsst.daf.persistence  19.0.0-5-g24a5ec6
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
lsst.daf.persistence.registries.PosixRegistry Class Reference
Inheritance diagram for lsst.daf.persistence.registries.PosixRegistry:
lsst.daf.persistence.registries.Registry

Classes

class  LookupData
 

Public Member Functions

def __init__ (self, root)
 
def lookup (self, lookupProperties, reference, dataId, **kwargs)
 

Static Public Member Functions

def getHduNumber (template, dataId)
 
def lookupMetadata (filepath, template, lookupData, storage)
 
def lookupFitsMetadata (filepath, template, lookupData, dataId)
 
def create (location)
 

Public Attributes

 root
 

Detailed Description

A glob-based filesystem registry

Definition at line 108 of file registries.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.daf.persistence.registries.PosixRegistry.__init__ (   self,
  root 
)

Definition at line 111 of file registries.py.

Member Function Documentation

◆ create()

def lsst.daf.persistence.registries.Registry.create (   location)
staticinherited
Create a registry object of an appropriate type.
@param location (string) Path or URL for registry, or None if
                 unavailable

Definition at line 71 of file registries.py.

◆ getHduNumber()

def lsst.daf.persistence.registries.PosixRegistry.getHduNumber (   template,
  dataId 
)
static
Looks up the HDU number for a given template+dataId.
:param template: template with HDU specifier (ends with brackets and an
identifier that can be populated by a key-value pair in dataId.
e.g. "%(visit)07d/instcal%(visit)07d.fits.fz[%(ccdnum)d]"
:param dataId: dictionary that hopefully has a key-value pair whose key
matches (has the same name) as the key specifier in the template.
:return: the HDU specified by the template+dataId pair, or None if the
HDU can not be determined.

Definition at line 116 of file registries.py.

◆ lookup()

def lsst.daf.persistence.registries.PosixRegistry.lookup (   self,
  lookupProperties,
  reference,
  dataId,
**  kwargs 
)
Perform a lookup in the registry.

Return values are refined by the values in dataId.
Returns a list of values that match keys in lookupProperties.
e.g. if the template is 'raw/raw_v%(visit)d_f%(filter)s.fits.gz', and
dataId={'visit':1}, and lookupProperties is ['filter'], and the
filesystem under self.root has exactly one file 'raw/raw_v1_fg.fits.gz'
then the return value will be [('g',)]

:param lookupProperties: keys whose values will be returned.
:param reference: other data types that may be used to search for values.
:param dataId: must be an iterable. Keys must be string.
If value is a string then will look for elements in the repository that match value for key.
If value is a 2-item iterable then will look for elements in the repository are between (inclusive)
the first and second items in the value.
:param **kwargs: keys required for the posix registry to search for items. If required keys are not
provide will return an empty list.
'template': required. template parameter (typically from a policy) that can be used to look for files
'storage': optional. Needed to look for metadata in files. Currently supported values: 'FitsStorage'.
:return: a list of values that match keys in lookupProperties.

Definition at line 194 of file registries.py.

◆ lookupFitsMetadata()

def lsst.daf.persistence.registries.PosixRegistry.lookupFitsMetadata (   filepath,
  template,
  lookupData,
  dataId 
)
static
Look up metadata in a fits file.
Will try to discover the correct HDU to look in by testing if the
template has a value in brackets at the end.
If the HDU is specified but the metadata key is not discovered in
that HDU, will look in the primary HDU before giving up.
:param filepath: path to the file
:param template: template that was used to discover the file. This can
be used to look up the correct HDU as needed.
:param lookupData: an instance if LookupData that contains the
lookupProperties, the dataId, and the data that has been found so far.
Will be updated with new information as discovered.
:param dataId:
:return:

Definition at line 249 of file registries.py.

◆ lookupMetadata()

def lsst.daf.persistence.registries.PosixRegistry.lookupMetadata (   filepath,
  template,
  lookupData,
  storage 
)
static
Dispatcher for looking up metadata in a file of a given storage type

Definition at line 242 of file registries.py.

Member Data Documentation

◆ root

lsst.daf.persistence.registries.PosixRegistry.root

Definition at line 113 of file registries.py.


The documentation for this class was generated from the following file: