SetTipTiltGain

class SetTipTiltGain(KPFTranslatorFunction):
    '''Set the guide loop gain.

    Args:
        GuideLoopGain (float): The desired gain value.

    KTL Keywords Used:

    - `kpfguide.TIPTILT_GAIN`
    '''
    @classmethod
    def pre_condition(cls, args, logger, cfg):
        check_input(args, 'GuideLoopGain', value_min=0, value_max=1)

    @classmethod
    def perform(cls, args, logger, cfg):
        gain = float(args.get('GuideLoopGain'))
        tiptiltgain = ktl.cache('kpfguide', 'TIPTILT_GAIN')
        tiptiltgain.write(gain)

    @classmethod
    def post_condition(cls, args, logger, cfg):
        gain = float(args.get('GuideLoopGain'))
        timeout = cfg.getfloat('times', 'tip_tilt_move_time', fallback=0.1)
        tol = cfg.getfloat('tolerances', 'tip_tilt_gain_tolerance', fallback=0.001)
        expr = (f"($kpfguide.TIPTILT_GAIN >= {gain-tol}) and "
                f"($kpfguide.TIPTILT_GAIN <= {gain+tol})")
        success = ktl.waitFor(expr, timeout=timeout)
        if success is not True:
            tiptiltgain = ktl.cache('kpfguide', 'TIPTILT_GAIN')
            raise FailedToReachDestination(tiptiltgain.read(), gain)

    @classmethod
    def add_cmdline_args(cls, parser, cfg=None):
        parser.add_argument('GuideLoopGain', type=float,
                            help="Tip tilt control loop gain")
        return super().add_cmdline_args(parser, cfg)