ExecuteSlewCal

Bases: KPFTranslatorFunction

Script which executes the observations of a Slew Cal

This must have arguments as input, either from a file using the -f command line tool, or passed in from the execution engine.

ARGS:

:OB: dict A fully specified slew cal observing block (OB).

Source code in kpf/scripts/ExecuteSlewCal.py
 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
class ExecuteSlewCal(KPFTranslatorFunction):
    '''Script which executes the observations of a Slew Cal

    This must have arguments as input, either from a file using the `-f` command
    line tool, or passed in from the execution engine.

    ARGS:
    =====
    :OB: `dict` A fully specified slew cal observing block (OB).
    '''
    abortable = True

    @classmethod
    def pre_condition(cls, args, logger, cfg):
        check_input(args, 'Template_Name', allowed_values=['kpf_slewcal'])
        check_input(args, 'Template_Version', version_check=True, value_min='0.4')

    @classmethod
    def perform(cls, args, logger, cfg):
        set_script_keywords(Path(__file__).name, os.getpid())
        log.info('-------------------------')
        log.info(f"Running {cls.__name__}")
        for key in args:
            log.debug(f"  {key}: {args[key]}")
        log.info('-------------------------')

        kpfconfig = ktl.cache('kpfconfig')
        kpfconfig['SCRIPTMSG'].write("Executing Slew Cal")
        calsource = kpfconfig['SIMULCALSOURCE'].read()
        runagitator = kpfconfig['USEAGITATOR'].read(binary=True)
        fast_read_mode = QueryFastReadMode.execute({})

        # Fill in args in case this is not called by configure for acquisition
        if args.get('TriggerCaHK', None) is None: args['TriggerCaHK'] = False
        if args.get('TriggerGreen', None) is None: args['TriggerGreen'] = True
        if args.get('TriggerRed', None) is None: args['TriggerRed'] = True

        # Skip this lamp if it is not enabled
        if IsCalSourceEnabled.execute({'CalSource': calsource}) == False:
            return

        # Set Octagon
        calsource = kpfconfig['SIMULCALSOURCE'].read()
        octagon = ktl.cache('kpfcal', 'OCTAGON').read()
        log.debug(f"Current OCTAGON = {octagon}, desired = {calsource}")
        if octagon != calsource:
            log.info(f"Set CalSource/Octagon: {calsource}")
            SetCalSource.execute({'CalSource': calsource, 'wait': False})

        progname = ktl.cache('kpfexpose', 'PROGNAME')
        original_progname = progname.read()

        ## ----------------------------------------------------------------
        ## First, configure lamps and cal bench (may happen during readout)
        ## ----------------------------------------------------------------
        log.info(f"Configuring FIU")
        ConfigureFIU.execute({'mode': 'Calibration', 'wait': False})

        check_scriptstop() # Stop here if requested

        # Configure Cal Bench
        nd1 = args.get('CalND1')
        nd2 = args.get('CalND2')
        log.info(f"Set ND1, ND2 Filter Wheels: {nd1}, {nd2}")
        SetND1.execute({'CalND1': nd1, 'wait': False})
        SetND2.execute({'CalND2': nd2, 'wait': False})
        log.info(f"Waiting for Octagon/CalSource, ND1, ND2, FIU")
        WaitForND1.execute(args)
        WaitForND2.execute(args)
        WaitForCalSource.execute({'CalSource': calsource})
        WaitForConfigureFIU.execute({'mode': 'Calibration'})

        check_scriptstop() # Stop here if requested

        ## ----------------------------------------------------------------
        ## Second, configure kpfexpose (may not happen during readout)
        ## ----------------------------------------------------------------
        # Wait for current exposure to readout
        exposestatus = ktl.cache('kpfexpose', 'EXPOSE')
        if exposestatus.read() != 'Ready':
            log.info(f"Waiting for kpfexpose to be Ready")
            WaitForReady.execute({})
            log.info(f"Readout complete")
            check_scriptstop() # Stop here if requested
        log.info(f"Set Detector List")
        SetTriggeredDetectors.execute(args)
        log.info(f"Set Source Select Shutters")
        SetSourceSelectShutters.execute({'SSS_Science': True,
                                         'SSS_Sky': True,
                                         'SSS_SoCalSci': False,
                                         'SSS_SoCalCal': False,
                                         'SSS_CalSciSky': True})
        log.info(f"Set exposure time: {args.get('ExpTime'):.3f}")
        SetExpTime.execute(args)
        # No need to specify TimedShutter_Scrambler
        args['TimedShutter_Scrambler'] = True
        log.debug(f"Automatically setting TimedShutter_Scrambler: {args['TimedShutter_Scrambler']}")
        # No need to specify TimedShutter_CaHK
        args['TimedShutter_CaHK'] = args.get('TriggerCaHK', False)
        log.debug(f"Automatically setting TimedShutter_CaHK: {args['TimedShutter_CaHK']}")
        # No need to specify TimedShutter_FlatField
        args['TimedShutter_FlatField'] = False
        log.debug(f"Automatically setting TimedShutter_FlatField: {args['TimedShutter_FlatField']}")
        # Set TimedShutter_SimulCal
        args['TimedShutter_SimulCal'] = args['TakeSimulCal']
        log.debug(f"Automatically setting TimedShutter_SimulCal: {args['TimedShutter_SimulCal']}")
        log.info(f"Setting timed shutters")
        SetTimedShutters.execute(args)
        log.info(f"Setting OBJECT: {args.get('Object')}")
        SetObject.execute(args)
        log.info(f"Clearing stellar parameters")
        SetTargetInfo.execute({})
        SetProgram.execute({'progname': 'ENG'})

        ## ----------------------------------------------------------------
        ## Third, take actual exposures
        ## ----------------------------------------------------------------
        nexp = args.get('nExp', 1)
        # If we are in fast read mode, turn on agitator once
        if runagitator and fast_read_mode:
            StartAgitator.execute({})
        for j in range(nexp):
            check_scriptstop() # Stop here if requested
            # Wait for current exposure to readout
            if exposestatus.read() != 'Ready':
                log.info(f"Waiting for kpfexpose to be Ready")
                WaitForReady.execute({})
                log.info(f"Readout complete")
                check_scriptstop() # Stop here if requested
            # Start next exposure
            if runagitator and not fast_read_mode:
                StartAgitator.execute({})
            log.info(f"Starting expoure {j+1}/{nexp} ({args.get('Object')})")
            StartExposure.execute({})
            WaitForReadout.execute({})
            log.info(f"Readout has begun")
            if runagitator and not fast_read_mode:
                StopAgitator.execute({})
            ZeroOutSlewCalTime.execute({})
        # If we are in fast read mode, turn off agitator at end
        if runagitator and fast_read_mode:
            StopAgitator.execute({})

        # Set FIU Mode
        log.info('Setting FIU mode to Observing')
        kpfconfig['SCRIPTMSG'].write("Slew Cal complete. Setting FIU to observing mode.")
        ConfigureFIU.execute({'mode': 'Observing', 'wait': False})
        # Set PROGNAME
        log.info(f'Setting PROGNAME back to {original_progname}')
        SetProgram.execute({'progname': original_progname})
        clear_script_keywords()

    @classmethod
    def post_condition(cls, args, logger, cfg):
        pass