LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Public Attributes | List of all members
lsst.daf.persistence.butlerFactory.ButlerFactory Class Reference

Public Member Functions

def __init__ (self, mapper)
 
def create (self)
 

Public Attributes

 mapper
 

Detailed Description

ButlerFactory creates data Butlers containing data mappers.  Use of it
is deprecated in favor of the direct Butler constructor.

The ButlerFactory class takes a mapper for a data collection.
It can then create Butlers with these mappers.

A data identifier is a dictionary.  The keys match those understood by a
mapper; the values select particular data sets or collections of data
sets.  For example, one key might be "visit".  Specifying a value of
"695934" for this key might select a collection of images.

The mappers perform four functions:
  1. Determine what keys are valid for dataset ids.
  2. Obtain a collection of potential dataset ids matching a
     partial dataset id.
  3. Map a dataset id to the location of the dataset, including its
     C++ and Python types.
  4. Manipulate a retrieved dataset object so that it conforms to a
     standard.

Public methods:

__init__(self, mapper)

create(self)

Definition at line 32 of file butlerFactory.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.daf.persistence.butlerFactory.ButlerFactory.__init__ (   self,
  mapper 
)
Construct a ButlerFactory.

@param mapper mapper object.

Definition at line 60 of file butlerFactory.py.

60  def __init__(self, mapper):
61  """Construct a ButlerFactory.
62 
63  @param mapper mapper object.
64  """
65 
66  self.mapper = mapper
67 

Member Function Documentation

◆ create()

def lsst.daf.persistence.butlerFactory.ButlerFactory.create (   self)
Create a Butler.

@returns a new Butler.

Definition at line 68 of file butlerFactory.py.

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)

Member Data Documentation

◆ mapper

lsst.daf.persistence.butlerFactory.ButlerFactory.mapper

Definition at line 66 of file butlerFactory.py.


The documentation for this class was generated from the following file: