Skip to content

Processing

Post-processing of LST calculation results.

Functions

tracking_process

1
2
3
from lst_tools import tracking_process

tracking_process(config)

Post-process tracking calculation results (N-factors, growth rates). Post-process tracking calculation results.

lst_tools.process.tracking_process

tracking_process(*, cfg: Config | None = None, do_maxima: bool = True, do_volume: bool = True, work_dir: Path | None = None, kc_dirs: list[Path] | None = None, interpolate: bool | None = None, plain_output: bool = False) -> Path

Process LST tracking calculation results.

Parameters:

Name Type Description Default
cfg Optional[Config]

Configuration object. Processing defaults come from cfg.processing.tracking (gate_tol, min_valid, peak_order, interpolate). CLI flags override config values.

None
do_maxima bool

If True, run ridge-line maxima extraction for every kc_* case.

True
do_volume bool

If True, assemble 2-D slices into a 3-D volume file.

True
work_dir Optional[Path]

Working directory containing kc_* subdirectories. Defaults to the current working directory.

None
kc_dirs Optional[list[Path]]

Specific kc_* directories to process. If None, discovers all kc_* directories in work_dir.

None
interpolate Optional[bool]

Use parabolic interpolation for peak refinement. If None, falls back to cfg.processing.tracking.interpolate.

None
plain_output bool

If True, use line-by-line text output instead of rich progress bars where supported.

False

Returns:

Name Type Description
Path Path

Path to the working directory.

spectra_process

1
2
3
from lst_tools import spectra_process

spectra_process(config)

Post-process spectra calculation results.

lst_tools.process.spectra_process

spectra_process(*, cfg: Mapping[str, Any] | None = None, reporter: Callable[[str], None] | None = None, do_animate: bool = True, do_branches: bool = True, do_classify: bool = False) -> Path

Process LST spectra calculation results

This function processes the output data from LST spectra calculations, collecting results from multiple x-location directories, analyzing spectral data across frequencies and wavenumbers, and preparing data for visualization.

Parameters:

Name Type Description Default
cfg Optional[Mapping[str, Any]]

Configuration dictionary or path to config file

None

Returns:

Name Type Description
Path Path

Path to the processed results file