getJP2Image

hvpy.getJP2Image(date, sourceId, jpip=False, json=False)

Retrieve a JP2000 image from the helioviewer.org API.

Parameters:

• date (datetime) – Desired datetime of the JP2 image.

• sourceId (Union[int, DataSource]) – Unique image datasource identifier.

• jpip (bool) – Returns a JPIP URI instead of the binary data of the image if set to True. Default is False, optional.

• json (bool) – Returns the JSON if set to True. Default is False, optional.

Return type:

Union[bytes, str, Dict[str, Any]]

References

• https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjp2image

Examples

>>> from hvpy import getJP2Image
>>> from datetime import datetime, timedelta
>>> getJP2Image(date=datetime.today(), sourceId=14, jpip=True)
'jpips://...'