Skip to content

plugins

Product Format Plugins protocols

Input Products plugins protocols.

Attributes

Detector module-attribute

Python
Detector = Callable[[str | Path], bool]

Classes

AbsoluteLocalizationErrorCorrector

Bases: Protocol

SCT protocol to define the behavior of specific sensors Absolute Localization Error computation

Methods:

__init__
Python
__init__(external_product_path: Path | None)
get_ale_corrections_function
Python
get_ale_corrections_function() -> ALECorrectionFunctionType

Getter of the ALE correction function to effectively compute corrections

update_corrections_config
Python
update_corrections_config(corrections_config: SCTPointTargetAnalysisCorrectionsConf) -> SCTPointTargetAnalysisCorrectionsConf

Function to update the input SCT Point Target Analysis corrections config to disable specific corrections when an external product is provided.

Parameters:

Name Type Description Default
corrections_config SCTPointTargetAnalysisCorrectionsConf

SCT Point Target Analysis corrections config to be updated

 required

Returns:

Type Description
SCTPointTargetAnalysisCorrectionsConf

updated SCT Point Target Analysis corrections config

InputProductPluginProtocol

Bases: Protocol

Module/Object protocol

Attributes

version instance-attribute
Python
version: str

Methods:

get_manager classmethod
Python
get_manager() -> type[SCTInputProduct]

Retrieve manager

get_detector classmethod
Python
get_detector() -> Detector

Retrieve detector

get_ale_corrector classmethod
Python
get_ale_corrector() -> AbsoluteLocalizationErrorCorrector | None

Retrieve ALE corrector class for both range and azimuth directions

Input Products plugins loader.

Attributes

import_input_product_plugins module-attribute

Python
import_input_product_plugins = partial(import_plugins, plugin_protocol=InputProductPluginProtocol, namespace='sct.input_products')

Classes

Functions:

import_plugins

Python
import_plugins(*, plugin_protocol: Type, namespace: str) -> list

Load plugins using Stevedore entry points.

Parameters:

Name Type Description Default
plugin_protocol Type

Protocol that plugins must satisfy

 required
namespace str

Entry-point namespace

 required

Returns:

Type Description
list

list of available plugins