Class Recording

Namespace

DotFly

Assembly

DotFly.Engine.dll

A parsed .dfs recording.

public sealed class Recording

Inheritance

object

Recording

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Header

Header.

public required RecordingHeader Header { get; init; }

Property Value

RecordingHeader

Injections

Injections.

public required IReadOnlyList<RecordedInjection> Injections { get; init; }

Property Value

IReadOnlyList<RecordedInjection>

Inputs

Input writes.

public required IReadOnlyList<RecordedInput> Inputs { get; init; }

Property Value

IReadOnlyList<RecordedInput>

Outputs

Output frames.

public required IReadOnlyList<RecordedOutput> Outputs { get; init; }

Property Value

IReadOnlyList<RecordedOutput>

Ports

Port definitions.

public required IReadOnlyList<RecordedPort> Ports { get; init; }

Property Value

IReadOnlyList<RecordedPort>

Resets

Steps at which the simulation was reset/restored (the restored step).

public required IReadOnlyList<long> Resets { get; init; }

Property Value

IReadOnlyList<long>

Spikes

All spikes as (step, neuron), in order.

public required IReadOnlyList<(long Step, int Neuron)> Spikes { get; init; }

Property Value

IReadOnlyList<(long Step, int Neuron)>

Methods

Read(string)

Reads a .dfs file.

public static Recording Read(string path)

Parameters

path string

Returns

Recording

Replay(Simulation)

Re-applies the recorded input writes and injections to sim at their recorded steps (relative to the simulation's current step being the recording's start step). Ports are matched by id and must have been created in the same order with the same sets.

public void Replay(Simulation sim)

Parameters

sim Simulation

WriteFramesCsv(string, int)

Writes the output frames of one port as CSV: one row per frame, columns frame,step,neural_ms,v0..vK-1. Feature vectors for training readout adapters.

public void WriteFramesCsv(string path, int port)

Parameters

path string

port int

WriteSpikesCsv(string)

Writes the spikes as CSV (step,neuron).

public void WriteSpikesCsv(string path)

Parameters

path string