Series Collections#

Classes and tools for working with collections of Series products.

class lkdata.seriescollection.SeriesCollection(data, time_indices=None, row_indices=None, col_indices=None, **kwargs)[source]#

Abstract dataclass for frame-like data with time and multiple series

property array#

Numpy array representation with shape (ntime, nseries)

describe_collection(**printoptions)[source]#

Print a description of the SeriesCollection instance.

This description prints information about the temporal and spatial indices available in the SeriesCollection. It also prints out any additional user-assigned properties given via keyword arguments on initialization.

classmethod from_pandas(data, **kwargs)[source]#

Convert a pd.DataFrame to a SeriesCollection

property nseries#

Number of series in the SeriesCollection

class lkdata.seriescollection.DataSeriesCollection(data, uncertainty=None, time_indices=None, row_indices=None, col_indices=None, **kwargs)[source]#
Args:

data: Union[List, np.ndarray], uncertainty: Union[List, np.ndarray] = None, index: pd.MultiIndex = None, columns: pd.MultiIndex = None, time_indices: Union[Dict, List, None] = None, row_indices: Union[Dict, List, None] = None, col_indices: Union[Dict, List, None] = None, dtype: type = float

class lkdata.seriescollection.BoolSeriesCollection(*args, **kwargs)[source]#

A Cube object which contains boolean values with time and 2 spatial dimensions.

Args:

data: Union[List, np.ndarray], index: pd.MultiIndex = None, columns: pd.MultiIndex = None, time_indices: Union[Dict, List, None] = None, row_indices: Union[Dict, List, None] = None, col_indices: Union[Dict, List, None] = None,

class lkdata.seriescollection.BitwiseSeriesCollection(*args, **kwargs)[source]#

A Cube object which contains bitwise values with time and 2 spatial dimensions.

Args:

data: Union[List, np.ndarray], index: pd.MultiIndex = None, columns: pd.MultiIndex = None, time_indices: Union[Dict, List, None] = None, row_indices: Union[Dict, List, None] = None, col_indices: Union[Dict, List, None] = None, display_as: str = “int”

property styler#

pd.Styler object associated with this BitwiseSeriesCollection.

The Styler allows for customized display of the data in HTML format.

Returns:
pd.Styler

The associated Styler object, or None if not set.