Skip to content

common⚓︎

Localization strategies and shared primitives for PIPT.

Design principles: - Keep parsing, geometry, and adaptive math in separate classes. - Expose small, explicit workflow strategies with a stable API.

LocalizationBase ⚓︎

Bases: ABC

Shared base for localization engines and workflow strategies.

config_common(info) ⚓︎

Configure the common localization parameters for all strategies.

Parameters:

Name Type Description Default
info dict or list

Localization configuration information. - field: list of integers specifying the localization field dimensions. - actnum: optional path to a .npz file containing the actnum array

required

LocalizationConfigBuilder ⚓︎

Build normalized localization configuration and precomputed masks.

build(data_index, data_types, parameters, ne) ⚓︎

Build the localization info dictionary used by strategies.

infer_name(info) ⚓︎

Name the localization mode a config selects by keyword rather than by name.

Localization used to be chosen by which keyword appeared in the block -- autoadaloc, localanalysis, dist_loc, a pickled mask file, or none of them for the parallel update. Those configs carry no name, so it is worked out here and they keep running unchanged.

normalize_parsed_info(parsed_info) ⚓︎

Normalize localization input to dictionary form, naming the mode if it does not.

parse_init_args(data_indices=None, data_types=None, parameters=None, ensemble_size=None) ⚓︎

Parse constructor arguments using canonical keyword names.