Type Reference

Types & Structures

Browse all 101 types used throughout the library. See where each type is used as input or output.

101

Total Types

Structs

Enums

Structs(46)

AggregatedEventTimestamps

Aggregated event counts per timestamp bin, grouped by activity.

1 output

AlignmentOptions

Options for computing alignment

4 inputs

AlignmentResult

Alignment Result

2 outputs

AlphaPPPConfig

Algorithm parameters for Alpha+++

1 input

Arc

Arc in a Petri net Connecting a transition and a place (or the other way around)

AttributeChange

A single attribute value change at a point in time.

Connection

A discovered connection between two entities, with timestamps. Only source and target are materialized (not the full intermediate path).

ConnectionEquivalenceClass

A group of schemas that connect the same set of (source, target) pairs.

CostFunction

Cost function for alignment moves. Defines the cost of model moves, log moves, synchronous moves, and silent moves.

DirectlyFollowsGraph

A directly-follows graph of [`Activity`]s. Graph containing a set of activities, a set of directly-follows relations, a set of start activities, and a set of end activities. Both, the number of occurrences of activities and of directly follows relations are annotated with their frequency.

3 inputs

1 output

DiscoveredSchema

One enumerated schema with its computed stats and equivalence class.

DottedChartData

Result of [`get_dotted_chart`], containing the plotted points grouped by color.

1 output

DottedChartOptions

Options for [`get_dotted_chart`].

1 input

DottedChartPoints

A series of (x, y) coordinates for one color group in a dotted chart.

DuckDbImportOptions

Options controlling how an OCEL is streamed into a `DuckDB` database.

3 inputs

EventTimestampOptions

Options for [`get_event_timestamps`].

1 input

FitnessResult

Alignment Fitness Result

1 output

ObjectAttributeChanges

Time-stamped attribute change history for a single OCEL object.

1 output

OCDeclareArc

OC-DECLARE Constraint arc/edge between two nodes (i.e., activities)

1 input

OCDeclareArcLabel

Object Involvement Label of an OC-DECLARE arc

OCDeclareDiscoveryOptions

Options for the automatic discovery of OC-DECLARE constraints

1 input

OCDirectlyFollowsGraph

An object-centric directly-follows graph containing a [`DirectlyFollowsGraph`] for each object type involved.

1 output

OCELEvent

OCEL Event

1 output

OCELEventAttribute

OCEL Event Attributes

OCELObject

OCEL Object

1 output

OCELObjectAttribute

OCEL Object Attribute Describing a named value _at a certain point in time_

OCELRelationship

OCEL Relationship (qualified; referring back to an [`OCELObject`])

OCELType

OCEL Event/Object Type

OCELTypeAttribute

OCEL Attribute types

OCELTypeStats

Statistics on the event and object types of an OCEL

1 output

PathConnectionParams

Parameters for connection finding.

1 input

PathSchemaConnections

Connections of a single schema, with metrics and throughput.

1 output

PathSchemaDiscovery

Result of [`discover_path_schemas`].

1 output

PathSchemaQuery

A discovery query: source/target types, max schema length, and connection params.

1 input

PathSchemaTypeGraph

The OCEL type graph: typed nodes and qualified relationship edges.

1 output

PathSchemaTypeNode

A node (event or object type) of the OCEL type graph, with its entity count.

PetriNet

A Petri net of [`Place`]s and [`Transition`]s Bipartite graph of [`Place`]s and [`Transition`]s with [`Arc`]s connecting them, as well as initial and final [`Marking`]s

6 inputs

1 output

Place

Place in a Petri net

ProcessTree

Object-centric process tree struct that contains [`Node`] as root

2 inputs

ProcessVariant

A process variant (activity sequence with its frequency)

ResolvedPathSchema

A self-contained, serializable path schema: edges are embedded, so no [`TypeGraph`] is needed to interpret or traverse it. Produced via [`PathSchema::resolve`].

1 input

ResolvedStep

One step of a [`ResolvedPathSchema`]: a typed edge plus traversal direction.

SchemaStats

Metrics plus optional throughput for a single schema.

Transition

Transition in a Petri net

TypeEdge

A directed, typed edge in the type graph (a qualified E2O or O2O relationship type).

VariantAlignmentResult

Alignment result for a single trace variant

Enums(17)

AlignmentMove

A single alignment step

DottedChartColorAxis

Color-axis mode for the dotted chart.

DottedChartXAxis

X-axis mode for the dotted chart.

DottedChartYAxis

Y-axis mode for the dotted chart.

EventSelection

Strategy for choosing target events when several are reachable from one source.

Node

Node in a process tree

O2OMode

O2O Mode for OC-DECLARE Discovery Determines to what extent object-to-object (O2O) relationships are considered

OCDeclareArcType

OC-DECLARE Arc Direction/Type Models temporal relationships

OCDeclareReductionMode

Mode for reducing OC-DECLARE constraints

1 input

OCELAttributeValue

OCEL Attribute Values

TemporalConstraint

Temporal constraint applied along a path.

TypeRef

A reference to an OCEL type: an event type or an object type, by name. Type-level analogue of [`EntityRef`] (which references an instance). Event and object types live in separate namespaces, so the same name can denote both; carrying the kind here keeps them distinct everywhere a type is named.

1 input