pm4py.statistics.sojourn_time.log package

Submodules

pm4py.statistics.sojourn_time.log.get module

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.statistics.sojourn_time.log.get.Parameters(value)[source]

Bases: enum.Enum

An enumeration.

ACTIVITY_KEY = 'pm4py:param:activity_key'
AGGREGATION_MEASURE = 'aggregationMeasure'
BUSINESS_HOURS = 'business_hours'
START_TIMESTAMP_KEY = 'pm4py:param:start_timestamp_key'
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'
WEEKENDS = 'weekends'
WORKCALENDAR = 'workcalendar'
WORKTIMING = 'worktiming'
pm4py.statistics.sojourn_time.log.get.apply(log: pm4py.objects.log.obj.EventLog, parameters: Optional[Dict[Union[str, pm4py.statistics.sojourn_time.log.get.Parameters], Any]] = None) Dict[str, float][source]

Gets the sojourn time per activity on an event log object

Parameters
  • dataframe – Pandas dataframe

  • parameters – Parameters of the algorithm, including: - Parameters.ACTIVITY_KEY => activity key - Parameters.START_TIMESTAMP_KEY => start timestamp key - Parameters.TIMESTAMP_KEY => timestamp key - Parameters.BUSINESS_HOURS => calculates the difference of time based on the business hours, not the total time.

    Default: False

    • Parameters.WORKTIMING => work schedule of the company (provided as a list where the first number is the start
      of the work time, and the second number is the end of the work time), if business hours are enabled

      Default: [7, 17] (work shift from 07:00 to 17:00)

    • Parameters.WEEKENDS => indexes of the days of the week that are weekend

      Default: [6, 7] (weekends are Saturday and Sunday)

    • Parameters.AGGREGATION_MEASURE => performance aggregation measure (sum, min, max, mean, median)

Returns

Sojourn time dictionary

Return type

soj_time_dict

Module contents

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.