Series

Classes and tools for working with 1 dimensional data.

class lkdata.dataseries.Series(data, time_indices=None, **kwargs)

Abstract pd.Series-like extension class.

property array

Numpy array representation

describe_series(**printoptions)

Print a description of the Series instance.

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

classmethod from_pandas(data, **kwargs)

Convert a pd.Series to a DataSeries

class lkdata.dataseries.DataSeries(data, uncertainty=None, index=None, dtype=None, **kwargs)

A pandas.Series-like object with uncertainty.

Parameters:

dataarray-like, Iterable

Contains data stored in Series. If data is a dict, argument order is maintained.

uncertaintyarray-like, optional

Uncertainty in the dataset.

indexarray-like or Index (1d)

Will default to RangeIndex (0, 1, 2, …, n) if not provided. If data is dict-like and index is None, then the keys in the data are used as the index. If the index is not None, the resulting Series is reindexed with the index values.

dtypestr, numpy.dtype, or ExtensionDtype, optional

Data type for the output Series. If not specified, this will be inferred from data.

class lkdata.dataseries.BoolSeries(data, index=None, **kwargs)

pandas.Series-like object for bool datatypes with lightkurve functions.

class lkdata.dataseries.BitwiseSeries(data, code_dict=None, display_as='int', index=None, **kwargs)

pandas.Series-like object for bitwise datatypes with lightkurve functions.

Parameters:

dataarray-like, Iterable, dict, or scalar value

Contains data stored in Series. Entries are cast to the BitSet type in which integers are broken into their bits. I.e. 3 becomes {1, 2}.

code_referencedictionary, optional

A dictionary of codes with keys that are powers of 2 and values are definitions of the code.

values_displaystr, default “int”

What kind of display should be used? Must be one of “int”, “bitset”, or “detailed”. “detailed” requires code_reference to be provided, or else is identical to “bitset” which displays a set of the bits indicated by the binary representation of the integer value.

indexarray-like or Index (1d)

Values must be hashable and have the same length as data. Non-unique index values are allowed. Will default to RangeIndex (0, 1, 2, …, n) if not provided. If data is dict-like and index is None, then the keys in the data are used as the index. If the index is not None, the resulting Series is reindexed with the index values.