pymovements.Dataset.compute_properties#

Dataset.compute_properties(event_properties: str | tuple[str, dict[str, Any]] | list[str | tuple[str, dict[str, Any]]], name: str | None = None, verbose: bool = True) Dataset[source]#

Calculate an event property for and add it as a column to the event dataframe.

Alias for pymovements.Dataset.compute_event_properties()

Parameters:
  • event_properties (str | tuple[str, dict[str, Any]] | list[str | tuple[str, dict[str, Any]]]) – The event properties to compute.

  • name (str | None) – Process only events that match the name. (default: None)

  • verbose (bool) – If True, show a progress bar. (default: True)

Returns:

Returns self, useful for method cascading.

Return type:

Dataset

Raises:

UnknownMeasure – If event_properties includes an unknwon measure. See Sample Measures and Event Measures for an overview of supported measures.