sadda.corpus¶
The corpus surface — projects, bundles, tiers, annotations. STABLE tier: won't break across minor versions.
Project loaders live at the top of the sadda package:
new_project
builtin
¶
Creates a new sadda project at path (which must not already exist).
Returns a sadda.Project handle ready for .add_speaker(...) /
.add_session(...) / .add_bundle(...) calls.
Source: crates/python/src/lib.rs:3540
open_project
builtin
¶
Opens an existing sadda project at path. Applies any pending schema
migrations first, writing a corpus.db.bak.<old_version> backup.
Source: crates/python/src/lib.rs:3550
Project¶
Project ¶
A sadda project: a directory holding audio, derived signals, attachments,
and a SQLite-backed corpus database. Construct via sadda.new_project(...)
or sadda.open_project(...).
Source: crates/python/src/lib.rs:1983
name
property
¶
Project's human-readable name (from the singleton project row).
Source: crates/python/src/lib.rs:2002
audit_user
property
¶
User string written into audit_log.user for mutations on this
connection. Defaults to "local".
Source: crates/python/src/lib.rs:2278
add_bundle
method descriptor
¶
Registers a bundle by copying source_audio_path into the project's
signals/original/ directory and recording its metadata in the corpus
database. Returns the new bundle's id. Optional kwargs attach the
bundle to a Session / Speaker and set a JSON extra payload.
Source: crates/python/src/lib.rs:2011
add_bundle_split
method descriptor
¶
Splits a (typically very long) WAV into contiguous chunks of about
chunk_seconds each, writing every chunk into the project as its own
bundle named "<name_prefix>_NNN". The source is streamed, so memory
stays flat regardless of length — this is how a file too large to load
whole still gets in. Chunk audio preserves the source format; the final
chunk holds the remainder. Returns the new bundle ids in order.
Source: crates/python/src/lib.rs:2036
bundles
method descriptor
¶
Lists all bundles in id order.
Source: crates/python/src/lib.rs:2048
rename_bundle
method descriptor
¶
Renames a bundle's display name. The underlying WAV file is
left untouched. Raises if bundle_id does not exist or the
new name is empty / whitespace-only.
Source: crates/python/src/lib.rs:2068
delete_bundle
method descriptor
¶
Permanently deletes a bundle and all its tiers, annotations,
derived signals, and processing-run audit rows. Best-effort
removes the underlying WAV from disk. No-op if bundle_id
does not exist.
Source: crates/python/src/lib.rs:2059
load_audio
method descriptor
¶
Loads the audio file for a bundle.
Source: crates/python/src/lib.rs:2184
add_speaker
method descriptor
¶
Inserts a Speaker row. Returns the new speaker's id.
Source: crates/python/src/lib.rs:2193
speakers
method descriptor
¶
Lists all speakers in id order.
Source: crates/python/src/lib.rs:2212
get_speaker
method descriptor
¶
Fetches a single speaker by id.
Source: crates/python/src/lib.rs:2220
add_session
method descriptor
¶
add_session(name, *, started_at=None, ended_at=None, location=None, instrument_id=None, protocol_id=None, notes=None, extra=None)
Inserts a Session row. Returns the new session's id.
Source: crates/python/src/lib.rs:2235
sessions
method descriptor
¶
Lists all sessions in id order.
Source: crates/python/src/lib.rs:2260
get_session
method descriptor
¶
Fetches a single session by id.
Source: crates/python/src/lib.rs:2268
add_instrument
method descriptor
¶
Inserts an instrument (microphone / interface), optionally with a
Calibration. Returns the new instrument's id.
Source: crates/python/src/lib.rs:2140
instruments
method descriptor
¶
Lists all instruments in id order.
Source: crates/python/src/lib.rs:2159
get_instrument
method descriptor
¶
Fetches a single instrument by id.
Source: crates/python/src/lib.rs:2167
bundle_calibration
method descriptor
¶
Resolves a bundle's calibration via bundle → session →
instrument. None means levels for that bundle are dB-FS only.
Source: crates/python/src/lib.rs:2176
add_tier
method descriptor
¶
Inserts a Tier row. type is one of interval, point, reference,
continuous_numeric, continuous_vector, categorical_sampled.
Returns the new tier's id.
Source: crates/python/src/lib.rs:2332
tiers
method descriptor
¶
Lists tiers, optionally restricted to a single bundle.
Source: crates/python/src/lib.rs:2359
get_tier
method descriptor
¶
Fetches a single tier by id.
Source: crates/python/src/lib.rs:2367
rename_tier
method descriptor
¶
Renames a tier's display name. Raises if tier_id does not exist
or the new name is empty / whitespace-only.
Source: crates/python/src/lib.rs:2376
delete_tier
method descriptor
¶
Deletes a tier and all of its annotations (intervals / points /
references) and any dense derived-signal sidecar. Raises if the
tier has child tiers (delete those first) or if tier_id does
not exist.
Source: crates/python/src/lib.rs:2386
add_interval
method descriptor
¶
add_interval(tier_id, start_seconds, end_seconds, *, label=None, parent_annotation_id=None, status=None, note=None, extra=None)
Inserts an interval annotation. Enforces parent-child cardinality at
insert time; raises ValueError on cardinality violation.
Source: crates/python/src/lib.rs:2397
intervals
method descriptor
¶
Lists intervals for a tier in (start_seconds, id) order.
Source: crates/python/src/lib.rs:2423
add_point
method descriptor
¶
add_point(tier_id, time_seconds, *, label=None, parent_annotation_id=None, status=None, note=None, extra=None)
Inserts a point annotation. Enforces parent-child cardinality.
Source: crates/python/src/lib.rs:2436
points
method descriptor
¶
Lists points for a tier in (time_seconds, id) order.
Source: crates/python/src/lib.rs:2460
add_reference
method descriptor
¶
add_reference(tier_id, target_kind, target_id, *, label=None, parent_annotation_id=None, extra=None)
Inserts a reference annotation pointing at another row via
(target_kind, target_id).
Source: crates/python/src/lib.rs:2473
references_for
method descriptor
¶
Lists references for a tier in id order. Named references_for
rather than references (which collides with Rust's ref family
of grep targets).
Source: crates/python/src/lib.rs:2496
query ¶
Returns the rows of a sparse tier as a polars.DataFrame. Columns
depend on the tier's type:
interval: id, tier_id, start_seconds, end_seconds, duration_seconds, label, parent_annotation_id, extrapoint: id, tier_id, time_seconds, label, parent_annotation_id, extrareference: id, tier_id, target_kind, target_id, label, parent_annotation_id, extra
Dense tiers (continuous_numeric / continuous_vector / categorical_sampled) live in Parquet sidecars and arrive in B3.
write_continuous_numeric
method descriptor
¶
Writes a continuous_numeric Parquet sidecar from a 1-D float64
NumPy array and inserts the matching DerivedSignal row. Returns
the new DerivedSignal id. Errors with TypeError-style messages if
the tier isn't continuous_numeric or already has a sidecar.
Source: crates/python/src/lib.rs:3197
write_continuous_vector
method descriptor
¶
Writes a continuous_vector Parquet sidecar from a 2-D float64
NumPy array of shape [n_frames, n_dims].
Source: crates/python/src/lib.rs:3227
write_categorical_sampled
method descriptor
¶
Writes a categorical_sampled Parquet sidecar from a list of
strings.
Source: crates/python/src/lib.rs:3255
read_continuous_numeric
method descriptor
¶
Reads a continuous_numeric sidecar back into a 1-D float64 NumPy
array.
Source: crates/python/src/lib.rs:3213
read_continuous_vector
method descriptor
¶
Reads a continuous_vector sidecar back into a 2-D float64 NumPy
array.
Source: crates/python/src/lib.rs:3241
read_categorical_sampled
method descriptor
¶
Reads a categorical_sampled sidecar back into a list of strings.
Source: crates/python/src/lib.rs:3267
dense_path
method descriptor
¶
Returns the absolute filesystem path of a dense tier's Parquet
sidecar (as a string), or None if no sidecar has been written yet.
Use with polars.scan_parquet(path) for zero-engine-API reads.
Source: crates/python/src/lib.rs:3285
derived_signal
method descriptor
¶
Returns the DerivedSignal row for a tier, or None if no sidecar has been written yet.
Source: crates/python/src/lib.rs:3275
import_textgrid
method descriptor
¶
Imports a Praat TextGrid into bundle_id. Each Praat tier becomes a
new Tier row (interval or point); each annotation becomes an
annotation_interval / annotation_point row. JSON sentinels in
labels are decoded back into the extra field. Returns the list of
new tier IDs in import order. Records a processing_run row for
audit provenance.
Source: crates/python/src/lib.rs:3296
export_textgrid
method descriptor
¶
Writes a Praat TextGrid for bundle_id's sparse tiers to path.
If tier_ids is given, only those tiers are exported. Dense tiers
(continuous_numeric / vector / categorical_sampled) are skipped.
Reference tiers are exported as IntervalTiers with a degenerate
[0.0, 0.001] time span plus a JSON sentinel carrying their
(target_kind, target_id).
Source: crates/python/src/lib.rs:3309
import_eaf
method descriptor
¶
Imports an ELAN .eaf into bundle_id. Tier hierarchy is preserved
via EAF's PARENT_REF ↔ tier.parent_id. Point tiers are
recovered from degenerate [t, t+1ms] alignable annotations via
a ≤2ms heuristic. Reference tiers (Symbolic_Association
linguistic type) come back as reference tiers. Returns the new
tier IDs in import order (parents first per topological sort).
Records a processing_run row for audit provenance.
Source: crates/python/src/lib.rs:3327
export_eaf
method descriptor
¶
Writes an ELAN .eaf (EAF 2.8) for bundle_id's sparse tiers to
path. If tier_ids is given, only those tiers are exported.
Dense tiers (continuous_numeric / vector / categorical_sampled)
are skipped. Interval tiers with parents use the Included_In
stereotype; reference tiers become REF_ANNOTATION tiers with
the Symbolic_Association stereotype + a JSON sentinel encoding
(target_kind, target_id).
Source: crates/python/src/lib.rs:3341
record_processing_run
method descriptor
¶
record_processing_run(bundle_id, kind, processor_id, *, parameters=None, input_tier_ids=None, output_tier_ids=None, output_signal_ids=None, weights_checksum=None)
Records a completed processing run for audit provenance and
returns its id. The engine fills in the sadda version, timestamps,
and active recipe id. kind is one of dsp_algorithm,
ml_model, clinical_measure, plugin, live_recording.
Source: crates/python/src/lib.rs:2082
processing_runs
method descriptor
¶
Returns a bundle's processing-run timeline (provenance), oldest first.
Source: crates/python/src/lib.rs:2107
citations
method descriptor
¶
Returns the literature citations for the analyses a bundle used, deduplicated by processor and ordered by first use. Uncited processors (imports, recording) are omitted.
Source: crates/python/src/lib.rs:2130
extract_embeddings
method descriptor
¶
E12: resolve model_id (sadda/… / local://… / hf://…), run it
as an embedding extractor over bundle_id's audio, and store the
result as a new continuous_vector tier tier_name, recording an
ml_model processing run. Returns the new tier id. (Provisional.)
Source: crates/python/src/lib.rs:2317
pin_refdist
method descriptor
¶
Pins a reference distribution id to a specific version in
project.toml, so the project reopens against the same data for
reproducibility (C7). Overwrites any existing pin for that id.
Source: crates/python/src/lib.rs:2291
refdist_pins
method descriptor
¶
The reference distributions this project has pinned, as a
{id: version} dict.
Source: crates/python/src/lib.rs:2299
remove_refdist_pin
method descriptor
¶
Removes a reference-distribution pin; returns whether one existed.
Source: crates/python/src/lib.rs:2309
set_audit_user
method descriptor
¶
Sets the user string written into audit_log.user for subsequent
mutations on this connection.
Source: crates/python/src/lib.rs:2284
Data types¶
Audio ¶
Audio data loaded from disk. Samples are interleaved float32 in [-1.0, 1.0];
for stereo the layout is [L0, R0, L1, R1, ...]. Construct via
sadda.load_wav(path).
Source: crates/python/src/lib.rs:81
__doc__
class-attribute
¶
__doc__ = 'Audio data loaded from disk. Samples are interleaved float32 in `[-1.0, 1.0]`;\nfor stereo the layout is `[L0, R0, L1, R1, ...]`. Construct via\n`sadda.load_wav(path)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
channels
property
¶
Number of audio channels (1 = mono, 2 = stereo, …).
Source: crates/python/src/lib.rs:96
duration_seconds
property
¶
Audio duration in seconds.
Source: crates/python/src/lib.rs:108
n_frames
property
¶
Number of audio frames (samples per channel).
Source: crates/python/src/lib.rs:102
samples
property
¶
Interleaved samples as a 1-D float32 NumPy array.
For stereo the layout is [L0, R0, L1, R1, ...].
Source: crates/python/src/lib.rs:115
from_samples
staticmethod
¶
Construct an Audio from a 1-D float32 NumPy array of interleaved samples
(values in [-1.0, 1.0]). For stereo the layout is [L0, R0, L1, R1, ...].
Source: crates/python/src/lib.rs:134
mono
method descriptor
¶
Mono downmix as a new single-channel Audio (multi-channel frames are
averaged). Returns an Audio — not a raw array — so it can be passed
straight back into dsp.* functions; reach the samples via
audio.mono().samples. Note most dsp.* and clinical.* functions
already mono-mix internally, so you rarely need to call this first.
Source: crates/python/src/lib.rs:124
resample
method descriptor
¶
Return a new Audio resampled to target_hz (Hz), preserving the
channel count. Uses the engine's FFT-domain resampler — the same one the
VAD path uses to reach a model's required rate — so any-rate audio can be
fed to a fixed-rate model (e.g. forced alignment's 16 kHz net). A no-op
copy when the rate already matches.
Source: crates/python/src/lib.rs:153
AudioProbe ¶
Header-only summary of a WAV file (see sadda.probe_wav): its size without
the cost of decoding. Lets a caller gauge a file's in-memory footprint
before loading it.
Source: crates/python/src/lib.rs:3488
Initialize self. See help(type(self)) for accurate signature.
__doc__
class-attribute
¶
__doc__ = "Header-only summary of a WAV file (see `sadda.probe_wav`): its size without\nthe cost of decoding. Lets a caller gauge a file's in-memory footprint\nbefore loading it."
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
decoded_bytes
property
¶
Bytes a full decode would occupy (interleaved f32): the RAM cost of loading this file whole.
Source: crates/python/src/lib.rs:3518
duration_seconds
property
¶
Duration in seconds.
Source: crates/python/src/lib.rs:3512
n_frames
property
¶
Number of frames (samples per channel).
Source: crates/python/src/lib.rs:3507
Bundle ¶
One recording inside a [Project]: audio header plus optional Session +
Speaker FKs and a freeform JSON extra payload. Read-only view; mutate
via Project.add_bundle(...).
Source: crates/python/src/lib.rs:175
__doc__
class-attribute
¶
__doc__ = 'One recording inside a [`Project`]: audio header plus optional Session +\nSpeaker FKs and a freeform JSON `extra` payload. Read-only view; mutate\nvia `Project.add_bundle(...)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
audio_relative_path
property
¶
Audio file path relative to the project root.
Source: crates/python/src/lib.rs:194
n_frames
property
¶
Number of audio frames (samples per channel).
Source: crates/python/src/lib.rs:209
session_id
property
¶
Optional Session id this bundle belongs to.
Source: crates/python/src/lib.rs:214
speaker_id
property
¶
Optional Speaker id this bundle recorded.
Source: crates/python/src/lib.rs:219
Tier ¶
One annotation tier: the header row in tier. Annotation rows
belonging to it live in annotation_interval / annotation_point /
annotation_reference (for the three sparse types) or a Parquet sidecar
(the three dense types, landing in B3). Read-only view; create via
Project.add_tier(...).
Source: crates/python/src/lib.rs:366
__doc__
class-attribute
¶
__doc__ = 'One annotation tier: the header row in `tier`. Annotation rows\nbelonging to it live in `annotation_interval` / `annotation_point` /\n`annotation_reference` (for the three sparse types) or a Parquet sidecar\n(the three dense types, landing in B3). Read-only view; create via\n`Project.add_tier(...)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
cardinality
property
¶
Parent-child cardinality (one_to_one | one_to_many | many_to_one
| none).
Source: crates/python/src/lib.rs:402
created_at
property
¶
ISO 8601 UTC creation timestamp.
Source: crates/python/src/lib.rs:417
name
property
¶
Human-readable tier name (unique within a bundle).
Source: crates/python/src/lib.rs:385
type
property
¶
Tier type: one of interval, point, reference,
continuous_numeric, continuous_vector, categorical_sampled.
Source: crates/python/src/lib.rs:391
Interval ¶
One interval annotation. Read-only view; create via
Project.add_interval(...).
Source: crates/python/src/lib.rs:436
__doc__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
duration_seconds
property
¶
Duration in seconds (end_seconds - start_seconds).
Source: crates/python/src/lib.rs:465
parent_annotation_id
property
¶
Parent annotation id in the parent tier.
Source: crates/python/src/lib.rs:475
processing_run_id
property
¶
Provenance link to the producing ProcessingRun (e.g. a criterion
run), or None for a hand-made annotation.
Source: crates/python/src/lib.rs:491
status
property
¶
Annotation status (a rubric-defined status string), or None.
Source: crates/python/src/lib.rs:480
Point ¶
One point annotation. Read-only view; create via
Project.add_point(...).
Source: crates/python/src/lib.rs:516
__doc__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
parent_annotation_id
property
¶
Parent annotation id.
Source: crates/python/src/lib.rs:545
processing_run_id
property
¶
Provenance link to the producing ProcessingRun (e.g. a criterion
run), or None for a hand-made annotation.
Source: crates/python/src/lib.rs:561
status
property
¶
Annotation status (a rubric-defined status string), or None.
Source: crates/python/src/lib.rs:550
Reference ¶
One reference annotation. Read-only view; create via
Project.add_reference(...).
Source: crates/python/src/lib.rs:582
__doc__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
parent_annotation_id
property
¶
Parent annotation id.
Source: crates/python/src/lib.rs:616
target_kind
property
¶
Target kind: bundle | session | speaker | tier | annotation.
Source: crates/python/src/lib.rs:601
DerivedSignal ¶
Registration row for a Parquet sidecar holding a dense tier's data.
Created automatically by the Project.write_continuous_numeric /
write_continuous_vector / write_categorical_sampled methods.
Source: crates/python/src/lib.rs:1668
__doc__
class-attribute
¶
__doc__ = "Registration row for a Parquet sidecar holding a dense tier's data.\nCreated automatically by the `Project.write_continuous_numeric` /\n`write_continuous_vector` / `write_categorical_sampled` methods."
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
created_at
property
¶
ISO 8601 UTC creation timestamp.
Source: crates/python/src/lib.rs:1717
relative_path
property
¶
Path to the Parquet sidecar, relative to the project root.
Source: crates/python/src/lib.rs:1687
sample_rate_hz
property
¶
Sample rate in Hz; None for non-sampled / variable-rate signals.
Source: crates/python/src/lib.rs:1702
Speaker ¶
A person who produced speech in the project (participant, patient, case
subject, …). Read-only view; create via Project.add_speaker(...).
Source: crates/python/src/lib.rs:244
__doc__
class-attribute
¶
__doc__ = 'A person who produced speech in the project (participant, patient, case\nsubject, …). Read-only view; create via `Project.add_speaker(...)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
birth_year
property
¶
Birth year (full integer year).
Source: crates/python/src/lib.rs:268
created_at
property
¶
ISO 8601 UTC creation timestamp.
Source: crates/python/src/lib.rs:283
name
property
¶
Human-readable name or pseudonymous identifier.
Source: crates/python/src/lib.rs:258
Session ¶
A recording session — a time-bounded block during which one or more
bundles were captured. Read-only view; create via Project.add_session(...).
Source: crates/python/src/lib.rs:296
__doc__
class-attribute
¶
__doc__ = 'A recording session — a time-bounded block during which one or more\nbundles were captured. Read-only view; create via `Project.add_session(...)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
created_at
property
¶
ISO 8601 UTC creation timestamp.
Source: crates/python/src/lib.rs:350
instrument_id
property
¶
FK into the instrument table.
Source: crates/python/src/lib.rs:330
Instrument ¶
A capture instrument (microphone, interface) and its optional
calibration. Returned by Project.instruments() / get_instrument().
Source: crates/python/src/lib.rs:1906
__doc__
class-attribute
¶
__doc__ = 'A capture instrument (microphone, interface) and its optional\ncalibration. Returned by `Project.instruments()` / `get_instrument()`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
calibration
property
¶
Calibration, if the instrument has been calibrated.
Source: crates/python/src/lib.rs:1935
created_at
property
¶
ISO 8601 UTC creation timestamp.
Source: crates/python/src/lib.rs:1945
Calibration ¶
Microphone / signal-chain calibration mapping dB-FS to dB-SPL.
Construct with Calibration(reference_spl_db=…, reference_db_fs=…).
Source: crates/python/src/lib.rs:1855
__doc__
class-attribute
¶
__doc__ = 'Microphone / signal-chain calibration mapping dB-FS to dB-SPL.\nConstruct with `Calibration(reference_spl_db=…, reference_db_fs=…)`.'
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
reference_db_fs
property
¶
dB-FS measured for that tone.
Source: crates/python/src/lib.rs:1880
reference_spl_db
property
¶
SPL of the calibration tone (dB-SPL).
Source: crates/python/src/lib.rs:1875
__new__
builtin
¶
Create and return a new object. See help(type) for accurate signature.
spl_offset_db
method descriptor
¶
dB added to a dB-FS reading to obtain dB-SPL.
Source: crates/python/src/lib.rs:1884
to_spl
method descriptor
¶
Converts a relative dB-FS value to calibrated dB-SPL.
Source: crates/python/src/lib.rs:1888
ProcessingRun ¶
One row of a bundle's provenance timeline — an analysis that ran on
the bundle. Returned by Project.processing_runs(bundle_id).
Source: crates/python/src/lib.rs:1738
__doc__
class-attribute
¶
__doc__ = "One row of a bundle's provenance timeline — an analysis that ran on\nthe bundle. Returned by `Project.processing_runs(bundle_id)`."
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
finished_at
property
¶
ISO 8601 UTC finish timestamp, if recorded.
Source: crates/python/src/lib.rs:1787
kind
property
¶
dsp_algorithm | ml_model | clinical_measure | plugin | live_recording.
Source: crates/python/src/lib.rs:1757
output_tier_ids
property
¶
JSON array of produced tier ids, if any.
Source: crates/python/src/lib.rs:1777
parameters
property
¶
JSON parameters (processor-specific shape), if any.
Source: crates/python/src/lib.rs:1772
processor_id
property
¶
Reverse-DNS processor id, e.g. sadda.dsp.pitch.autocorrelation.
Source: crates/python/src/lib.rs:1762
processor_version
property
¶
Sadda version at run time.
Source: crates/python/src/lib.rs:1767
started_at
property
¶
ISO 8601 UTC start timestamp.
Source: crates/python/src/lib.rs:1782
Citation ¶
A literature reference for an analysis a bundle used. Returned by
Project.citations(bundle_id), suitable for a paper's reference list.
Source: crates/python/src/lib.rs:1808
__doc__
class-attribute
¶
__doc__ = "A literature reference for an analysis a bundle used. Returned by\n`Project.citations(bundle_id)`, suitable for a paper's reference list."
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__module__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
__sadda_stability__
class-attribute
¶
str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.
processor_id
property
¶
The processor this cites (matches ProcessingRun.processor_id).
Source: crates/python/src/lib.rs:1817
reference
property
¶
Human-readable reference string.
Source: crates/python/src/lib.rs:1822
weblink
property
¶
A resolvable weblink: the https://doi.org/<doi> URL when there's a DOI,
otherwise an explicit canonical URL. None only if neither is known.
Source: crates/python/src/lib.rs:1833