pypeit.spectrographs.bok_bc module

Module for Bok/B&C specific methods.

class pypeit.spectrographs.bok_bc.BokBCSpectrograph

Bases: Spectrograph

Child to handle BOK specific code

bpm(filename, det, shape=None, msbias=None)

Generate a default bad-pixel mask.

Parameters:

• filename (str or None) – An example file to use to get the image shape.

• det (int) – 1-indexed detector number to use when getting the image shape from the example file.

• shape (tuple, optional) – Processed image shape Required if filename is None Ignored if filename is not None

• msbias (numpy.ndarray, optional) – Processed bias frame used to identify bad pixels

Returns:

An integer array with a masked value set to 1 and an unmasked value set to 0. All values are set to 0.

Return type:

numpy.ndarray

camera = 'BC'

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 = 'Bok B&C spectrometer'

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_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

classmethod default_pypeit_par()

Return the default parameters to use for this instrument.

Returns:

Parameters required by all of PypeIt methods.

Return type:

PypeItPar

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

header_name = 'Bok B&C spectrometer'

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 = 'bok_bc'

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

ndet = 1

Number of detectors for this instrument.

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

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 = True

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          BOK                 KECK     str         False    longitude     -111.6              None     int, float  False    latitude      31.963333333333342  None     int, float  False    elevation     2119.999999997953   None     int, float  False    fratio        None                None     int, float  False    diameter      None                None     int, float  False    eff_aperture  None                None     int, float  False   

Instance of TelescopePar providing telescope-specific metadata.

url = 'http://james.as.arizona.edu/~psmith/90inch/90inch.html'

Reference url