3 mcs_getentities.m: summary of functionality – Multichannel Systems MATLAB Manual User Manual

Page 19

Advertising
background image

Matlab and Neuroshare

20

3.3 mcs_GetEntities.m:

Summary of Functionality:

mcs_GetEntities is a function to generate a vector of entity numbers of entities with a given
characteristic.

mcs_GetEntities uses ns_GetFileInfo to produce the structure FileInfo. FileInfo contains
information about EntityCount, needed to call ns_GetEntityInfo. ns_GetEntityInfo retrieves
general entity information and type of entity saved in the structure EntityInfo that contains
EntityLabel, EntityType and ItemCount.

Usage:

[entities] = mcs_GetEntities (hFile,stream_name, varargin)

Description:

Generates a vector of entity numbers that belongs to the stream with the name stream_name
and possible of a certain entity type given in varargin from the data file referenced by hFile.

Parameters:

hFile

Handle/Identification number to an open file stream_name
for example 'elec0001', 8 letter: stream name with: 4 letters name,
4 digits stream number.

varargin

Variable length input argument list, "variable argument in" (optional)
number of entity type.

Return Values:

entities

Array of entity numbers.

Advertising