Skip to content

API Reference

Plugin Interface

Elevation Notch 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 = 'elevation_notch'

Classes

ElevationNotchAnalysisPlugin

Elevation Notch Analysis plugin.

Attributes

version class-attribute instance-attribute
Python
version = __version__
short_help class-attribute instance-attribute
Python
short_help = 'Elevation Notch Analysis.'

Methods:

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

Main API entry point

Elevation Notch Analysis implementation.

Classes

Functions:

full_elevation_notch_analysis

Python
full_elevation_notch_analysis(product: Path, antenna_pattern: Path | None, output_directory: Path, config: SCTElevationNotchAnalysisConfig | None, graphs: bool) -> Path

Full implementation of Elevation Notch Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
antenna_pattern Path | None

Path to the antenna pattern NetCDF file

 required
output_directory Path

Path to the output directory

 required
config SCTElevationNotchAnalysisConfig | None

analysis configuration parameters, if needed

 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 Elevation Notch Analysis.

Classes

Functions:

notch_analysis

Python
notch_analysis(ctx: Context, product: InputProductOption, output_directory: OutputDirectoryOption, antenna_pattern: AntennaPatternInputOption = None, graphs: GraphsOption = False) -> None

Elevation Notch Analysis.

 Antenna pattern NetCDF file can be provided to estimate the elevation pointing offset with Least Square fitting of the elevation profile of the focused data with a three parameters internal model.

elevation_notch_analysis_implementation

Python
elevation_notch_analysis_implementation(product: Path, antenna_pattern: Path | None, output_directory: Path, config: SCTElevationNotchAnalysisConfig, graphs: bool, dump_config: bool) -> None

Implement the elevation notch analysis command.

Configuration

Elevation Notch Analysis Configuration.

Attributes

Classes

SCTElevationNotchAnalysisConfig dataclass

Bases: AnalysisConfigABC

SCT Elevation Notch Analysis configuration

Attributes

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

Methods:

__init__
Python
__init__(base_config: ElevationNotchConfig = ElevationNotchConfig()) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTElevationNotchAnalysisConfig

Convert from dict

to_dict
Python
to_dict()

Convert to dict