Skip to content

CLASS ndi.daq.reader

  NDI_DAQREADER - A class for objects that read samples for NDI_DAQSYSTEM objects

Superclasses

ndi.ido, did.ido, ndi.documentservice

Properties

Property Description
identifier

Methods

Method Description
epochclock return the ndi.time.clocktype objects for an epoch
epochclock_ingested return the ndi.time.clocktype objects for an ingested epoch
eq tests whether 2 ndi.daq.reader objects are equal
getingesteddocument return the ndi.document with the data for an ingested epoch
id return the identifier of an DID.IDO object
ingest_epochfiles create a document that describes data read by an ndi.daq.reader
newdocument create a new ndi.document for an ndi.daq.reader object
reader create a new ndi.daq.reader object
searchquery create a search for this ndi.daq.reader object
t0_t1 return the t0_t1 (beginning and end) epoch times for an epoch
t0_t1_ingested return the t0_t1 (beginning and end) epoch times for an ingested epoch
unique_id Generate a unique ID number for DID databases (Static method)
verifyepochprobemap Verifies EPOCHPROBEMAP is compatible with device and data on disk

Methods help

epochclock - return the ndi.time.clocktype objects for an epoch

EC = EPOCHCLOCK(NDI_DAQREADER_OBJ, EPOCHFILES)

  Return the clock types available for this epoch as a cell array
  of ndi.time.clocktype objects (or sub-class members).

  For the generic ndi.daq.reader, this returns a single clock
  type 'no_time';

  See also: ndi.time.clocktype

epochclock_ingested - return the ndi.time.clocktype objects for an ingested epoch

EC = EPOCHCLOCK_INGESTED(NDI_DAQREADER_OBJ, EPOCHFILES, S)

  Return the clock types available for this epoch as a cell array
  of ndi.time.clocktype objects (or sub-class members).

  See also: ndi.time.clocktype

eq - tests whether 2 ndi.daq.reader objects are equal

B = EQ(NDI_DAQREADER_OBJ1, NDI_DAQREADER_OBJ2)

  Examines whether or not the ndi.daq.reader objects are equal.

getingesteddocument - return the ndi.document with the data for an ingested epoch

D = GETINGESTEDDOCUMENT(NDI_DAQREADER_MFDAQ_OBJ, EPOCHFILES, S)

  Returns the document D that contains the ingested ndi.daq.reader.mfdaq data for
  the epoch described by EPOCHFILES. EPOCHFILES should be an ingested epoch.
  S is the ndi.session for the dataset.

id - return the identifier of an DID.IDO object

IDENTIFIER = ID(DID.IDO_OBJ)

  Returns the unique identifier of an DID.IDO object.

Help for ndi.daq.reader/id is inherited from superclass did.ido

ingest_epochfiles - create a document that describes data read by an ndi.daq.reader

D = INGEST_EPOCHFILES(NDI_DAQREADER_OBJ, EPOCHFILES)

  Creates an ndi.document of type 'daqreader_epochdata_ingested' that contains the data
  for an ndi.daq.reader object. The document D is not added to any database.

  Example:
     D = mydaqreader.ingest_epochfiles(epochfiles);

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

DOC = NEWDOCUMENT(NDI_DAQREADER_OBJ)

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

reader - create a new ndi.daq.reader object

OBJ = ndi.daq.reader()

   Creates an ndi.daq.reader. 

   OBJ = ndi.daq.reader(NDI_SESSION_OBJ, NDI_DOCUMENT_OBJ)

   Creates an ndi.daq.reader from an NDI_DOCUMENT_OBJ.

   ndi.daq.reader has mostly abstract methods, it is made to be overriden.

    Documentation for ndi.daq.reader/reader
       doc ndi.daq.reader

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

SQ = SEARCHQUERY(NDI_DAQREADER_OBJ)

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

t0_t1 - return the t0_t1 (beginning and end) epoch times for an epoch

T0T1 = T0_T1(NDI_DAQREADER_OBJ, EPOCH_NUMBER)

  Return the beginning (t0) and end (t1) times of the epoch EPOCH_NUMBER
  in the same units as the ndi.time.clocktype objects returned by EPOCHCLOCK.

  The abstract class always returns {[NaN NaN]}.

  See also: ndi.time.clocktype, EPOCHCLOCK

t0_t1_ingested - return the t0_t1 (beginning and end) epoch times for an ingested epoch

T0T1 = T0_T1_INGESTED(NDI_DAQREADER_OBJ, EPOCH_NUMBER, S)

  Return the beginning (t0) and end (t1) times of the epoch EPOCH_NUMBER
  in the same units as the ndi.time.clocktype objects returned by EPOCHCLOCK.

  The abstract class always returns {[NaN NaN]}.

  See also: ndi.time.clocktype, EPOCHCLOCK

unique_id - Generate a unique ID number for DID databases (Static method)

ID = DID.IDO.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.reader.unique_id is inherited from superclass did.ido

verifyepochprobemap - Verifies EPOCHPROBEMAP is compatible with device and data on disk

B = VERIFYEPOCHPROBEMAP(NDI_DAQREADER_OBJ, EPOCHPROBEMAP, NUMBER)

  Examines the ndi.epoch.epochprobemap_daqsystem EPOCHPROBEMAP and determines if it is
  valid for the given device epoch NUMBER.

  For the abstract class ndi.daq.reader, EPOCHPROBEMAP is always valid as long as
  EPOCHPROBEMAP is an ndi.epoch.epochprobemap_daqsystem object.

  See also: ndi.daq.reader, ndi.epoch.epochprobemap_daqsystem