readevent.read_solarmonitor_event Namespace Reference

Classes
class	NOAAError
class	NOAAEvent

Functions
def	write_events
	Write event list in a file. More...
def	print_events
	Write event list on standard output. More...
def	regroup_event_by_attribute
	Regroup events by attribute. More...
def	noaa_decode_time
	Decode NOAA formatted date. More...
def	noaa_code_time
	Code NOAA date. More...
def	noaa_decode_obs
	Decode NOAA observatory name. More...
def	noaa_decode_type
	Decode NOAA type and give a short description. More...
def	noaa_decode_frequency
	Decode NOAA frequency. More...
def	noaa_code_frequency
	Code NOAA frequency. More...
def	noaa_decode_particular
	Decode additional info. More...
def	noaa_code_particular
	Code particular columns. More...
def	decode_ar_id
	Decode Active region ID. More...
def	read_v0
	Read event txt file return by SOLARMONITOR website and extract info about the events. More...
def	write_v0
	Write event txt file with ASCII_SOLARMONITORNOAAEVENT_V0. More...

Variables
string	header = '%-4s %-4s %-16s %-16s %-16s %-9s %-16s %-5s %-8s %-8s %-5s\n'

Function Documentation

def readevent.read_solarmonitor_event.decode_ar_id

(

line

)

Decode Active region ID.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_code_frequency	(		type_str,
			freq_list
	)

Code NOAA frequency.

Returns

Intensity string formatted as Solarmonitor does.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_code_particular

(

event

)

Code particular columns.

Returns

Particular string formatted as Solarmonitor does.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_code_time	(		time_in,
			time_comnt
	)

Code NOAA date.

Returns

Date string formatted as Solarmonitor does.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_decode_frequency	(		type_str,
			freq_str
	)

Decode NOAA frequency.

Returns

List of frequency in MHz.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_decode_obs

(

obs_str

)

Decode NOAA observatory name.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_decode_particular	(		type_str,
			line
	)

Decode additional info.

• For XRA: [ABCMX]%3.1f %7.1E (Class + Integrated flux from start to end, in joules m E-2).
• For FLA: [S1234][FNB] [VWL|UMB|PRB|LPS|YSR|ERU|BPT|HSS|DSD|DSF|BLU| ] (class and flare Characteristics).
• For DSF: int (between 0 and 26?)
• For XFL: %7.1e %7.1e (maximum area and max intensity).
• For RBR: d (flux peak value unit).
• For RSP: [II|III|IV|V|VI|VII|CTM][123] [d| ] (class and shock speed)
• For RNS: int (between 140 and 340?)
• For DSD: int (?)
• For EPL: float (?)

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_decode_time

(

time_str

)

Decode NOAA formatted date.

• HM
• AHM (After HM)
• BHM (Before HM)
• UHM (Uncertain HM)
• //// (undefined)

Returns

None or time.struct_time object at good time with date 1900-1-1

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.noaa_decode_type

(

type_str

)

Decode NOAA type and give a short description.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.print_events

(

events

)

Write event list on standard output.

def readevent.read_solarmonitor_event.read_v0

(

filepath

)

Read event txt file return by SOLARMONITOR website and extract info about the events.

SOLARMONITOR NOAA EVENT V0-format for noaa event file is the following
Header (part1):

• :Product: file ID
• :Created: file creation
• :Date: event day

Header (part2): 9 lines begin with '#'.
Prepared by the U.S. Dept. of Commerce, NOAA, Space Weather Prediction Center Please send comments and suggestions to SWPC..nosp@m.Webm.nosp@m.aster.nosp@m.@noa.nosp@m.a.gov

Missing data: //// Updated every 5 minutes. Edited Events for 2019 May 05

Event Begin Max End Obs Q Type Loc/Frq Particulars Reg#

Colums ordering:

• Event : event number 'd' or 'd +' (if more than 1 event)
• Begin : beginning hour with format HM or AHM (After HM) or BHM (After HM) or UHM (Uncertain HM) or //// (undefined)
• Max : peak hour
• End : ending hour
• Obs : observatory ID. Cf noaa_decode_obs.
• Q : quality (Corrected report, Good, Uncertain or from 1 = very poor to 5 = excellent)
• Type : type of event. Cf noaa_decode_type. See http://www.swpc.noaa.gov/info/glossary.html.
• Loc/Frq : location with format [NS]%2d[WE]%2d. Heliographic coordinates in degree. Longitude from central meridian (center of the solar disk as viewed from Earth). Frequencies are in Mhz.
• Particulars : additional information, depend on event type. Cf decode_particular.
• Reg# : SWPC-assigned solar region number

//// is missing data.
Sometimes, blank lines between data.
'NO EVENT REPORTS.' if no events.

Returns

List of all NOAAEvent objects.

Here is the call graph for this function:

def readevent.read_solarmonitor_event.regroup_event_by_attribute	(		events,
			attribute = 'event_id'
	)

Regroup events by attribute.

Attribute can be: event_id, event_type, event_class, obs_id, obs_id, or whatever NOAAEvent attribute.

Returns

Dictionnary. attribute_value: list of events with this attribute value.

Here is the caller graph for this function:

def readevent.read_solarmonitor_event.write_events	(		events,
			fid
	)

Write event list in a file.

def readevent.read_solarmonitor_event.write_v0	(		events,
			filepath
	)

Write event txt file with ASCII_SOLARMONITORNOAAEVENT_V0.

Here is the call graph for this function:

Variable Documentation

string readevent.read_solarmonitor_event.header = '%-4s %-4s %-16s %-16s %-16s %-9s %-16s %-5s %-8s %-8s %-5s\n'