stream_graph.TimeSetDF

class stream_graph.TimeSetDF(df=None, disjoint_intervals=True, discrete=None, default_closed='both')

A DataFrame implementation of a TimeSet.

Parameters

df: pandas.DataFrame or Iterable, default=None

If a DataFrame it should contain two columns ts, tf and optionally a column itype of elements ‘right’, ‘left’, ‘both’, ‘neither’ that indicate. If an Iterable it should produce (ts, tf) tuples of two timestamps (Real) with ts < tf and optionally a third element ‘right’, ‘left’, ‘both’, ‘neither’ that indicates the interval-type.

disjoint_intervals: Bool, default=False

Defines if all intervals are disjoint.

discreteBool or None, default=None

default_closed‘right’, ‘left’, ‘both’, ‘neither’, default=’left’

Attributes

df

discrete

Designate if the TimeSet is on discrete Time.

instantaneous

Defines if the Time Set is instantaneous.

is_merged_

is_sorted_

size

Returns the size of the TimeSet.

sort_df_

sorted_df

Methods

copy(self[, deep])	Returns a deep or shallow copy of the current TimeSet.
discretize(self[, bins, bin_size])	Returns a discrete version of the current TimeSet.
sort_df(self, sort_by)	Retrieve, store if no-order and produce a sorted version of the df

issuperset

__class__

alias of abc.ABCMeta

__delattr__(self, name, /)

Implement delattr(self, name).

__dir__()

default dir() implementation

__eq__(self, value, /)

Return self==value.

__format__()

default object formatter

__ge__(self, value, /)

Return self>=value.

__getattribute__(self, name, /)

Return getattr(self, name).

__gt__(self, value, /)

Return self>value.

__hash__(self, /)

Return hash(self).

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(self, value, /)

Return self<=value.

__lt__(self, value, /)

Return self<value.

__ne__(self, value, /)

Return self!=value.

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__(self, /)

Return repr(self).

__setattr__(self, name, value, /)

Implement setattr(self, name, value).

__sizeof__()

size of object in memory, in bytes

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

copy(self, deep=True)

Returns a deep or shallow copy of the current TimeSet.

Parameters

deepBool

Returns

timeset_copyTimeSet

Returns a deep or shallow copy of the current TimeSet.

discretize(self, bins=None, bin_size=None)

Returns a discrete version of the current TimeSet.

Parameters

binsIterable or None.

If None, step should be provided. If Iterable it should contain n+1 elements that declare the start and the end of all (continuous) bins.

bin_sizeInt or datetime

If bins is provided this argument is ommited. Else declare the size of each bin.

Returns

timeset_discreteTimeSet

Returns a discrete version of the TimeSet.

binslist

A list of the created bins.

property instantaneous

Defines if the Time Set is instantaneous.

sort_df(self, sort_by)

Retrieve, store if no-order and produce a sorted version of the df

Examples using stream_graph.TimeSetDF

Initialize and print a simple stream-graph