mtuq.graphics.attrs.PyGMTUtilities.get_header¶

static PyGMTUtilities.get_header(label, origin, filename, process=None)[source]¶

Generates a header for a plot based on the provided parameters.

Parameters

label (str): The label for the plot. Usually defined in the frontend function.

origin (mtuq.Origin): mtuq.event.Origin object, used to retrieve the event time and depth.

filename (str): The filename of the plot. Defined by default the high-level function. Used to retrieve the component.

process (Process, optional): mtuq.process_data.ProcessData object for appropriate dataset.

Returns

list: A list containing two lines of the header. [Label - (component)], [Event Time: (time) UTC, Depth: (depth) km]