VLFClient

class sidpy.vlfclient.VLFClient[source]

Bases: object

Client containing functions specific to the processing of SuperSID VLF data; reading csv files, get data from csv, get header information from csv, normalize data, convert data to pandas DataFrame, plot data and create summary plot.

Methods Summary

create_plot(header, data, file_path, ...[, ...])

Generate plot for given parameters and data.

create_plot_xrs(header, data, file_path, ...)

Generate plot for given parameters and data.

get_data(df, original_sid)

Generate new dataframe containing only datetime and signal intensity with comments removed.

get_header(df)

Process csv comments into file parameters.

get_recent_goes([file])

Process GOES XRS files defaults to most recent GOES X-ray data from the NOAA page.

read_csv(filename)

Read .csv files containing signal strength and time.

Methods Documentation

static create_plot(header, data, file_path, archive_path, original_sid=False)[source]

Generate plot for given parameters and data.

Parameters:

  • header (dict) – Dictionary containing observation parameters, eg. transmitter freq.

  • data (object) – Pandas dataframe containing csv data.

  • file_path (str) – Path to csv file.

  • archive_path (str) – Path to archive.

  • original_sid (bool) – Statement on whether SID or Supersid data is being used.

Returns:

image_path (str) – Path to image location.

static create_plot_xrs(header, data, file_path, archive_path, gl, gs, original_sid=False)[source]

Generate plot for given parameters and data.

Parameters:

  • header (dict) – Dictionary containing observation parameters, eg. transmitter freq.

  • data (object) – Pandas dataframe containing csv data.

  • file_path (PosixPath) – Path to archive.

  • archive_path (PosixPath) – Path to csv file.

  • gl (pandas.Series) – GOES XRS Long data.

  • gs (pandas.Series) – GOES XRS Short data.

  • original_sid (bool) – Statement on whether SID or Supersid data is being used.

Returns:

image_path (str) – Path to image location.

static get_data(df, original_sid)[source]

Generate new dataframe containing only datetime and signal intensity with comments removed.

Parameters:

  • df (object) – Pandas dataframe containing csv data.

  • original_sid (bool) – Statement on whether SID or Supersid data is being used.

Returns:

df (object) – Pandas dataframe containing normalized csv data without comments.

static get_header(df)[source]

Process csv comments into file parameters.

Parameters:

df (object) – Pandas dataframe containing csv data.

Returns:

parameters (dict) – Dictionary containing observation parameters, eg. transmitter freq.

static get_recent_goes(file='https://services.swpc.noaa.gov/json/goes/primary/xrays-7-day.json')[source]

Process GOES XRS files defaults to most recent GOES X-ray data from the NOAA page.

Returns:

  • gl (pd.DataFrame object) – The GOES long channels as pandas series

  • gs (pd.DataFrame object) – The GOES short channels as pandas series

static read_csv(filename)[source]

Read .csv files containing signal strength and time.

Parameters:

filename (str) – Path to csv file.

Returns:

df (object) – Pandas dataframe containing csv data.