Skip to content

CLASS ndi.file.type.mfdaq_epoch_channel

  MFDAQ_EPOCH_CHANNEL - create a new MFDAQ_EPOCH_CHANNEL file document

  OBJ = MFDAQ_EPOCH_CHANNEL(INPUT1, ...)

  Creates a new MFDAQ_EPOCH_CHANNEL object. If INPUT1 is a character string,
  then it is assumed that this object should be built from information stored in a
  file. If INPUT1 is a structure, then it is assumed that this object should be built
  with a channel_structure (provided in INPUT1) as in
  ndi.file.type.mfdaq_epoch_channel.create_properties().

Superclasses

none

Properties

Property Description
channel_information

Methods

Method Description
channelgroupdecoding decode channel list into the groups where the channels are stored
create_properties make a structure that describes segmented storage of MFDAQ data
mfdaq_epoch_channel create a new MFDAQ_EPOCH_CHANNEL file document
readFromFile read an mfdaq_epoch_channel object from a file
writeToFile write the channel_structure to a file

Methods help

channelgroupdecoding - decode channel list into the groups where the channels are stored

[GROUPS, CHANNEL_INDEXES_IN_GROUPS, CHANNEL_INDEXES_IN_OUTPUT]=...
    CHANNELGROUPDECODING(CHANNEL_INFO, CHANNEL_TYPE, CHANNELS)

create_properties - make a structure that describes segmented storage of MFDAQ data

OBJ = CREATE_PROPERTIES(OBJ, CHANNEL_STRUCTURE, ...)

  CHANNEL_STRUCTURE has fields 'name','type', 'sample_rate', 
    'offset', and 'scale'

  This function also takes name/value pairs that modify the
  default behavior.
  -----------------------------------------------------------------
  | Parameters (default)            | Description                  |
  |---------------------------------|------------------------------|
  | analog_in_channels_per_group    | Number of channels per group |
  |   (400)                         |  for analog input channels   |
  | analog_out_channels_per_group   | Number of channels per group |
  |   (400)                         |  for analog output channels  |
  | auxiliary_in_channels_per_group | Number of channels per group |
  |   (400)                         |  for auxiliary input channels|
  | auxiliary_out_channels_per_group| Number of channels per group |
  |   (400)                         |  for auxiliary output        |
  | analog_out_channels_per_group   | Number of channels per group |
  |   (400)                         |  for analog output channels  |
  | ditial_in_channels_per_group    | Number of channels per group |
  |   (512)                         |  for digital input channels  |
  | digital_out_channels_per_group  | Number of channels per group |
  |   (512)                         |  for digital output channels |

mfdaq_epoch_channel - create a new MFDAQ_EPOCH_CHANNEL file document

OBJ = MFDAQ_EPOCH_CHANNEL(INPUT1, ...)

  Creates a new MFDAQ_EPOCH_CHANNEL object. If INPUT1 is a character string,
  then it is assumed that this object should be built from information stored in a
  file. If INPUT1 is a structure, then it is assumed that this object should be built
  with a channel_structure (provided in INPUT1) as in
  ndi.file.type.mfdaq_epoch_channel.create_properties().

    Documentation for ndi.file.type.mfdaq_epoch_channel/mfdaq_epoch_channel
       doc ndi.file.type.mfdaq_epoch_channel

readFromFile - read an mfdaq_epoch_channel object from a file

MFDAQ_EPOCH_CHANNEL_OBJ = READFROMFILE(MFDAQ_EPOCH_CHANNEL_OBJ, FILENAME)

  Reads the properties of an MFDAQ_EPOCH_CHANNEL object from FILENAME.

  Example:
    mfdaq_epoch_channel_obj = mfdaq_epoch_channel_obj.readFromFile(filename);

writeToFile - write the channel_structure to a file

[B,ERRMSG] = WRITETOFILE(MFDAQ_EPOCH_CHANNEL_OBJ, FILENAME)

  Writes the properties of an MFDAQ_EPOCH_CHANNEL object to the binary file
  FILENAME. If the operation is successful, B is 1. Otherwise, it is 0. ERRMSG
  contains any error message that describes the error state.

  Example:
  [b,errmsg] = mfdaq_epoch_channel_obj.writeToFile(filename);
  if ~b, disp(['The function failed with an error: ' errmsg '.']); end;