Dataset-level metadata from dataset_description.json. More...

#include <bids_dataset_description.h>

Static Public Member Functions
static BidsDatasetDescription	read (const QString &sFilePath)
	Read a dataset_description.json file.
static bool	write (const QString &sFilePath, const BidsDatasetDescription &desc)
	Write a dataset_description.json file.

Public Attributes
QString	name
QString	bidsVersion
QString	datasetType
QString	license

Detailed Description

Dataset-level metadata from dataset_description.json.

Every BIDS dataset must contain a dataset_description.json at its root. This struct captures the required and recommended fields.

Definition at line 64 of file bids_dataset_description.h.

Member Function Documentation

◆ read()

BidsDatasetDescription BidsDatasetDescription::read ( const QString & sFilePath )

static

Read a dataset_description.json file.

Parameters

[in] sFilePath Path to dataset_description.json.

Returns: Populated description, or default if file cannot be read.

Definition at line 60 of file bids_dataset_description.cpp.

◆ write()

bool BidsDatasetDescription::write	(	const QString &	sFilePath,
		const BidsDatasetDescription &	desc )

static

Write a dataset_description.json file.

Parameters

[in]	sFilePath	Output path.
[in]	desc	Dataset description to write.

Returns: true on success.

Definition at line 91 of file bids_dataset_description.cpp.

Member Data Documentation

◆ bidsVersion

QString BIDSLIB::BidsDatasetDescription::bidsVersion

BIDS specification version, e.g. "1.9.0" (REQUIRED).

Definition at line 67 of file bids_dataset_description.h.

◆ datasetType

QString BIDSLIB::BidsDatasetDescription::datasetType

"raw" or "derivative" (RECOMMENDED).

Definition at line 68 of file bids_dataset_description.h.

◆ license

QString BIDSLIB::BidsDatasetDescription::license

License identifier (RECOMMENDED).

Definition at line 69 of file bids_dataset_description.h.

◆ name

QString BIDSLIB::BidsDatasetDescription::name

Human-readable dataset name (REQUIRED).

Definition at line 66 of file bids_dataset_description.h.

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

src/libraries/bids/bids_dataset_description.h
src/libraries/bids/bids_dataset_description.cpp

Static Public Member Functions

Public Attributes