HelioviewerDownloadTask

Inherits Task

This task downloads solar image data from the Helioviewer API and stores the resulting JP2 files on disk for use in OpenSpace.

All available images within the given interval are retrieved at the requested temporal cadence and stored locally as JP2 files. The filenames are formatted according to the OpenSpace SolarBrowsing convention, encoding timestamp, spacecraft name, and instrument identifier. The instrument string must match the local colormap naming convention (hyphen-separated, e.g., “AIA-193”) so that the correct colormap can be resolved at runtime. Existing files are not re-downloaded.

The actual temporal spacing of the downloaded images depends on data availability from Helioviewer, but will never be shorter than the requested cadence.

Members

Name	Documentation	Type	Description	Optional
ColorMap	The path to the colormap that will be used for this spacecraft and instrument. Note that the colormap is copied into the output folder.	File	Value of type ‘File’	No
EndTime	The end of the time interval to extract data from. Format: YYYY-MM-DDTHH:MM:SS	Date and time	Value of type ‘Date and time’	No
Instrument	Instrument identifier (e.g., “AIA-171”).	String	Value of type ‘String’	No
Name	Name of the spacecraft or telescope.	String	Value of type ‘String’	No
OutputFolder	Directory where the downloaded JP2 images will be stored.	Directory	Value of type ‘Directory’	No
SourceId	The unique identifier as specified in the Helioviewer documentation: https://api.helioviewer.org/docs/v2/appendix/data_sources.html	Integer	Value of type ‘Integer’	No
StartTime	The beginning of the time interval to extract data from. Format: YYYY-MM-DDTHH:MM:SS	Date and time	Value of type ‘Date and time’	No
TimeStep	Desired temporal sampling interval in seconds. The system will attempt to retrieve images spaced at approximately this interval, depending on data availability. The actual interval will never be shorter than this value. Useful for temporal downsampling.	Double	Value of type ‘Double’	No
Type	This key specifies the type of Task that gets created. It has to be one of the valid Tasks that are available for creation (see the FactoryDocumentation for a list of possible Tasks), which depends on the configration of the application.	String	A valid Task created by a factory	No

Inherited members from Task

Name	Documentation	Type	Description	Optional
Type	This key specifies the type of Task that gets created. It has to be one of the valid Tasks that are available for creation (see the FactoryDocumentation for a list of possible Tasks), which depends on the configration of the application.	String	A valid Task created by a factory	No