Skip to content

API

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

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

Ambiguity Ratio Analysis implementation.

Attributes

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

Command Line Interface Command

Command Line Interface for Target Ambiguity Ratio Analysis.

Attributes

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.

Core implementation

Target Ambiguity Ratio Analysis

Attributes

Classes

Functions:

sct_point_target_ambiguity_ratio_analysis

Python
sct_point_target_ambiguity_ratio_analysis(product_path: str | Path, external_target_source: str | Path, config: SCTTargetAmbiguityRatioConfig | None = None) -> list[PointTargetAmbiguityRatioDataOutput]

Point Target Ambiguity Ratio Analysis performed on the input product.

Parameters:

Name Type Description Default
product_path str | Path

path to the product to be analyzed

 required
external_target_source str | Path

path to external point target source

 required
config SCTTargetAmbiguityRatioConfig | None

configuration parameters, by default None

 None

Returns:

Type Description
list[PointTargetAmbiguityRatioDataOutput]

list of PointTargetAmbiguityRatioDataOutput analysis output, one for each product channel and each Point Target