LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
defineVisits.py
Go to the documentation of this file.
1 # This file is part of obs_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (http://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 
22 from lsst.daf.butler import Butler
23 from lsst.obs.base import DefineVisitsTask, DefineVisitsConfig
24 from ..utils import getInstrument
25 
26 
27 def defineVisits(repo, config_file, collections, instrument, processes=1):
28  """Implements the command line interface `butler define-visits` subcommand,
29  should only be called by command line tools and unit test code that tests
30  this function.
31 
32  Defines visits from exposures in the butler registry
33 
34  Parameters
35  ----------
36  repo : `str`
37  URI to the location to create the repo.
38  config_file : `str` or `None`
39  Path to a config file that contains overrides to the ingest config.
40  collections : `list` [`str`]
41  An expression specifying the collections to be searched (in order) when
42  reading datasets, and optionally dataset type restrictions on them.
43  If empty it will be passed as `None` to Butler.
44  insrument : `str`
45  The name or fully-qualified class name of an instrument.
46  """
47  if not collections:
48  collections = None
49  butler = Butler(repo, collections=collections, writeable=True)
50  instr = getInstrument(instrument, butler.registry)
51  config = DefineVisitsConfig()
52  instr.applyConfigOverrides(DefineVisitsTask._DefaultName, config)
53 
54  if collections is None:
55  # Default to the raw collection for this instrument
56  collections = instr.makeDefaultRawIngestRunName()
57 
58  if config_file is not None:
59  config.load(config_file)
60  task = DefineVisitsTask(config=config, butler=butler)
61  task.run(butler.registry.queryDataIds(["exposure"], dataId={"instrument": instr.getName()}),
62  collections=collections, processes=processes)
lsst.obs.base.utils.getInstrument
def getInstrument(instrumentName, registry=None)
Definition: utils.py:131
lsst.obs.base.defineVisits.DefineVisitsTask
Definition: defineVisits.py:281
lsst.obs.base.script.defineVisits.defineVisits
def defineVisits(repo, config_file, collections, instrument, processes=1)
Definition: defineVisits.py:27
lsst.obs.base.defineVisits.DefineVisitsConfig
Definition: defineVisits.py:262
lsst.obs.base
Definition: __init__.py:1