BIDSLIB::AbstractFormatReader Class Reference

The AbstractFormatReader class provides a common interface for reading raw neurophysiology data from various file formats (EDF, BrainVision, etc.) used in BIDS datasets. More...

#include <bids_abstract_format_reader.h>

Public Types
using	UPtr = std::unique_ptr<AbstractFormatReader>

Public Member Functions
virtual	~AbstractFormatReader ()=default
	Virtual destructor.
virtual bool	open (const QString &sFilePath)=0
	Open and parse the file header. Must be called before reading data.
virtual FIFFLIB::FiffInfo	getInfo () const =0
	Return measurement metadata as FiffInfo.
virtual Eigen::MatrixXf	readRawSegment (int iStartSampleIdx, int iEndSampleIdx) const =0
	Read a segment of raw data.
virtual long	getSampleCount () const =0
	Return total number of samples across the recording.
virtual float	getFrequency () const =0
	Return the sampling frequency in Hz.
virtual int	getChannelCount () const =0
	Return the number of measurement channels.
virtual FIFFLIB::FiffRawData	toFiffRawData () const =0
	Convert the entire dataset to a FiffRawData structure.
virtual QString	formatName () const =0
	Return a descriptive name for the format (e.g. "EDF", "BrainVision").
virtual bool	supportsExtension (const QString &sExtension) const =0
	Check whether this reader can handle the given file extension.

Protected Member Functions
	AbstractFormatReader ()=default

Detailed Description

The AbstractFormatReader class provides a common interface for reading raw neurophysiology data from various file formats (EDF, BrainVision, etc.) used in BIDS datasets.

Subclasses implement format-specific parsing and expose the data uniformly as FIFF structures.

Definition at line 74 of file bids_abstract_format_reader.h.

Inheritance diagram for BIDSLIB::AbstractFormatReader:

Member Typedef Documentation

UPtr

using BIDSLIB::AbstractFormatReader::UPtr = std::unique_ptr<AbstractFormatReader>

Definition at line 77 of file bids_abstract_format_reader.h.

Constructor & Destructor Documentation

~AbstractFormatReader()

virtual BIDSLIB::AbstractFormatReader::~AbstractFormatReader ( )

virtualdefault

Virtual destructor.

AbstractFormatReader()

BIDSLIB::AbstractFormatReader::AbstractFormatReader ( )

protecteddefault

Member Function Documentation

formatName()

virtual QString BIDSLIB::AbstractFormatReader::formatName ( ) const

pure virtual

Return a descriptive name for the format (e.g. "EDF", "BrainVision").

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

getChannelCount()

virtual int BIDSLIB::AbstractFormatReader::getChannelCount ( ) const

pure virtual

Return the number of measurement channels.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

getFrequency()

virtual float BIDSLIB::AbstractFormatReader::getFrequency ( ) const

pure virtual

Return the sampling frequency in Hz.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

getInfo()

virtual FIFFLIB::FiffInfo BIDSLIB::AbstractFormatReader::getInfo ( ) const

pure virtual

Return measurement metadata as FiffInfo.

Returns

FiffInfo populated from the native format header.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

getSampleCount()

virtual long BIDSLIB::AbstractFormatReader::getSampleCount ( ) const

pure virtual

Return total number of samples across the recording.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

open()

virtual bool BIDSLIB::AbstractFormatReader::open ( const QString & sFilePath )

pure virtual

Open and parse the file header. Must be called before reading data.

Parameters

[in]

sFilePath

Absolute path to the primary data file.

Returns

True if the file was opened and parsed successfully.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

readRawSegment()

virtual Eigen::MatrixXf BIDSLIB::AbstractFormatReader::readRawSegment ( int iStartSampleIdx, int iEndSampleIdx ) const

pure virtual

Read a segment of raw data.

Parameters

[in]	iStartSampleIdx	First sample index (0-based, inclusive).
[in]	iEndSampleIdx	Last sample index (0-based, exclusive).

Returns

Matrix of shape (n_channels x n_samples) with calibrated physical values.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

supportsExtension()

virtual bool BIDSLIB::AbstractFormatReader::supportsExtension ( const QString & sExtension ) const

pure virtual

Check whether this reader can handle the given file extension.

Parameters

[in]

sExtension

File extension including dot (e.g. ".edf", ".vhdr").

Returns

True if this reader supports the extension.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

toFiffRawData()

virtual FIFFLIB::FiffRawData BIDSLIB::AbstractFormatReader::toFiffRawData ( ) const

pure virtual

Convert the entire dataset to a FiffRawData structure.

Returns

FiffRawData populated with info, calibrations, and sample bounds.

Implemented in BIDSLIB::BrainVisionReader, and BIDSLIB::EDFReader.

---

The documentation for this class was generated from the following file:

• src/libraries/bids/readers/bids_abstract_format_reader.h