Inheritance diagram for lsst.daf.persistence.fsScanner.FsScanner:

Public Member Functions
def	__init__ (self, pathTemplate)

def	getFields (self)

def	isNumeric (self, name)

def	isInt (self, name)

def	isFloat (self, name)

def	processPath (self, location)

Public Attributes
	globString

	fields

	reString

Detailed Description

Class to scan a filesystem location for paths matching a template.

Decomposes the resulting paths into fields and passes them to a callback
function.

Definition at line 35 of file fsScanner.py.

Constructor & Destructor Documentation

◆ init()

def lsst.daf.persistence.fsScanner.FsScanner.__init__	(	self,
		pathTemplate
	)

Constructor.  Takes the path template, which should be in the form
of a Python string with named format substitution specifications.
Such a template would be suitable for generating a path given a set of
fields in a dictionary.  Does not handle hex (%x or %X).

Example:
    %(field)s/%(visit)d/%(exposure)d/raw-%(visit)d-e%(exposure)03d-c%(ccd)03d-a%(amp)03d.fits

Note that fields may appear multiple times; the second and subsequent
appearances of such fields will have "_{number}" appended to them to
disambiguate, although it is typically assumed that they will all be
identical.

Trailing brackets (and their contents) can be used to indicate which HDU from a file should
be used. They will not be included in the filename search.

Definition at line 42 of file fsScanner.py.

Member Function Documentation

◆ getFields()

def lsst.daf.persistence.fsScanner.FsScanner.getFields ( self )

Return the list of fields that will be returned from matched
paths, in order.

Definition at line 100 of file fsScanner.py.

◆ isFloat()

def lsst.daf.persistence.fsScanner.FsScanner.isFloat	(	self,
		name
	)

Return true if the given field contains an float.

Definition at line 119 of file fsScanner.py.

◆ isInt()

def lsst.daf.persistence.fsScanner.FsScanner.isInt	(	self,
		name
	)

Return true if the given field contains an integer.

Definition at line 114 of file fsScanner.py.

◆ isNumeric()

def lsst.daf.persistence.fsScanner.FsScanner.isNumeric	(	self,
		name
	)

Return true if the given field contains a number.

Definition at line 109 of file fsScanner.py.

◆ processPath()

def lsst.daf.persistence.fsScanner.FsScanner.processPath	(	self,
		location
	)

Scan a given path location. Return info about paths that conform to the path template:
:param location:
:return: Path info: {path: {key:value ...}, ...} e.g.:
    {'0239622/instcal0239622.fits.fz': {'visit_0': 239622, 'visit': 239622}}

Definition at line 124 of file fsScanner.py.

Member Data Documentation

◆ fields

lsst.daf.persistence.fsScanner.FsScanner.fields

Definition at line 71 of file fsScanner.py.

◆ globString

lsst.daf.persistence.fsScanner.FsScanner.globString

Definition at line 67 of file fsScanner.py.

◆ reString

lsst.daf.persistence.fsScanner.FsScanner.reString

Definition at line 72 of file fsScanner.py.

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

python/lsst/daf/persistence/fsScanner.py

Public Member Functions

Public Attributes