Table of Contents

Namespace OpenEphys.Miniscope.Gui

Classes

CalculateMaxProjection

Computes a running per-pixel maximum-intensity projection over the input image sequence, emitting the accumulated projection for each input frame. Emit true on the maxProjectionSettings sequence to clear the accumulation (the next frame reseeds it).

CameraStatus

Camera acquisition selection.

CaptureCurrentImage

Captures the current image and saves to an image file when requested, forwarding the frame unchanged. When an explicit folder is set the frame is saved there with a timestamped name; otherwise a clone of the frame is captured and a save dialog prompts for a destination.

CircularBufferBuilder

Represents an operator that creates a circular buffer object which can be used for drawing one or multiple series.

CircularPlotPointSeries<TSource>

Provides an adapter over a circular buffer used for providing data for interactive visualizations.

CommutatorSettings

Commutator connection settings.

ConfigurationRequest

Represents a request to save or load the GUI configuration.

ConsolePanel

Renders the console log docked at the bottom of the GUI. The panel spans the full width of the window and is preceded by a draggable splitter that resizes its height.

ControlScheduler

Provides the single, process-wide scheduler used to serialize every control-plane state update in the GUI onto one dedicated thread.

CreateGuiLayout

Emits the default GuiLayout, used to seed the workflow's Layout subject.

CreateMiniscopeLog

Creates a new MiniscopeLog instance and emits it to the workflow.

DataDisplaySettings

Data panel display settings.

DataPanel

Renders the image tabs and signal tabs inside a single child region that fills the available content area.

DeserializeFromYaml

Deserializes a sequence of YAML strings into data model objects.

DffSettings

dF/F calculation settings.

FilePanel

Renders the "Recording" controls (file saving and recording), anchored to the bottom of the settings sidebar.

FileSettings

File saving settings.

GenerateRecordingFileNames

Generates a synchronized set of file names for a recording from a single file name template and PathSuffix, so that the CSV, video, and log files always share an identical base name and suffix.

GuiLayout

Snapshot of the shared GUI layout state, threaded through the panel chain each render tick. Every panel reads the fields it needs and returns an updated copy, so cross-panel coordination happens through the dataflow graph rather than through mutable static state.

HardwareSettings

Combined Miniscope and commutator settings.

ImGuiMiniscopeExtension

Represents an extension context for ImGui that initializes an ImGui context and links it to the provided ImGui context.

ImGuiMiniscopeMashupVisualizer

Represents a mashup visualizer that hosts a Dear ImGui control and coordinates rendering between the visualizer and any nested mashup visualizers.

ImGuiMiniscopeMashupVisualizerBuilder

Represents a visualizer builder that exposes a render notification sequence used to coordinate rendering between a mashup visualizer and its nested visualizers.

ImGuiMiniscopeVisualizer

Defines a visualizer that initializes an ImGui-based visualizer for Miniscope data.

ImGuiMiniscopeVisualizerBuilder

Defines a visualizer builder that constructs an ImGui-based visualizer for Miniscope data, utilizing the ImGuiMiniscopeVisualizer as its visualizer implementation.

LoadConfiguration

On each load request from a ConfigurationRequest, opens an Open File dialog and deserializes the chosen YAML file into a MiniscopeConfiguration. Downstream, split the result into the individual settings subjects.

LogError

Logs the error provided.

LogInfo

Logs the information provided.

LogPropertyChanged

Logs the information provided.

LogWarning

Logs the warning provided.

MaxProjectionSettings

Max projection settings.

MiniscopeConfiguration

Root configuration object persisted to a single JSON file and used as the source of truth for the GUI and the workflow.

MiniscopeLog

A thread-safe queue that accumulates console messages (errors, written file paths, and other notable actions) for display in the GUI. A single instance is created per GUI scope and shared through the workflow (via a BehaviorSubject): any producer can push to it directly, and the console panel reads Snapshot() to render the scrollback history.

MiniscopeSettings

Miniscope acquisition settings displayed and edited by the GUI.

MiniscopeVisualizerClosed

Emits a notification when the Open Ephys Miniscope V4 GUI visualizer window is closed.

ObserveOnControl

Observes the source sequence on the shared ControlScheduler, moving every downstream notification onto the single Miniscope control thread.

ObserveOnRecording

Observes the source sequence on the shared RecordingScheduler, moving every downstream notification onto the single Miniscope recording thread.

OverlayReference

Superimposes a saved reference image over the live image using a multi-color overlay: each grayscale source is tinted by its own user-selected color (ReferenceColor and LiveColor) and the tinted results are added together, so overlapping bright regions blend towards the combination of both colors.

OverlaySettings

Reference-image overlay settings.

RecordingScheduler

Provides the single, process-wide scheduler used to serialize every notification in the data-recording pipeline (frame delivery and the recording stop signal) onto one dedicated thread, so a TakeUntil gating the pipeline is never entered concurrently from two different threads.

SaturationSettings

Saturation overlay settings.

SaveConfiguration

On each save request from a ConfigurationRequest, opens a Save File dialog and writes the current MiniscopeConfiguration to the chosen YAML file.

SerializeToYaml

Serializes a sequence of data model objects into YAML strings.

SettingsPanel

Renders all settings panels in a collapsible sidebar and returns an updated HardwareSettings.

StatusBar

Renders the ImGui status bar controls at the top of the GUI.

UpdateLogFrameNumber

Updates the frame number stamped onto subsequent MiniscopeLog messages, then forwards each frame number unchanged.

WriteLogsToFile

Directs the MiniscopeLog instance supplied on the second input to mirror its messages to a CSV log file for as long as the sequence is subscribed. Opening and closing the file brackets a recording: the file is created when the sequence is subscribed and closed when it is unsubscribed, so every message logged in between — including any error that stops the recording — is captured for the user to look back on.

Structs

LogEntry

A single timestamped message in the console log.

RecordingFileNames

A synchronized set of file names generated for a single recording. All names share an identical base name and path suffix and differ only by file extension.

Enums

ConfigurationRequestType

Specifies the type of configuration request being made.

ImageTab

Identifies the image tab currently selected in the DataPanel.

LogLevel

Severity of a LogEntry.

RecordingMode

The recording mode selected.

SegmentMode

How a segmented recording is split into files and when it stops.