getJPXInputParameters

class hvpy.parameters.getJPXInputParameters(**data)

Bases: HvpyParameters

Handles the input parameters of the getJPX API.

startTime

Datetime for the beginning of the JPX movie data.

endTime

Datetime for the end of the JPX movie data.

sourceId

Unique image datasource identifier.

linked

Generate a linked JPX file containing image pointers instead of data for each individual frame in the series. Default is True, optional.

verbose

if set to True, the JSON response will include timestamps for each frame in the resulting movie and any warning messages associated with the request. In addition to the JPX movie file URI. Default is False, optional.

jpip

Return a JPIP URI string instead of the binary data of the movie itself, or instead of an HTTP URI in the JSON response (if verbose is set to True). Default is False, optional.

cadence

The desired amount of time (in seconds) between each frame in the movie. Default is None (maximum cadence), optional.

References

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

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