mapreader.download.iiif_downloader
==================================

.. py:module:: mapreader.download.iiif_downloader


Classes
-------

.. autoapisummary::

   mapreader.download.iiif_downloader.IIIFDownloader


Module Contents
---------------

.. py:class:: IIIFDownloader(iiif, iiif_versions = 'infer', iiif_uris = None)

   .. py:attribute:: iiif
      :value: []



   .. py:method:: save_georeferenced_maps(path_save = 'maps')

      Save georefereced maps from a IIIF presentation 3 json as tiffs.

      :param path_save: Path to save the images
      :type path_save: str | pathlib.Path

      .. rubric:: Notes

      Calls the `save_georeferenced_map` method for each IIIF object.



   .. py:method:: save_georeferenced_map(iiif, path_save = 'maps', iiif_uri = None)

      Save a single georefereced map from a IIIF presentation 3 json as a tiff.

      :param iiif: the IIIF url or IIIF presentation API object containing the map(s)
      :type iiif: str | dict | IIIFPresentation3
      :param path_save: Path to save the images
      :type path_save: str | pathlib.Path
      :param iiif_uri: The URI of the IIIF object, needed if the IIIF object is missing an 'id' field.
      :type iiif_uri: str

      .. rubric:: Notes

      Only first order polynomial transformations are currently supported, see the [allmaps documentation](https://allmaps.org/) for more information on the transformation options.

      :raises ValueError: Only first order polynomial transformations are currently supported.



   .. py:method:: save_maps(path_save = 'maps')

      Save maps from a IIIF presentation json as pngs.

      :param path_save: Path to save the images
      :type path_save: str | pathlib.Path

      .. rubric:: Notes

      Calls the `save_map` method for each IIIF object.



   .. py:method:: save_map(iiif, iiif_version = 3, path_save = 'maps', iiif_uri = None)

      Save a single map from a IIIF presentation json as a png.

      :param iiif: the IIIF url or IIIF presentation API object containing the map(s)
      :type iiif: str | dict | IIIFPresentation3 | IIIFPresentation2
      :param iiif_version: The IIIF version, ignored if iiif is already a IIIF object
      :type iiif_version: int | float | str
      :param path_save: Path to save the images
      :type path_save: str | pathlib.Path
      :param iiif_uri: The URI of the IIIF object, needed if the IIIF object is missing an 'id' field.
      :type iiif_uri: str



   .. py:method:: download_image(iiif_version, annot)