pypeit.scripts.collate_1d module

This script collates multiple 1d spectra in multiple files by object, runs flux calibration on them, and then coadds them.

class pypeit.scripts.collate_1d.Collate1D

Bases: ScriptBase

classmethod get_parser(width=None)

Construct the command-line argument parser.

Derived classes should override this. Ideally they should use this base-class method to instantiate the ArgumentParser object and then fill in the relevant parser arguments

Warning

Any argument that defaults to the string 'current working directory' will be replaced by the result of Path.cwd() when the script is executed. This means help dialogs will include this replacement, and parsing of the command line will use Path.cwd() as the default. This functionality is largely to allow for PypeIt’s automated documentation of script help dialogs without the “current working” directory being that of the developer that most recently compiled the docs.

Parameters:

• description (str, optional) – A short description of the purpose of the script.

• width (int, optional) – Restrict the width of the formatted help output to be no longer than this number of characters, if possible given the help formatter. If None, the width is the same as the terminal width.

• formatter (argparse.HelpFormatter) – Class used to format the help output.

• include_log_options (bool, optional) – Include options that define the logging level(s) and log file.

• default_log_file (bool, optional) – If true, script will use the default log file name if none is provided. Ignored if include_log_options is False.

Returns:

Command-line interpreter.

Return type:

argparse.ArgumentParser

classmethod main(args)

Execute the script.

pypeit.scripts.collate_1d.build_parameters(args)

Read the command-line arguments and the input .collate1d file (if any), to build the parameters needed by collate_1d. The command line arguments will take priority over any parameters in the .collate1d file.

Parameters:

args (argparse.Namespace) – The parsed command line as returned by the argparse module.

Returns:

Returns three objects: a PypeItPar instance with the parameters for collate_1d, a Spectrograph instance with the spectrograph parameters used to take the data, and a list with the spec1d files read from the command line or .collate1d file.

Return type:

tuple