getTileInputParameters

class hvpy.parameters.getTileInputParameters(**data)

Bases: HvpyParameters

Handles the input parameters of the getTile API.

id

Unique image identifier.

x

Tile x-coordinate.

y

Tile y-coordinate.

imageScale

Image scale in arcseconds per pixel.

difference

Specify image type difference.

• 0 - Display regular image

• 1 - Running difference image

• 2 - Base difference image

Default is None, optional.

diffCount

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

Select Running difference time period:

• 1 - Minutes

• 2 - Hours

• 3 - Days

• 4 - Weeks

• 5 - Month

• 6 - Years

Default is None, optional.

baseDiffTime

Datetime for base difference images. Default is None, optional.

References

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

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

get_output_type()

Returns the output type of the API call.

Attributes Documentation

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

get_output_type()

Returns the output type of the API call.

Return type:

OutputType