EISTemplateLocator

class eispac.templates.EISTemplateLocator(filename_head=None, verbose=False, ignore_local=True)[source]

Bases: object

Helper class used by the “eis_browse_templates” GUI

Finds fit templates matching all data windows in a given EIS observation and generates lists of the filepaths. Not intended for direct use. For a more user-friendly function with similar capabilities, see match_templates

Parameters:
  • filename_head (str, optional) – Filepath to a EIS Level-1 HDF5 file. Both data and header filepaths are accepted.

  • verbose (bool, optional) – If set to True, will automatically print a list of all found templates. Default is False.

  • ignore_local (bool, optional) – If set to True, will look for templates in either SSW or those distributed with EISPAC. If set to False, will instead ONLY look for templates in a local directory named either “eis_template_dir” or “eis_fit_templates”. Default is True.

Methods Summary

find_templates()

Find all fit template files available

make_text_list()

Generate a text list of all templates found

match_templates()

Match each observation window and with all relevant fit templates

parse_input_filename(input_filename)

Read an EIS level-1 filename and determine the header filepath

print_text_list()

Print the list of found templates

read_wininfo()

"Read the window information from the header file

Methods Documentation

find_templates()[source]

Find all fit template files available

make_text_list()[source]

Generate a text list of all templates found

match_templates()[source]

Match each observation window and with all relevant fit templates

parse_input_filename(input_filename)[source]

Read an EIS level-1 filename and determine the header filepath

print_text_list()[source]

Print the list of found templates

read_wininfo()[source]

“Read the window information from the header file