level1.py 4.33 KB
Newer Older
Wei Shoulin's avatar
c3  
Wei Shoulin committed
1
2
3
4
5
6
7
8

from ..common.delegate import Delegate

class Level1DataApi(object):
    """
    Level1 Data Operation Class
    """
    def __init__(self):
Wei Shoulin's avatar
Wei Shoulin committed
9
        self.pymodule = Delegate().load(sub_module = "facility")
Wei Shoulin's avatar
c3  
Wei Shoulin committed
10
11
12
13
14
        self.stub = getattr(self.pymodule, "Level1DataApi")()
        
    def find(self, **kwargs):
        ''' retrieve level1 records from database

Wei Shoulin's avatar
docs    
Wei Shoulin committed
15
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
Wei Shoulin committed
16
            obs_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
17
            level0_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
18
            module_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
19
            file_type: [str]
Wei Shoulin's avatar
Wei Shoulin committed
20
            obs_time : (start, end)
Wei Shoulin's avatar
Wei Shoulin committed
21
22
23
            create_time : (start, end)
            qc1_status : [int]
            prc_status : [int]
Wei Shoulin's avatar
c3  
Wei Shoulin committed
24
            filename: [str]
Wei Shoulin's avatar
Wei Shoulin committed
25
            ra_cen: float = None
Wei Shoulin's avatar
Wei Shoulin committed
26
            dec_cen: float = None,
Wei Shoulin's avatar
Wei Shoulin committed
27
            radius: float = None
Wei Shoulin's avatar
Wei Shoulin committed
28
            pipeline_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
29
            build: [int]
Wei Shoulin's avatar
Wei Shoulin committed
30
31
32
            detector_no: [str]
            filter: [str]
            object_name: [str]
Wei Shoulin's avatar
c3  
Wei Shoulin committed
33
            limit: limits returns the number of records,default 0:no-limit
Wei Shoulin's avatar
docs    
Wei Shoulin committed
34
35
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
36
37
38
        '''
        return self.stub.find(**kwargs)

Wei Shoulin's avatar
hstdm    
Wei Shoulin committed
39
40
41
42
43
44
45
46
47
    def find_by_brick_ids(self, **kwargs):
        ''' retrieve level1 records by brick_ids like [1,2,3,4]

        :param kwargs: Parameter dictionary, key items support:
            brick_ids: [list]
        :returns: csst_dfs_common.models.Result
        '''
        return self.stub.find_by_brick_ids(**kwargs)

Wei Shoulin's avatar
Wei Shoulin committed
48
49
50
51
52
53
54
55
56
    def find_refs_by_ids(self, **kwargs):
        ''' retrieve level1 reference records by internal level1 ids like [1,2,3,4]

        :param kwargs: Parameter dictionary, key items support:
            ids: [list]
        :returns: csst_dfs_common.models.Result
        '''
        return self.stub.find_refs_by_ids(**kwargs)
    
Wei Shoulin's avatar
Wei Shoulin committed
57
58
59
60
    def find_by_ids(self, **kwargs):
        ''' retrieve level1 records by internal level1 ids like [1,2,3,4]

        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
Wei Shoulin committed
61
62
            ids: [list],
            module_id: [str] like 'MSC'
Wei Shoulin's avatar
Wei Shoulin committed
63
64
65
66
        :returns: csst_dfs_common.models.Result
        '''
        return self.stub.find_by_ids(**kwargs)
    
Wei Shoulin's avatar
Wei Shoulin committed
67
68
69
70
71
72
73
74
75
76
77
    def sls_find_by_qc1_status(self, **kwargs):
        ''' retrieve level1 records from database

        :param kwargs: Parameter dictionary, key items support:
            qc1_status : [int],
            limit: limits returns the number of records,default 1
        
        :returns: csst_dfs_common.models.Result
        '''
        return self.stub.sls_find_by_qc1_status(**kwargs)

Wei Shoulin's avatar
c3  
Wei Shoulin committed
78
79
80
    def get(self, **kwargs):
        '''  fetch a record from database

Wei Shoulin's avatar
docs    
Wei Shoulin committed
81
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
82
            id : [int] 
Wei Shoulin's avatar
docs    
Wei Shoulin committed
83
84
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
85
86
87
88
89
90
91
        '''
        return self.stub.get(**kwargs)


    def update_proc_status(self, **kwargs):
        ''' update the status of reduction

Wei Shoulin's avatar
docs    
Wei Shoulin committed
92
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
93
94
            id = [int],
            status = [int]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
95
96
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
97
98
99
100
        '''
        return self.stub.update_proc_status(**kwargs)

    def update_qc1_status(self, **kwargs):
Wei Shoulin's avatar
Wei Shoulin committed
101
        ''' update the status of QC1
Wei Shoulin's avatar
c3  
Wei Shoulin committed
102
        
Wei Shoulin's avatar
docs    
Wei Shoulin committed
103
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
c3  
Wei Shoulin committed
104
105
            id = [int],
            status = [int]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
106
107
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
108
109
110
111
112
        '''        
        return self.stub.update_qc1_status(**kwargs)    

    def write(self, **kwargs):
        ''' insert a level1 record into database
Wei Shoulin's avatar
Wei Shoulin committed
113

Wei Shoulin's avatar
docs    
Wei Shoulin committed
114
        :param kwargs: Parameter dictionary, key items support:
Wei Shoulin's avatar
Wei Shoulin committed
115
            level0_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
116
            level1_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
117
            obs_id: [str]
Wei Shoulin's avatar
doc    
Wei Shoulin committed
118
            module_id: [str]
Wei Shoulin's avatar
Wei Shoulin committed
119
            detector_no: [str]
Wei Shoulin's avatar
doc    
Wei Shoulin committed
120
            file_type : [str]
Wei Shoulin's avatar
Wei Shoulin committed
121
            obs_time = [str]
Wei Shoulin's avatar
c3  
Wei Shoulin committed
122
            filename : [str]
Wei Shoulin's avatar
Wei Shoulin committed
123
124
            file_path : [str]
            qc1_status: [int]        
Wei Shoulin's avatar
c3  
Wei Shoulin committed
125
126
127
            prc_status : [int]
            prc_time : [str]
            pipeline_id : [str]
Wei Shoulin's avatar
Wei Shoulin committed
128
            pmapname : [str]
Wei Shoulin's avatar
Wei Shoulin committed
129
            build : [int],
Wei Shoulin's avatar
l1 refs    
Wei Shoulin committed
130
131
132
133
            refs : list of dict, for example: 
                [{'file_type':'dark', 'id': 'csst_msc_dark_001.rmap'},
                {'file_type':'bias', 'id': 'csst_msc_bias_001.rmap'}, 
                {'file_type':'flat', 'id': 'csst_msc_flat_001.rmap'}]
Wei Shoulin's avatar
docs    
Wei Shoulin committed
134
135
        
        :returns: csst_dfs_common.models.Result
Wei Shoulin's avatar
c3  
Wei Shoulin committed
136
137
        '''          
        return self.stub.write(**kwargs)
Wei Shoulin's avatar
Wei Shoulin committed
138