Source code for hvpy.api_groups.jpeg2000.get_jpx

from typing import Union, Optional
from datetime import datetime

from pydantic import field_validator

from hvpy.datasource import DataSource
from hvpy.io import HvpyParameters, OutputType
from hvpy.utils import _data_source_to_int, convert_date_to_isoformat


class getJPXInputParameters(HvpyParameters):
    """
    Handles the input parameters of the ``getJPX`` API.

    .. {Shared}
    Attributes
    ----------
    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>`__

    .. {Shared}
    """

    startTime: datetime
    endTime: datetime
    sourceId: Union[int, DataSource]
    linked: bool = True
    verbose: bool = False
    jpip: bool = False
    cadence: Optional[int] = None
    _date_validator = field_validator("startTime", "endTime")(convert_date_to_isoformat)
    _source_id_validator = field_validator("sourceId")(_data_source_to_int)

    def get_output_type(self) -> OutputType:
        """
        Returns the output type of the API call.
        """
        if not self.jpip and not self.verbose:
            return OutputType.RAW
        elif self.jpip and not self.verbose:
            return OutputType.STRING
        else:
            return OutputType.JSON