trendminer.layer module¶

This module only contains the utility class Layer

class trendminer.layer.Layer(id: str, start_date: datetime.datetime, end_date: datetime.datetime, included_tags: List[trendminer.data_reference.DataReference], is_base_layer: bool)¶

Bases: object

A layer is defined by a time range and the tags that are visible.

end_date() → datetime.datetime¶

Retrieve the end date provided at initialisation time

Returns

The end date of this layer

id() → str¶

Retrieve the identifier provided at initialisation time

Returns

The identifier of this layer

included_data_references() → List[trendminer.data_reference.DataReference]¶

Retrieve the tag list provided at initialisation time

Returns

The tags in this layer as a list of DataReferences

is_base_layer() → bool¶

Check if this layer is a base layer

Returns

Whether this layer is a base layer

start_date() → datetime.datetime¶

Retrieve the start date provided at initialisation time

Returns

The start date of this layer