lsst.obs.base.cameraMapper Namespace Reference

Classes
class	CameraMapper

Functions
def	exposureFromImage (image, dataId=None, mapper=None, logger=None, setVisitInfo=True)
def	validateRecipeFitsStorage (recipes)

Function Documentation

exposureFromImage()

def lsst.obs.base.cameraMapper.exposureFromImage	(		image,
			dataId = None,
			mapper = None,
			logger = None,
			setVisitInfo = True
	)

Generate an Exposure from an image-like object

If the image is a DecoratedImage then also set its WCS and metadata
(Image and MaskedImage are missing the necessary metadata
and Exposure already has those set)

Parameters
----------
image : Image-like object
    Can be one of lsst.afw.image.DecoratedImage, Image, MaskedImage or
    Exposure.

Returns
-------
`lsst.afw.image.Exposure`
    Exposure containing input image.

Definition at line 1286 of file cameraMapper.py.

def exposureFromImage(image, dataId=None, mapper=None, logger=None, setVisitInfo=True):
    """Generate an Exposure from an image-like object
 
    If the image is a DecoratedImage then also set its WCS and metadata
    (Image and MaskedImage are missing the necessary metadata
    and Exposure already has those set)
 
    Parameters
    ----------
    image : Image-like object
        Can be one of lsst.afw.image.DecoratedImage, Image, MaskedImage or
        Exposure.
 
    Returns
    -------
    `lsst.afw.image.Exposure`
        Exposure containing input image.
    """
    translatorClass = None
    if mapper is not None:
        translatorClass = mapper.translatorClass
 
    metadata = None
    if isinstance(image, afwImage.MaskedImage):
        exposure = afwImage.makeExposure(image)
    elif isinstance(image, afwImage.DecoratedImage):
        exposure = afwImage.makeExposure(afwImage.makeMaskedImage(image.getImage()))
        metadata = image.getMetadata()
        fix_header(metadata, translator_class=translatorClass)
        exposure.setMetadata(metadata)
    elif isinstance(image, afwImage.Exposure):
        exposure = image
        metadata = exposure.getMetadata()
        fix_header(metadata, translator_class=translatorClass)
    else:  # Image
        exposure = afwImage.makeExposure(afwImage.makeMaskedImage(image))
 
    # set VisitInfo if we can
    if setVisitInfo and exposure.getInfo().getVisitInfo() is None:
        if metadata is not None:
            if mapper is None:
                if not logger:
                    logger = lsstLog.Log.getLogger("CameraMapper")
                logger.warn("I can only set the VisitInfo if you provide a mapper")
            else:
                exposureId = mapper._computeCcdExposureId(dataId)
                visitInfo = mapper.makeRawVisitInfo(md=metadata, exposureId=exposureId)
 
                exposure.getInfo().setVisitInfo(visitInfo)
 
    return exposure
 
 

validateRecipeFitsStorage()

def lsst.obs.base.cameraMapper.validateRecipeFitsStorage

(

recipes

)

Validate recipes for FitsStorage

The recipes are supplemented with default values where appropriate.

TODO: replace this custom validation code with Cerberus (DM-11846)

Parameters
----------
recipes : `lsst.daf.persistence.Policy`
    FitsStorage recipes to validate.

Returns
-------
validated : `lsst.daf.base.PropertySet`
    Validated FitsStorage recipe.

Raises
------
`RuntimeError`
    If validation fails.

Definition at line 1339 of file cameraMapper.py.

def validateRecipeFitsStorage(recipes):
    """Validate recipes for FitsStorage
 
    The recipes are supplemented with default values where appropriate.
 
    TODO: replace this custom validation code with Cerberus (DM-11846)
 
    Parameters
    ----------
    recipes : `lsst.daf.persistence.Policy`
        FitsStorage recipes to validate.
 
    Returns
    -------
    validated : `lsst.daf.base.PropertySet`
        Validated FitsStorage recipe.
 
    Raises
    ------
    `RuntimeError`
        If validation fails.
    """
    # Schemas define what should be there, and the default values (and by the default
    # value, the expected type).
    compressionSchema = {
        "algorithm": "NONE",
        "rows": 1,
        "columns": 0,
        "quantizeLevel": 0.0,
    }
    scalingSchema = {
        "algorithm": "NONE",
        "bitpix": 0,
        "maskPlanes": ["NO_DATA"],
        "seed": 0,
        "quantizeLevel": 4.0,
        "quantizePad": 5.0,
        "fuzz": True,
        "bscale": 1.0,
        "bzero": 0.0,
    }
 
    def checkUnrecognized(entry, allowed, description):
        """Check to see if the entry contains unrecognised keywords"""
        unrecognized = set(entry.keys()) - set(allowed)
        if unrecognized:
            raise RuntimeError(
                "Unrecognized entries when parsing image compression recipe %s: %s" %
                (description, unrecognized))
 
    validated = {}
    for name in recipes.names(True):
        checkUnrecognized(recipes[name], ["image", "mask", "variance"], name)
        rr = dafBase.PropertySet()
        validated[name] = rr
        for plane in ("image", "mask", "variance"):
            checkUnrecognized(recipes[name][plane], ["compression", "scaling"],
                              name + "->" + plane)
 
            for settings, schema in (("compression", compressionSchema),
                                     ("scaling", scalingSchema)):
                prefix = plane + "." + settings
                if settings not in recipes[name][plane]:
                    for key in schema:
                        rr.set(prefix + "." + key, schema[key])
                    continue
                entry = recipes[name][plane][settings]
                checkUnrecognized(entry, schema.keys(), name + "->" + plane + "->" + settings)
                for key in schema:
                    value = type(schema[key])(entry[key]) if key in entry else schema[key]
                    rr.set(prefix + "." + key, value)
    return validated