CollectGuiderDarkCubes

Bases: KPFFunction

Obtains CRED2 "trigger file" data cubes under dark conditions at each of the three gain settings for the detector.

Sequence: - Set FIU to Stowed - Set kpfguide.SENSORSETP = -40 - Wait for temperature to reach target - modify -s kpfexpose SRC_SHUTTERS='' - Set FPS = 100 - Set GAIN = High - Take 10s trigger cube - Set GAIN = High - Take 10s trigger cube - Set GAIN = Low - Take 10s trigger cube - Set kpfguide.SENSORSETP = 0

Parameters:
  • scheduled (bool) –

    Obey ALLOWSCHEDULEDCALS keyword

KTL Keywords Used:

  • kpfconfig.ALLOWSCHEDULEDCALS
  • kpfguide.OUTDIR
  • kpfguide.SENSORSETP
  • kpfguide.SENSORTEMP
  • kpfguide.CONTINUOUS
  • kpfguide.SUB_HIGH
  • kpfguide.SUB_MEDIUM
  • kpfguide.SUB_LOW
Source code in kpf/guider/CollectGuiderDarkCubes.py 
 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
133
134
135
136
137
138
139
140
141
142
143
144
145
class CollectGuiderDarkCubes(KPFFunction):
    '''Obtains CRED2 "trigger file" data cubes under dark conditions at each of
    the three gain settings for the detector.

    Sequence:
    - Set FIU to Stowed
    - Set kpfguide.SENSORSETP = -40
    - Wait for temperature to reach target
    - modify -s kpfexpose SRC_SHUTTERS=''
    - Set FPS = 100
    - Set GAIN = High
    - Take 10s trigger cube
    - Set GAIN = High
    - Take 10s trigger cube
    - Set GAIN = Low
    - Take 10s trigger cube
    - Set kpfguide.SENSORSETP = 0

    Args:
        scheduled (bool): Obey ALLOWSCHEDULEDCALS keyword

    KTL Keywords Used:

    - `kpfconfig.ALLOWSCHEDULEDCALS`
    - `kpfguide.OUTDIR`
    - `kpfguide.SENSORSETP`
    - `kpfguide.SENSORTEMP`
    - `kpfguide.CONTINUOUS`
    - `kpfguide.SUB_HIGH`
    - `kpfguide.SUB_MEDIUM`
    - `kpfguide.SUB_LOW`
    '''
    @classmethod
    @obey_scriptrun
    def pre_condition(cls, args):
        # If specified obey the ALLOWSCHEDULEDCALS keyword
        if args.get('scheduled', False) == True:
            ALLOWSCHEDULEDCALS = ktl.cache('kpfconfig', 'ALLOWSCHEDULEDCALS')
            if ALLOWSCHEDULEDCALS.read(binary=True) == False:
                raise FailedPreCondition('ALLOWSCHEDULEDCALS is No')

    @classmethod
    @register_script(Path(__file__).name, os.getpid())
    @add_script_log(Path(__file__).name.replace(".py", ""))
    def perform(cls, args):
        output_file = Path('/s/sdata1701/CRED2DarkCubes/CRED2_dark_cubes.txt')
        OUTDIR = ktl.cache('kpfguide', 'OUTDIR')
        original_OUTDIR = OUTDIR.read()
        new_OUTDIR = str(output_file.parent)
        log.debug(f'Setting OUTDIR to {new_OUTDIR}')
        OUTDIR.write(new_OUTDIR)
        SENSORSETP = ktl.cache('kpfguide', 'SENSORSETP')
        SENSORTEMP = ktl.cache('kpfguide', 'SENSORTEMP')
        CONTINUOUS = ktl.cache('kpfguide', 'CONTINUOUS')
        kpfguide = ktl.cache('kpfguide')
        try:
            log.info('Taking CRED2 dark cubes')
            ConfigureFIU.execute({'mode': 'Stowed'})
            log.info('Cooling CRED2')
            SENSORSETP.write(-40)
            log.info('Waiting up to 10 minutes for detector to reach set point')
            reached_temp = SENSORTEMP.waitFor("<-39.9", timeout=600)
            if reached_temp == False:
                log.error('CRED2 failed to reach set point. Exiting.')
                SENSORSETP.write(0)
                return

            check_scriptstop()

            log.debug('Waiting additional time for temperature to stabilize')
            time.sleep(60) # shim to give time to stabilize

            check_scriptstop()

            log.debug('Closing source shutters')
            SetSourceSelectShutters.execute({})

            CONTINUOUS.write('Active')
            SetGuiderFPS.execute({'GuideFPS': 100})

            for gain in ['high', 'medium', 'low']:
                log.info(f'Collecting {gain} gain cube')
                SetGuiderGain.execute({'GuideCamGain': gain})
                cube_file = TakeGuiderCube.execute({'duration': 10})
                with open(output_file, 'a') as f:
                    f.write(f"{gain:12s}, {cube_file}\n")
                check_scriptstop()
                time.sleep(30) # shim to give time to recover after writing cube
                check_scriptstop()

            for gain in ['high', 'medium', 'low']:
                sub_file = kpfguide[f'SUB_{gain.upper()}'].read()
                kpfguide[f'SUB_{gain.upper()}'].write('')
                log.info(f'Collecting {gain} gain cube without bias subtraction')
                SetGuiderGain.execute({'GuideCamGain': gain})
                cube_file = TakeGuiderCube.execute({'duration': 10})
                with open(output_file, 'a') as f:
                    gain_string = f'{gain}_nosub'
                    f.write(f"{gain_string:12s}, {cube_file}\n")
                kpfguide[f'SUB_{gain.upper()}'].write(sub_file)
                check_scriptstop()
                time.sleep(30) # shim to give time to recover after writing cube
                check_scriptstop()


        except Exception as e:
            log.error('Error running CollectGuiderDarkCubes')
            log.debug(e)

        log.info('Resetting CRED2 temperature set point to 0')
        SENSORSETP.write(0)
        log.debug(f'Setting OUTDIR to {original_OUTDIR}')
        OUTDIR.write(original_OUTDIR)
        clear_script_keywords()


    @classmethod
    def post_condition(cls, args):
        pass


    @classmethod
    def add_cmdline_args(cls, parser):
        parser.add_argument('--scheduled', dest="scheduled",
            default=False, action="store_true",
            help='Script is scheduled and should obey ALLOWSCHEDULEDCALS keyword')
        return super().add_cmdline_args(parser)