Skip to content

API Reference

Plugin Interface

Interferometric Analysis plugin entry point.

Lightweight module: importing it must not pull in the heavy analysis implementation or the scientific stack. All heavy imports are deferred to the accessor methods.

Attributes

ANALYSIS_NAME module-attribute

Python
ANALYSIS_NAME = 'interferometry'

Classes

InterferometricAnalysisPlugin

Interferometric Analysis plugin.

Attributes

version class-attribute instance-attribute
Python
version = __version__
short_help class-attribute instance-attribute
Python
short_help = 'Interferometric Analysis (coherence and 2D histograms).'

Methods:

get_cli classmethod
Python
get_cli() -> Typer | Callable
get_handlers classmethod
Python
get_handlers() -> dict[str, AnalysisHandler]

Main API entry point

Interferometric Analysis implementation.

Classes

Functions:

full_interferometric_analysis

Python
full_interferometric_analysis(product: Path, product_2: Path | None, output_directory: Path, config: SCTInterferometricAnalysisConfig | None, graphs: bool) -> Path

Full implementation of Interferometric Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
product_2 Path | None

Second co-registered product, must be provided if the first product is not an interferogram

 required
config SCTInterferometricAnalysisConfig | None

analysis configuration parameters, if needed

 required
output_directory Path

Path to the output directory

 required
graphs bool

flag to enable graphs generation

 required

Returns:

Type Description
Path

Path to the NetCDF file containing the results

CLI commands

Command Line Interface for Interferometric Analysis.

Attributes

SecondProductOption module-attribute

Python
SecondProductOption = Path | None

Classes

Functions:

interf_coherence_analysis

Python
interf_coherence_analysis(ctx: Context, product: InputProductOption, output_directory: OutputDirectoryOption, product_2: SecondProductOption = None, graphs: GraphsOption = False) -> None

Interferometric Analysis (Coherence and Coherence intensity 2D histograms).

 It can be performed: - using a single interferogram product, via -p/--product argument - using two co-registered products, respectively with -p/--product and -pp/--product_2

interf_coherence_analysis_implementation

Python
interf_coherence_analysis_implementation(product: Path, product_2: Path | None, config: SCTInterferometricAnalysisConfig, output_directory: Path, graphs: bool, dump_config: bool) -> None

Implement of the interferometric analysis command.

Configuration

Interferometric Analysis Configuration.

Attributes

Classes

SCTInterferometricAnalysisConfig dataclass

Bases: AnalysisConfigABC

SCT Interferometric Analysis configuration

Attributes

base_config class-attribute instance-attribute
Python
base_config: InterferometricConfig = field(default_factory=InterferometricConfig)
config_group_name class-attribute instance-attribute
Python
config_group_name = 'interferometric_analysis'
validation_schema class-attribute instance-attribute
Python
validation_schema = Path(config_schema)

Methods:

__init__
Python
__init__(base_config: InterferometricConfig = InterferometricConfig()) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTInterferometricAnalysisConfig

Convert from dict

to_dict
Python
to_dict()

Convert to dict