getTile#
- hvpy.getTile(id, x, y, imageScale, difference=None, diffCount=None, diffTime=None, baseDiffTime=None)[source]#
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.Specify image type difference.
0
- Display regular image1
- Running difference image2
- Base difference image
Default is None, optional.
diffCount (
Optional
[int
]) – Used to display Running difference image. Work withdiffTime
parameter and set amount of time to use in time period. Default is None, optional.Select Running difference time period:
1
- Minutes2
- Hours3
- Days4
- Weeks5
- Month6
- Years
Default is None, optional.
baseDiffTime (
Optional
[datetime
]) – Datetime for base difference images. Default is None, optional.
- Return type:
References
Examples
>>> from hvpy import getTile >>> getTile(id=36275490, ... x=-1, ... y=-1, ... imageScale=2, ... ) b'...'