DISP3DLIB Namespace Reference

3-D brain visualisation using the Qt RHI rendering backend. More...

Classes
class	GeometryInfo
	This class holds static methods for sensor-to-mesh mapping and surface constrained distance calculation on a mesh. More...
class	Interpolation
	This class holds methods for creating distance-based weight matrices and for interpolating signals. More...
struct	ElectrodeContact
	Single contact on a depth electrode shaft. More...
struct	ElectrodeArray
	One electrode array — sEEG depth shaft, ECoG strip, or ECoG grid. More...
class	ElectrodeObject
	Data model for stereotactic depth electrode (sEEG) visualization. More...
class	SliceObject
	Data model for a single 2-D MRI volume slice. More...
class	VideoOverlay
	Camera-facing textured quad rendered at a focus point in the 3-D scene. More...
struct	SceneLayer
	Opaque, type-erased handle to a layer payload. More...
class	MultimodalScene
	Host-app-agnostic controller that owns the ordered renderable set and dispatches picks back to the producing layer. More...
struct	PickResult
	Uniform payload for object-id picking across the multimodal scene. More...
class	RtSensorDataWorker
	Background worker for real-time sensor data streaming. More...
class	RtSensorInterpolationMatWorker
	Background worker for computing sensor field mapping matrices. More...
class	RtSourceDataWorker
	Background worker for real-time source estimate streaming. More...
class	RtSourceInterpolationMatWorker
	Background worker for computing source interpolation matrices. More...

Typedefs
using	FieldMap = FWDLIB::FwdFieldMap

Enumerations
enum class	ElectrodeLayout { Depth = 0 , Strip , Grid }
	Geometry layout for an electrode array. More...
enum class	SliceOrientation { Axial = 0 , Coronal = 1 , Sagittal = 2 }
	Orientation for an orthogonal MRI slice. More...
enum class	SceneLayerKind {   BrainSurface = 0 , MriSlice , Sensor , Helmet ,   Electrode , Dipole , SourceOverlay , Network ,   Custom }
	Modality of a layer in the multimodal scene. More...
enum class	PickKind {   None = 0 , CorticalVertex , ElectrodeContact , Sensor ,   MriVoxel , Dipole , Bem , Custom }
	Kind of object that produced a 3-D pick. More...

Functions
const char *	buildDateTime ()
const char *	buildHash ()
const char *	buildHashLong ()
bool	isHit (const PickResult &r) noexcept

Detailed Description

3-D brain visualisation using the Qt RHI rendering backend.

Typedef Documentation

FieldMap

using DISP3DLIB::FieldMap = FWDLIB::FwdFieldMap

Deprecated

Use FWDLIB::FwdFieldMap instead.

Definition at line 24 of file field_map.h.

Enumeration Type Documentation

ElectrodeLayout

enum class DISP3DLIB::ElectrodeLayout

strong

Geometry layout for an electrode array.

Added in v2.3.0 to extend the original sEEG-only ElectrodeObject with ECoG strip and grid topologies. The renderer interprets the layout field on ElectrodeArray:

• Depth — render the cylindrical shaft + sphere instances per contact (the only mode supported in v2.2.0).
• Strip — render sphere instances only, no shaft (a 1×N ECoG strip).
• Grid — render sphere instances on a regular gridRows × gridCols lattice, optionally with a translucent quad mesh linking the contacts as a visual reference.

Enumerator
Depth	Stereotactic depth electrode (cylinder + contacts).
Strip	1×N ECoG strip — spheres only.
Grid	gridRows × gridCols ECoG grid — spheres + optional mesh.

Definition at line 90 of file electrodeobject.h.

PickKind

enum class DISP3DLIB::PickKind

strong

Kind of object that produced a 3-D pick.

The enum is intentionally flat (rather than a class hierarchy) so that PickResult stays a trivially copyable POD that can be queued, signalled, and serialized without owning any GPU resources.

Enumerator
None	No hit.
CorticalVertex	Vertex on a cortical surface.
ElectrodeContact	Contact on an sEEG / ECoG / EEG electrode.
Sensor	MEG / EEG sensor element.
MriVoxel	Voxel on an MRI ortho slice.
Dipole	Dipole renderable.
Bem	Triangle on a BEM surface.
Custom	User-supplied renderable.

Definition at line 49 of file pickresult.h.

SceneLayerKind

enum class DISP3DLIB::SceneLayerKind

strong

Modality of a layer in the multimodal scene.

The scene draws layers in modality order so opaque geometry (cortex, BEM, MRI slices) renders before translucent overlays (source-estimate, sensor, dipole, electrode highlights, network graph).

Enumerator
BrainSurface	Cortical or BEM surface.
MriSlice	MRI orthogonal slice.
Sensor	MEG/EEG sensor positions.
Helmet	MEG helmet shell.
Electrode	sEEG / ECoG electrode array.
Dipole	Dipole renderable.
SourceOverlay	Source-estimate activation overlay.
Network	Connectivity network graph.
Custom	Host-app-specific renderable.

Definition at line 57 of file multimodalscene.h.

SliceOrientation

enum class DISP3DLIB::SliceOrientation

strong

Orientation for an orthogonal MRI slice.

Enumerator
Axial	XY plane (Z = const).
Coronal	XZ plane (Y = const).
Sagittal	YZ plane (X = const).

Definition at line 60 of file sliceobject.h.

Function Documentation

buildDateTime()

const char * DISP3DLIB::buildDateTime

(

)

Returns build date and time.

Definition at line 29 of file disp3D_global.cpp.

buildHash()

const char * DISP3DLIB::buildHash

(

)

Returns abbreviated build git hash.

Definition at line 30 of file disp3D_global.cpp.

buildHashLong()

const char * DISP3DLIB::buildHashLong

(

)

Returns full build git hash.

Definition at line 31 of file disp3D_global.cpp.

isHit()

bool DISP3DLIB::isHit ( const PickResult & r )

inlinenoexcept

Returns

True iff the pick reports a hit (kind != None).

Definition at line 124 of file pickresult.h.