API Reference#
hvpy Package#
Functions#
|
Automatically creates a movie using queueMovie, getMovieStatus and downloadMovie functions. |
|
Automatically creates a screenshot using takeScreenshot, downloadScreenshot functions. |
|
Creates a string of events separated by commas. |
|
Creates a string of layers separated by commas. |
|
Download a custom movie that was generated using the |
Download a custom screenshot that was generated using the |
|
|
Find the image data that is closest to the requested datetime. |
|
Return a hierarchial list of the available datasources. |
|
Get the XML header embedded in a JPEG2000 image. |
|
Retrieve a JP2000 image from the helioviewer.org API. |
|
Generate and (optionally) download a custom JPX movie of the specified datasource from the helioviewer.org API. |
|
Generate and (optionally) download a custom JPX movie of the specified datasource with one frame per pair of start/endtimes given. |
|
Get the status of a movie. |
|
Get the XML RSS feed of the official Helioviewer Project Blog. |
Returns information about how far behind the latest available JPEG2000 images. |
|
|
Request a single image tile to be used in the Helioviewer.org Viewport. |
|
Queue a movie for download from the helioviewer.org API. |
|
Re-generate a custom movie that is no longer cached on the server. |
|
Saves a file to the specified path. |
|
Sets the API URL. |
|
Shorten a Helioviewer.org URL with the bit.ly URL shortening web service. |
|
Generate a custom screenshot. |
Classes#
|
Enum for datasources hosted by the Helioviewer Project. |
|
Enum for the event types supported by Helioviewer. |
hvpy.core Module#
Functions#
|
Executes the API call and returns a parsed response. |
|
Parses the response from the API call based on the output type. |
hvpy.io Module#
Classes#
|
Base model for all Helioviewer API parameters. |
|
hvpy.parameters Module#
Classes#
|
Handles the input parameters of the |
|
Handles the input parameters of the |
Handles the input parameters of the |
|
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
Handles the input parameters of the |
|
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
|
Handles the input parameters of the |
Class Inheritance Diagram#
hvpy.datasource Module#
Classes#
|
Enum for datasources hosted by the Helioviewer Project. |
hvpy.event Module#
Classes#
|
Enum for the event types supported by Helioviewer. |
hvpy.utils Module#
Functions#
Converts the date from a datetime object to a string in the ISO format. |
|
Converts a list of datetimes to Unix timestamps format separated with commas. |
|
|
Creates a string of layers separated by commas. |
|
Creates a string of events separated by commas. |
|
Saves a file to the specified path. |