lsst.pipe.tasks.script.registerSkymap Namespace Reference

Classes
class	MakeSkyMapConfig

Functions
	makeSkyMap (butler, config)
	registerSkymap (repo, config, config_file)

Variables
	_log = logging.getLogger(__name__)

Function Documentation

makeSkyMap()

lsst.pipe.tasks.script.registerSkymap.makeSkyMap	(		butler,
			config )

Construct and save a SkyMap into a gen3 butler repository.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler repository to which the new skymap will be written.
config : `MakeSkyMapConfig` or None
    Instance of a configuration class specifying task options.

Definition at line 53 of file registerSkymap.py.

def makeSkyMap(butler, config):
    """Construct and save a SkyMap into a gen3 butler repository.
 
    Parameters
    ----------
    butler : `lsst.daf.butler.Butler`
        Butler repository to which the new skymap will be written.
    config : `MakeSkyMapConfig` or None
        Instance of a configuration class specifying task options.
    """
    skyMap = config.skyMap.apply()
    skyMap.logSkyMapInfo(_log)
    skyMap.register(config.name, butler)
 
 

registerSkymap()

lsst.pipe.tasks.script.registerSkymap.registerSkymap	(		repo,
			config,
			config_file )

Make and register a SkyMap in a butler repository.

Parameters
----------
repo : `str`
    URI to the location of the butler repository.
config : `dict` [`str`, `str`] or `None`
    Key-value pairs to apply as overrides to the ingest config.
config_file : `str` or `None`
    Path to a config overrides file. Can be a URI.

Raises
------
RuntimeError
    If a config overrides file is given and does not exist.

Definition at line 68 of file registerSkymap.py.

def registerSkymap(repo, config, config_file):
    """Make and register a SkyMap in a butler repository.
 
    Parameters
    ----------
    repo : `str`
        URI to the location of the butler repository.
    config : `dict` [`str`, `str`] or `None`
        Key-value pairs to apply as overrides to the ingest config.
    config_file : `str` or `None`
        Path to a config overrides file. Can be a URI.
 
    Raises
    ------
    RuntimeError
        If a config overrides file is given and does not exist.
    """
 
    skyMapConfig = MakeSkyMapConfig()
    if config_file:
        # pex_config can not support URIs but in the script interface
        # we trust that the caller trusts the remote resource they are
        # specifying (configs allow arbitrary python code to run).
        resource = ResourcePath(config_file)
        with resource.as_local() as local_config:
            skyMapConfig.load(local_config.ospath)
 
    if config:
        skyMapConfig.update(**config)
 
    butler = Butler(repo, writeable=True)
    makeSkyMap(butler, skyMapConfig)

Variable Documentation

_log

lsst.pipe.tasks.script.registerSkymap._log = logging.getLogger(__name__)

protected

Definition at line 30 of file registerSkymap.py.