Skip to content

API

Configuration

Point Target Analysis Configuration.

Attributes

Classes

IonosphericCorrectionsConf dataclass

SCT Point Target Analysis ionospheric corrections configuration

Attributes

maps_directory instance-attribute
Python
maps_directory: Path
analysis_center instance-attribute
Python
analysis_center: IonosphericAnalysisCenters
tec_incidence_angle_method class-attribute instance-attribute
Python
tec_incidence_angle_method: TECIncidenceAngleMethod = TECIncidenceAngleMethod.GROUND_CONVERTED

Methods:

__init__
Python
__init__(maps_directory: Path, analysis_center: IonosphericAnalysisCenters, tec_incidence_angle_method: TECIncidenceAngleMethod = TECIncidenceAngleMethod.GROUND_CONVERTED) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> IonosphericCorrectionsConf

Convert from dict

to_dict
Python
to_dict() -> dict

Convert to dict

TroposphericCorrectionsConf dataclass

SCT Point Target Analysis tropospheric corrections configuration

Attributes

maps_directory instance-attribute
Python
maps_directory: Path
map_grid_resolution class-attribute instance-attribute
Python
map_grid_resolution: TroposphericGRIDResolution = TroposphericGRIDResolution.FINE

Methods:

__init__
Python
__init__(maps_directory: Path, map_grid_resolution: TroposphericGRIDResolution = TroposphericGRIDResolution.FINE) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> TroposphericCorrectionsConf

Convert from dict

to_dict
Python
to_dict() -> dict

Convert to dict

SCTPointTargetAnalysisCorrectionsConf dataclass

SCT Point Target Analysis corrections configuration

Attributes

enable_solid_tides_correction class-attribute instance-attribute
Python
enable_solid_tides_correction: bool = False
enable_plate_tectonics_correction class-attribute instance-attribute
Python
enable_plate_tectonics_correction: bool = True
enable_sensor_specific_processing_corrections class-attribute instance-attribute
Python
enable_sensor_specific_processing_corrections: bool = True
enable_ionospheric_correction class-attribute instance-attribute
Python
enable_ionospheric_correction: bool = False
enable_tropospheric_correction class-attribute instance-attribute
Python
enable_tropospheric_correction: bool = False
ionosphere class-attribute instance-attribute
Python
ionosphere: IonosphericCorrectionsConf | None = None
troposphere class-attribute instance-attribute
Python
troposphere: TroposphericCorrectionsConf | None = None

Methods:

__init__
Python
__init__(enable_solid_tides_correction: bool = False, enable_plate_tectonics_correction: bool = True, enable_sensor_specific_processing_corrections: bool = True, enable_ionospheric_correction: bool = False, enable_tropospheric_correction: bool = False, ionosphere: IonosphericCorrectionsConf | None = None, troposphere: TroposphericCorrectionsConf | None = None) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTPointTargetAnalysisCorrectionsConf

Convert from dict

to_dict
Python
to_dict() -> dict

Convert to dict

SCTPointTargetAnalysisConfig dataclass

Bases: AnalysisConfigABC

SCT Point Target Analysis configuration

Attributes

base_config class-attribute instance-attribute
Python
base_config: PointTargetAnalysisConfig = field(default_factory=PointTargetAnalysisConfig)
corrections class-attribute instance-attribute
Python
corrections: SCTPointTargetAnalysisCorrectionsConf = field(default_factory=SCTPointTargetAnalysisCorrectionsConf)
config_group_name class-attribute instance-attribute
Python
config_group_name = 'point_target_analysis'
validation_schema class-attribute instance-attribute
Python
validation_schema = Path(config_schema)

Methods:

__init__
Python
__init__(base_config: PointTargetAnalysisConfig = PointTargetAnalysisConfig(), corrections: SCTPointTargetAnalysisCorrectionsConf = SCTPointTargetAnalysisCorrectionsConf()) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTPointTargetAnalysisConfig

Convert from dict

to_dict
Python
to_dict() -> dict

Convert to dict

base_config_to_dict staticmethod
Python
base_config_to_dict(base_config: PointTargetAnalysisConfig) -> dict

Convert base config to dict with SCT configuration conventions.

base_config_from_dict staticmethod
Python
base_config_from_dict(arg: dict) -> PointTargetAnalysisConfig

Convert base config from dict with SCT configuration conventions.

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

Point Target Analysis implementation.

Attributes

Classes

Functions:

full_point_target_analysis

Python
full_point_target_analysis(product: Path, point_target_source: Path, output_directory: Path, external_orbit: Path | None, external_corrections_product: Path | None, config: SCTPointTargetAnalysisConfig | None, graphs: bool) -> Path

Full implementation of Point Target Analysis.

Parameters:

Name Type Description Default
product Path

Path to the product to be analyzed

 required
point_target_source Path

Path to the point target source file

 required
output_directory Path

Path to the output directory

 required
external_orbit Path | None

Path to the external orbit file, if any

 required
external_corrections_product Path | None

Path to the external corrections product, if any

 required
config SCTPointTargetAnalysisConfig | None

analysis configuration parameters, if needed

 required
graphs bool

flag to enable graphs generation

 required

Returns:

Type Description
Path

Path to the CSV file containing the point target analysis results

Command Line Interface Command

Command Line Interface for Point Target Analysis.

Attributes

Classes

Functions:

target_analysis

Python
target_analysis(ctx: Context, product: InputProductOption, point_target_source: InputPointTargetSource, output_directory: OutputDirectoryOption, external_orbit: ExternalOrbitInputOption = None, external_corrections_product: ExternalCorrectionInputProductOption = None, graphs: GraphsOption = False) -> None

Point Target Analysis (IRF, Localization and RCS).

target_analysis_implementation

Python
target_analysis_implementation(product: Path, external_orbit: Path | None, external_corrections_product: Path | None, point_target_source: Path, output_directory: Path, config: SCTPointTargetAnalysisConfig, graphs: bool, dump_config: bool) -> None

Implement the point target analysis command.

Core implementation

Point Target Analysis

Attributes

Classes

Functions:

sct_point_target_analysis_with_corrections

Python
sct_point_target_analysis_with_corrections(product_path: str | Path, external_target_source: str | Path, external_orbit_path: str | Path | None = None, external_corrections_product: str | Path | None = None, config: SCTPointTargetAnalysisConfig | None = None) -> tuple[pd.DataFrame, list[PointTargetGraphicalData]]

Point Target Analysis high-level function that executes the proper wrapper of PERSEO-Quality point_target_analysis function based on input product type.

Parameters:

Name Type Description Default
product_path str | Path

Path to the input product

 required
external_target_source str | Path

path to external point target source (file or folder)

 required
external_orbit_path str | Path | None

Path to the external orbit file, by default None

 None
external_corrections_product str | Path | None

Path to the external ALE corrections product, by default None

 None
config SCTPointTargetAnalysisConfig

config file SCTPointTargetAnalysisConfig dataclass to enable and manage different features, if provided, by default None

 None

Returns:

Type Description
DataFrame

pandas data frame containing all the computed features for each point target
list[PointTargetGraphicalData]

dict of data stored for graphical output needs