getTile

hvpy.getTile(id, x, y, imageScale, difference=None, diffCount=None, diffTime=None, baseDiffTime=None)

Request a single image tile to be used in the Helioviewer.org Viewport. Tiles are 512x512 pixel PNG images, generated for a given image scale from the intermediary JPEG2000 image files.

Use the getClosestImage API endpoint to obtain the desired image identifier for the id parameter.

Parameters:

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

• x (int) – Tile x-coordinate.

• y (int) – Tile y-coordinate.

• imageScale (int) – Image scale in arcseconds per pixel.

• difference (Optional[int]) –

  Specify image type difference.

  • 0 - Display regular image

  • 1 - Running difference image

  • 2 - Base difference image

  Default is None, optional.

• diffCount (Optional[int]) – Used to display Running difference image. Work with diffTime parameter and set amount of time to use in time period. Default is None, optional.

• diffTime (Optional[int]) –

  Select Running difference time period:

  • 1 - Minutes

  • 2 - Hours

  • 3 - Days

  • 4 - Weeks

  • 5 - Month

  • 6 - Years

  Default is None, optional.

• baseDiffTime (Optional[datetime]) – Datetime for base difference images. Default is None, optional.

Return type:

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

References

• https://api.helioviewer.org/docs/v2/api/api_groups/official_clients.html#gettile

Examples

>>> from hvpy import getTile
>>> getTile(id=36275490,
...         x=-1,
...         y=-1,
...         imageScale=2,
...         )
b'...'