sar_processor.computing package

This module is an example of a processor level package that contains processors and processing units.

Submodules

sar_processor.computing.my_processing_unit module

class sar_processor.computing.my_processing_unit.MyProcessingUnit(identifier='')

Bases: EOProcessingUnit

My Processing Unit

Attributes:

identifier

Identifier of the processing step

Methods

run:	Execute this processing unit.

run(inputs, adfs=None, mode=None, **kwargs)

Runs the processing unit

A more complete description can be added here.

Return type:

Mapping[str, EOProduct | EOContainer | DataTree | Iterable[EOProduct | EOContainer | DataTree]]

Parameters:

inputs: dict[str, DataType]

all the product to process in this processing unit

adfs: Optional[dict[str, ADF]]

all the ADFs needed to process

**kwargs: any

any needed kwargs (parameters etc)

Returns:

dict[str, DataType]

Examples

Usage examples can be added as Jupyter notebook cells.

# All required imports
from eopf.computing.abstract import DataType
from eopf.product import EOProduct
from sar_processor.computing.my_processing_unit import MyProcessingUnit

# Simple example to demonstrate how to create and run the
# processing unit.
my_processing_unit = MyProcessingUnit()
input = EOProduct("PRODUCT.A")
input_dict: dict[str, DataType] = {"a": input}
my_processing_unit.run(input_dict, name="MY_PRODUCT.UNITTEST")

sar_processor.computing.my_processor module

class sar_processor.computing.my_processor.MyProcessor(identifier='')

Bases: EOProcessingUnit

My Processor

Attributes:

identifier

Identifier of the processing step

Methods

run:	Execute the processor.

run(inputs, adfs=None, mode=None, **kwargs)

Runs the processor.

Return type:

Mapping[str, EOProduct | EOContainer | DataTree | Iterable[EOProduct | EOContainer | DataTree]]

Parameters:

inputs: dict[str, DataType]

all the product to process in this processing unit

adfs: Optional[dict[str, ADF]]

all the ADFs needed to process

**kwargs: any

any needed kwargs (parameters etc)

Returns:

dict[str, DataType]

Examples

This is an example demonstrating how doctest can be used to illustrate the usage of the source code. See https://numpydoc.readthedocs.io/en/latest/example.html for numpydoc examples.

>>> from sar_processor.computing.my_processor import (
>>>    MyProcessor,
>>> )
>>> myProcessor = MyProcessor()
>>> myProcessor.run()