lsst.pipe.tasks.script.makeDiscreteSkyMap Namespace Reference

Functions
	makeDiscreteSkyMap (repo, config_file, collections, instrument, skymap_id='discrete', old_skymap_id=None)

Function Documentation

makeDiscreteSkyMap()

lsst.pipe.tasks.script.makeDiscreteSkyMap.makeDiscreteSkyMap	(		repo,
			config_file,
			collections,
			instrument,
			skymap_id = 'discrete',
			old_skymap_id = None )

Implements the command line interface `butler make-discrete-skymap` subcommand,
should only be called by command line tools and unit test code that tests
this function.

Constructs a skymap from calibrated exposure in the butler repository

Parameters
----------
repo : `str`
    URI to the location to read the repo.
config_file : `str` or `None`
    URI to a config file that contains overrides to the skymap config.
collections : `list` [`str`]
    An expression specifying the collections to be searched (in order) when
    reading datasets, and optionally dataset type restrictions on them.
    At least one collection must be specified.  This is the collection
    with the calibrated exposures.
instrument : `str`
    The name or fully-qualified class name of an instrument.
skymap_id : `str`, optional
    The identifier of the skymap to save.  Default is 'discrete'.
old_skymap_id : `str`, optional
    The identifer of the skymap to append to.  Must differ from
    ``skymap_id``.  Ignored unless ``config.doAppend=True``.

Definition at line 29 of file makeDiscreteSkyMap.py.

                       skymap_id='discrete', old_skymap_id=None):
    """Implements the command line interface `butler make-discrete-skymap` subcommand,
    should only be called by command line tools and unit test code that tests
    this function.
 
    Constructs a skymap from calibrated exposure in the butler repository
 
    Parameters
    ----------
    repo : `str`
        URI to the location to read the repo.
    config_file : `str` or `None`
        URI to a config file that contains overrides to the skymap config.
    collections : `list` [`str`]
        An expression specifying the collections to be searched (in order) when
        reading datasets, and optionally dataset type restrictions on them.
        At least one collection must be specified.  This is the collection
        with the calibrated exposures.
    instrument : `str`
        The name or fully-qualified class name of an instrument.
    skymap_id : `str`, optional
        The identifier of the skymap to save.  Default is 'discrete'.
    old_skymap_id : `str`, optional
        The identifer of the skymap to append to.  Must differ from
        ``skymap_id``.  Ignored unless ``config.doAppend=True``.
    """
    butler = Butler(repo, collections=collections, writeable=True)
    instr = Instrument.from_string(instrument, butler.registry)
    config = MakeDiscreteSkyMapConfig()
    instr.applyConfigOverrides(MakeDiscreteSkyMapTask._DefaultName, config)
 
    if config_file is not None:
        resource = ResourcePath(config_file)
        with resource.as_local() as local_config:
            config.load(local_config.ospath)
 
    # The coaddName for a SkyMap is only relevant in Gen2, and we completely
    # ignore it here; once Gen2 is gone it can be removed.
    oldSkyMap = None
    if config.doAppend:
        if old_skymap_id is None:
            raise ValueError("old_skymap_id must be provided if config.doAppend is True.")
        dataId = {'skymap': old_skymap_id}
        try:
            oldSkyMap = butler.get(BaseSkyMap.SKYMAP_DATASET_TYPE_NAME, collections=collections,
                                   dataId=dataId)
        except LookupError as e:
            msg = (f"Could not find seed skymap with dataId {dataId} "
                   f"in collections {collections} but doAppend is {config.doAppend}.  Aborting...")
            raise LookupError(msg, *e.args[1:])
 
    datasets = butler.registry.queryDatasets('calexp', collections=collections)
    wcs_bbox_tuple_list = [(butler.get(ref.makeComponentRef("wcs")),
                            butler.get(ref.makeComponentRef("bbox")))
                           for ref in datasets]
    task = MakeDiscreteSkyMapTask(config=config)
    result = task.run(wcs_bbox_tuple_list, oldSkyMap)
    result.skyMap.register(skymap_id, butler)