Skip to content
heliaPROFILER
Reference
HELIA

fixture_capture

What a run captures from the board: the capture result, its timing and memory, and the power and PSRAM observations a capture can carry.

Every name on this page is imported from helia_profiler.

API tier: experimental

Generated from the src/helia_profiler tree f38e378c801d34438affb680257217e0b58d2cd1.

Machine-readable model

class

FixturePowerSync

Python

Explicit firmware GPIO wiring; constructing this never opens hardware.

src/helia_profiler/fixtures/power.py:25

FixturePowerSync(sync_gpio_pin: int, state_gpio_pin: int, go_gpio_pin: int, protocol_version: int = 2) -> None

dataclass

Explicit firmware GPIO wiring; constructing this never opens hardware.

API tier: experimental

class

FixturePsramObservation

Python

API tier: experimental

src/helia_profiler/fixtures/psram.py:72

FixturePsramObservation(base_address: int, size_bytes: int, clock_hz: int, active_addresses: tuple[int, ...]) -> None

dataclass

API tier: experimental

class

FixtureTiming

Python

API tier: experimental

src/helia_profiler/fixtures/capture.py:105

FixtureTiming(
    ticks: int,
    iterations: int,
    warmups: int,
    timer_hz: int,
    settle_ticks: int,
    cpu_hz: int,
    timing_scope: FixtureTimingScope,
) -> None

dataclass

API tier: experimental

class

FixtureBatchCompletion

Python

Observed protocol-v2 transitions on the instrument's native sample counter.

src/helia_profiler/fixtures/power.py:105

FixtureBatchCompletion(
    protocol_version: int,
    counter_domain: str,
    sample_rate: int,
    ready_sample: int,
    go_ack_sample: int,
    gate_rise_sample: int,
    gate_fall_sample: int,
    done_sample: int,
    raw: FixtureFile,
) -> None

dataclass

Observed protocol-v2 transitions on the instrument’s native sample counter.

API tier: experimental

class

FixtureMemory

Python

API tier: experimental

src/helia_profiler/fixtures/capture.py:116

FixtureMemory(capacity: int, after_io_access: int, after_warmup: int, after_invoke: int) -> None

dataclass

API tier: experimental

class

FixtureRailEnergy

Python

API tier: experimental

src/helia_profiler/fixtures/power.py:120

FixtureRailEnergy(
    iterations: int,
    scope: str,
    rail: str,
    instrument_serial: str,
    subtraction: str,
    duration_s: float,
    mean_power_w: float,
    mean_current_a: float,
    energy_j: float,
    energy_per_iteration_j: float,
    raw: FixtureFile,
    completion: FixtureBatchCompletion | None = None,
) -> None

dataclass

API tier: experimental

class

FixtureCaptureResult

Python

API tier: experimental

src/helia_profiler/fixtures/capture.py:124

FixtureCaptureResult(
    state: str,
    timing_scope: FixtureTimingScope,
    output: FixtureFile | None = None,
    status: int | None = None,
    checksum: int | None = None,
    timing: FixtureTiming | None = None,
    memory: FixtureMemory | None = None,
    artifacts: tuple[FixtureFile, ...] = (),
    error: str | None = None,
    outputs: tuple[FixtureFile, ...] = (),
    arena_scan: tuple[tuple[int, int], ...] = (),
    psram_weights: FixturePsramObservation | None = None,
    rail_energy: FixtureRailEnergy | None = None,
) -> None

dataclass

API tier: experimental

Machine-readable: fixture_capture.json · fixture_capture.md, complete and lossless.