Instrument Scientist: Josh Walawender
Deputy Instrument Scientist: Sherry Yeh
Email Contact: KPF Support

Observing System Design

KPF is designed to be operated using principles from Keck's Data Services Initiative (DSI) project. The DSI infrastructure will eventually be used to drive KPF, but in the mean time we will prepare and execute observations using KPF software, but the design of the KPF system is strongly influence by the DSI design hence observers will see a lot of similarities when the transition happens.

Observing Blocks (OBs)

The basic unit of KPF nighttime operations is the Observing Block (OB). An OB describes a single visit to a science target and the observations made there. The data in an OB can be divided in to 4 rough categories:

Target information: The OB will contain information about the target beyond what is in a typical Keck Star List entry in order to flow that information to the FITS header and the data reduction pipeline (DRP).

Guide camera configuration: The OB will also contain information about how to configure the guide camera and tip tilt system for this target.

Instrument Setup: The OB will also contain information about how to configure the instrument for this set of observations.

Observations: Finally, the OB will contain a list of "observations" to be made of the target. For typical KPF observers, this will only have one entry, but multiple entries are supported. Each entry describes a set of exposures on the target and contains the information on how those exposures should be executed.

The data contained in the OB is a set of keyword-value pairs. Observers can prepare OBs as text files which can be read in by the KPF software and executed or (once logged in to the KPF VNCs) they can use tools there to build the OBs and save them as files.

KPF Science OB Contents

Here is an example science OB formatted as a text file (this is the YAML data format). The comments (preceded by a # symbol) are not needed, but are present to help the reader.

Template_Name: kpf_sci Template_Version: 0.6 # Target Info TargetName: 10700 # User supplied GaiaID: DR3 2452378776434276992# Gaia DR3 ID 2MASSID: 01440402-1556141 # 2MASS ID Parallax: 273.81 # Parallax in arcsec RadialVelocity: -16.597 # Radial Velocity in km/s Gmag: 3.3 # G band magnitude Jmag: 2.14 # J band magnitude Teff: 5266 # Effective temperature # Guider Setup GuideMode: manual # "manual", "auto", "off" GuideCamGain: low # Guide camera gain; values = low, medium, high GuideFPS: 100 # Frames per second for guide camera # Spectrograph Setup TriggerCaHK: True # Include CaHK in exposure? TriggerGreen: True # Include Green CCD in exposure? TriggerRed: True # Include Red CCD in exposure? # Observations SEQ_Observations: - Object: 10700 # User settable comment nExp: 4 # Number of exoposures in the OB ExpTime: 30 # Exposure time of the main spectrometer+CaH&K ExpMeterMode: monitor # Only "monitor" is available for now AutoExpMeter: False # Set Exposure Meter exposure time automatically? ExpMeterExpTime: 0.5 # Exposure time of the Exposure Meter subframes TakeSimulCal: True # Take simultaneous calibrations? AutoNDFilters: False # Automatically set ND filters? CalND1: OD 4.0 # Throughput=10^-OD CalND2: OD 0.1 # Throughput=10^-OD.

Each value in the OB is described in more detail below.

Template_Name and Template_Version:

These values indicate to the software what sort of observation this is and what script to execute. For a science observation, always use "kpf_sci" as the template name.

TargetName

This is a name chosen by the observer.

GaiaID and 2MASSID

These values are used by the DRP to identify the star and determine its properties.

Parallax and RadialVelocity

These values are used by the DRP.

Gmag

This is used by the DRP and by the algorithm which automatically sets the exposure meter exposure time.

Jmag

This is used by the algorithm which automatically sets the guider gain and frame rate.

Teff

The effective temperature of the star is used by the DRP.

GuideMode

The options are "manual" or "auto". If "manual" is selected, the values for the gain and FPS below are used. If "auto" is selected, the camera gain and FPS values in the OB are ignored and the software will choose values based on the Jmag value.

GuideCamGain and GuideFPS

The gain (high, medium, or low) and the frame rate (frames per second) at which to operate the guide camera. These are ignored if the GuideMode is set to "auto".

TriggerCaHK, TriggerGreen, and TriggerRed

These values indicate whether to trigger the respective camera during the science exposures. All of these cameras will be synced up and will get the same exposure time.

SEQ_Observations:

This line is required. The following block of lines represent one entry in a list. If more than one set of exposures on a target is desired, this block of text can be repeated to build a second "observation" on the target with different parameters.

Object

This value will go in to the FITS header as the OBJECT keyword value. This is can be used as a notes field for the observer to explain how this set of exposures differs from any following observations of this target. This field can be left blank or set to the target name, it is entirely up to the observer.

nExp and ExpTime

The number of exposures and exposure time. Note that if the exposure meter is controlling the exposure duration, this exposure time is the maximum value which will be allowed (the exposure meter may cut the exposure short if the desired flux level is reached).

ExpMeterMode

For now, only the "monitor" mode is available. In "monitor" the exposure meter will take exposure during the science exposure and record fluxes. This data will be stored in the resulting FITS file can be used to determine the flux weighted exposure midpoint in time for accurate barycentric correction.

AutoExpMeter

If this is True, the software will use the Gmag value to estimate a good exposure time for the individual exposure meter exposures and use that instead of the ExpMeterExpTime value below.

ExpMeterExpTime

The exposure time for individual exposure meter exposures. This is ignored if AutoExpMeter is True.

TakeSimulCal

Should the instrument be configured to illuminate the simultaneous calibration fiber during the science exposure?

AutoNDFilters

Should the software automatically set the ND filters based on the target and exposure information? This is not currently implemented and will be ignored!

CalND1

Which neutral density filter should be used in the ND1 filter wheel to cut down the brightness of the simultaneous calibration light source? This is only needed if TakeSimulCal is True. Allowed values are "OD 0.1", "OD 1.0", "OD 1.3", "OD 2.0", "OD 3.0", and "OD 4.0"

CalND2

Which neutral density filter should be used in the ND2 filter wheel to cut down the brightness of the simultaneous calibration light source? This is only needed if TakeSimulCal is True. Allowed values are "OD 0.1", "OD 0.3", "OD 0.5", "OD 0.8", "OD 1.0", and "OD 4.0"

KPF OB GUI

A graphical tool has been built to help observers build their KPF OBs. To launch it, use the FVWM background menu to select:

KPF Utilities --> KPF OB GUI

A screenshot of the KPF OB GUI. This tool is still under development and may change.

The top section of the GUI, "Instrument Status" shows whether an instrument script (e.g. an observation or calibration set) is being run and allows users to request that script either stop or pause.

The middle section can be used to load an OB from a file, build an OB from scratch using a Gaia DR3 catalog query, save the OB to a file, or execute the OB.

The lower section is where a user can fill out the OB parameters as described in the "KPF Science OB Contents" section above.