Realtime CheckΒΆ

DQuality real time check example. (Download file: realtime_check.py)

  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
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#!/usr/bin/env python
# -*- coding: utf-8 -*-

# #########################################################################
# Copyright (c) 2015, UChicago Argonne, LLC. All rights reserved.         #
#                                                                         #
# Copyright 2015. UChicago Argonne, LLC. This software was produced       #
# under U.S. Government contract DE-AC02-06CH11357 for Argonne National   #
# Laboratory (ANL), which is operated by UChicago Argonne, LLC for the    #
# U.S. Department of Energy. The U.S. Government has rights to use,       #
# reproduce, and distribute this software.  NEITHER THE GOVERNMENT NOR    #
# UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR        #
# ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is     #
# modified to produce derivative works, such modified software should     #
# be clearly marked, so as not to confuse it with the version available   #
# from ANL.                                                               #
#                                                                         #
# Additionally, redistribution and use in source and binary forms, with   #
# or without modification, are permitted provided that the following      #
# conditions are met:                                                     #
#                                                                         #
#     * Redistributions of source code must retain the above copyright    #
#       notice, this list of conditions and the following disclaimer.     #
#                                                                         #
#     * Redistributions in binary form must reproduce the above copyright #
#       notice, this list of conditions and the following disclaimer in   #
#       the documentation and/or other materials provided with the        #
#       distribution.                                                     #
#                                                                         #
#     * Neither the name of UChicago Argonne, LLC, Argonne National       #
#       Laboratory, ANL, the U.S. Government, nor the names of its        #
#       contributors may be used to endorse or promote products derived   #
#       from this software without specific prior written permission.     #
#                                                                         #
# THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC AND CONTRIBUTORS     #
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT       #
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS       #
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UChicago     #
# Argonne, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,        #
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,    #
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;        #
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER        #
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT      #
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN       #
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE         #
# POSSIBILITY OF SUCH DAMAGE.                                             #
# #########################################################################
"""
Please make sure the installation :ref:`pre-requisite-reference-label` are met.

This script is specific for beamline 32id.

This example takes one mandatory parameter, and three optional:
instrument: a string defining the detector that will be used. User can enter one of these choices: 
'32id_nano', '32id_micro'. The instrument determines the directory to look for a configuration file that will be used.
type: optional parameter, data type to be verified (i.e. data_dark, data_white or data), defaulted to 'data'
report_file: optional parameter, name of report file, defaulted to None
report_type: optional parameter, report type, currently supporting REPORT_NONE, REPORT_ERRORS, and REPORT_FULL, 
defaulted to REPORT_FULL.

This script calls real_time verifier.

"""
import sys
import os
import argparse
import dquality.check_rt as rt
from os.path import expanduser

def main(arg):

    parser = argparse.ArgumentParser()
    parser.add_argument("instrument", help="instrument name, name should have a matching directory in the .dquality folder")
    parser.add_argument("--report_file", default=None, help="optional, name of report file")
    parser.add_argument("--sequence", default=None, help="optional, expected sequence of data types")

    args = parser.parse_args()
    instrument = args.instrument
    report_file = args.report_file
    sequence = args.sequence

    home = expanduser("~")
    conf = os.path.join(home, ".dquality", instrument)

    bad_indexes = rt.realtime(conf, report_file, sequence)
    return bad_indexes


if __name__ == "__main__":
    main(sys.argv[1:])

# sequence example
# variableDict = {'PreDarkImages': 5,
#             'PreWhiteImages': 10,
#             'Projections': 60,
#             'PostDarkImages': 5,
#             'PostWhiteImages': 10}
# sequence = []
# index = -1
# try:
#     images = variableDict['PreDarkImages']
#     index += images
#     sequence.append(('data_dark', index))
# except KeyError:
#     pass
# try:
#     images = variableDict['PreWhiteImages']
#     index += images
#     sequence.append(('data_white', index))
# except KeyError:
#     pass
# try:
#     images = variableDict['Projections']
#     index += images
#     sequence.append(('data', index))
# except KeyError:
#     pass
# try:
#     images = variableDict['PostDarkImages']
#     index += images
#     sequence.append(('data_dark', index))
# except KeyError:
#     pass
# try:
#     images = variableDict['PostWhiteImages']
#     index += images
#     sequence.append(('data_white', index))
# except KeyError:
#     pass
#
# json_sequence = json.dumps(sequence).replace(" ","")
#