EuroCropsML

https://eurocropsml.readthedocs.io/en/latest/
Admin
EuroCropsML is a pre-processed and ready-to-use machine learning dataset for crop type...
Tokens:26,328
Snippets:230
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Help for EuroCropsML CLI

Source: https://eurocropsml.readthedocs.io/en/latest/starting.html

Use this command to display help information for all available commands and options within the EuroCropsML CLI.

```bash
$ eurocropsml-cli --help

```

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

### Install EuroCropsML Package

Source: https://eurocropsml.readthedocs.io/en/latest/starting.html

Install the EuroCropsML package using pip. It is recommended to do this within a virtual environment.

```bash
$ python -Im pip install eurocropsml

```

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

### Get Help for EuroCropsML Datasets CLI

Source: https://eurocropsml.readthedocs.io/en/latest/dataset.html

Use this command to display help information for the eurocropsml-cli datasets eurocrops command, which is used for data preprocessing.

```bash
$ eurocropsml-cli datasets eurocrops --help

```

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

### Get Data for a Specific Country

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Use this command to initiate the data acquisition process for a specified country using a custom configuration file.

```bash
$ eurocropsml-cli acquisition eurocrops get-data cfg=eurocrops_country
```

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

### build_dataset

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.builder.html

Acquires and prepares the EuroCrops dataset for machine learning purposes. This function takes a configuration object as input to guide the data processing pipeline.

```APIDOC
## build_dataset

### Description
Acquires and prepares the EuroCrops dataset for machine learning purposes.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **config** (object) - Required - Configuration object for dataset building.

### Request Example
```json
{
  "config": {
    "example": "configuration details"
  }
}
```

### Response
#### Success Response (200)
This function does not explicitly define a return value in the documentation. It is assumed to perform data preparation and storage.

#### Response Example
```json
{
  "message": "Dataset built successfully"
}
```
```

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

### Get Data for Specific Months in Estonia

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

This command allows for collecting data for a specific month (January in this case) for Estonia by overriding the default month configuration.

```bash
$ eurocropsml-cli acquisition eurocrops get-data cfg=estonia cfg.country_config.months="[1,1]"
```

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

### Set Download Directory via Environment Variable

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Customize the data download directory by setting the EUROCROPS_DATA_DIR environment variable to an absolute path. This is useful when eurocropsml is installed as a dependency.

```bash
$ export EUROCROPS_DATA_DIR=<absolute-path-to-data-directory>

$ eurocropsml-cli datasets eurocrops download

```

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

### Select Custom Configuration File

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Create and select a custom YAML configuration file for dataset preprocessing when multiple customizations are needed.

```bash
$ eurocropsml-cli datasets eurocrops <COMMAND> preprocess=custom_config

```

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

### EuroCropsDatasetConfig.post_init()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.EuroCropsDatasetConfig.post_init.html

This method initializes dynamic configuration settings based on the parameters provided during the object's initialization. It's an internal method and doesn't return any value.

```APIDOC
## EuroCropsDatasetConfig.post_init()

### Description
Initializes dynamic configuration based on the parameters that have already been initialized.

### Method
This is a method within the EuroCropsDatasetConfig class.

### Parameters
This method does not accept any explicit parameters.

### Returns
None
```

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

### MMapStore.__init__()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.utils.MMapStore.__init__.html

Initializes the MMapStore with a collection of file paths. This constructor is used to set up the memory-mapped store for efficient data access.

```APIDOC
## MMapStore.__init__

### Description
Initializes the MMapStore with a collection of file paths. This constructor is used to set up the memory-mapped store for efficient data access.

### Method
__init__

### Parameters
#### Path Parameters
- **_file_paths** (Iterable[Path]) - Required - An iterable of Path objects representing the files to be memory-mapped.
```

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

### EuroCropsML CLI Main Usage

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Shows the main entry point for the eurocropsml-cli tool and its available top-level commands and options.

```bash
$ eurocropsml-cli [OPTIONS] COMMAND [ARGS]...
```

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

### MMapMetadata.__init__()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.utils.MMapMetadata.__init__.html

Initializes the MMapMetadata object. This constructor takes an iterable of Path objects representing file paths.

```APIDOC
## MMapMetadata.__init__()

### Description
Initializes the MMapMetadata object. This constructor takes an iterable of Path objects representing file paths.

### Method
__init__

### Parameters
#### Path Parameters
- **_file_paths** (Iterable[Path]) - Required - An iterable of Path objects specifying the metadata files.

### Response
#### Success Response
Initializes the MMapMetadata object in place.

### Response Example
```json
{
  "message": "MMapMetadata object initialized successfully"
}
```
```

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

### CollectorConfig.post_init

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.CollectorConfig.post_init.html

The post_init method is called after the CollectorConfig object is initialized. It takes a Path object representing the vector data directory and returns None. Its purpose is to dynamically configure settings based on the provided parameters.

```APIDOC
## CollectorConfig.post_init

### Description
Make dynamic config based on initialized params.

### Method
None (This is a method within a class, not a direct API endpoint)

### Signature
`CollectorConfig.post_init(_vector_data_dir: Path_) -> None`

### Parameters
#### Path Parameters
- **_vector_data_dir** (Path) - Description: The path to the vector data directory.
```

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

### Collect Data for Estonia using CLI

Source: https://eurocropsml.readthedocs.io/en/latest/dataset.html

This command initiates the data collection process for Estonia by specifying its configuration file. Ensure the configuration file exists in the specified directory.

```bash
$ eurocropsml-cli acquisition eurocrops get-data cfg=estonia

```

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

### Display EuroCropsML Acquisition Subcommand Help

Source: https://eurocropsml.readthedocs.io/en/latest/dataset.html

This command shows the specific options available for the 'acquisition eurocrops' subcommand.

```bash
$ eurocropsml-cli acquisition eurocrops --help

```

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

### Download EuroCropsML Dataset

Source: https://eurocropsml.readthedocs.io/en/latest/starting.html

Download the EuroCropsML dataset using the CLI. The download will use the currently configured settings.

```bash
$ eurocropsml-cli datasets eurocrops download

```

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

### preprocess

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.preprocess.html

Executes the main preprocessing pipeline.

```APIDOC
## preprocess

### Description
Run preprocessing.

### Function Signature
`preprocess`(preprocess_config[, nuts_level])

### Parameters
* **preprocess_config**: Configuration object for the preprocessing steps.
* **nuts_level** (Optional): The NUTS level to use for preprocessing.

### Returns
Processed dataset.
```

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

### build_dataset

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.builder.build_dataset.html

Acquires and prepares the EuroCrops dataset for ML purposes. It takes an AcquisitionConfig object as input and returns None.

```APIDOC
## build_dataset

### Description
Acquires and prepares the EuroCrops dataset for ML purposes.

### Method
N/A (Python function)

### Signature
`build_dataset(_config: AcquisitionConfig_) -> None`

### Parameters
#### Arguments
- **config** (AcquisitionConfig) - Required - Configuration for acquiring EuroCrops reflectance data.
```

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

### preprocess

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.preprocess.preprocess.html

Runs the dataset preprocessing pipeline. This function takes a configuration object and an optional NUTS level to perform the preprocessing steps.

```APIDOC
## preprocess()

### Description
Runs the dataset preprocessing pipeline. This function takes a configuration object and an optional NUTS level to perform the preprocessing steps.

### Signature
`preprocess(_preprocess_config : EuroCropsDatasetPreprocessConfig_, _nuts_level : Literal[1, 2, 3] = 3_) -> None`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
*   **_preprocess_config** (EuroCropsDatasetPreprocessConfig_) - Required - Configuration object for preprocessing.
*   **_nuts_level** (Literal[1, 2, 3]) - Optional - The NUTS level to use for preprocessing. Defaults to 3.
```

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

### Show EuroCropsML Dataset Configuration

Source: https://eurocropsml.readthedocs.io/en/latest/starting.html

Display the current configuration settings for the EuroCropsML dataset CLI. This command shows the active configuration used for dataset operations.

```bash
$ eurocropsml-cli datasets eurocrops config

```

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

### DataItem.__init__()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.DataItem.__init__.html

Initializes a DataItem object. This constructor takes a data tensor and optional metadata, which is a dictionary mapping string keys to tensors.

```APIDOC
## DataItem.__init__()

### Description
Initializes a DataItem object with provided data and optional metadata.

### Method
__init__

### Parameters
* **_data** (Tensor) - Required - The primary data tensor for the item.
* **_meta_data** (dict[str, Tensor] | None) - Optional - A dictionary containing metadata, where keys are strings and values are Tensors. Defaults to None.
```

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

### get_user_choice

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.html

Prompts the user to select which files from a list should be downloaded.

```APIDOC
## get_user_choice

### Description
Allows the user to interactively choose specific files from a list of available dataset files for download.

### Parameters
#### Request Body
- **files_to_download** (list) - Required - A list of files available for download, from which the user will make a selection.
```

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

### EuroCropsDataset.__init__

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.dataset.EuroCropsDataset.__init__.html

Initializes the EuroCropsDataset with file dictionaries, encoding, memory-mapped storage, and configuration objects. It also supports optional padding parameters for sequence data.

```APIDOC
## EuroCropsDataset.__init__

### Description
Initializes the EuroCropsDataset with file dictionaries, encoding, memory-mapped storage, and configuration objects. It also supports optional padding parameters for sequence data.

### Method
__init__

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
*   **_file_dict** (dict[str, list[Path]]) - Description of the file dictionary mapping string keys to lists of Path objects.
*   **_encode** (dict[int, int]) - Description of the encoding dictionary mapping integer keys to integer values.
*   **_mmap_store** (MMapStore) - Description of the memory-mapped store object.
*   **_config** (EuroCropsDatasetConfig) - Description of the EuroCropsDataset configuration object.
*   **_preprocess_config** (EuroCropsDatasetPreprocessConfig) - Description of the EuroCropsDataset preprocessing configuration object.
*   **_pad_seq_to_366** (bool) - Optional. Defaults to False. Indicates whether to pad sequences to a length of 366.
*   **_padding_value** (float) - Optional. Defaults to 0.0. The value to use for padding sequences.
```

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

### TransformDataset.__init__()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.TransformDataset.__init__.html

Initializes the TransformDataset. This constructor takes a dataset, optional data and target transformations, a custom collate function, and optional polygons.

```APIDOC
## TransformDataset.__init__()

### Description
Initializes the TransformDataset with a dataset, optional data transformations, optional target transformations, a custom collate function, and optional polygons.

### Method
__init__

### Parameters
*   **_dataset** (~torch.utils.data.dataset.Dataset[~eurocropsml.dataset.base.LabelledData]) - The underlying dataset.
*   **data_transforms** (list[~typing.Callable[[~torch.Tensor], ~torch.Tensor]] | None) - Optional list of callable functions to transform the data.
*   **target_transforms** (list[~typing.Callable[[~torch.Tensor], ~torch.Tensor]] | None) - Optional list of callable functions to transform the targets.
*   **collate_fn** (~typing.Callable[[~collections.abc.Sequence[~eurocropsml.dataset.base.LabelledData]], ~eurocropsml.dataset.base.LabelledData]) - The collate function to use. Defaults to `custom_collate_fn`.
*   **polygons** (dict[int, ~shapely.geometry.polygon.Polygon | ~shapely.geometry.multipolygon.MultiPolygon] | None) - Optional dictionary of polygons.
```

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

### select_version

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.select_version.html

Selects one of the available dataset versions hosted on Zenodo. It takes a list of version dictionaries and returns the selected version along with a list of strings representing available versions.

```APIDOC
## select_version

### Description
Selects one of the available dataset versions on Zenodo.

### Method
N/A (Python function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **_versions** (list[dict]) - Required - A list of dictionaries, where each dictionary represents a dataset version.

### Request Example
```python
# Example usage (assuming versions_list is populated from Zenodo)
selected_version, available_versions = eurocropsml.dataset.download.select_version(versions_list)
```

### Response
#### Success Response
*   **tuple[dict, list[str]]** - A tuple containing:
    *   The selected dataset version (dict).
    *   A list of strings representing all available dataset versions (list[str]).

#### Response Example
```json
{
  "selected_version": {
    "version_id": "1.0.0",
    "doi": "10.5281/zenodo.1234567"
  },
  "available_versions": ["1.0.0", "1.1.0", "2.0.0"]
}
```
```

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

### EuroCropsML CLI Datasets EuroCrops Download Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Downloads EuroCrops datasets. Allows overriding configuration values.

```bash
$ eurocropsml-cli datasets eurocrops download [OPTIONS] [OVERRIDES]...
```

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

### EuroCropsDatasetConfig.__init__

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.EuroCropsDatasetConfig.__init__.html

Initializes the EuroCropsDatasetConfig by parsing and validating input data. It raises a ValidationError if the data cannot be validated.

```APIDOC
## EuroCropsDatasetConfig.__init__

### Description
Creates a new model by parsing and validating input data from keyword arguments. Raises `ValidationError` if the input data cannot be validated to form a valid model. `self` is explicitly positional-only to allow `self` as a field name.

### Method
`__init__`

### Parameters
#### Positional-Only Parameters
- **data** (Any) - Description: Input data to parse and validate.

### Raises
- `ValidationError`: If the input data cannot be validated to form a valid model.
```

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

### TensorDataset.__init__

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.TensorDataset.__init__.html

Initializes the TensorDataset. It takes a sequence of LabelledData objects as input.

```APIDOC
## TensorDataset.__init__

### Description
Initializes the TensorDataset with a sequence of labelled data.

### Method
__init__

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **_data** (Sequence[LabelledData]) - Required - A sequence of labelled data objects to initialize the dataset with.

### Request Example
```json
{
  "_data": [
    {
      "label": "example_label",
      "data": [1, 2, 3]
    }
  ]
}
```

### Response
#### Success Response (None)
This method does not return a value.

#### Response Example
None
```

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

### EuroCropsDataset Constructor

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.dataset.EuroCropsDataset.html

Initializes the EuroCropsDataset with specified file paths, encoding, memory map store, and configuration settings. It supports optional padding of sequences.

```APIDOC
## EuroCropsDataset Constructor

### Description
Initializes the EuroCropsDataset with specified file paths, encoding, memory map store, and configuration settings. It supports optional padding of sequences.

### Parameters

#### Constructor Parameters

- **file_dict** (dict[str, list[Path]]) - Required - Dictionary of file paths for each satellite.
- **encode** (dict[int, int]) - Required - Encoding used to encode the classes into integers.
- **mmap_store** (MMapStore) - Required - Instance of memory map store.
- **config** (EuroCropsDatasetConfig) - Required - EuroCropsDatasetConfig instance.
- **preprocess_config** (EuroCropsDatasetPreprocessConfig) - Required - EuroCropsDatasetPreprocessConfig instance.
- **pad_seq_to_366** (bool) - Optional - If sequence should be padded to 366 days. Defaults to False.
- **padding_value** (float) - Optional - Padding value used for padding data sequences. Defaults to 0.0.
```

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

### EuroCropsML CLI Acquisition EuroCrops Config Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Prints the currently used configuration for acquiring EuroCrops data. Allows overriding configuration values.

```bash
$ eurocropsml-cli acquisition eurocrops config [OPTIONS] [OVERRIDES]...
```

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

### download_dataset

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.html

Downloads the EuroCropsML dataset from Zenodo based on the provided preprocessing configuration.

```APIDOC
## download_dataset

### Description
Downloads the EuroCropsML dataset from Zenodo. This function likely handles the retrieval of the dataset files and may apply preprocessing steps as defined in the configuration.

### Parameters
#### Request Body
- **preprocess_config** (object) - Required - Configuration object specifying preprocessing steps for the dataset download.
```

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

### Config

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.html

General configuration for acquiring EuroCrops reflectance data. This class acts as a wrapper or container for other configuration objects.

```APIDOC
## Config

### Description
General configuration object for acquiring EuroCrops reflectance data. This class typically holds other configuration objects, providing a unified configuration structure.

### Parameters
#### Path Parameters
- **cfg** (object) - Required - A configuration object, potentially an instance of `AcquisitionConfig`, `CollectorConfig`, or a similar configuration class.
```

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

### EuroCropsML CLI Datasets EuroCrops Preprocess Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Preprocesses EuroCrops datasets. Allows overriding configuration values.

```bash
$ eurocropsml-cli datasets eurocrops preprocess [OPTIONS] [OVERRIDES]...
```

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

### select_version

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.html

Enables the user to select a specific version of the EuroCropsML dataset from the available options on Zenodo.

```APIDOC
## select_version

### Description
Presents the user with a list of available dataset versions on Zenodo and allows them to select one for download.

### Parameters
#### Request Body
- **versions** (list) - Required - A list of available dataset versions on Zenodo.
```

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

### Directory Structure for Vector Data

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Illustrates the expected directory structure for meta-data, including NUTS files and country-specific vector data, which is necessary for the acquisition pipeline.

```text
    └── meta_data/
        ├── NUTS/
        │   ├── NUTS_RG_01M_2021_3035.geojson
        │   ├── NUTS_RG_01M_2021_3857.geojson
        │   └── NUTS_RG_01M_2021_4326.geojson
        └── vector_data/
            └── country_folder_from_zenodo

```

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

### Plain Text Citation for EuroCropsML Dataset (Zenodo)

Source: https://eurocropsml.readthedocs.io/en/latest/license.html

Use this plain text format for citing the EuroCropsML dataset hosted on Zenodo.

```text
Reuss, J., & Macdonald, J. (2024). EuroCropsML [dataset]. Zenodo. https://doi.org/10.5281/zenodo.10629609

```

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

### get_user_choice

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.get_user_choice.html

Retrieves the user's selection of files to download from the EuroCropsML dataset. It takes a list of available file names and returns a list of the files the user has chosen.

```APIDOC
## get_user_choice

### Description
Get user choice for which files to download.

### Signature
`get_user_choice(_files_to_download : list[str]_) → list[str]`

### Parameters
#### Path Parameters
- **_files_to_download** (list[str]) - Description: A list of strings representing the available files that can be downloaded.
```

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

### EuroCropsML CLI Datasets Command Usage

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Details the usage for the 'datasets' command, which manages datasets.

```bash
$ eurocropsml-cli datasets [OPTIONS] COMMAND [ARGS]...
```

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

### Acquire Sentinel-1 Data with Operational Mode

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

This command demonstrates how to acquire Sentinel-1 data and also specify an operational mode, such as 'EW'.

```bash
$ eurocropsml-cli acquisition eurocrops <COMMAND> cfg.country_config.satellite="S1" +cfg.country_config.operational_mode="EW"
```

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

### EuroCropsML CLI Datasets EuroCrops Config Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Prints the currently used configuration for EuroCrops dataset operations. Allows overriding configuration values.

```bash
$ eurocropsml-cli datasets eurocrops config [OPTIONS] [OVERRIDES]...
```

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

### EuroCropsML CLI Datasets EuroCrops Build-Splits Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Builds data splits for EuroCrops datasets. Allows overriding configuration values.

```bash
$ eurocropsml-cli datasets eurocrops build-splits [OPTIONS] [OVERRIDES]...
```

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

### EuroCropsML CLI Acquisition Command Usage

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Details the usage for the 'acquisition' command, which is used to acquire data.

```bash
$ eurocropsml-cli acquisition [OPTIONS] COMMAND [ARGS]...
```

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

### download_dataset

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.download.download_dataset.html

Downloads the EuroCropsML dataset from Zenodo using a provided configuration. This function handles the retrieval of the dataset and raises an HTTPError if access to Zenodo records fails.

```APIDOC
## download_dataset

### Description
Downloads the EuroCropsML dataset from Zenodo using the provided preprocessing configuration. This function is essential for acquiring the dataset for use with the EuroCropsML library.

### Method
`download_dataset`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **preprocess_config** (EuroCropsDatasetPreprocessConfig) - Required - Config used to access the Zenodo URL.

### Raises
- **requests.exceptions.HTTPError**: If Zenodo records could not be accessed.

### Request Example
```python
from eurocropsml.dataset import download_dataset
from eurocropsml.dataset.preprocess import EuroCropsDatasetPreprocessConfig

# Assuming preprocess_config is already defined and configured
preprocess_config = EuroCropsDatasetPreprocessConfig(...)

download_dataset(preprocess_config=preprocess_config)
```

### Response
#### Success Response (None)
This function does not return any value upon successful execution.

#### Response Example
None
```

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

### EuroCropsML CLI Datasets EuroCrops Command Usage

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Shows the usage for the 'datasets eurocrops' command, related to EuroCrops datasets.

```bash
$ eurocropsml-cli datasets eurocrops [OPTIONS] COMMAND [ARGS]...
```

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

### AcquisitionConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.AcquisitionConfig.html

The AcquisitionConfig class provides a structured way to configure the acquisition of EuroCrops reflectance data. It defines essential parameters such as data directories, worker configurations, and processing options.

```APIDOC
## Class AcquisitionConfig

### Description
Configuration for acquiring EuroCrops reflectance data.

### Attributes
- **raw_data_dir** (Path) - Directory for raw data.
- **output_dir** (Path) - Directory for output data.
- **eodata_dir** (str | None) - Optional directory for EODATA.
- **local_dir** (Path | None) - Optional local directory.
- **country_config** (CollectorConfig) - Configuration for country-specific data collection.
- **workers** (int) - Number of workers for processing.
- **chunk_size** (int) - Size of data chunks for processing.
- **multiplier** (int) - Multiplier for processing.
- **rebuild** (bool) - Flag to indicate if data should be rebuilt (default: False).
```

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

### Bibtex Citation for EuroCropsML Dataset (Zenodo)

Source: https://eurocropsml.readthedocs.io/en/latest/license.html

Use this Bibtex format for citing the EuroCropsML dataset hosted on Zenodo in LaTeX documents.

```bibtex
@misc{reuss_macdonald_eurocropsml_zenodo_2024,
  author = {Reuss, Joana and Macdonald, Jan},
  title = {EuroCropsML},
  year = {2024},
  publisher = {Zenodo},
  doi = {10.5281/zenodo.10629609},
  url = {https://doi.org/10.5281/zenodo.10629609}
}

```

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

### MMapStore Class

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.utils.MMapStore.html

The MMapStore class is designed to create memory-mapped files. It takes an iterable of file paths as input and caches instances based on these paths to efficiently manage file handles.

```APIDOC
## MMapStore

### Description
Memory map creator class. It takes a list of paths to files and memory maps them. The instance will be cached and possibly reused based on sorted file paths to reduce opening too many file handles.

### Parameters
#### Path Parameters
- **file_paths** (Iterable[Path]) - Required - List of paths to files to be memory mapped.

### Attributes
#### all_mmaps
- Description: Stores all memory-mapped files.

### Methods
#### __init__
- Parameters:
  - **file_paths** (Iterable[Path]) - Required - List of paths to files to be memory mapped.
```

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

### TensorDataset Constructor

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.TensorDataset.html

Initializes a TensorDataset with a sequence of labelled data. This dataset is optimized for serving PyTorch tensor data.

```APIDOC
## TensorDataset

### Description
Initializes a TensorDataset with a sequence of labelled data. This dataset is optimized for serving PyTorch tensor data.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
`__init__(data)`

### Parameters
* **data** (Sequence[LabelledData]) - Required - List of tuples, consisting of input data and labels.
```

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

### LabelledData Class Methods

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.LabelledData.html

Provides documentation for the methods available on the LabelledData class, which allow for data conversion and retrieval.

```APIDOC
## LabelledData Class

### Description
Class that holds data, metadata and labels. It inherits from NamedTuple.

### Methods

#### `from_tensor_dict(tensors)`
* **Description**: Create Labelled data instance from dict of tensors.
* **Parameters**:
  * `tensors` (dict) - A dictionary containing tensors to create the LabelledData instance.

#### `to_tensor_dict()`
* **Description**: Output LabelledData as dict.
* **Returns**: A dictionary representation of the LabelledData.

#### `to_tuple()`
* **Description**: Output LabelledData as tuple of DataItem and tensor containing labels.
* **Returns**: A tuple containing the DataItem and a tensor of labels.

### Attributes

#### `data`
* **Description**: Get data from data_item.

#### `data_item`
* **Description**: Alias for field number 0 in the NamedTuple.

#### `label`
* **Description**: Alias for field number 1 in the NamedTuple.

#### `meta_data`
* **Description**: Get meta_data from data_items.
```

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

### Config Class

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.Config.html

Represents the configuration for acquiring EuroCrops reflectance data. It inherits from BaseModel and includes model configuration and acquisition configuration attributes.

```APIDOC
## class Config

### Description
Configuration for acquiring EuroCrops reflectance data. This class is a data model for holding acquisition-related configuration parameters.

### Attributes
- **model_config** (dict) - Configuration for the model, should be a dictionary conforming to `ConfigDict`.
- **cfg** (AcquisitionConfig) - The acquisition configuration object.
```

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

### TensorDataset

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.html

A simple dataset implementation designed for serving PyTorch tensor data.

```APIDOC
## TensorDataset

### Description
Simple dataset for serving torch tensor data.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### CollectorConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.CollectorConfig.html

Initializes the CollectorConfig with country-specific parameters for data acquisition. This class allows users to define various settings for collecting EuroCrops reflectance data, including satellite mission, product type, spectral bands, and file paths for shapefiles.

```APIDOC
## Class: CollectorConfig

### Description
Country-specific configuration for acquiring EuroCrops reflectance data.

### Parameters
* **country** (str) - Required - Name of the country to collect the data for.
* **year** (int) - Required - Year of observation to collect the data from.
* **months** (tuple[int, int]) - Optional - Months of the year. Defaults to (1, 12).
* **satellite** (Literal['S1', 'S2']) - Optional - Satellite mission (Sentinel 1 (S1) or Sentinel 2(S2)). Only S2 is currently implemented. Defaults to 'S2'.
* **product_type** (Literal['L1C', 'L2A', 'GRD']) - Optional - Satellite product type. Defaults to 'L1C'.
* **processing_level** (Literal[None, 'LEVEL1', 'LEVEL2']) - Optional - Sentinel-1 processing level. Defaults to None.
* **operational_mode** (Literal[None, 'IW', 'EW', 'SM', 'WF']) - Optional - Sentinel-1 operational mode. Defaults to None.
* **max_cloud_cover** (int) - Optional - Maximum cloud cover (only used for Sentinel-2). Defaults to 100.
* **bands** (list[str]) - Optional - Radar (Sentinel-1) or spectral (Sentinel-2) bands to consider. Defaults to ['01', '02', '03', '04', '05', '06', '07', '08', '8A', '09', '10', '11', '12'].
* **max_requested_products** (int) - Optional - Maximum requested products during API call. It is only possible to process up to 2000 products at once. If there are more than max_requested_products available, the products will be processed on a monthly basis. Defaults to 1000.
* **country_code** (str | None) - Optional - EuroCrops country code to identify shapefile. Defaults to None.
* **ec_filename** (str | None) - Optional - EuroCrops zip-file name (without extension). Defaults to None.
* **shapefile_folder** (Path | None) - Optional - Path of the EuroCrops shapefile directory. Defaults to None.
* **shapefile** (Path | None) - Optional - Path of the final EuroCrops shapefile. Defaults to None.
* **polygon** (str | None) - Optional - Country polygon encircling the entire country. Defaults to None.
* **parcel_id_name** (str | None) - Optional - Identifier of parcel ID column (different for each country). If no unique identifier is available in EuroCropsCountryConfig.parcel_ids, one will be created in collector.py. Defaults to None.

### Methods
* **post_init**(vector_data_dir)
  * Make dynamic config based on initialized params.

### Attributes
* **model_config**
  * Configuration for the model, should be a dictionary conforming to `ConfigDict`.
* **country**
* **year**
* **months**
* **satellite**
* **product_type**
* **processing_level**
* **operational_mode**
* **max_cloud_cover**
* **bands**
* **max_requested_products**
* **country_code**
* **ec_filename**
* **shapefile_folder**
* **shapefile**
* **polygon**
* **parcel_id_name**
```

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

### EuroCropsDatasetPreprocessConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.html

Configuration for the downloading and preprocessing steps of the EuroCrops dataset.

```APIDOC
## Class EuroCropsDatasetPreprocessConfig

### Description
Configuration for downloading and preprocessing the EuroCrops dataset. This class defines the parameters related to data acquisition and preparation.

### Parameters
- **Parameters** related to downloading and preprocessing are defined here.
```

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

### EuroCropsML CLI Acquisition EuroCrops Get-Data Command

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Retrieves data using the 'acquisition eurocrops get-data' command. Allows overriding configuration values.

```bash
$ eurocropsml-cli acquisition eurocrops get-data [OPTIONS] [OVERRIDES]...
```

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

### Set eo-data Directory via Configuration Argument

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Specify a custom directory for eo-data tiles using the +cfg.eodata_dir argument in the eurocropsml-cli. This overrides the default '/eodata' location.

```bash
$ eurocropsml-cli acquisition eurocrops get-data +cfg.eodata_dir="personal_eodata_dir"

```

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

### AcquisitionConfig.relative_path

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.AcquisitionConfig.relative_path.html

A class method that interprets relative paths with respect to the project root.

```APIDOC
## AcquisitionConfig.relative_path

### Description
Interprets relative paths with respect to the project root.

### Method
classmethod

### Signature
`_AcquisitionConfig.relative_path(_v : Path_) -> Path`

### Parameters
#### Path Parameters
- **_v** (Path) - Description: The relative path to interpret.
```

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

### create_splits

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.splits.create_splits.html

Creates EuroCrops dataset splits based on provided configuration and directory. It supports an optional download URL for specific benchmark sets.

```APIDOC
## create_splits

### Description
Create EuroCrops dataset splits.

### Method
create_splits

### Parameters
#### Path Parameters
* **_split_config** (EuroCropsSplit_) - Required - Configuration used for splitting dataset.
* **_split_dir** (Path_) - Required - Data directory where split folder is saved.
* **_download_url** (str | None) - Optional - Zenodo download URL. Used for downloading benchmark split.

### Raises
#### ValueError
If download_url not provided and benchmark set to True.
```

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

### EuroCropsML CLI Acquisition EuroCrops Command Usage

Source: https://eurocropsml.readthedocs.io/en/latest/cli.html

Shows the usage for the 'acquisition eurocrops' command, specifically for acquiring data from EuroCrops.

```bash
$ eurocropsml-cli acquisition eurocrops [OPTIONS] COMMAND [ARGS]...
```

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

### create_splits

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.splits.html

Creates EuroCrops dataset splits based on a provided configuration. This function is the primary entry point for generating dataset partitions.

```APIDOC
## create_splits

### Description
Create EuroCrops dataset splits.

### Method
Not applicable (Python function)

### Parameters
- **split_config**: Configuration object for splitting.
- **split_dir**: Directory to save the splits.
- **...**: Additional optional parameters.
```

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

### EuroCropsDatasetPreprocessConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.EuroCropsDatasetPreprocessConfig.html

Configuration class for downloading and preprocessing the EuroCrops dataset. It allows users to specify download URLs, data directories, cloud filtering thresholds, class exclusions/inclusions, satellite type, bands, and the processing year.

```APIDOC
## Class: EuroCropsDatasetPreprocessConfig

### Description
Configuration for downloading and preprocessing EuroCrops dataset.

### Parameters

* **download_url** (str) - Default: 'https://zenodo.org/api/records/10629610/versions' - Zenodo URL to download dataset from.
* **raw_data_dir** (Path) - Required - Directory where the raw EuroCropsML data is stored (from data acquisition).
* **preprocess_dir** (Path) - Required - Directory where the preprocessed data is stored.
* **band4_t1** (float) - Default: 0.07 - Lower threshold for band 4 for identifying cloudy pixels.
* **band4_t2** (float) - Default: 0.25 - Upper threshold for band 4 for identifying cloudy pixels.
* **band4_prob_threshold** (float) - Default: 0.5 - Probability threshold for filtering clouds that decides whether an observation is defined cloudy or non-cloudy.
* **filter_clouds** (bool) - Default: True - Whether to filter clouds from Sentinel-2 time series.
* **num_workers** (int | None) - Optional - Number of workers used during multiprocessing.
* **excl_classes** (list[int]) - Default: [] - Classes that should be excluded even before preprocessing.
* **keep_classes** (list[int]) - Default: [] - Classes to keep for preprocessing. This comes in handy if for example only a couple of classes are relevant. In that case, it massively speeds up the preprocessing.
* **satellite** (Literal['S1', 'S2']) - Default: 'S2' - Preprocess Sentinel-1 or Sentinel-2.
* **bands** (list[str] | None) - Optional - If this is None, the default bands stated in the global variables will be used. These are also the ones available in the ready-to-use EuroCropsML dataset. If during your own data acquisition not all bands or different bands were acquired, please define them here.
* **year** (int) - Default: 2021 - Year for which data are to be processed.

### Methods

* **relative_path(v)** - Interpret relative paths w.r.t.

### Attributes

* **model_config** - Configuration for the model, should be a dictionary conforming to `ConfigDict`.
* **download_url**
* **raw_data_dir**
* **preprocess_dir**
* **band4_t1**
* **band4_t2**
* **band4_prob_threshold**
* **filter_clouds**
* **num_workers**
* **excl_classes**
* **keep_classes**
* **satellite**
* **bands**
* **year**
```

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

### EuroCropsConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.EuroCropsConfig.html

Main configuration for building EuroCrops splits. It holds settings for dataset preprocessing and data splitting.

```APIDOC
## EuroCropsConfig

### Description
Main configuration for building EuroCrops splits. It holds settings for dataset preprocessing and data splitting.

### Attributes
- **preprocess** (EuroCropsDatasetPreprocessConfig) - Configuration for dataset preprocessing.
- **split** (EuroCropsSplit) - Configuration for dataset splitting.
```

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

### DataItem

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.base.html

Represents a single data item, containing the core task data and optional associated meta-data.

```APIDOC
## DataItem

### Description
Data structure that contains task data and maybe additional meta data.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### Adjust Cloud Thresholds

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Customize the lower (t1) and upper (t2) thresholds for classifying Sentinel-2 observations as cloudy or non-cloudy.

```bash
$ eurocropsml-cli datasets eurocrops <COMMAND> preprocess.band4_t1=0.04 preprocess.band4_t2=0.2

```

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

### CollectorConfig.product_type

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.config.CollectorConfig.product_type.html

Defines the allowed product types for the CollectorConfig.product_type attribute. These are literal values that can be assigned.

```APIDOC
## CollectorConfig.product_type

### Description
This attribute specifies the type of product that can be collected. It accepts one of the following literal string values: 'L1C', 'L2A', or 'GRD'.

### Type
Literal['L1C', 'L2A', 'GRD']

### Allowed Values
- L1C
- L2A
- GRD
```

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

### EuroCropsDatasetConfig

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.config.EuroCropsDatasetConfig.html

Configuration for the EuroCrops dataset. This class allows users to specify various parameters for loading and processing the EuroCrops dataset, including date types, cloud filtering, normalization, data sources, band selection, year, sample limits, metrics, data splitting strategies, and the total number of channels.

```APIDOC
## Class EuroCropsDatasetConfig

Configuration for the EuroCrops dataset.

**Parameters**

*   **remove_s2_bands** (list[str] | None, optional): Bands to remove from Sentinel-2 data. Defaults to None.
*   **date_type** (Literal['day', 'month'], optional): Type of date to use ('day' or 'month'). Defaults to 'day'.
*   **filter_clouds** (bool, optional): Whether to filter out cloudy pixels. Defaults to True.
*   **normalize** (bool, optional): Whether to normalize the data. Defaults to True.
*   **data_sources** (list[Literal['S1', 'S2']], optional): List of data sources to use (e.g., 'S1' for Sentinel-1, 'S2' for Sentinel-2). Defaults to ['S2'].
*   **s1_bands** (list[str] | None, optional): Specific bands to use from Sentinel-1 data. Defaults to None.
*   **s2_bands** (list[str] | None, optional): Specific bands to use from Sentinel-2 data. Defaults to None.
*   **year** (int, optional): The year for which to load the dataset. Defaults to 2021.
*   **max_samples** (list[int | str], optional): Maximum number of samples to use, can be 'all'. Defaults to ['all'].
*   **metrics** (list[str], optional): List of metrics to compute. Defaults to ['Acc'].
*   **split** (Literal['class', 'regionclass', 'region']): Strategy for splitting the data (e.g., 'class', 'regionclass', 'region'). This parameter is required.
*   **total_num_channels** (int, optional): Total number of channels expected in the data. Defaults to 0.

**Methods**

*   `__init__(**data)`: Create a new model by parsing and validating input data from keyword arguments.
*   `post_init()`: Make dynamic config based on initialized params.

**Attributes**

*   `model_config`: Configuration for the model, should be a dictionary conforming to `ConfigDict`.
*   `remove_s2_bands`: (See Parameters)
*   `date_type`: (See Parameters)
*   `filter_clouds`: (See Parameters)
*   `normalize`: (See Parameters)
*   `data_sources`: (See Parameters)
*   `s1_bands`: (See Parameters)
*   `s2_bands`: (See Parameters)
*   `year`: (See Parameters)
*   `max_samples`: (See Parameters)
*   `metrics`: (See Parameters)
*   `split`: (See Parameters)
*   `total_num_channels`: (See Parameters)
```

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

### Pre-process Sentinel-1 Data

Source: https://eurocropsml.readthedocs.io/en/latest/examples.html

Set the satellite variable to 'S1' to pre-process Sentinel-1 data, either directly in the YAML file or via the command line.

```bash
$ eurocropsml-cli datasets eurocrops preprocess preprocess.satellite="S1"

```

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

### acquire_sentinel_tiles

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.collector.acquire_sentinel_tiles.html

Function to acquire Sentinel tiles. It processes country-specific configurations, shapefiles, and Sentinel data to store intermediate results and merged files.

```APIDOC
## acquire_sentinel_tiles

### Description
Function to acquire Sentinel tiles. It processes country-specific configurations, shapefiles, and Sentinel data to store intermediate results and merged files.

### Function Signature
`acquire_sentinel_tiles(_config : CollectorConfig_, _output_dir : Path_, _shape_dir : Path_, _shape_dir_clean : Path_, _eodata_dir : str | None_, _workers : int_, _batch_size : int = 10000_) → None`

### Parameters
#### Path Parameters
- **_config** (CollectorConfig_) - Required - Country-specific configuration for acquiring EuroCrops reflectance data.
- **_output_dir** (Path_) - Required - Directory path where intermediate results will be stored.
- **_shape_dir** (Path_) - Required - File path of EuroCrops shapefile.
- **_shape_dir_clean** (Path_) - Required - Directory where the cleaned shapefile will be stored.
- **_eodata_dir** (str | None_) - Optional - Directory where Sentinel-1 or Sentinel-2 data is stored. If None, eodata is used since this will be returned by the API call.
- **_workers** (int_) - Required - Maximum number of workers used for multiprocessing.
- **_batch_size** (int_) - Optional - Batch size used for multiprocessed merging of .SAFE files and parcels. Defaults to 10000.

### Returns
None
```

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

### clipping()

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.acquisition.clipping.clipper.clipping.html

Main function to conduct polygon clipping. This function orchestrates the process of clipping EuroCrops reflectance data based on provided configurations and shapefiles.

```APIDOC
## clipping()

### Description
Main function to conduct polygon clipping. This function orchestrates the process of clipping EuroCrops reflectance data based on provided configurations and shapefiles.

### Method
None (Python function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **config** (_CollectorConfig_) - Country-specific configuration for acquiring EuroCrops reflectance data.
* **output_dir** (_Path_) - Directory path where intermediate results will be stored.
* **shape_dir** (_Path_) - Directory path where EuroCrops shapefile is stored.
* **workers** (_int_) - Maximum number of workers used for multiprocessing.
* **chunk_size** (_int_) - Chunk size used for multiprocessed raster clipping.
* **multiplier** (_int_) - Intermediate results will be saved every multiplier steps.
* **local_dir** (_Path | None_, optional) - Local directory where the .SAFE files were copied to. Defaults to None.
* **rebuild** (_bool_, optional) - Whether to re-build the clipped parquet files for each month. This will overwrite the existing ones. Defaults to False.

### Returns
None
```

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

### Plain Text Citation for EuroCropsML Dataset

Source: https://eurocropsml.readthedocs.io/en/latest/license.html

Use this plain text format for citing the EuroCropsML dataset in publications.

```text
Reuss, J., Macdonald, J., Becker, S. et al. The EuroCropsML time series benchmark dataset for few-shot crop type classification in Europe. Sci Data 12, 664 (2025). https://doi.org/10.1038/s41597-025-04952-7

```

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

### find_clouds

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.preprocess.html

Calculates cloud probabilities for a multi-spectral time series.

```APIDOC
## find_clouds

### Description
Get cloud probabilities multi-spectral timeseries.

### Function Signature
`find_clouds`(array, band4_idx, preprocess_config)

### Parameters
* **array**: Input multi-spectral time series data.
* **band4_idx**: Index of the band 4.
* **preprocess_config**: Configuration for preprocessing.

### Returns
Cloud probabilities for the time series.
```

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

### find_clouds

Source: https://eurocropsml.readthedocs.io/en/latest/api/eurocropsml.dataset.preprocess.find_clouds.html

Calculates the probability of clouds in a multi-spectral time-series dataset. It takes an array of multi-spectral data, the index of band 4, and a preprocessing configuration object as input. It returns a float representing the cloud probability.

```APIDOC
## find_clouds

### Description
Get cloud probabilities multi-spectral timeseries.

### Method
N/A (Python function)

### Endpoint
N/A (Python function)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
- **float** - The probability of clouds in the timeseries.

#### Response Example
N/A
```
Tokens:
Raw