Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

#!/usr/bin/env python 

 

# 

# LSST Data Management System 

# Copyright 2008, 2009, 2010 LSST Corporation. 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

 

# -*- python -*- 

 

"""This module defines the ButlerFactory class.""" 

from builtins import object 

 

from lsst.daf.persistence import Butler 

 

 

class ButlerFactory(object): 

"""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) 

""" 

 

def __init__(self, mapper): 

"""Construct a ButlerFactory. 

 

@param mapper mapper object. 

""" 

 

self.mapper = mapper 

 

def create(self): 

"""Create a Butler. 

 

@returns a new Butler. 

""" 

 

if hasattr(self.mapper, 'root'): 

root = self.mapper.root 

else: 

root = None 

return Butler(root=root, mapper=self.mapper)