rail.plotting.dataset module

class rail.plotting.dataset.RailDataset

Bases: DynamicClass

Base class for datasets

Subclasses should implement the data_types data member to show what the expected data are.

For example:

data_types = dict(
    truth: np.ndarray,
    point_estimate: np.ndarry,
)

data_types: dict[str, type] = {}

classmethod full_class_name()

Return the full name of the class, including the parent module

Return type:

str

sub_classes: dict[str, type[DynamicClass]] = {'RailCatMagnitudesDataset': <class 'rail.plotting.cat_plotters.RailCatMagnitudesDataset'>, 'RailCatTruthAndMagnitudesDataset': <class 'rail.plotting.cat_plotters.RailCatTruthAndMagnitudesDataset'>, 'RailCatTruthDataset': <class 'rail.plotting.cat_plotters.RailCatTruthDataset'>, 'RailDataset': <class 'rail.plotting.dataset.RailDataset'>}

classmethod validate_inputs(**kwargs)

Return type:

None

Parameters:

kwargs (Any)