Skip to content

API

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

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

Elevation Notch Analysis implementation.

Attributes

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

Command Line Interface Command

Command Line Interface for Elevation Notch Analysis.

Attributes

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.

Core implementation

Elevation Notch Analysis

Attributes

Classes

Functions:

sct_elevation_notch_analysis

Python
sct_elevation_notch_analysis(product_path: str | Path, antenna_pattern_file: str | Path | None = None, config: SCTElevationNotchAnalysisConfig | None = None) -> list[ElevationNotchOutput]

Elevation Notch Analysis performed on the input product, taking into account the antenna pattern data, if provided.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
antenna_pattern_file str | Path | None

path to the antenna pattern NetCDF file, if needed, by default None

 None
config SCTElevationNotchAnalysisConfig | None

configuration parameters, by default None

 None

Returns:

Type Description
list[ElevationNotchOutput]

list of ElevationNotchOutput analysis output, one for each product channel