EOReader

https://eoreader.readthedocs.io/stable
Admin
EOReader is a remote-sensing Python library that reads optical and SAR satellite constellations,...
Tokens:86,166
Snippets:600
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### get_band_paths Example

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Example of how to retrieve the paths for multiple bands from a SPOT4/5 product.

```APIDOC
## GET /websites/eoreader_readthedocs_io_stable/get_band_paths

### Description
Returns the paths of required bands.

### Method
GET

### Endpoint
/websites/eoreader_readthedocs_io_stable/get_band_paths

### Parameters
#### Query Parameters
- **band_list** (list) - Required - List of the wanted bands
- **pixel_size** (float) - Optional - Band pixel size

### Request Example
```python
from eoreader.reader import Reader
from eoreader.bands import *
path = r"IMG_PHR1B_PMS_001"
prod = Reader().open(path)
print(prod.get_band_paths([GREEN, RED]))
```

### Response
#### Success Response (200)
- **dict** - Dictionary containing the path of each queried band

#### Response Example
```json
{
    "GREEN": "IMG_PHR1A_PMS_001/DIM_PHR1A_PMS_202005110231585_ORT_5547047101.XML",
    "RED": "IMG_PHR1A_PMS_001/DIM_PHR1A_PMS_202005110231585_ORT_5547047101.XML"
}
```
```

--------------------------------

### get_date Example

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Example of how to retrieve the acquisition date of a SPOT4/5 product.

```APIDOC
## GET /websites/eoreader_readthedocs_io_stable/get_date

### Description
Gets the product's acquisition date.

### Method
GET

### Endpoint
/websites/eoreader_readthedocs_io_stable/get_date

### Parameters
#### Query Parameters
- **as_date** (bool) - Optional - If false, returns a string. Defaults to False.

### Request Example
```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_date(as_date=True))
print(prod.get_date(as_date=False))
```

### Response
#### Success Response (200)
- **str | date** - Its acquisition date

#### Response Example
```python
# If as_date=True
# datetime.datetime(2020, 8, 24, 0, 0)
# If as_date=False
'20200824'
```
```

--------------------------------

### get_datetime Example

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Example of how to retrieve the acquisition datetime of a SPOT4/5 product.

```APIDOC
## GET /websites/eoreader_readthedocs_io_stable/get_datetime

### Description
Gets the product's acquisition datetime, with format `YYYYMMDDTHHMMSS`.

### Method
GET

### Endpoint
/websites/eoreader_readthedocs_io_stable/get_datetime

### Parameters
#### Query Parameters
- **as_datetime** (bool) - Optional - If false, returns a string. Defaults to False.

### Request Example
```python
from eoreader.reader import Reader
path = r"IMG_PHR1B_PMS_001"
prod = Reader().open(path)
print(prod.get_datetime(as_datetime=True))
print(prod.get_datetime(as_datetime=False))
```

### Response
#### Success Response (200)
- **str | datetime** - Its acquisition datetime

#### Response Example
```python
# If as_datetime=True
# datetime.datetime(2020, 5, 11, 2, 31, 58)
# If as_datetime=False
'20200511T023158'
```
```

--------------------------------

### Install EOReader using Conda (Shell)

Source: https://eoreader.readthedocs.io/stable

Shows how to install EOReader using Conda, ensuring strict channel priority. This method installs EOReader and its dependencies from the conda-forge channel.

```shell
conda config --env --set channel_priority strict
conda install -c conda-forge eoreader

```

--------------------------------

### Install EOReader using Pip (Shell)

Source: https://eoreader.readthedocs.io/stable

Provides the command to install the EOReader Python package using pip. EOReader has dependencies on geopandas, xarray, and rasterio.

```shell
pip install eoreader

```

--------------------------------

### Get Quicklook Path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_slstr_product.S3SlstrProduct.html

Retrieves the file path for the product's quicklook image, if available.

```APIDOC
## GET /products/{product_id}/quicklook_path

### Description
Gets the quicklook path if it exists. Some providers offer a quicklook image.

### Method
GET

### Endpoint
/products/{product_id}/quicklook_path

### Response
#### Success Response (200)
- **path** (str) - The path to the quicklook image.

#### Response Example
```json
{
  "path": "/path/to/quicklook.jpg"
}
```
```

--------------------------------

### GET /product/band-paths

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_product.S3Product.html

Retrieve the file paths for existing bands in the product.

```APIDOC
## GET /product/band-paths

### Description
Returns a dictionary mapping band names to their respective file paths on the system or archive.

### Method
GET

### Endpoint
/product/band-paths

### Parameters
#### Query Parameters
- **kwargs** (dict) - Optional arguments for path retrieval (e.g., orthorectification settings).

### Response
#### Success Response (200)
- **paths** (dict) - Dictionary where keys are band names and values are file path strings.

#### Response Example
{
  "GREEN": "zip+file://path/to/data.zip!/IMG_DATA/B03.jp2",
  "NIR": "zip+file://path/to/data.zip!/IMG_DATA/B08.jp2"
}
```

--------------------------------

### GET /product/metadata

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.sar.capella_product.CapellaProduct.html

Retrieve metadata information such as orbit direction or quicklook paths.

```APIDOC
## GET /product/metadata

### Description
Retrieves specific metadata attributes from the satellite product, such as the orbit direction or the path to the quicklook image.

### Method
GET

### Endpoint
/product/metadata

### Response
#### Success Response (200)
- **orbit_direction** (string) - The orbit direction (ASCENDING/DESCENDING).
- **quicklook_path** (string) - The file path to the product quicklook.
```

--------------------------------

### Get Raw Band Paths (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Returns a dictionary of raw band paths for the product. This method is useful when direct access to the original, unprocessed band files is required.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_raw_band_paths())
```

--------------------------------

### Get Quicklook Path - Python

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.vantor_product.VantorProduct.html

Retrieves the path to the quicklook image for a product, if one exists. This is useful for a quick visual inspection of the data. The 'eoreader' library is a prerequisite.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
prod.get_quicklook_path()
```

--------------------------------

### Get Quicklook Path (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Retrieves the file path for the product's quicklook image, if available. Quicklook images are low-resolution previews useful for rapid visual inspection.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_quicklook_path())
```

--------------------------------

### GET /products/s3olci/metadata

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_olci_product.S3OlciProduct.html

Retrieves temporal metadata such as acquisition date and time for the product.

```APIDOC
## GET /products/s3olci/metadata

### Description
Fetches the acquisition date or full datetime for the Sentinel-3 OLCI product.

### Method
GET

### Endpoint
/products/s3olci/metadata

### Parameters
#### Query Parameters
- **as_datetime** (bool) - Optional - If true, returns a datetime object; otherwise, returns a formatted string.

### Request Example
{
  "as_datetime": true
}

### Response
#### Success Response (200)
- **datetime** (string/datetime) - The acquisition date/time of the product.

#### Response Example
{
  "datetime": "2019-11-15T23:37:22"
}
```

--------------------------------

### GET /product/load

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Loads specific bands and indices from a satellite product into an xarray Dataset.

```APIDOC
## GET /product/load

### Description
Loads specified bands or indices from a product. It is recommended to load DEM data alongside real bands.

### Method
GET

### Endpoint
/product/load

### Parameters
#### Query Parameters
- **bands** (list/BandNames/str) - Required - List of bands or indices to load.
- **pixel_size** (float) - Optional - Pixel size of the band in meters.
- **size** (tuple/list) - Optional - Array dimensions (width, height). Ignored if pixel_size is provided.

### Response
#### Success Response (200)
- **dataset** (xr.Dataset) - Dataset with a variable per band.

### Response Example
{
  "dataset": "xr.Dataset object"
}
```

--------------------------------

### GET /product/bands

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_theia_product.S2TheiaProduct.html

Retrieves information about existing bands and their respective file paths within a product.

```APIDOC
## GET /product/bands

### Description
Returns a list of all existing bands or a dictionary mapping band names to their file paths.

### Method
GET

### Endpoint
/product/get_existing_bands

### Response
#### Success Response (200)
- **bands** (list) - List of available SpectralBandNames.

### Response Example
["COASTAL_AEROSOL", "BLUE", "GREEN", "RED"]
```

--------------------------------

### GET /products/s3olci/band-paths

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_olci_product.S3OlciProduct.html

Retrieves the file paths for requested spectral bands of an S3OlciProduct, performing orthorectification if necessary.

```APIDOC
## GET /products/s3olci/band-paths

### Description
Retrieves the paths of required bands for a specific Sentinel-3 OLCI product. If the bands do not exist, this function will trigger an orthorectification process.

### Method
GET

### Endpoint
/products/s3olci/band-paths

### Parameters
#### Query Parameters
- **band_list** (list) - Required - List of the wanted spectral bands (e.g., [GREEN, RED])
- **pixel_size** (float) - Optional - Pixel size in meters

### Request Example
{
  "band_list": ["GREEN", "RED"],
  "pixel_size": 300
}

### Response
#### Success Response (200)
- **paths** (dict) - Dictionary mapping band names to their respective file paths.

#### Response Example
{
  "GREEN": "path/to/green_band.tif",
  "RED": "path/to/red_band.tif"
}
```

--------------------------------

### Get Default Band Path for Optical Product (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_product.S3Product.html

Retrieves the file path for the default band (GREEN for optical data) of the product. This is a convenient method for accessing the most commonly used band.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
prod.get_default_band_path()
```

--------------------------------

### List Enum Names and Values

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.band_names.DemBandNames.html

Examples for retrieving the complete list of names or values defined within the enumeration class.

```python
>>> TsxPolarization.list_values()
["SINGLE", "DUAL", "QUAD", "TWIN"]
>>> TsxPolarization.list_values()
["S", "D", "Q", "T"]
```

--------------------------------

### Get Default Band and Path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.sky_product.SkyProduct.html

Retrieves the default spectral band (typically GREEN for optical sensors) and its corresponding file path for a given product.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
prod.get_default_band()
prod.get_default_band_path()
```

--------------------------------

### Get Acquisition Date and Datetime

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Shows how to extract the acquisition date and full datetime from an S2StacProduct instance, with options to return as string or datetime objects.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get date
prod.get_date(as_date=True)
# Get datetime
prod.get_datetime(as_datetime=True)
```

--------------------------------

### Query Existing Bands and Paths

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.sv1_product.Sv1Product.html

Shows how to list all available bands in a product and retrieve a dictionary mapping those bands to their respective file paths.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# List existing bands
bands = prod.get_existing_bands()
# Get dictionary of band paths
band_paths = prod.get_existing_band_paths()
```

--------------------------------

### List Existing Bands and Paths

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.venus_product.VenusProduct.html

Shows how to inspect a product to list all available spectral bands and retrieve a dictionary mapping each band to its respective file path.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get list of existing bands
bands = prod.get_existing_bands()
# Get dictionary of band paths
paths = prod.get_existing_band_paths()
```

--------------------------------

### S3Instrument: Get Enum from Value

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_product.S3Instrument.html

Retrieves an S3Instrument enum instance based on its value. This method allows you to get the corresponding enum object if you only have the value.

```python
class S3Instrument(ListEnum):
    ...
    @classmethod
    def from_value(cls, val: Any) -> ListEnum:
        """
        Get the enum class from its value: 

        Parameters:
            val (Any): Value of the Enum 

        Returns:
            Enum with value 

        Return type:
            ListEnum
        """
        ...

# Example usage:
# TsxPolarization.from_value("Q")
```

--------------------------------

### Retrieve Default and Existing Band Paths

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_slstr_product.S3SlstrProduct.html

Demonstrates how to open a product using the Reader and retrieve the default band path or a dictionary of all existing band paths.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get default band path
default_path = prod.get_default_band_path()
# Get all existing band paths
all_paths = prod.get_existing_band_paths()
```

--------------------------------

### Retrieve Band Paths for a Product

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.sky_product.SkyProduct.html

Demonstrates how to open a satellite product using the Reader class and retrieve the file paths for specific spectral bands like RED and GREEN.

```python
from eoreader.reader import Reader
from eoreader.bands import *
path = r"SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2"
prod = Reader().open(path)
prod.get_band_paths([GREEN, RED])
```

--------------------------------

### Get S2MaskBandNames Enum from List (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.band_names.S2MaskBandNames.html

Retrieves a list of S2MaskBandNames enum instances from a given list or string of band names. This is a convenient way to get enum representations for multiple bands.

```python
class S2MaskBandNames(_value_):
    ...
    @classmethod
    def from_list(_name_list : list | str_) -> list:
        """Get the band enums from list of band names"""
        ...

# Example usage:
# S2MaskBandNames.from_list('CLDPRB')

```

--------------------------------

### Initialize SpectralBand Object

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.spectral_bands.SpectralBand.html

Demonstrates how to instantiate a SpectralBand object within the EOReader framework using a specific band name.

```python
from eoreader.bands import SpectralBand

# Initialize a new SpectralBand instance
band = SpectralBand(eoreader_name="RED")
```

--------------------------------

### Initialize Sentinel-2 Product Class

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.html

Demonstrates the instantiation of the S2Product class for handling Sentinel-2 satellite data. This class requires the product path and optionally the archive path to manage data access.

```python
from eoreader.products import S2Product

# Initialize a Sentinel-2 product
product = S2Product(product_path="/path/to/S2_product.SAFE")
```

--------------------------------

### Get Enum Instance from Value (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45ProductType.html

The `from_value` class method retrieves an enum class instance based on its provided value. This is helpful when you have a raw value and need to get the corresponding enum object.

```python
class _Spot45ProductType(_value_):
    ...
    @classmethod
    def from_value(_val : Any) -> ListEnum:
        """Get the enum class from its value"""
        ...

# Example usage:
# TsxPolarization.from_value("Q")
```

--------------------------------

### SlstrView: Get Enum Instance from Value (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_slstr_product.SlstrView.html

The `from_value` class method retrieves an SlstrView enum instance based on its associated value. This is helpful when you have a raw value and need to get the corresponding enum object.

```python
class SlstrView(ListEnum):
    NADIR = 'n'
    OBLIQUE = 'o'

    @classmethod
    def from_value(cls, val: Any) -> ListEnum:
        """Get the enum class from its value"""
        for member in cls:
            if member.value == val:
                return member
        raise ValueError(f"Value {val} not found in {cls.__name__}")
```

--------------------------------

### VantorProduct Class Initialization

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.vantor_product.html

Initializes a Vantor product instance to handle satellite imagery data.

```APIDOC
## GET /vantor_product/VantorProduct

### Description
Initializes the VantorProduct class to process satellite products from a specified path.

### Method
GET

### Endpoint
/vantor_product/VantorProduct

### Parameters
#### Query Parameters
- **product_path** (string) - Required - The file system path to the Vantor product.
- **archive_path** (string) - Optional - The path to the product archive if applicable.

### Request Example
{
  "product_path": "/data/satellite/image_01.ntf"
}

### Response
#### Success Response (200)
- **status** (string) - Returns the initialized VantorProduct object reference.

#### Response Example
{
  "status": "VantorProduct instance created successfully"
}
```

--------------------------------

### Initialize and Retrieve Acquisition Date from VenusProduct

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.venus_product.VenusProduct.html

Demonstrates how to instantiate a VenusProduct using the Reader class and retrieve the acquisition date in either string or datetime format. This is essential for temporal filtering and product identification.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get date as a datetime object
date_obj = prod.get_date(as_date=True)
# Get date as a string
date_str = prod.get_date(as_date=False)
```

--------------------------------

### Get List of Enum Names (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.band_names.BandNames.html

Returns a list containing all the names of the enum members. This class method provides a simple way to get a string representation of all available band names within a specific enum class.

```python
>>> TsxPolarization.list_values()
["SINGLE", "DUAL", "QUAD", "TWIN"]
```

--------------------------------

### Get Acquisition Datetime

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Retrieves the acquisition datetime of the product.

```APIDOC
## Get Datetime

### Description
Gets the product’s acquisition datetime, with format `YYYYMMDDTHHMMSS` <-> `%Y%m%dT%H%M%S`.

### Example
```python
from eoreader.reader import Reader
path = r"IMG_PHR1B_PMS_001"
prod = Reader().open(path)
print(prod.get_datetime(as_datetime=True))
print(prod.get_datetime(as_datetime=False))
```

### Method
`get_datetime(as_datetime=False)`

### Parameters
- **as_datetime** (bool, optional) - If True, returns the datetime as a `datetime.datetime` object. If False, returns a string. Defaults to False.

### Returns
- **str | datetime**: The acquisition datetime.
```

--------------------------------

### Retrieve Default Band and Path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.sv1_product.Sv1Product.html

Demonstrates how to identify the default spectral band for a product and retrieve the file path to that specific band.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get default band
default_band = prod.get_default_band()
# Get default band path
default_path = prod.get_default_band_path()
```

--------------------------------

### Get Acquisition Date

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Retrieves the acquisition date of the product.

```APIDOC
## Get Date

### Description
Gets the product’s acquisition date.

### Example
```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_date(as_date=True))
print(prod.get_date(as_date=False))
```

### Method
`get_date(as_date=False)`

### Parameters
- **as_date** (bool, optional) - If True, returns the date as a `datetime.date` object. If False, returns a string. Defaults to False.

### Returns
- **str | date**: The acquisition date.
```

--------------------------------

### Get Band Names

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Retrieves the names of all bands composing the product.

```APIDOC
## Get Bands Names

### Description
Gets the name of the bands composing the product, ordered by ID. For example, for SPOT7: [‘RED’, ‘GREEN’, ‘BLUE’, ‘NIR’].

### Method
`get_bands_names()`

### Returns
- **list**: Ordered bands names.
```

--------------------------------

### Spot67Product Class Initialization

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Initializes a Spot67Product object. This class is designed to work with SPOT-6/7 products.

```APIDOC
## Spot67Product Initialization

### Description
Initializes a Spot67Product object. This class is designed to work with SPOT-6/7 products.

### Parameters
- **product_path** (str | CloudPath | Path) - Path to the product.
- **archive_path** (str | CloudPath | Path, optional) - Path to the archive. Defaults to None.
- **output_path** (str | CloudPath | Path, optional) - Path for output. Defaults to None.
- **remove_tmp** (bool, optional) - Whether to remove temporary files. Defaults to False.
- **kwargs** - Additional keyword arguments.
```

--------------------------------

### GET /product/has_band

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.vis1_product.Vis1Product.html

Check if a specific band or index exists within the product.

```APIDOC
## GET /product/has_band

### Description
Verify if the product contains the specified satellite band, index, DEM band, or cloud band.

### Method
GET

### Parameters
#### Query Parameters
- **band** (str) - Required - The name of the band or index to check.

### Response
#### Success Response (200)
- **exists** (bool) - True if the band is present, False otherwise.
```

--------------------------------

### GET /product/bands

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_product.S3Product.html

Retrieve information about the bands available in a loaded satellite product.

```APIDOC
## GET /product/bands

### Description
Returns a list of all existing bands available within the currently opened satellite product.

### Method
GET

### Endpoint
/product/bands

### Response
#### Success Response (200)
- **bands** (list) - List of SpectralBandNames or strings representing available bands.

#### Response Example
["COASTAL_AEROSOL", "BLUE", "GREEN", "RED", "NIR"]
```

--------------------------------

### CapellaProduct Initialization and Metadata

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.sar.capella_product.CapellaProduct.html

Methods for initializing a Capella product and retrieving core metadata such as dates, sensor modes, and spatial extents.

```APIDOC
## GET /CapellaProduct/metadata

### Description
Retrieves metadata and initializes the Capella product object for further processing.

### Method
GET

### Endpoint
/CapellaProduct/metadata

### Parameters
#### Query Parameters
- **path** (string) - Required - The file path to the Capella product archive.

### Request Example
{
  "path": "/data/capella_product_001.zip"
}

### Response
#### Success Response (200)
- **datetime** (string) - The acquisition date and time of the product.
- **sensor_mode** (string) - The sensor mode used for acquisition.
- **crs** (string) - The coordinate reference system of the product.

#### Response Example
{
  "datetime": "2023-10-27T10:00:00Z",
  "sensor_mode": "Spotlight",
  "crs": "EPSG:4326"
}
```

--------------------------------

### GET /product/band-path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_theia_product.S2TheiaProduct.html

Retrieves the file path for the default band of a satellite product.

```APIDOC
## GET /product/band-path

### Description
Retrieves the file path for the default band (e.g., GREEN for optical data) of the loaded product.

### Method
GET

### Endpoint
/product/get_default_band_path

### Parameters
#### Query Parameters
- **kwargs** (dict) - Optional - Additional arguments for path resolution.

### Response
#### Success Response (200)
- **path** (string) - The resolved file path to the default band.

### Response Example
{
  "path": "zip+file://S2A_MSIL1C_.../IMG_DATA/T30TTK_20200824T110631_B03.jp2"
}
```

--------------------------------

### Load and Stack Optical Bands with EOReader (Python)

Source: https://eoreader.readthedocs.io/stable

Demonstrates how to use EOReader to load and stack spectral bands, indices, DEM, and cloud bands from Sentinel-2 optical data. It initializes a reader, opens a satellite product, loads specified bands (like NDVI and CLOUDS), and creates a stacked GeoTIFF file of RGB bands.

```python
from eoreader.reader import Reader
from eoreader.bands import RED, GREEN, BLUE, NDVI, CLOUDS

# Sentinel-2 path
s2_path = "S2B_MSIL1C_20181126T022319_N0207_R103_T51PWM_20181126T050025.SAFE"

# Create the reader object and open satellite data
reader = Reader()

# The reader will recognize the constellation from its product structure
s2_prod = reader.open(s2_path)

# Load some bands and index
bands = s2_prod.load([NDVI, GREEN, CLOUDS])

# Create a stack with some bands
stack = s2_prod.stack([RED, GREEN, BLUE], stack_path="s2_rgb_stack.tif")

```

--------------------------------

### Stacking Satellite Product Bands

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Demonstrates how to load a satellite product and stack specific bands or indices into a single DataArray with a defined pixel size.

```python
from eoreader.reader import Reader
from eoreader.bands import *
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
stack = prod.stack([NDVI, MNDWI, GREEN], pixel_size=20)
```

--------------------------------

### GET /products/s2stac/bands

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Provides access to band-specific information and file paths for the S2StacProduct.

```APIDOC
## GET /products/s2stac/bands

### Description
Retrieves a list of available bands or the file path for a specific band within the product.

### Method
GET

### Endpoint
/products/s2stac/bands

### Parameters
#### Query Parameters
- **product_id** (string) - Required - The unique identifier for the S2StacProduct instance.
- **band_name** (string) - Optional - The specific band to retrieve the path for.

### Response
#### Success Response (200)
- **bands** (array) - List of available band names.
- **path** (string) - File path for the requested band.

#### Response Example
{
  "bands": ["B02", "B03", "B04", "B08"],
  "path": "/data/s2/B04.tif"
}
```

--------------------------------

### GET /utils/read_href

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Reads bytes from a given HREF using blocking I/O.

```APIDOC
## GET /utils/read_href

### Description
Reads the content of an HREF and returns it as bytes.

### Method
GET

### Endpoint
/utils/read_href

### Parameters
#### Query Parameters
- **href** (str) - Required - The URL to read.
- **config** (dict) - Optional - Download configuration.

### Response
#### Success Response (200)
- **data** (bytes) - The content of the file.

### Response Example
{
  "data": "b'binary_data'"
}
```

--------------------------------

### Get EOReader Indices

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.indices.get_eoreader_indices.html

Retrieves a list of all available indices supported by EOReader.

```APIDOC
## GET /eoreader/indices

### Description
Retrieves a list of all available indices supported by EOReader.

### Method
GET

### Endpoint
/eoreader/indices

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **indices** (list) - A list of strings, where each string is an available EOReader index.

#### Response Example
```json
{
  "indices": [
    "NDVI",
    "EVI",
    "NDWI"
  ]
}
```
```

--------------------------------

### Retrieve Default Band and Path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.venus_product.VenusProduct.html

Demonstrates how to open a satellite product using the Reader class and retrieve the default spectral band (typically GREEN for optical data) and its corresponding file path.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
# Get default band
band = prod.get_default_band()
# Get default band path
band_path = prod.get_default_band_path()
```

--------------------------------

### GET /utils/is_eoreader_idx

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.indices.is_eoreader_idx.html

Validates whether a provided string is a valid EOReader index.

```APIDOC
## GET /utils/is_eoreader_idx

### Description
Checks if the provided input string is a valid EOReader index.

### Method
GET

### Endpoint
/utils/is_eoreader_idx

### Parameters
#### Query Parameters
- **index** (string) - Required - The string to test against EOReader index patterns.

### Request Example
GET /utils/is_eoreader_idx?index=NDVI

### Response
#### Success Response (200)
- **result** (boolean) - Returns true if the string is a valid EOReader index, false otherwise.

#### Response Example
{
  "result": true
}
```

--------------------------------

### S3OlciProduct Class Initialization

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_olci_product.html

Initializes a new instance of the S3OlciProduct class to handle Sentinel-3 OLCI data.

```APIDOC
## GET /S3OlciProduct

### Description
Initializes the S3OlciProduct class to load and process Sentinel-3 OLCI satellite products from a specified path.

### Method
GET

### Endpoint
S3OlciProduct(product_path, archive_path=None)

### Parameters
#### Path Parameters
- **product_path** (string) - Required - The local path to the Sentinel-3 OLCI product directory or file.
- **archive_path** (string) - Optional - The path to the compressed archive if the product is not extracted.

### Request Example
S3OlciProduct(product_path="/data/S3A_OL_1_EFR")

### Response
#### Success Response (200)
- **instance** (S3OlciProduct) - An initialized object representing the Sentinel-3 OLCI product.

#### Response Example
{
  "status": "success",
  "object": "S3OlciProduct instance"
}
```

--------------------------------

### GET /product/metadata

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.sar.capella_product.CapellaProduct.html

Retrieves acquisition metadata such as the date or full datetime of the satellite product.

```APIDOC
## GET /product/metadata

### Description
Retrieves the acquisition date or datetime of the product. Can return as a formatted string or a datetime object.

### Method
GET

### Endpoint
/product/get_datetime

### Parameters
#### Query Parameters
- **as_datetime** (bool) - Optional - If true, returns a datetime object; otherwise returns a string in YYYYMMDDTHHMMSS format.

### Request Example
{
  "as_datetime": true
}

### Response
#### Success Response (200)
- **result** (string|datetime) - The acquisition timestamp.

#### Response Example
{
  "datetime": "2020-10-28T22:46:25"
}
```

--------------------------------

### Importing and Using Bands from EOReader

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.html

Demonstrates how to import all band-related functionalities from the eoreader.bands module and access common band names and indices. This includes spectral bands like GREEN, SAR bands like HH, and predefined indices like NDVI.

```python
from eoreader.bands import *

print(GREEN)
print(HH)
print(NDVI)
```

--------------------------------

### Initialize and Access S2_MSK

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2_MSK.html

Demonstrates how to instantiate the S2_MSK class and access its properties. The class stores the mask filename and band number as a tuple.

```python
from eoreader.mask import S2_MSK

# Initialize the S2_MSK object
mask = S2_MSK("mask_file.tif", 1)

# Access properties
print(mask.mask_fname)   # Outputs: mask_file.tif
print(mask.band_number)  # Outputs: 1
```

--------------------------------

### GET /product/bands

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_theia_product.S2TheiaProduct.html

Provides access to band-specific file paths and management methods for S2TheiaProduct.

```APIDOC
## GET /product/bands

### Description
Retrieves information about available spectral bands, including file paths and band names for the product.

### Method
GET

### Endpoint
/product/bands

### Parameters
#### Query Parameters
- **product_id** (string) - Required - The unique identifier for the S2TheiaProduct.

### Response
#### Success Response (200)
- **bands** (list) - List of available band names.
- **band_paths** (dict) - Mapping of band names to their respective file paths.

#### Response Example
{
  "bands": ["B02", "B03", "B04"],
  "band_paths": {
    "B02": "/path/to/B02.tif"
  }
}
```

--------------------------------

### GET /product/has-band

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_theia_product.S2TheiaProduct.html

Checks if a specific band, index, or DEM layer exists in the product.

```APIDOC
## GET /product/has-band

### Description
Verifies if the product contains the specified band, index, or auxiliary layer.

### Method
GET

### Endpoint
/product/has_band

### Parameters
#### Query Parameters
- **band** (string) - Required - The name of the band or index to check.

### Response
#### Success Response (200)
- **exists** (boolean) - True if the band is present.
```

--------------------------------

### Load and Stack SAR Bands with EOReader (Python)

Source: https://eoreader.readthedocs.io/stable

Illustrates loading and stacking radar bands from Sentinel-1 SAR data using EOReader. This includes initializing the reader, opening a SAR product, loading specific bands (like VV and VH), and creating a stacked GeoTIFF file of dual-polarization bands. Note that SAR processing requires ESA SNAP.

```python
from eoreader.reader import Reader
from eoreader.bands import VV, VH, VV_DSPK, VH_DSPK

# Sentinel-1 GRD path
s1_path = "S1B_EW_GRDM_1SDH_20200422T080459_20200422T080559_021254_028559_784D.zip"

# Create the reader object and open satellite data
reader = Reader()

# The reader will recognize the constellation from its product structure
s1_prod = reader.open(s1_path)

# Load some bands and index
bands = s1_prod.load([VV, VH])

# Create a stack with some bands
stack = s1_prod.stack([VV_DSPK, VH_DSPK], stack_path="s1_stack.tif")

```

--------------------------------

### GET /products/s2stac/metadata

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Retrieves the core metadata and configuration properties for a loaded S2StacProduct instance.

```APIDOC
## GET /products/s2stac/metadata

### Description
Returns the metadata attributes of the S2StacProduct, including sensor type, resolution, and STAC item details.

### Method
GET

### Endpoint
/products/s2stac/metadata

### Parameters
#### Query Parameters
- **product_id** (string) - Required - The unique identifier for the S2StacProduct instance.

### Response
#### Success Response (200)
- **sensor_type** (string) - SAR or optical.
- **resolution** (float) - Default resolution in meters.
- **product_type** (string) - Satellite-related field (e.g., L1C, L2A).
- **is_stacked** (boolean) - True if bands are stacked.
- **nodata** (integer) - Value representing no data.

#### Response Example
{
  "sensor_type": "optical",
  "resolution": 10,
  "product_type": "L2A",
  "is_stacked": true,
  "nodata": -9999
}
```

--------------------------------

### Class: Spot67Product

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.html

Initializes and handles SPOT-6/7 satellite product data structures.

```APIDOC
## CLASS Spot67Product

### Description
Represents a SPOT-6 or SPOT-7 satellite product. This class handles the loading and management of product paths and archive paths for further processing.

### Constructor
`Spot67Product(product_path, archive_path=None, ...)`

### Parameters
#### Path Parameters
- **product_path** (string) - Required - The local file system path to the SPOT-6/7 product directory or file.
- **archive_path** (string) - Optional - The path to the compressed archive if the product is not extracted.

### Usage Example
```python
from eoreader.products import Spot67Product

# Initialize a SPOT-6/7 product
product = Spot67Product(product_path="/path/to/spot6_product")
```

### Response
Returns an instance of the `Spot67Product` class ready for satellite image analysis.
```

--------------------------------

### Retrieve Band Paths for S2StacProduct

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Demonstrates how to open a Sentinel-2 product and retrieve the file paths for specific spectral bands like GREEN and RED.

```python
from eoreader.reader import Reader
from eoreader.bands import *
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
prod.get_band_paths([GREEN, RED])
```

--------------------------------

### SkyProduct Class Initialization

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.sky_product.html

Initializes a new SkySat product instance for processing or archival.

```APIDOC
## GET /sky_product

### Description
Initializes the SkyProduct class to handle SkySat satellite data products, including path configuration for archives.

### Method
GET

### Endpoint
/sky_product

### Parameters
#### Query Parameters
- **product_path** (string) - Required - The file system path to the SkySat product.
- **archive_path** (string) - Optional - The path to the product archive location.

### Request Example
{
  "product_path": "/data/skysat/product_001",
  "archive_path": "/archive/skysat"
}

### Response
#### Success Response (200)
- **status** (string) - Returns the initialized SkyProduct object metadata.

#### Response Example
{
  "status": "success",
  "product_type": "SkyProduct",
  "path": "/data/skysat/product_001"
}
```

--------------------------------

### Get Spyndex Indices

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.indices.get_spyndex_indices.html

Retrieves a list of all available indices within the Spyndex system.

```APIDOC
## GET /indices

### Description
Retrieves a list of all available Spyndex indices.

### Method
GET

### Endpoint
/indices

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **indices** (list) - A list containing the names of all available Spyndex indices.

#### Response Example
```json
{
  "indices": [
    "NDVI",
    "EVI",
    "NDWI"
  ]
}
```
```

--------------------------------

### Retrieve Default Band Path

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Demonstrates how to open a satellite product using the Reader class and retrieve the path to the default band.

```python
from eoreader.reader import Reader
path = r"IMG_PHR1B_PMS_001"
prod = Reader().open(path)
prod.get_default_band_path()
```

--------------------------------

### GET /VenusProduct/get_date

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.venus_product.VenusProduct.html

Retrieves the acquisition date of the Venus product in either string or datetime format.

```APIDOC
## GET /VenusProduct/get_date

### Description
Fetches the acquisition date of the product. Can return a formatted string or a datetime object.

### Method
GET

### Endpoint
/VenusProduct/get_date

### Parameters
#### Query Parameters
- **as_date** (bool) - Optional - If true, returns a datetime.date object; otherwise returns a string (default: False).

### Response
#### Success Response (200)
- **date** (str|date) - The acquisition date.

#### Response Example
{
  "date": "20200824"
}
```

--------------------------------

### S3Product Initialization and Data Access

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s3_product.S3Product.html

Methods for initializing the S3Product object and accessing fundamental band information and file paths.

```APIDOC
## S3Product Initialization

### Description
Initializes the S3Product object and provides methods to retrieve band paths and names.

### Method
N/A (Class Method)

### Parameters
#### Path Parameters
- **path** (str) - Required - Path to the Sentinel-3 product directory or archive.

### Response
- **S3Product** (object) - Returns an instance of the S3Product class.

## GET /bands

### Description
Retrieves information about available bands within the product.

### Method
GET

### Parameters
#### Query Parameters
- **band_name** (str) - Optional - Specific band name to retrieve.

### Response
#### Success Response (200)
- **band_paths** (list) - List of file paths for the requested bands.
```

--------------------------------

### Get Default Band

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Retrieves the default band for the product (e.g., GREEN for optical data).

```APIDOC
## Get Default Band

### Description
Gets the default band: `GREEN` for optical data as every optical satellite has a GREEN band.

### Example
```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_default_band())
```

### Method
`get_default_band()`

### Returns
- **BandNames**: The default band.
```

--------------------------------

### Get Band Paths for Multiple Bands - Python

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.vis1_product.Vis1Product.html

Retrieves the file paths for a list of specified bands within a product. It can manage different pixel sizes and additional arguments for band loading. Returns a dictionary mapping bands to their paths.

```python
from eoreader.reader import Reader
from eoreader.bands import *
path = r"IMG_PHR1B_PMS_001"
prod = Reader().open(path)
print(prod.get_band_paths([GREEN, RED]))
```

--------------------------------

### Band File Name Retrieval

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot67_product.Spot67Product.html

Gets the filename of a specified band, managing windows and other arguments.

```APIDOC
## Get Band File Name

### Description
Gets the filename of any band, managing windows and other arguments.

### Method
`get_band_file_name(band, pixel_size, size=None, **kwargs)`

### Parameters
- **band** (BandNames) - The desired band.
- **pixel_size** (float) - The pixel size in meters.
- **size** (tuple | list, optional) - The size of the array (width, height). Not used if pixel_size is provided.
- **kwargs** - Additional arguments.

### Returns
- **str**: The band file name.
```

--------------------------------

### GET /product/to_band

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.spot45_product.Spot45Product.html

Maps raw band identifiers (names, IDs) to standardized band objects.

```APIDOC
## GET /product/to_band

### Description
Converts raw band identifiers (names, IDs, or mapped names) into usable band objects.

### Method
GET

### Endpoint
/product/to_band

### Parameters
#### Query Parameters
- **raw_bands** (list) - Required - List of raw band identifiers.

### Request Example
{
  "raw_bands": ["BLUE", 2]
}

### Response
#### Success Response (200)
- **mapped_bands** (list) - List of standardized band objects.
```

--------------------------------

### Get Existing Band Paths (Python)

Source: https://eoreader.readthedocs.io/stable/api/eoreader.products.optical.s2_product.S2StacProduct.html

Returns a dictionary mapping spectral band names to their corresponding file paths. This method is essential for understanding which bands are available within a product and how to access them.

```python
from eoreader.reader import Reader
path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
prod = Reader().open(path)
print(prod.get_existing_band_paths())
```

--------------------------------

### Map SAR Bands using SarBandMap

Source: https://eoreader.readthedocs.io/stable/api/eoreader.bands.sar_bands.SarBandMap.html

Demonstrates how to initialize the SarBandMap class and use the map_bands method to associate SAR band names with specific band numbers.

```python
from eoreader.bands import SarBandMap

sb = SarBandMap()
sb.map_bands({
    "VV": 1
})
```
Tokens:
Raw