lsst.obs.base.script.defineVisits Namespace Reference

Functions
def	defineVisits (repo, config_file, collections, instrument, processes=1)

Function Documentation

defineVisits()

def lsst.obs.base.script.defineVisits.defineVisits	(		repo,
			config_file,
			collections,
			instrument,
			processes = 1
	)

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

Defines visits from exposures in the butler registry

Parameters
----------
repo : `str`
    URI to the location to create the repo.
config_file : `str` or `None`
    Path to a config file that contains overrides to the ingest config.
collections : `list` [`str`]
    An expression specifying the collections to be searched (in order) when
    reading datasets, and optionally dataset type restrictions on them.
    If empty it will be passed as `None` to Butler.
insrument : `str`
    The name or fully-qualified class name of an instrument.

Definition at line 27 of file defineVisits.py.

def defineVisits(repo, config_file, collections, instrument, processes=1):
    """Implements the command line interface `butler define-visits` subcommand,
    should only be called by command line tools and unit test code that tests
    this function.
 
    Defines visits from exposures in the butler registry
 
    Parameters
    ----------
    repo : `str`
        URI to the location to create the repo.
    config_file : `str` or `None`
        Path to a config file that contains overrides to the ingest config.
    collections : `list` [`str`]
        An expression specifying the collections to be searched (in order) when
        reading datasets, and optionally dataset type restrictions on them.
        If empty it will be passed as `None` to Butler.
    insrument : `str`
        The name or fully-qualified class name of an instrument.
    """
    if not collections:
        collections = None
    butler = Butler(repo, collections=collections, writeable=True)
    instr = getInstrument(instrument, butler.registry)
    config = DefineVisitsConfig()
    instr.applyConfigOverrides(DefineVisitsTask._DefaultName, config)
 
    if collections is None:
        # Default to the raw collection for this instrument
        collections = instr.makeDefaultRawIngestRunName()
 
    if config_file is not None:
        config.load(config_file)
    task = DefineVisitsTask(config=config, butler=butler)
    task.run(butler.registry.queryDataIds(["exposure"], dataId={"instrument": instr.getName()}),
             collections=collections, processes=processes)