File: eoproduct.rst

package info (click to toggle)
eodag 3.10.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 48,500 kB
  • sloc: python: 41,542; xml: 3,791; makefile: 27; sh: 9
file content (60 lines) | stat: -rw-r--r-- 1,731 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.. module:: eodag.api.product._product

=========
EOProduct
=========

EOProduct is the main class representing Earth Observation (EO) products in the EODAG library.
It provides a comprehensive interface for interacting with EO products, including metadata access, downloading, and conversion to various formats.
This section details the attributes, methods, and additional functionalities available in the EOProduct class.

Constructor
-----------

.. autoclass:: EOProduct

   :Attributes:

      .. autoattribute:: provider
      .. autoattribute:: properties
      .. autoattribute:: product_type
      .. autoattribute:: geometry
      .. autoattribute:: search_intersection
      .. autoattribute:: location
      .. autoattribute:: remote_location
      .. autoattribute:: assets
      .. autoattribute:: driver

Download
--------

.. automethod:: EOProduct.download
.. automethod:: EOProduct.get_quicklook

Conversion
----------

.. automethod:: EOProduct.as_dict
.. automethod:: EOProduct.from_geojson

Interface
---------

.. autoproperty:: EOProduct.__geo_interface__

Pixel access
------------

.. warning::

   The following methods will only be available with `eodag-cube <https://github.com/CS-SI/eodag-cube>`__ installed.

.. class:: eodag_cube.api.product._product.EOProduct
   :canonical: eodag_cube.api.product._product.EOProduct

   Inherits from :class:`eodag.api.product._product.EOProduct` and implements pixel access related methods.

.. automethod:: eodag_cube.api.product._product.EOProduct.to_xarray
.. automethod:: eodag_cube.api.product._product.EOProduct.get_file_obj
.. automethod:: eodag_cube.api.product._product.EOProduct.rio_env
.. automethod:: eodag_cube.api.product._product.EOProduct.get_data