rail.plotting.nz_data_holders module

class rail.plotting.nz_data_holders.RailNZTomoBinsDataHolder(**kwargs)

Bases: RailDatasetHolder

Simple class for holding a dataset for plotting data that comes from a RailProject

Parameters:

kwargs (Any)

config_options: dict[str, StageParameter] = {'algo': Parameter(RailProject algorithm, type: <class 'str'>, default: None [required]), 'classifier': Parameter(Tomographic bin classifier, type: <class 'str'>, default: None [required]), 'flavor': Parameter(RailProject analysis flavor, type: <class 'str'>, default: None [required]), 'name': Parameter(Dataset name, type: <class 'str'>, default: None [required]), 'project': Parameter(RailProject name, type: <class 'str'>, default: None [required]), 'selection': Parameter(RailProject data selection, type: <class 'str'>, default: None [required]), 'summarizer': Parameter(p(z) to n(z) summarizer, type: <class 'str'>, default: None [required])}

extractor_inputs: dict = {'algo': <class 'str'>, 'classifier': <class 'str'>, 'flavor': <class 'str'>, 'project': <class 'rail.projects.project.RailProject'>, 'selection': <class 'str'>, 'summarizer': <class 'str'>}

classmethod generate_dataset_dict(**kwargs)

Return type:

tuple[list[RailProjectHolder], list[RailDatasetHolder], list[RailDatasetListHolder]]

Parameters:

**kwargs (Any) – Set Notes

Notes

dataset_list_name: str

Name for the resulting DatasetList

project_file: str

Config file for project to inspect

selections: list[str]

Selections to use

flavors: list[str]

Flavors to use

classifiers: list[str]

Flavors to use

summarizers: list[str]

Summarizers to use

Returns:

• list[RailProjectHolder] – Underlying RailProjects

• list[RailDatasetHolder] – Extracted datasets

• list[RailDatasetListHolder] – Extracted dataset lists

Parameters:

kwargs (Any)

Return type:

tuple[list[RailProjectHolder], list[RailDatasetHolder], list[RailDatasetListHolder]]

get_extractor_inputs()

Resolve the inputs needed to get the data from the configuration paramters.

For example, load RailProject configurations, resolve the set of requested interpolants, etc…

Return type:

dict[str, Any]

output_type

alias of RailNZTomoBinsDataset