Skip to content

CLASS ndi.daq.metadatareader

  NDI.DAQ.METADATAREADER.BASE - a class for reading metadata related to data acquisition, such as stimulus parameter information

Superclasses

ndi.ido, ndi.documentservice

Properties

Property Description
tab_separated_file_parameter regular expression to search within epochfiles for a
identifier

Methods

Method Description
eq are 2 ndi.daq.metadatareader objects equal?
id return the identifier of an ndi.ido object
metadatareader Create a new multifunction DAQ object
ndi_unique_id Generate a unique ID number for NDI projects
newdocument create a new ndi.document for an ndi.daq.metadatareader object
readmetadata PARAMETERS = READMETADATA(NDI_DAQSYSTEM_STIMULUS_OBJ, EPOCHFILES)
readmetadatafromfile read in metadata from the file that is identified
searchquery create a search for this ndi.daq.reader object

Methods help

eq - are 2 ndi.daq.metadatareader objects equal?

TF = EQ(NDI_DAQMETADATAREADER_OBJ_A, NDI_DAQMETADATAREADER_OBJ_B)

  TF is 1 if the two objects are of the same class and have the same properties.
  TF is 0 otherwise.

id - return the identifier of an ndi.ido object

IDENTIFIER = ID(NDI_ID_OBJ)

  Returns the unique identifier of an ndi.ido object.

Help for ndi.daq.metadatareader/id is inherited from superclass NDI.IDO

metadatareader - Create a new multifunction DAQ object

D = ndi.daq.metadatareader()
   or
   D = ndi.daq.metadatareader(TSVFILE_REGEXPRESSION)

   Creates a new ndi.daq.metadatareader object. If TSVFILE_REGEXPRESSION
   is given, it indicates a regular expression to use to search EPOCHFILES
   for a tab-separated-value text file that describes stimulus parameters.

ndi_unique_id - Generate a unique ID number for NDI projects

ID = NDI_UNIQUE_ID

  Generates a unique ID character array based on the current time and a random
  number. It is a hexidecimal representation of the serial date number in
  UTC Leap Seconds time. The serial date number is the number of days since January 0, 0000 at 0:00:00.
  The integer portion of the date is the whole number of days and the fractional part of the date number
  is the fraction of days.

  ID = [NUM2HEX(SERIAL_DATE_NUMBER) '_' NUM2HEX(RAND)]

  See also: NUM2HEX, NOW, RAND

Help for ndi.daq.metadatareader.ndi_unique_id is inherited from superclass NDI.IDO

newdocument - create a new ndi.document for an ndi.daq.metadatareader object

DOC = NEWDOCUMENT(ndi.daq.metadatareader OBJ)

  Creates an ndi.document object DOC that represents the
     ndi.daq.reader object.

readmetadata - PARAMETERS = READMETADATA(NDI_DAQSYSTEM_STIMULUS_OBJ, EPOCHFILES)

Returns the parameters (cell array of structures) associated with the
  stimulus or stimuli that were prepared to be presented in epoch with file list EPOCHFILES.

  If the property 'tab_separated_file_parameter' is not empty, then EPOCHFILES will be searched for
  files that match the regular expression in 'tab_separated_file_parameter'. The tab-separated-value
  file should have the form:

  STIMID<tab>PARAMETER1<tab>PARAMETER2<tab>PARAMETER3 (etc) <newline>
  1<tab>VALUE1<tab>VALUE2<tab>VALUE3 (etc) <newline>
  2<tab>VALUE1<tab>VALUE2<tab>VALUE3 (etc) <newline>
   (etc)

  For example, a stimulus file for an interoral cannula might be:
  stimid<tab>substance1<tab>substance1_concentration<newline>
  1<tab>Sodium chloride<tab>30e-3<newline>
  2<tab>Sodium chloride<tab>300e-3<newline>
  3<tab>Quinine<tab>30e-6<newline>
  4<tab>Quinine<tab>300e-6<newline>

  This function can be overridden in more specialized stimulus classes.

readmetadatafromfile - read in metadata from the file that is identified

PARAMETERS = READMETADATAFROMFILE(NDI_DAQMETADATAREADER_OBJ, FILE)

  Given a file that matches the metadata search criteria for an ndi.daq.metadatareader
  document, this function loads in the metadata.

searchquery - create a search for this ndi.daq.reader object

SQ = SEARCHQUERY(NDI_DAQMETADATAREADER_OBJ)

  Creates a search query for the ndi.daq.metadatareader object.