Skip to content

API

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

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

Radiometric Analysis implementation.

Attributes

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

Command Line Interface Command

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.

Core implementation

Radiometric Analysis

Attributes

Classes

SupportedRadiometricProfiles

Bases: Enum

Supported radiometric profiles analyses

Attributes

NESZ class-attribute instance-attribute
Python
NESZ = 'nesz'
PROFILES class-attribute instance-attribute
Python
PROFILES = 'average_profiles'
SCALLOPING class-attribute instance-attribute
Python
SCALLOPING = 'scalloping'

Functions:

sct_radiometric_profiles

Python
sct_radiometric_profiles(product_path: str | Path, analysis_type: SupportedRadiometricProfiles, config: RadiometricProfilesConfig, output_quantity: SARRadiometricQuantity | None = None) -> list[RadiometricProfilesOutput]

Radiometric profiles SCT wrapper.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
analysis_type SupportedRadiometricProfiles

type of analysis to perform

 required
config RadiometricProfilesConfig

radiometric profiles configuration

 required
output_quantity SARRadiometricQuantity | None

output SAR radiometric quantity, by default None

 None

Returns:

Type Description
list[RadiometricProfilesOutput]

list of RadiometricProfilesOutput results dataclass, one for each channel

sct_nesz_analysis

Python
sct_nesz_analysis(product_path: str | Path, config: SCTRadiometricAnalysisConfig | None = None) -> list[RadiometricProfilesOutput]

SCT Noise Equivalent Sigma-Zero (NESZ) radiometric block-wise analysis.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
config SCTRadiometricAnalysisConfig | None

SCT radiometric analysis configuration, by default None

 None

Returns:

Type Description
list[RadiometricProfilesOutput]

list of RadiometricProfilesOutput results dataclass, one for each channel

sct_average_elevation_profile_analysis

Python
sct_average_elevation_profile_analysis(product_path: str | Path, output_quantity: SARRadiometricQuantity, config: SCTRadiometricAnalysisConfig | None = None) -> list[RadiometricProfilesOutput]

SCT Average Radiometric Elevation Profile block-wise analysis.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
output_quantity SARRadiometricQuantity

output SAR radiometric quantity

 required
config SCTRadiometricAnalysisConfig | None

SCT radiometric analysis configuration, by default None

 None

Returns:

Type Description
list[RadiometricProfilesOutput]

list of RadiometricProfilesOutput results dataclass, one for each channel

sct_scalloping_analysis

Python
sct_scalloping_analysis(product_path: str | Path, config: SCTRadiometricAnalysisConfig | None = None) -> list[RadiometricProfilesOutput]

SCT Scalloping radiometric block-wise analysis.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
config SCTRadiometricAnalysisConfig | None

SCT radiometric analysis configuration, by default None

 None

Returns:

Type Description
list[RadiometricProfilesOutput]

list of RadiometricProfilesOutput results dataclass, one for each channel