SetObserver

Bases: KPFTranslatorFunction

Sets the OBSERVER keyword for the science detectors in the kpfexpose keyword service.

ARGS:

:observer: str The desired value of the OBSERVER keyword.

Source code in kpf/spectrograph/SetObserver.py
 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
class SetObserver(KPFTranslatorFunction):
    '''Sets the OBSERVER keyword for the science detectors in the kpfexpose
    keyword service.

    ARGS:
    =====
    :observer: `str` The desired value of the OBSERVER keyword.
    '''
    @classmethod
    def pre_condition(cls, args, logger, cfg):
        check_input(args, 'observer')

    @classmethod
    def perform(cls, args, logger, cfg):
        kpfexpose = ktl.cache('kpfexpose')
        observer = args.get('observer')
        log.info(f"Setting OBSERVER to {observer}")
        kpfexpose['OBSERVER'].write(observer)
        time_shim = cfg.getfloat('times', 'kpfexpose_shim_time', fallback=0.1)
        time.sleep(time_shim)

    @classmethod
    def post_condition(cls, args, logger, cfg):
        observer = args.get('observer')
        timeout = cfg.getfloat('times', 'kpfexpose_response_time', fallback=1)
        expr = f'($kpfexpose.OBSERVER == "{observer}")'
        success = ktl.waitFor(expr, timeout=timeout)
        if success is not True:
            observerkw = ktl.cache('kpfexpose', 'OBSERVER')
            raise FailedToReachDestination(observerkw.read().strip(),
                                           observer.strip())

    @classmethod
    def add_cmdline_args(cls, parser, cfg=None):
        parser.add_argument('observer', type=str,
                            help='The OBSERVER keyword')
        return super().add_cmdline_args(parser, cfg)