MATLAB API reference¶

The MATLAB binding mirrors the Python API one-to-one — a parity test (matlab/test_api_parity.m, run in CI) asserts that every public method of mef3io.Reader / mef3io.Writer corresponds to the Python method of the same name and carries help text, so the two never drift.

The authoritative in-product docs are the class help, available in MATLAB via:

doc mef3io.Reader        % or:  help mef3io.Reader
help mef3io.Writer/write

For usage and every method's arguments, see the MATLAB guide; the semantics (NaN gaps, precision inference, in-segment append, the strict writeInt32 contract, encryption levels) are identical to Python because both call the same C++ core.

Method correspondence¶

Python	MATLAB
`Reader.channels`	`Reader.channels`
`Reader.info`	`Reader.info`
`Reader.read`	`Reader.read`
`Reader.read_raw`	`Reader.readRaw`
`Reader.segments`	`Reader.segments`
`Reader.toc`	`Reader.toc`
`Reader.records`	`Reader.records`
`Writer.write`	`Writer.write`
`Writer.write_int32`	`Writer.writeInt32`
`Writer.write_annotations`	`Writer.writeAnnotations`
`mef3io.archive_session`	`mef3io.archiveSession`
`mef3io.extract_session`	`mef3io.extractSession`
`mef3io.recover_session`	`mef3io.recoverSession`

Durability and recovery¶

mef3io.Writer takes Durability ('fast', the default, or 'full'), matching the Python durability= argument. These files are built by appending for days to months, so the append is the hot path; 'fast' performs no flushes, as every MEF writer before this one did.

mef3io.recoverSession is the counterpart — it makes a session's block index and data agree again after an unclean shutdown, rebuilding missing index entries from the RED block headers. Dry run unless Apply=true.

w = mef3io.Writer(p, Overwrite=true, Durability='fast');   % the default
w.writeInt32('ch1', counts, 0.1, t0, 512);
delete(w)

summary = mef3io.recoverSession(p);                        % dry run
summary = mef3io.recoverSession(p, Apply=true);

Still Python-only

Validator / validate_session / repair_session have no MATLAB surface yet (see issue #18). Reading, writing, appending, archiving, extracting and recovering are at parity.