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
butlerFactory.py
Go to the documentation of this file.
1 #!/usr/bin/env python
2 
3 #
4 # LSST Data Management System
5 # Copyright 2008, 2009, 2010 LSST Corporation.
6 #
7 # This product includes software developed by the
8 # LSST Project (http://www.lsst.org/).
9 #
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the LSST License Statement and
21 # the GNU General Public License along with this program. If not,
22 # see <http://www.lsstcorp.org/LegalNotices/>.
23 #
24 
25 # -*- python -*-
26 
27 """This module defines the ButlerFactory class."""
28 
29 from lsst.daf.persistence import Butler
30 
31 
33  """ButlerFactory creates data Butlers containing data mappers. Use of it
34  is deprecated in favor of the direct Butler constructor.
35 
36  The ButlerFactory class takes a mapper for a data collection.
37  It can then create Butlers with these mappers.
38 
39  A data identifier is a dictionary. The keys match those understood by a
40  mapper; the values select particular data sets or collections of data
41  sets. For example, one key might be "visit". Specifying a value of
42  "695934" for this key might select a collection of images.
43 
44  The mappers perform four functions:
45  1. Determine what keys are valid for dataset ids.
46  2. Obtain a collection of potential dataset ids matching a
47  partial dataset id.
48  3. Map a dataset id to the location of the dataset, including its
49  C++ and Python types.
50  4. Manipulate a retrieved dataset object so that it conforms to a
51  standard.
52 
53  Public methods:
54 
55  __init__(self, mapper)
56 
57  create(self)
58  """
59 
60  def __init__(self, mapper):
61  """Construct a ButlerFactory.
62 
63  @param mapper mapper object.
64  """
65 
66  self.mapper = mapper
67 
68  def create(self):
69  """Create a Butler.
70 
71  @returns a new Butler.
72  """
73 
74  if hasattr(self.mapper, 'root'):
75  root = self.mapper.root
76  else:
77  root = None
78  return Butler(root=root, mapper=self.mapper)
lsst::daf::persistence.butlerFactory.ButlerFactory
Definition: butlerFactory.py:32
lsst::daf::persistence.butlerFactory.ButlerFactory.mapper
mapper
Definition: butlerFactory.py:66
lsst::daf::persistence.butler.Butler
Definition: butler.py:321
lsst::daf::persistence
Definition: Utils.h:50
lsst::daf::persistence.butlerFactory.ButlerFactory.__init__
def __init__(self, mapper)
Definition: butlerFactory.py:60
lsst::daf::persistence.butlerFactory.ButlerFactory.create
def create(self)
Definition: butlerFactory.py:68