Skip to content

API Reference

Plugin Interface

Radiometric 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.

This single plugin exposes several analysis types (NESZ, rain-forest, elevation profiles, scalloping) that share one CLI group.

Attributes

ANALYSIS_BASE_NAME module-attribute

Python
ANALYSIS_BASE_NAME = 'radiometry'

ANALYSES_NAMES module-attribute

Python
ANALYSES_NAMES = ['nesz', 'rain-forest', 'profiles', 'scalloping']

Classes

RadiometricAnalysisPlugin

Radiometric Analysis plugin (exposes several analysis types, one CLI group).

Attributes

version class-attribute instance-attribute
Python
version = __version__
short_help class-attribute instance-attribute
Python
short_help = 'Block-wise Radiometric Analysis.'

Methods:

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

Main API entry point

Radiometric Analysis implementation.

Classes

Functions:

full_nesz_analysis

Python
full_nesz_analysis(product: Path, output_directory: Path, config: SCTRadiometricAnalysisConfig | None, graphs: bool) -> tuple[Path, Path]

Full implementation of Noise Equivalent Sigma-Zero (NESZ) Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
output_directory Path

Path to the output directory

 required
config SCTRadiometricAnalysisConfig | 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 radiometric profiles
Path

Path to the CSV file containing the radiometric statistics

full_average_elevation_profiles_analysis

Python
full_average_elevation_profiles_analysis(product: Path, output_radiometric_quantity: SARRadiometricQuantity, output_directory: Path, config: SCTRadiometricAnalysisConfig | None, graphs: bool) -> tuple[Path, Path]

Full implementation of Average Radiometric Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
output_radiometric_quantity SARRadiometricQuantity

output radiometric quantity selected

 required
output_directory Path

Path to the output directory

 required
config SCTRadiometricAnalysisConfig | 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 radiometric profiles
Path

Path to the CSV file containing the radiometric statistics

full_rain_forest_analysis

Python
full_rain_forest_analysis(product: Path, output_directory: Path, config: SCTRadiometricAnalysisConfig | None, graphs: bool) -> tuple[Path, Path]

Full implementation of Rain Forest Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
output_directory Path

Path to the output directory

 required
config SCTRadiometricAnalysisConfig | 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 radiometric profiles
Path

Path to the CSV file containing the radiometric statistics

full_scalloping_analysis

Python
full_scalloping_analysis(product: Path, output_directory: Path, config: SCTRadiometricAnalysisConfig | None, graphs: bool) -> tuple[Path, Path]

Full implementation of Scalloping Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
output_directory Path

Path to the output directory

 required
config SCTRadiometricAnalysisConfig | 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 radiometric profiles
Path

Path to the CSV file containing the radiometric statistics

CLI commands

Command Line Interface for Radiometric Analysis.

Attributes

radiometric_app module-attribute

Python
radiometric_app = typer.Typer(help='Block-wise Radiometric Analysis.')

Classes

Functions:

radiometric_analysis_nesz

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

Noise Equivalent Sigma-Zero radiometric analysis.

radiometric_analysis_average_profiles

Python
radiometric_analysis_average_profiles(ctx: Context, product: InputProductOption, output_radiometric_quantity: RadiometricQuantityOption, output_directory: OutputDirectoryOption, graphs: GraphsOption = False) -> None

Average Elevation Profiles radiometric analysis.

radiometric_analysis_rain_forest

Python
radiometric_analysis_rain_forest(ctx: Context, product: InputProductOption, output_directory: OutputDirectoryOption, graphs: GraphsOption = False)

Rain Forest radiometric analysis (Gamma Profiles).

radiometric_analysis_scalloping

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

Scalloping Profiles radiometric analysis.

radiometric_analysis_nesz_implementation

Python
radiometric_analysis_nesz_implementation(product: Path, output_directory: Path, config: SCTRadiometricAnalysisConfig, graphs: bool, dump_config: bool) -> None

Implement the NESZ radiometric analysis command.

radiometric_analysis_average_profiles_implementation

Python
radiometric_analysis_average_profiles_implementation(product: Path, output_radiometric_quantity: SARRadiometricQuantity, output_directory: Path, config: SCTRadiometricAnalysisConfig, graphs: bool, dump_config: bool) -> None

Implement the average elevation profiles radiometric analysis command.

radiometric_analysis_scalloping_implementation

Python
radiometric_analysis_scalloping_implementation(product: Path, output_directory: Path, config: SCTRadiometricAnalysisConfig, graphs: bool, dump_config: bool) -> None

Implement the scalloping profiles radiometric analysis command.

Configuration

Radiometric Analysis Configuration.

Attributes

Classes

SCTRadiometricAnalysisConfig dataclass

Bases: AnalysisConfigABC

SCT Radiometric Analysis configuration

Attributes

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

Methods:

__init__
Python
__init__(base_config: RadiometricProfilesConfig = RadiometricProfilesConfig()) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTRadiometricAnalysisConfig

Convert from dict

to_dict
Python
to_dict() -> dict

Convert to dict