Event Strings

Handling Event Strings

Some endpoints such as takeScreenshot and queueMovie accepts a list of events to overlay over the images. These events use the format:

[Event Type, Feature Recognition Method, 1]

Adding Events

To add active regions to your screenshot or movie, you would pass this in for events:

[AR,all,1]

Multiple Events

Multiple event types can be included in a query by joining them with a comma. For example, to include active regions along with Coronal Mass Ejections, you would pass this in for events:

[AR,all,1],[CE,all,1]

Specific Recognition Method

Some event types have unique recognition methods that can be selected. For example, Active Regions come in different flavors, such as Spatial Possibilistic Clustering Algorithm (SPoCA) or National Oceanic and Atmospheric Administration Space Weather Prediction Center Observer (NOAA SWPC Observer)

In the above example, the keyword all is used to request all Active Region types. To request a specific recognition method, use the string that represents that recognition method.

[AR,SPoCA,1]
or
[AR,NOAA_SWPC_Observer,1]

Multiple Recognition Methods

When using multiple recognition methods, each method should be separated by a semicolon.

[AR,SPoCA;NOAA_SWPC_Observer,1]

Reference

Helioviewer Events are based on Heliophysics Event Knowledgebase (HEK) API

Event Types

This is the list of event types supported by Helioviewer.

Recognition methods aren't available on the HEK website, so the recognition methods column may be incomplete. Assistance filling in this table would be appreciated.

Event Type	Description	Recognition Methods
AR	Active Region	SPoCA, NOAA_SWPC_Observer, SolarMonitor_Active_Region_Tracker_(SMART), HMI_SHARP
CC	Coronal Cavity
CD	Coronal Dimming
CH	Coronal Hole	SPoCA
CJ	Coronal Jet
CE	Coronal Mass Ejection	CACTus_(Computer_Aided_CME_Tracking)
CR	Coronal Rain
CW	Coronal Wave
EF	Emerging Flux
ER	Eruption
FI	Filament	berger
FA	Filament Activation
FE	Filament Eruption
FL	Flare	SSW_Latest_Events
LP	Loop
OS	Oscillation
PG	Plage
SG	Sigmoid	Sigmoid_Sniffer
SP	Spray Surge
SS	Sunspot	EGSO_SFC