Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_e2o_rev_ids(ocel, 'ob-893f8ab9')
slim_ocel_bindings
process_mining::bindings::slim_ocel_bindings
Related Examples(2)
Building a Linked OCEL
Construct an OCEL end-to-end: Declare event and object types, add events/objects with E2O/O2O relations, and export the resulting OCEL 2.0 to different formats.
Building an OCEL from CSV tables
Read events, objects, and relationships from CSV tables and build an OCEL 2.0 log. Works the same way for Pandas or Polars dataframes.
Functions in this Module(46)
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_object_type_of_id(ocel, 'ob-893f8ab9')
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_event_ids_of_type(ocel, 'pay order')
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_object_ids_of_type(ocel, 'order')
locel_construct_ocel
Reconstruct a full OCEL from a SlimLinkedOCEL. Can be expensive for large logs.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_construct_ocel(ocel, 'example')
locel_get_ob_attr_vals
Get the time-indexed history of an object attribute by name as
Panics if the index is out of bounds.
(timestamp, value) pairs. Empty if absent.Panics if the index is out of bounds.
fn locel_get_ob_attr_vals(ocel*: SlimLinkedOCEL, ob*: u32, attr_name*: String) → Vec<(DateTime, OCELAttributeValue)>
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_attr_vals(ocel, 1, 'price')
locel_get_ev_attr_val
Get the value of an event attribute by name.
Panics if the index is out of bounds.
None if the attribute does not exist.Panics if the index is out of bounds.
fn locel_get_ev_attr_val(ocel*: SlimLinkedOCEL, ev*: u32, attr_name*: String) → Nullable_OCELAttributeValue
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_attr_val(ocel, 1, 'price')
locel_get_full_ob
Get the full OCELObject (resolved type name, named time-indexed attributes, string object IDs).
Allocates. Prefer the specific
Panics if the index is out of bounds.
Allocates. Prefer the specific
locel_get_ob_* accessors for single fields.Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_full_ob(ocel, 1)
locel_get_full_ev
Get the full OCELEvent (resolved type name, named attributes, string object IDs).
Allocates. Prefer the specific
Panics if the index is out of bounds.
Allocates. Prefer the specific
locel_get_ev_* accessors for single fields.Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_full_ev(ocel, 1)
locel_get_o2o_rev
Get the reverse O2O relationships of an object (objects with an O2O to it) as
(qualifier, object_index) pairs.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_o2o_rev(ocel, 1)
locel_get_o2o
Get the outgoing O2O relationships of an object as
(qualifier, object_index) pairs.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_o2o(ocel, 1)
get_dfg_of_object_type
Get the directly-follows graph (DFG) for objects of the given object type.
Each entry is
object's timestamp-ordered activity trace. Result order is unspecified.
Each entry is
((from_activity, to_activity), count), counting adjacent pairs in eachobject's timestamp-ordered activity trace. Result order is unspecified.
fn get_dfg_of_object_type(ocel*: SlimLinkedOCEL, ob_type*: String) → Vec<((String, String), i64<uint>)>
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_dfg_of_object_type(ocel, 'order')
get_variants_of_object_type
Get all activity-trace variants for objects of the given object type, with their occurrence counts
Each entry is a tuple
connected to an object (ordered by event timestamp), and
requested type that share that exact trace.
Each entry is a tuple
(activity_trace, count), where activity_trace is the sequence of event typesconnected to an object (ordered by event timestamp), and
count is the number of objects of therequested type that share that exact trace.
fn get_variants_of_object_type(ocel*: SlimLinkedOCEL, ob_type*: String) → Vec<(Vec<String>, i64<uint>)>
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_variants_of_object_type(ocel, 'order')
get_obj_activity_trace
Get the activity trace of an object (i.e., the sequence of event types connected to the object, ordered by event timestamp)
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_obj_activity_trace(ocel, 1)
locel_get_e2o_rev
Get the reverse E2O relationships of an object (events relating to it) as
(qualifier, event_index) pairs.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_e2o_rev(ocel, 1)
locel_get_e2o
Get the E2O relationships of an event as
(qualifier, object_index) pairs.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_e2o(ocel, 1)
locel_get_ev_time
Get the timestamp of an event. Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_time(ocel, 1)
locel_get_ob_type_of
Get the object type of an object. Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_type_of(ocel, 1)
locel_get_ev_type_of
Get the event type (activity) of an event. Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_type_of(ocel, 1)
locel_get_ob_id
Get the ID string of an object. Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_id(ocel, 1)
locel_get_ev_id
Get the ID string of an event. Panics if the index is out of bounds.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_id(ocel, 1)
locel_get_ob_by_id
Look up an object by its ID string.
None if not found.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_by_id(ocel, 'ob-893f8ab9')
locel_get_ev_by_id
Look up an event by its ID string.
None if not found.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_by_id(ocel, 'ev-893f8ab9')
locel_get_obs_of_type
Get all object indices of the given object type. Empty if unknown.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_obs_of_type(ocel, 'order')
locel_get_evs_of_type
Get all event indices of the given event type. Empty if unknown.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_evs_of_type(ocel, 'pay order')
locel_get_ob_type
Get the object type specification (name + attributes), or
None if unknown.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_type(ocel, 'order')
locel_add_event_type
Add an event type with the given ordered attribute declarations.
No-op if the event type already exists.
No-op if the event type already exists.
fn locel_add_event_type(ocel*: SlimLinkedOCEL, event_type*: String, attributes: Vec<OCELTypeAttribute>) → ()
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
r4pm.bindings.locel_add_event_type(ocel, 'pay order', [{"name": 'example', "type": 'string'}])
locel_oc_perf_sojourn_per_event
Per-event sojourn time.
For each event with at least one directly-follows predecessor, the sojourn time is
ascending event id, sorted descending.
For each event with at least one directly-follows predecessor, the sojourn time is
event_time - latest_predecessor_time in integer microseconds. Returns one row(event_id, sojourn_us) per qualifying event.top_k: if Some(k), return only the k rows with the largest sojourn_us, ties broken byascending event id, sorted descending.
None returns every qualifying event.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_oc_perf_sojourn_per_event(ocel, 1)
locel_oc_perf_sync_per_event
Per-event synchronization time and the delaying object.
For each event with at least one directly-follows predecessor, the synchronization time is
earliest and latest directly-preceding event). The delaying object is the object linking the
latest predecessor (ties broken by ascending object id).
Returns one row
ascending event id, sorted descending.
For each event with at least one directly-follows predecessor, the synchronization time is
max_predecessor_time - min_predecessor_time in integer microseconds (the span between itsearliest and latest directly-preceding event). The delaying object is the object linking the
latest predecessor (ties broken by ascending object id).
Returns one row
(event_id, sync_us, delaying_object_id) per qualifying event.top_k: if Some(k), return only the k rows with the largest sync_us, ties broken byascending event id, sorted descending.
None returns every qualifying event.fn locel_oc_perf_sync_per_event(ocel*: SlimLinkedOCEL, top_k: Option<i64>) → Vec<(String, i64, String)>
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_oc_perf_sync_per_event(ocel, 1)
locel_conversion_rate
Conversion rate from
Returns the fraction of
# Errors
Returns an error if
declared, so a rate of
source_type to target_type via O2O, restricted to targets touched by activity.Returns the fraction of
source_type objects that have at least one outgoing O2O edge to atarget_type object related (via E2O) to some event of the given event type.# Errors
Returns an error if
activity names no declared event type, or if either object type is notdeclared, so a rate of
0.0 cannot mean a misspelled name.fn locel_conversion_rate(ocel*: SlimLinkedOCEL, activity*: String, source_type*: String, target_type*: String) → f64
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_conversion_rate(ocel, 'example', 'example', 'example')
locel_event_object_type_counts
Count E2O relationships per
Each entry is
by multiple qualifiers contributes once per qualifier. Pairs with zero relations are omitted.
Result row order is unspecified.
(event_type, object_type) pair.Each entry is
(event_type, object_type, count). A single (event, object) pair connectedby multiple qualifiers contributes once per qualifier. Pairs with zero relations are omitted.
Result row order is unspecified.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_event_object_type_counts(ocel)
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_event_timestamp_of_id(ocel, 'ev-893f8ab9')
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_event_type_of_id(ocel, 'ev-893f8ab9')
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_o2o_ids(ocel, 'ob-893f8ab9')
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.get_e2o_ids(ocel, 'ev-893f8ab9')
locel_get_ev_type
Get the event type specification (name + attributes), or
None if unknown.Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_type(ocel, 'pay order')
locel_get_ob_types
Get all declared object type names, in declaration order.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ob_types(ocel)
locel_get_ev_types
Get all declared event type names, in declaration order.
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_get_ev_types(ocel)
locel_delete_o2o
Remove all O2O relationships from
Returns
from_obj to to_obj (across every qualifier).Returns
true on success, false if either index is out of bounds (with a stderr warning).Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_delete_o2o(ocel, 1, 1)
locel_delete_e2o
Remove all E2O relationships between the given event and object (across every qualifier).
Returns
Returns
true on success, false if either index is out of bounds (with a stderr warning).Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_delete_e2o(ocel, 1, 1)
locel_add_o2o
Add a directed O2O (object-to-object) relationship from
Multiple qualifiers between the same
same
either index is out of bounds (with a stderr warning).
from_obj to to_obj with the given qualifier.Multiple qualifiers between the same
(from_obj, to_obj) pair are allowed. Re-adding the exactsame
(from_obj, to_obj, qualifier) triple is a no-op. Returns true on success, false ifeither index is out of bounds (with a stderr warning).
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_add_o2o(ocel, 1, 1, 'places')
locel_add_e2o
Add an E2O (event-to-object) relationship with the given qualifier.
Multiple qualifiers between the same
same
either index is out of bounds (with a stderr warning).
Multiple qualifiers between the same
(event, object) pair are allowed. Re-adding the exactsame
(event, object, qualifier) triple is a no-op. Returns true on success, false ifeither index is out of bounds (with a stderr warning).
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_add_e2o(ocel, 1, 1, 'places')
locel_add_object
Add an object and return its ObjectIndex.
The object type must have been declared via
Otherwise this returns
The object type must have been declared via
locel_add_object_type first.Otherwise this returns
None.id: If None, a UUID is assigned. Returns None if the id is already taken.attributes: Positional list of time-indexed attribute histories (one (timestamp, value) list per declared attribute, in order). Use 1970-01-01T00:00:00Z for constant/initial values. Padded with empty lists or truncated on length mismatch (with a warning).relationships: Outgoing O2O relationships as (qualifier, object_index) pairs (can also be added later via locel_add_o2o).fn locel_add_object(ocel*: SlimLinkedOCEL, object_type*: String, id: Option<String>, attributes: Vec<Vec<(DateTime, OCELAttributeValue)>>, relationships: Vec<(String, ObjectIndex)>) → Nullable_ObjectIndex
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_add_object(ocel, 'order', '893f8ab9', [[['2020-01-01T10:30:00Z', 1]]], [['example', 1]])
locel_add_event
Add an event and return its EventIndex.
The event type must have been declared via
Otherwise this returns
The event type must have been declared via
locel_add_event_type first.Otherwise this returns
None.id: If None, a UUID is assigned. Returns None if the id is already taken.attributes: Positional values in the declared attribute order. Padded with Null or truncated on length mismatch (with a warning).relationships: E2O relationships as (qualifier, object_index) pairs (can also be added later via locel_add_e2o).fn locel_add_event(ocel*: SlimLinkedOCEL, event_type*: String, time*: DateTime, id: Option<String>, attributes: Vec<OCELAttributeValue>, relationships: Vec<(String, ObjectIndex)>) → Nullable_EventIndex
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
res = r4pm.bindings.locel_add_event(ocel, 'pay order', '2020-01-01T10:30:00Z', '893f8ab9', [1], [['example', 1]])
locel_add_object_type
Add an object type with the given ordered attribute declarations.
No-op if the object type already exists.
No-op if the object type already exists.
fn locel_add_object_type(ocel*: SlimLinkedOCEL, object_type*: String, attributes: Vec<OCELTypeAttribute>) → ()
Arguments
Returns
import r4pm
ocel = r4pm.import_item('SlimLinkedOCEL','path/to/file')
r4pm.bindings.locel_add_object_type(ocel, 'order', [{"name": 'example', "type": 'string'}])
locel_new
Create a new empty SlimLinkedOCEL.
A SlimLinkedOCEL is an object-centric event log where events and objects are referenced
by integer indices (EventIndex / ObjectIndex) returned from the
and each indexed event/object is an instance of an event/object type (activity / object class)
declared beforehand with an ordered list of attributes.
A SlimLinkedOCEL is an object-centric event log where events and objects are referenced
by integer indices (EventIndex / ObjectIndex) returned from the
add_* calls,and each indexed event/object is an instance of an event/object type (activity / object class)
declared beforehand with an ordered list of attributes.
Arguments
Returns
import r4pm
res = r4pm.bindings.locel_new('example')