Skip to content

API

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

from_toml classmethod
Python
from_toml(file: str | Path) -> Self

Generating a Self dataclass from a .toml configuration file.

Parameters:

Name Type Description Default
file str | Path

path to the .toml configuration file

 required

Returns:

Type Description
Self

Self dataclass set from .toml file
to_toml
Python
to_toml(out_file: Path) -> None

Saving to disk a .toml file from the dataclass instance.

Parameters:

Name Type Description Default
out_file Path

path to the output .toml file

 required

Main Analysis Interface

Interferometric Analysis implementation.

Attributes

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

Command Line Interface Command

Command Line Interface for Interferometric Analysis.

Attributes

Classes

Functions:

interf_coherence_analysis

Python
interf_coherence_analysis(ctx: Context, product: InputProductOption, output_directory: OutputDirectoryOption, product_2: Path | None = typer.Option(None, '--product_2', '-pp', exists=True, dir_okay=True, help='Second co-registered product, must be provided if the first product is not an interferogram'), 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.

Core implementation

Interferometric Analysis

Attributes

Classes

Functions:

sct_interferometric_coherence_analysis

Python
sct_interferometric_coherence_analysis(product_path: str | Path, second_product_path: str | Path | None = None, config: SCTInterferometricAnalysisConfig | None = None) -> list[InterferometricCoherenceOutput]

Computing the interferometric analysis of the input product. Product can contain interferogram information or coherence information. In the first case, coherence is computed before generating the 2D azimuth and range coherence intensity histograms, if enabled in configuration.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed. it must be an interferogram product or a co-registered product but in that case a second product must be provided

 required
second_product_path str | Path | None

path to the second co-registered product to be analyzed, by default None

 None
config SCTInterferometricAnalysisConfig | None

SCTInterferometricAnalysisConfig configuration dataclass, by default None

 None

Returns:

Type Description
list[InterferometricCoherenceOutput]

an InterferometricCoherenceOutput dataclass for each channel