pypeit.spectrographs.keck_hires module

Module for Keck/HIRES

class pypeit.spectrographs.keck_hires.HIRESMosaicLookUp

Bases: object

Provides the geometry required to mosaic Keck HIRES data. Similar to GeminiGMOSMosaicLookUp

geometry = {'MSC01': {'blue_det': {'rotation': 0.0, 'shift': (-2089.0, -3.0)}, 'default_shape': (6168, 3990), 'green_det': {'rotation': 0.0, 'shift': (0.0, 0.0)}, 'red_det': {'rotation': 0.0, 'shift': (2101.0, 0.0)}}}

class pypeit.spectrographs.keck_hires.KECKHIRESSpectrograph

Bases: Spectrograph

Child to handle KECK/HIRES specific code.

This spectrograph is not yet supported.

property allowed_mosaics

Return the list of allowed detector mosaics.

Keck/HIRES only allows for mosaicing all three detectors.

Returns:

List of tuples, where each tuple provides the 1-indexed detector numbers that can be combined into a mosaic and processed by PypeIt.

Return type:

list

camera = 'HIRES'

Name of the spectrograph camera or arm. This is used by specdb, so use that naming convention

check_frame_type(ftype, fitstbl, exprng=None)

Check for frames of the provided type.

Parameters:

• ftype (str) – Type of frame to check. Must be a valid frame type; see frame-type Definitions.

• fitstbl (astropy.table.Table) – The table with the metadata for one or more frames to check.

• exprng (list, optional) – Range in the allowed exposure time for a frame of type ftype. See pypeit.core.framematch.check_frame_exptime().

Returns:

Boolean array with the flags selecting the exposures in fitstbl that are ftype type frames.

Return type:

numpy.ndarray

comment = 'Post detector upgrade (~ August 2004). See :doc:`keck_hires`'

A brief comment or description regarding PypeIt usage with this spectrograph.

compound_meta(headarr, meta_key)

Methods to generate metadata requiring interpretation of the header data, instead of simply reading the value of a header card.

Parameters:

• headarr (list) – List of astropy.io.fits.Header objects.

• meta_key (str) – Metadata keyword to construct.

Returns:

Metadata value read from the header(s).

Return type:

object

config_independent_frames()

Define frame types that are independent of the fully defined instrument configuration.

Bias and dark frames are considered independent of a configuration, but the DATE-OBS keyword is used to assign each to the most-relevant configuration frame group. See set_configurations().

Returns:

Dictionary where the keys are the frame types that are configuration independent and the values are the metadata keywords that can be used to assign the frames to a configuration group.

Return type:

dict

config_specific_par(scifile, inp_par=None)

Modify the PypeIt parameters to hard-wired values used for specific instrument configurations.

Parameters:

• scifile (str) – File to use when determining the configuration and how to adjust the input parameters.

• inp_par (ParSet, optional) – Parameter set used for the full run of PypeIt. If None, use default_pypeit_par().

Returns:

The PypeIt parameter set adjusted for configuration specific parameter values.

Return type:

ParSet

configuration_keys()

Return the metadata keys that define a unique instrument configuration.

This list is used by PypeItMetaData to identify the unique configurations among the list of frames read for a given reduction.

Returns:

List of keywords of data pulled from file headers and used to constuct the PypeItMetaData object.

Return type:

list

property default_mosaic

Return the default detector mosaic.

For instruments with no allowed detector mosaics, this must be returned as None.

classmethod default_pypeit_par()

Return the default parameters to use for this instrument.

Returns:

Parameters required by all of PypeIt methods.

Return type:

PypeItPar

ech_fixed_format = False

If an echelle spectrograph, this will be set to a boolean indicating whether it is a fixed format or tiltable echelle.

get_detector_par(det, hdu=None)

Return metadata for the selected detector.

Parameters:

• det (int) – 1-indexed detector number.

• hdu (astropy.io.fits.HDUList, optional) – The open fits file with the raw image of interest. If not provided, frame-dependent parameters are set to a default.

Returns:

Object with the detector metadata.

Return type:

DetectorContainer

get_echelle_angle_files()

Pass back the files required to run the echelle method of wavecalib

Returns:

List of files

Return type:

list

get_mosaic_par(mosaic, hdu=None, msc_ord=0)

Return the hard-coded parameters needed to construct detector mosaics from unbinned images.

The parameters expect the images to be trimmed and oriented to follow the PypeIt shape convention of (nspec,nspat). For returned lists, the length of the list is the same as the number of detectors in the mosaic, and they are ordered by the detector number.

Parameters:

• mosaic (tuple) – Tuple of detector numbers used to construct the mosaic. Must be one among the list of possible mosaics as hard-coded by the allowed_mosaics() function.

• hdu (astropy.io.fits.HDUList, optional) – The open fits file with the raw image of interest. If not provided, frame-dependent detector parameters are set to a default. BEWARE: If hdu is not provided, the binning is assumed to be 1,1, which will cause faults if applied to binned images!

• msc_ord (int, optional) – Order of the interpolation used to construct the mosaic.

Returns:

Object with the mosaic and detector parameters.

Return type:

Mosaic

get_rawimage(raw_file, det, spectrim=20)

Read raw images and generate a few other bits and pieces that are key for image processing.

Based on readmhdufits.pro

Parameters:

• raw_file (str) – File to read

• det (int) – 1-indexed detector to read

Returns:

• detector_par (pypeit.images.detector_container.DetectorContainer) – Detector metadata parameters.

• raw_img (numpy.ndarray) – Raw image for this detector.

• hdu (astropy.io.fits.HDUList) – Opened fits file

• exptime (float) – Exposure time read from the file header

• rawdatasec_img (numpy.ndarray) – Data (Science) section of the detector as provided by setting the (1-indexed) number of the amplifier used to read each detector pixel. Pixels unassociated with any amplifier are set to 0.

• oscansec_img (numpy.ndarray) – Overscan section of the detector as provided by setting the (1-indexed) number of the amplifier used to read each detector pixel. Pixels unassociated with any amplifier are set to 0.

header_name = 'HIRES'

Name of the spectrograph camera or arm from the Header. Usually the INSTRUME card.

init_meta()

Define how metadata are derived from the spectrograph files.

That is, this associates the PypeIt-specific metadata keywords with the instrument-specific header cards using meta.

name = 'keck_hires'

The name of the spectrograph. See Spectrographs for the currently supported spectrographs.

ndet = 3

Number of detectors for this instrument.

order_platescale(order_vec, binning=None)

Return the platescale for each echelle order.

This routine is only defined for echelle spectrographs, and it is undefined in the base class.

Parameters:

• order_vec (numpy.ndarray) – The vector providing the order numbers.

• binning (str, optional) – The string defining the spectral and spatial binning.

Returns:

An array with the platescale for each order provided by order.

Return type:

numpy.ndarray

parse_raw_files(fitstbl, det=1, ftype=None)

Parse the list of raw files with given frame type and detector. This is spectrograph-specific, and it is not defined for all spectrographs. Since different slitless_pixflat frames are usually taken for each of the three detectors, this method parses the slitless_pixflat frames and returns the correct one for the requested detector.

Parameters:

• fitstbl (astropy.table.Table) – Table with metadata of the raw files to parse.

• det (int, optional) – 1-indexed detector number to parse.

• ftype (str, optional) – Frame type to parse. If None, no frames are parsed and the indices of all frames are returned.

Returns:

The indices of the raw files in the fitstbl that are parsed.

Return type:

numpy.ndarray

pypeit_file_keys()

Define the list of keys to be output into a standard PypeIt file.

Returns:

The list of keywords in the relevant PypeItMetaData instance to print to the PypeIt Reduction File.

Return type:

list

pypeline = 'Echelle'

String used to select the general pipeline approach for this spectrograph.

raw_header_cards()

Return additional raw header cards to be propagated in downstream output files for configuration identification.

The list of raw data FITS keywords should be those used to populate the configuration_keys() or are used in config_specific_par() for a particular spectrograph, if different from the name of the PypeIt metadata keyword.

This list is used by subheader_for_spec() to include additional FITS keywords in downstream output files.

Returns:

List of keywords from the raw data files that should be propagated in output files.

Return type:

list

supported = False

Flag that PypeIt code base has been sufficiently tested with data from this spectrograph that it is officially supported by the development team.

telescope = Parameter     Value                Default  Type        Callable ---------------------------------------------------------------- name          KECK                 KECK     str         False    longitude     -155.47833333333335  None     int, float  False    latitude      19.828333333333333   None     int, float  False    elevation     4160.000000000756    None     int, float  False    fratio        15                   None     int, float  False    diameter      10                   None     int, float  False    eff_aperture  72.3674              None     int, float  False   

Instance of TelescopePar providing telescope-specific metadata.

url = 'https://www2.keck.hawaii.edu/inst/hires/'

Reference url

vet_assigned_ftypes(type_bits, fitstbl)

NOTE: this function should only be called when running pypeit_setup, in order to not overwrite any user-provided frame types.

This method checks the assigned frame types for consistency. For frames that are assigned both the science and standard types, this method chooses the one that is most likely, by checking if the frames are within 10 arcmin of a listed standard star.

In addition, for this instrument, if a frame is assigned both a pixelflat and slitless_pixflat type, the pixelflat type is removed. NOTE: if the same frame is assigned to multiple configurations, this method will remove the pixelflat type for all configurations, i.e., it is not possible to use slitless_pixflat type for one calibration group and pixelflat for another.

Parameters:

• type_bits (numpy.ndarray) – Array with the frame types assigned to each frame.

• fitstbl (PypeItMetaData) – The class holding the metadata for all the frames.

Returns:

The updated frame types.

Return type:

numpy.ndarray

pypeit.spectrographs.keck_hires.hires_read_1chip(hdu, chipno)

Read one of the HIRES detectors

Parameters:

• hdu (HDUList)

• chipno (int)

Returns:

• data (ndarray)

• oscan (ndarray)

pypeit.spectrographs.keck_hires.indexing(itt, postpix, det=None, xbin=1, ybin=1)

Some annoying book-keeping for instrument placement.

Parameters:

• itt (int)

• postpix (int)

• det (int, optional)