2 mcs_info.m: summary of functionality – Multichannel Systems MATLAB Manual User Manual

Page 18

Advertising
background image

Points to Discuss

19

3.2 mcs_Info.m: Summary of Functionality

mcs_Info is a function to show information about the streams that are in a certain file given
as stream, type, n, TimeSpan and infotext.

The output contains the stream name as a eight digits sequence, the type of entity, n is the
number of channels per stream, TimeSpan gives you information about the duration of data
collection and infotext contains optional information about the data type.

mcs_Info uses ns_GetFileInfo to receive the information EntityCount saved in FileInfo.
EntityCount is necessary to call the next function ns_GetEntityInfo and to get EntityLabel
and EntityType as a part of entity. EntityLabel includes some information about the stream
that is connected to EntityType in a structure entities.

The function returns a table with information if the number of output arguments is 0.
Otherwise the information is given as a matrix. That might be helpful if you like to work
on with the given values.

Usage:

[varargout] = mcs_Info(hFile, varargin)

Description:

Generates information about entities. This information is returned in a structured output
via CommandWindow (matrix or table).

Parameters:

hFile

Handle/Identification number to an open file.

Varargin

Variable length input argument list,"variable argument in".


Return Values:

- without return value: information is shown on the display as a table.

- with return value: cell matrix of this information.

Advertising