API Reference

Core Types

Fundamental types for coordinates, units, and domains.

Coordinate	A position on a timeline, defined by a value and unit.
CoordinateSpec
CoordinateValue
IdCoordinate	A Coordinate that carries the ID of the timeline it belongs to.
Domain	The temporal domain of a timeline.
TimeUnit	Units of measurement for coordinates.
NumberType	The numeric type used for coordinate values.
EventType	Whether an event is an instant or interval.
ScopedId	An identifier with a scope prefix and local part.
IdGenerator	Generates unique IDs within a given scope.

Timeline classes for all six domain/modality combinations.

Timeline	A positive coordinate axis with events and nested child timelines.
ContinuousLogicalTimeline	A logical timeline with continuous coordinates.
DiscreteLogicalTimeline	A logical timeline with discrete (integer) coordinates.
ContinuousPhysicalTimeline	A physical timeline with continuous coordinates.
DiscretePhysicalTimeline	A physical timeline with discrete (integer) coordinates.
ContinuousGraphicalTimeline	A graphical timeline with continuous coordinates.
DiscreteGraphicalTimeline	A graphical timeline with discrete (integer) coordinates.
LogicalTimeline	A timeline representing logical/musical time.
PhysicalTimeline	A timeline representing physical/acoustic time.
GraphicalTimeline	A timeline representing graphical/spatial coordinates.
BeatGrid	A metrical grid as a ContinuousLogicalTimeline in quarters.

Functions for transforming coordinates between units.

ConversionMap	Abstract base class for coordinate conversion maps.
ScalarMap	Pure scaling transformation: y = scalar * x.
LinearMap	Affine transformation: y = scalar * x + offset.
ShiftMap	Pure offset transformation: y = x + offset.
TableMap	Lookup table with interpolation between anchor points.
ChainMap	Composition of multiple maps: f(g(h(x))).
PiecewiseMap	Map defined by different maps on different intervals.
SecondsToSamples	Convert seconds to audio samples by multiplying by sample rate.

Classes for connecting and aligning timelines.

TimelineGroup	Container for commensurable timelines.
PerfectAlignment	DEPRECATED: TimelineGroup no longer uses per-timeline alignment objects.
AlignmentBundle	The primary entry point for all alignment workflows.
AlignmentAnchor	A coordinate pair associating one coordinate on timeline A with one
MatchClaim	A claim that two events or coordinates on different timelines correspond.
MatchMetadata	Provenance information for a match claim.
MatchGraph	A graph of MatchClaims connecting events across timelines/groups.
MatchStamp	A synchronized timestamp across multiple timelines.
MatchLine	Ordered sequence of MatchStamps for a source timeline.
WarpMap	Bidirectional coordinate warping derived from alignment data.
ClaimFilter	Reusable filter for querying MatchClaims and related objects.
TimelineIdGenerator	Generates systematic timeline IDs based on type.

Data ingestion from various file formats.

Loader	Abstract base class for loading music representations.
EventData	PyArrow-based storage for timeline events.
EventStore	Abstract base class for collections of EventData.
SingleStore	Store wrapper for a single EventData.
DictStore	Generic EventStore with arbitrary named EventData tables.
AudioLoader	Load audio file metadata for creating physical timelines.
AudioInfo	Metadata for an audio file.
RepoVizzLoader	Load RepoVizz XML manifests or single CSV files for creating physical timelines.
RepoVizzInfo	Parsed metadata from a RepoVizz CSV file (legacy mode).
EepNotesLoader	Loader for EEP `.notes` alignment files.
MatchfileLoader	Load Vienna Match (.match) alignment files via partitura.
TiliaJsonLoader	Loader for TiLiA JSON annotation exports.
TiliaDictStore	`DictStore` subclass with convenience properties for TiLiA timeline types.