Public members¶

instrument_name = 'dummy-instrument'

mode = 'spectroscopy'

grisms = {}

SpectroscopyEpoch(param_path: str = None, name: str = None, ...)

Initialize self. See help(type(self)) for accurate signature.

get_pypeit_path(key: str)

set_pypeit_path(key: str, value: str)

add_configuration(config: str)

set_configuration_property(config: str, key: str, value)

get_configuration_property(config: str, key: str)

proc_pypeit_flux(output_dir: str, **kwargs)

pypeit_flux_title()

read_pypeit_sorted_file()

setup_info(setup: str)

Pulls setup info from a pypeit .sorted file. :param setup: :return:

read_pypeit_file(config: str)

write_pypeit_file_science(config: str)

Rewrites the stored .pypeit file to disk at its original path. :return: path of .pypeit file.

add_pypeit_user_param(param: list, value: str, ...)

Inserts a parameter for the PypeIt run at the correct point in the stored .pypeit file. :param param: For m :param value: :return:

add_pypeit_file_lines(config: str, lines: list)

load_output_file(**kwargs) → dict

Loads the output .yaml file, which contains various values derived from this Epoch, using the object’s output_file attribute (which is a path to the file).

proc_pypeit_setup(output_dir: str, **kwargs)

proc_pypeit_run(output_dir: str, **kwargs)

proc_pypeit_coadd(output_dir: str, **kwargs)

proc_convert_to_marz_format(output_dir: str, **kwargs)

find_science_attributes()

find_std_attributes()

get_frames_science()

get_frames_standard()

get_decker()

set_decker(decker: str)

get_decker_std()

set_decker_std(decker: str)

classmethod stages()

classmethod select_child_class(instrument: str)

classmethod from_file(param_file: str | dict, ...)

classmethod from_params(name: str, ...)

classmethod build_param_path(field_name: str, instrument_name, ...)

stage_params : dict

exclude_frames : list

is_excluded(frame: Image | str)

__str__()

Return str(self).

__repr__()

Return repr(self).

date_str(include_time: bool = False)

mjd()

proc_initial_setup(output_dir: str, **kwargs)

set_program_id(program_id: str)

set_date(date: str | Time)

set_target(target: str)

get_binning()

set_binning(binning: str)

get_binning_std()

set_binning_std(binning: str)

get_path(key: str)

get_master_bias(chip: int)

get_master_flat(chip: int, fil: str)

classmethod sort_by_chip(images: list)

add_frame_raw(raw_frame: ImagingImage | str)

add_frame_reduced(reduced_frame: Image)

add_coadded_image(img: str | Image, key: str, **kwargs)

sort_frame(frame: Image, sort_key: str | None = None)

classmethod default_params()

classmethod new_yaml(name: str, path: str | None = None, **kwargs)

stage_output_dirs = True

add_log(action: str, method=None, method_args=None, ...)

set_path(key: str, value: str)

classmethod enumerate_stages(show: bool = True)

query_stage(message: str, stage_name: str, n: float, ...)

Helper method for asking the user if we need to do this stage of processing. If self.do is True, skips the query and returns True.

check_done(stage: str)

pipeline(no_query: bool = False, **kwargs)

Performs the pipeline methods given in stages() for this instance.

update_output_file()

update_param_file(param: str)

Epoch classes¶

frame_class(craftutils.observation.epoch.Epoch.frame_class)

alias of Spectrum

coadded_class(craftutils.observation.epoch.SpectroscopyEpoch.frame_class)

alias of Coadded1DSpectrum