lsst.datarel.datasetScanner Namespace Reference

Classes
class	_FormatKey
class	_PathComponent
class	DatasetScanner
class	HfsScanner

Functions
def	getMapperClass (camera)
def	parseDataIdRules (ruleList, camera)
def	_mungeStr (k, v, dataId)
def	_mungeInt (k, v, dataId)
def	_mungeLsstSim (k, v, dataId)
def	_mungeSdss (k, v, dataId)
def	_mungeCfht (k, v, dataId)

Variables
list	__all__
dictionary	_mapperClassName
dictionary	_keyTypes
dictionary	_mungeFunctions

Function Documentation

_mungeCfht()

def lsst.datarel.datasetScanner._mungeCfht (   k,   v,   dataId  )

private

Definition at line 378 of file datasetScanner.py.

def _mungeCfht(k, v, dataId):
    dataId = dataId.copy()
    if k == 'ccd':
        dataId['ccd'] = int(v)
        dataId['ccdName'] = v
    elif k == 'amp':
        dataId['amp'] = int(v)
        dataId['ampName'] = v
    elif _keyTypes['sdss'][k] == int:
        dataId[k] = int(v)
    else:
        dataId[k] = v
    return dataId

_mungeInt()

def lsst.datarel.datasetScanner._mungeInt (   k,   v,   dataId  )

private

Munger for keys with integer formats.

Definition at line 181 of file datasetScanner.py.

def _mungeInt(k, v, dataId):
    """Munger for keys with integer formats."""
    kv = dataId.copy()
    kv[k] = int(v)
    return kv

_mungeLsstSim()

def lsst.datarel.datasetScanner._mungeLsstSim (   k,   v,   dataId  )

private

Definition at line 346 of file datasetScanner.py.

def _mungeLsstSim(k, v, dataId):
    dataId = dataId.copy()
    if k == 'raft':
        r1, r2 = v
        dataId['raft'] = r1 + ',' + r2
        dataId['raftId'] = int(r1) * 5 + int(r2)
    elif k in ('sensor', 'ccd'):
        s1, s2 = v
        dataId['sensor'] = s1 + ',' + s2
        dataId['sensorNum'] = int(s1) * 3 + int(s2)
    elif k in ('channel', 'amp'):
        c1, c2 = v
        dataId['channel'] = c1 + ',' + c2
        dataId['channelNum'] = int(c1) * 8 + int(c2)
    elif k in ('snap', 'exposure'):
        dataId['snap'] = int(v)
    elif _keyTypes['lsstsim'][k] == int:
        dataId[k] = int(v)
    else:
        dataId[k] = v
    return dataId

_mungeSdss()

def lsst.datarel.datasetScanner._mungeSdss (   k,   v,   dataId  )

private

Definition at line 369 of file datasetScanner.py.

def _mungeSdss(k, v, dataId):
    dataId = dataId.copy()
    if _keyTypes['sdss'][k] == int:
        dataId[k] = int(v)
    else:
        dataId[k] = v
    return dataId

_mungeStr()

def lsst.datarel.datasetScanner._mungeStr (   k,   v,   dataId  )

private

Munger for keys with string formats.

Definition at line 174 of file datasetScanner.py.

def _mungeStr(k, v, dataId):
    """Munger for keys with string formats."""
    kv = dataId.copy()
    kv[k] = str(v)
    return kv

getMapperClass()

def lsst.datarel.datasetScanner.getMapperClass

(

camera

)

Return the subclass of lsst.daf.persistence.Mapper
to use for the camera with the given name (case-insensitive).

Definition at line 42 of file datasetScanner.py.

def getMapperClass(camera):
    """Return the subclass of lsst.daf.persistence.Mapper
    to use for the camera with the given name (case-insensitive).
    """
    camera = camera.lower()
    if camera not in _mapperClassName:
        raise RuntimeError(str.format("{} is not a valid camera name", camera))
    name = _mapperClassName[camera]
    try:
        pieces = name.split('.')
        cls = reduce(getattr, pieces[1:], __import__('.'.join(pieces[:-1])))
        return cls
    except:
        raise RuntimeError(str.format("Failed to import {}", name))

parseDataIdRules()

def lsst.datarel.datasetScanner.parseDataIdRules	(		ruleList,
			camera
	)

A rule is a string in the following format:

'key=value1[^value2[^value3...]'

The values may either be strings, or of the form 'int...int'
(e.g. '1..3') which is interpreted as '1^2^3' (inclusive, unlike a python
range). So '0^2..4^7..9' is equivalent to '0^2^3^4^7^8^9'.

This function parses a list of such strings, and returns a dict mapping
keys to sets of legal values.

ruleList:
    List of rule strings
camera:
    Camera the rule list applies to (e.g. 'lsstSim' or 'sdss')

Definition at line 105 of file datasetScanner.py.

def parseDataIdRules(ruleList, camera):
    """A rule is a string in the following format:

    'key=value1[^value2[^value3...]'

    The values may either be strings, or of the form 'int...int'
    (e.g. '1..3') which is interpreted as '1^2^3' (inclusive, unlike a python
    range). So '0^2..4^7..9' is equivalent to '0^2^3^4^7^8^9'.

    This function parses a list of such strings, and returns a dict mapping
    keys to sets of legal values.

    ruleList:
        List of rule strings
    camera:
        Camera the rule list applies to (e.g. 'lsstSim' or 'sdss')
    """
    camera = camera.lower()
    if camera not in _keyTypes:
        raise RuntimeError('{} is not a recognized camera name'.format(camera))
    kvs = {}
    for rule in ruleList:
        # process rule for a single key
        key, _, pattern = rule.partition('=')
        if key not in _keyTypes[camera]:
            raise RuntimeError('{} is not a valid dataId key for camera {}'.format(key, camera))
        if len(pattern) == 0:
            continue
        values = set()
        # compute union of all values or value ranges
        for p in pattern.split('^'):
            if _keyTypes[camera][key] == int:
                # check for range syntax
                m = re.search(r'^(\d+)\.\.(\d+)$', p)
                if m:
                    values.update(xrange(int(m.group(1)), int(m.group(2)) + 1))
                else:
                    values.add(int(p))
            else:
                values.add(p)
        if key in kvs:
            kvs[key].update(values)
        else:
            kvs[key] = values
    return kvs

Variable Documentation

__all__

list lsst.datarel.datasetScanner.__all__

private

Initial value:

=  ['getMapperClass',
           'parseDataIdRules',
           'HfsScanner',
           'DatasetScanner',
           ]

Definition at line 28 of file datasetScanner.py.

_keyTypes

dictionary lsst.datarel.datasetScanner._keyTypes

private

Definition at line 58 of file datasetScanner.py.

_mapperClassName

dictionary lsst.datarel.datasetScanner._mapperClassName

private

Initial value:

=  {
    'lsstsim': 'lsst.obs.lsstSim.LsstSimMapper',
    'sdss': 'lsst.obs.sdss.SdssMapper',
    'cfht': 'lsst.obs.cfht.CfhtMapper',
}

Definition at line 35 of file datasetScanner.py.

_mungeFunctions

dictionary lsst.datarel.datasetScanner._mungeFunctions

private

Initial value:

=  {
    'lsstsim': _mungeLsstSim,
    'sdss': _mungeSdss,
    'cfht': _mungeCfht,
}

Definition at line 392 of file datasetScanner.py.