Utils.py

Go to the documentation of this file.

#!/usr/bin/env python

# 
# LSST Data Management System
# Copyright 2008, 2009, 2010 LSST Corporation.
# 
# This product includes software developed by the
# LSST Project (http://www.lsst.org/).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the LSST License Statement and 
# the GNU General Public License along with this program.  If not, 
# see <http://www.lsstcorp.org/LegalNotices/>.
#

# -*- python -*-

import lsst.daf.base
import lsst.pex.logging
import lsst.pex.exceptions

def createAdditionalData(stage, stagePolicy, clipboard):
    """
    Extract additionalData values, as specified by policy, from the clipboard.
    Also create predefined keys for runId, sliceId, and universeSize.
    This routine no longer performs slice-to-CCD mappings as of DC3a.
    Instead, they are now performed in the SliceInfoStage.
    """

    additionalData = lsst.daf.base.PropertySet()
    # Parse array of "key=clipboard-key" or
    # "key=clipboard-key.dataproperty-key" mappings
    if stagePolicy.exists('parameters.additionalData'):
        dataPairs = stagePolicy.getStringArray('parameters.additionalData')
        for pair in dataPairs:
            (rename, name) = pair.split("=")
            if name.find(".") != -1:
                (clipKey, psKey) = name.split(".", 1)
                cprops = clipboard.get(clipKey)
                if cprops is None:
                    raise RuntimeError, \
                          "Expected data not found on clipboard: "+ clipKey
                if isinstance(cprops, dict):
                    additionalData.set(rename, cprops[psKey])
                elif isinstance(cprops, lsst.daf.base.PropertySet):
                    additionalData.copy(rename, cprops, psKey)
                else:
                    raise RuntimeError, \
                          "Unknown data type (not dict or PropertySet) found on clipboard: "+ clipKey
            else:
                cprops = clipboard.get(name)
                if cprops is None:
                    raise RuntimeError, \
                          "Expected data not found on clipboard: "+ name
                additionalData.set(rename, clipboard.get(name))
            lsst.pex.logging.Trace("pex.harness.Utils.createAdditionalData", 3, \
                    "AdditionalData item: " + pair)

    # Add the predefined runId, sliceId, and universeSize keys

    additionalData.set('runId', stage.getRun())
    additionalData.setInt('sliceId', stage.getRank())
    additionalData.setInt('universeSize', stage.getUniverseSize())

    lsst.pex.logging.Trace("pex.harness.Utils.createAdditionalData", 3, \
            "additionalData:\n" + additionalData.toString(False))

    return additionalData

def propertySetToDict(propertySet):
    """
    Convert a PropertySet to a Python dictionary.
    """
    dict = {}
    for i in propertySet.names():
        dict[i] = propertySet.get(i)
    return dict