API Reference#

hvpy Package#

Functions#

createMovie(startTime, endTime, layers, ...)

Automatically creates a movie using queueMovie, getMovieStatus and downloadMovie functions.

createScreenshot(date, imageScale, layers[, ...])

Automatically creates a screenshot using takeScreenshot, downloadScreenshot functions.

create_events(events)

Creates a string of events separated by commas.

create_layers(layer)

Creates a string of layers separated by commas.

downloadMovie(id, format[, hq])

Download a custom movie that was generated using the queueMovie API endpoint.

downloadScreenshot(id)

Download a custom screenshot that was generated using the takeScreenshot API endpoint.

getClosestImage(date, sourceId[, callback])

Find the image data that is closest to the requested datetime.

getDataSources([verbose, enable, callback])

Return a hierarchial list of the available datasources.

getJP2Header(id[, callback])

Get the XML header embedded in a JPEG2000 image.

getJP2Image(date, sourceId[, jpip, json])

Retrieve a JP2000 image from the helioviewer.org API.

getJPX(startTime, endTime, sourceId[, ...])

Generate and (optionally) download a custom JPX movie of the specified datasource from the helioviewer.org API.

getJPXClosestToMidPoint(startTimes, ...[, ...])

Generate and (optionally) download a custom JPX movie of the specified datasource with one frame per pair of start/endtimes given.

getMovieStatus(id, format[, verbose, ...])

Get the status of a movie.

getNewsFeed([callback])

Get the XML RSS feed of the official Helioviewer Project Blog.

getStatus()

Returns information about how far behind the latest available JPEG2000 images.

getTile(id, x, y, imageScale[, difference, ...])

Request a single image tile to be used in the Helioviewer.org Viewport.

queueMovie(startTime, endTime, layers, ...)

Queue a movie for download from the helioviewer.org API.

reQueueMovie(id[, force])

Re-generate a custom movie that is no longer cached on the server.

save_file(data, filename[, overwrite])

Saves a file to the specified path.

set_api_url(url)

Sets the API URL.

shortenURL(queryString[, callback])

Shorten a Helioviewer.org URL with the bit.ly URL shortening web service.

takeScreenshot(date, imageScale, layers[, ...])

Generate a custom screenshot.

Classes#

DataSource(value[, names, module, qualname, ...])

Enum for datasources hosted by the Helioviewer Project.

EventType(value[, names, module, qualname, ...])

Enum for the event types supported by Helioviewer.

hvpy.core Module#

Functions#

execute_api_call(input_parameters)

Executes the API call and returns a parsed response.

parse_response(response, output_type)

Parses the response from the API call based on the output type.

hvpy.io Module#

Classes#

HvpyParameters(**data)

Base model for all Helioviewer API parameters.

OutputType(value[, names, module, qualname, ...])

hvpy.parameters Module#

Classes#

getJP2ImageInputParameters(**data)

Handles the input parameters of the getJP2Image API.

getJP2HeaderInputParameters(**data)

Handles the input parameters of the getJP2Header API.

getJPXClosestToMidPointInputParameters(**data)

Handles the input parameters of the getJPXClosestToMidPoint API.

getJPXInputParameters(**data)

Handles the input parameters of the getJPX API.

getStatusInputParameters(**data)

Handles the input parameters of the getStatus API.

getClosestImageInputParameters(**data)

Handles the input parameters of the getClosestImage API.

getDataSourcesInputParameters(**data)

Handles the input parameters of the getDataSources API.

takeScreenshotInputParameters(**data)

Handles the input parameters of the takeScreenshot API.

downloadScreenshotInputParameters(**data)

Handles the input parameters of the downloadScreenshot API.

queueMovieInputParameters(**data)

Handles the input parameters of the queueMovie API.

reQueueMovieInputParameters(**data)

Handles the input parameters of the reQueueMovie API.

getMovieStatusInputParameters(**data)

Handles the input parameters of the getMovieStatus API.

downloadMovieInputParameters(**data)

Handles the input parameters of the downloadMovie API.

getNewsFeedInputParameters(**data)

Handles the input parameters of the getNewsFeed API.

shortenURLInputParameters(**data)

Handles the input parameters of the shortenURL API.

getTileInputParameters(**data)

Handles the input parameters of the getTile API.

Class Inheritance Diagram#

Inheritance diagram of hvpy.api_groups.jpeg2000.get_jp2_image.getJP2ImageInputParameters, hvpy.api_groups.jpeg2000.get_jp2_header.getJP2HeaderInputParameters, hvpy.api_groups.jpeg2000.get_jpx_closest_to_mid_point.getJPXClosestToMidPointInputParameters, hvpy.api_groups.jpeg2000.get_jpx.getJPXInputParameters, hvpy.api_groups.jpeg2000.get_status.getStatusInputParameters, hvpy.api_groups.official_clients.get_closest_image.getClosestImageInputParameters, hvpy.api_groups.official_clients.get_data_sources.getDataSourcesInputParameters, hvpy.api_groups.screenshots.take_screenshot.takeScreenshotInputParameters, hvpy.api_groups.screenshots.download_screenshot.downloadScreenshotInputParameters, hvpy.api_groups.movies.queue_movie.queueMovieInputParameters, hvpy.api_groups.movies.re_queue_movie.reQueueMovieInputParameters, hvpy.api_groups.movies.get_movie_status.getMovieStatusInputParameters, hvpy.api_groups.movies.download_movie.downloadMovieInputParameters, hvpy.api_groups.communications.get_news_feed.getNewsFeedInputParameters, hvpy.api_groups.communications.shorten_url.shortenURLInputParameters, hvpy.api_groups.screenshots.get_tile.getTileInputParameters

hvpy.datasource Module#

Classes#

DataSource(value[, names, module, qualname, ...])

Enum for datasources hosted by the Helioviewer Project.

hvpy.event Module#

Classes#

EventType(value[, names, module, qualname, ...])

Enum for the event types supported by Helioviewer.

hvpy.utils Module#

Functions#

convert_date_to_isoformat(v)

Converts the date from a datetime object to a string in the ISO format.

convert_date_to_unix(v)

Converts a list of datetimes to Unix timestamps format separated with commas.

create_layers(layer)

Creates a string of layers separated by commas.

create_events(events)

Creates a string of events separated by commas.

save_file(data, filename[, overwrite])

Saves a file to the specified path.