Skip to content

API Reference

Plugin Interface

Target Ambiguity Ratio 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.

Attributes

ANALYSIS_NAME module-attribute

Python
ANALYSIS_NAME = 'ambiguity_ratio'

Classes

TargetAmbiguityRatioAnalysisPlugin

Target Ambiguity Ratio Analysis plugin.

Attributes

version class-attribute instance-attribute
Python
version = __version__
short_help class-attribute instance-attribute
Python
short_help = 'Point Target Ambiguity Ratio Analysis.'

Methods:

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

Main API entry point

Ambiguity Ratio Analysis implementation.

Classes

Functions:

full_pt_ambiguity_ratio_analysis

Python
full_pt_ambiguity_ratio_analysis(product: Path, point_target_source: Path, output_directory: Path, config: SCTTargetAmbiguityRatioConfig | None, graphs: bool) -> None

Full implementation of Point Target Ambiguity Ratio 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
config SCTTargetAmbiguityRatioConfig | None

analysis configuration parameters, if needed

 required
graphs bool

flag to enable graphs generation

 required

CLI commands

Command Line Interface for Target Ambiguity Ratio Analysis.

Classes

Functions:

ptar_analysis

Python
ptar_analysis(ctx: Context, product: InputProductOption, point_target_source: InputPointTargetSource, output_directory: OutputDirectoryOption) -> None

Point Target Ambiguity Ratio Analysis.

pt_ambiguity_ratio_analysis_implementation

Python
pt_ambiguity_ratio_analysis_implementation(product: Path, point_target_source: Path, output_directory: Path, config: SCTTargetAmbiguityRatioConfig, graphs: bool, dump_config: bool) -> None

Implement the point target ambiguity ratio analysis command.

Configuration

Ambiguity Ratio Analysis configuration.

Attributes

Classes

SCTTargetAmbiguityRatioConfig dataclass

Bases: AnalysisConfigABC

SCT Target Ambiguity Ratio Analysis configuration

Attributes

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

Methods:

__init__
Python
__init__(base_config: AmbiguityRatioConfig = AmbiguityRatioConfig()) -> None
from_dict classmethod
Python
from_dict(arg: dict) -> SCTTargetAmbiguityRatioConfig

Convert from dict

to_dict
Python
to_dict()

Convert to dict