BIDSLIB::BidsCoordinateSystem Struct Reference

Coordinate system metadata from *_coordsystem.json. More...

#include <bids_coordinate_system.h>

Public Member Functions
FIFFLIB::FiffCoordTrans	toFiffCoordTrans (int fromFrame=FIFFV_COORD_MRI, int toFrame=FIFFV_COORD_HEAD) const
	Convert parsed transform to a FiffCoordTrans.

Static Public Member Functions
static BidsCoordinateSystem	readJson (const QString &sFilePath)
	Read a BIDS *_coordsystem.json file.
static bool	writeJson (const QString &sFilePath, const BidsCoordinateSystem &cs)
	Write a BIDS *_coordsystem.json file.

Public Attributes
QString	system
QString	units
QString	description
QString	processingDescription
QString	associatedImagePath
Eigen::Matrix4d	transform

Detailed Description

Coordinate system metadata from *_coordsystem.json.

Describes the spatial reference frame used for electrode positions.

Definition at line 71 of file bids_coordinate_system.h.

Member Function Documentation

readJson()

BidsCoordinateSystem BidsCoordinateSystem::readJson ( const QString & sFilePath )

static

Read a BIDS *_coordsystem.json file.

Parameters

[in]

sFilePath

Path to the coordsystem.json file.

Returns

Populated coordinate system, or default if file cannot be read.

Definition at line 61 of file bids_coordinate_system.cpp.

toFiffCoordTrans()

FIFFLIB::FiffCoordTrans BidsCoordinateSystem::toFiffCoordTrans	(	int	fromFrame = FIFFV_COORD_MRI,
		int	toFrame = FIFFV_COORD_HEAD ) const

Convert parsed transform to a FiffCoordTrans.

Parameters

[in]	fromFrame	Source coordinate frame (default FIFFV_COORD_MRI = 5).
[in]	toFrame	Destination coordinate frame (default FIFFV_COORD_HEAD = 4).

Returns

FiffCoordTrans populated with the parsed 4x4 matrix.

Definition at line 168 of file bids_coordinate_system.cpp.

writeJson()

bool BidsCoordinateSystem::writeJson ( const QString & sFilePath, const BidsCoordinateSystem & cs )

static

Write a BIDS *_coordsystem.json file.

Parameters

[in]	sFilePath	Output path.
[in]	cs	Coordinate system metadata.

Returns

true on success.

Definition at line 128 of file bids_coordinate_system.cpp.

Member Data Documentation

associatedImagePath

QString BIDSLIB::BidsCoordinateSystem::associatedImagePath

Relative path to associated T1w image (OPTIONAL).

Definition at line 77 of file bids_coordinate_system.h.

description

QString BIDSLIB::BidsCoordinateSystem::description

Description of the coordinate system (RECOMMENDED).

Definition at line 75 of file bids_coordinate_system.h.

processingDescription

QString BIDSLIB::BidsCoordinateSystem::processingDescription

How coordinates were obtained (RECOMMENDED).

Definition at line 76 of file bids_coordinate_system.h.

system

QString BIDSLIB::BidsCoordinateSystem::system

e.g. "ACPC", "MNI305", "Other" (REQUIRED for iEEG).

Definition at line 73 of file bids_coordinate_system.h.

transform

Eigen::Matrix4d BIDSLIB::BidsCoordinateSystem::transform

4x4 affine transform (identity if not provided).

Definition at line 78 of file bids_coordinate_system.h.

units

QString BIDSLIB::BidsCoordinateSystem::units

"m", "mm", or "cm" (REQUIRED for iEEG).

Definition at line 74 of file bids_coordinate_system.h.

---

The documentation for this struct was generated from the following files:

• src/libraries/bids/bids_coordinate_system.h
• src/libraries/bids/bids_coordinate_system.cpp