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

#include <bids_coordinate_system.h>

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

Detailed Description

Coordinate system metadata from *_coordsystem.json.

Describes the spatial reference frame used for electrode positions.

Definition at line 63 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 60 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 92 of file bids_coordinate_system.cpp.

Member Data Documentation

◆ associatedImagePath

QString BIDSLIB::BidsCoordinateSystem::associatedImagePath

Relative path to associated T1w image (OPTIONAL).

Definition at line 69 of file bids_coordinate_system.h.

◆ description

QString BIDSLIB::BidsCoordinateSystem::description

Description of the coordinate system (RECOMMENDED).

Definition at line 67 of file bids_coordinate_system.h.

◆ processingDescription

QString BIDSLIB::BidsCoordinateSystem::processingDescription

How coordinates were obtained (RECOMMENDED).

Definition at line 68 of file bids_coordinate_system.h.

◆ system

QString BIDSLIB::BidsCoordinateSystem::system

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

Definition at line 65 of file bids_coordinate_system.h.

◆ units

QString BIDSLIB::BidsCoordinateSystem::units

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

Definition at line 66 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

Static Public Member Functions

Public Attributes