CLASS ndr.reader.neo¶
ndr.reader.neo is a class.
self = ndr.reader.neo(varargin)
Superclasses¶
Properties¶
none
Methods¶
| Method | Description |
|---|---|
| canbereadtogether | Formatting objects from matlab to python |
| daqchannels2internalchannels | convert a set of DAQ channel prefixes and channel numbers to an internal structure to pass to internal reading functions |
| epochclock | return the ndr.time.clocktype objects for an epoch |
| getchannelsepoch | List the channels that are available on this device for a given epoch |
| insert_python_path | ndr.reader.neo.insert_python_path is a function. |
| mfdaq_channeltypes | channel types for ndi.daq.system.mfdaq objects |
| mfdaq_prefix | Give the channel prefix for a channel type |
| mfdaq_type | Give the preferred long channel type for a channel type |
| neo | ndr.reader.neo/neo is a constructor. |
| readchannels_epochsamples | read the data based on specified channels |
| readevents_epochsamples_native | read events or markers of specified channels for a specified epoch |
| reload_python | ndr.reader.neo.reload_python is a function. |
| samplerate | GET THE SAMPLE RATE FOR SPECIFIC CHANNEL |
| t0_t1 | return the t0_t1 (beginning and end) epoch times for an epoch |
| underlying_datatype | get the underlying data type for a channel in an epoch |
Methods help¶
canbereadtogether - Formatting objects from matlab to python
daqchannels2internalchannels - convert a set of DAQ channel prefixes and channel numbers to an internal structure to pass to internal reading functions
CHANNELSTRUCT = DAQCHANNELS2INTERNALCHANNELS(NDR_READER_BASE_OBJ, ...
CHANNELPREFIX, CHANNELNUMBERS, EPOCHSTREAMS, EPOCH_SELECT)
Inputs:
For a set of CHANNELPREFIX (cell array of channel prefixes that describe channels for
this device) and CHANNELNUMBER (array of channel numbers, 1 for each entry in CHANNELPREFIX),
and for a given recording epoch (specified by EPOCHSTREAMS and EPOCH_SELECT), this function
returns a structure CHANNELSTRUCT describing the channel information that should be passed to
READCHANNELS_EPOCHSAMPLES or READEVENTS_EPOCHSAMPLES.
EPOCHSTREAMS is a cell array of full path file names or remote
access streams that comprise the epoch of data
EPOCH_SELECT allows one to choose which epoch in the file one wants to access,
if the file(s) has more than one epoch contained. For most devices, EPOCH_SELECT is always 1.
Output: CHANNELSTRUCT is a structure with the following fields:
------------------------------------------------------------------------------
| Parameter | Description |
|-----------------------------|----------------------------------------------|
| internal_type | Internal channel type; the type of channel as|
| | it is known to the device. |
| internal_number | Internal channel number, as known to device |
| internal_channelname | Internal channel name, as known to the device|
| ndr_type | The NDR type of channel; should be one of the|
| | types returned by |
| | ndr.reader.base.mfdaq_type |
| samplerate | The sampling rate of this channel, or NaN if |
| | not applicable. |
------------------------------------------------------------------------------
abstract class returns empty
Help for ndr.reader.neo/daqchannels2internalchannels is inherited from superclass ndr.reader.base
epochclock - return the ndr.time.clocktype objects for an epoch
EC = EPOCHCLOCK(NDR_READER_BASE_OBJ, EPOCHSTREAMS, EPOCH_SELECT)
Return the clock types available for this epoch as a cell array
of ndr.time.clocktype objects (or sub-class members).
For the generic ndr.reader.base, this returns a single clock
type 'dev_local'time';
See also: ndr.time.clocktype
Help for ndr.reader.neo/epochclock is inherited from superclass ndr.reader.base
getchannelsepoch - List the channels that are available on this device for a given epoch
CHANNELS = GETCHANNELSEPOCH(NDR_READER_BASE_OBJ, EPOCHSTREAMS, EPOCH_SELECT)
Returns the channel list of acquired channels in this epoch
CHANNELS is a structure list of all channels with fields:
-------------------------------------------------------
'name' | The name of the channel (e.g., 'ai1')
'type' | The type of data stored in the channel
| (e.g., 'analogin', 'digitalin', 'image', 'timestamp')
Help for ndr.reader.neo/getchannelsepoch is inherited from superclass ndr.reader.base
insert_python_path - ndr.reader.neo.insert_python_path is a function.
mfdaq_channeltypes - channel types for ndi.daq.system.mfdaq objects
CT = MFDAQ_CHANNELTYPES - channel types for ndi.daq.system.mfdaq objects
Returns a cell array of strings of supported channels of the
ndi.daq.system.mfdaq class. These are the following:
Channel type: | Description:
-------------------------------------------------------------
analog_in | Analog input channel
aux_in | Auxiliary input
analog_out | Analog output channel
digital_in | Digital input channel
digital_out | Digital output channel
marker |
See also: ndi.daq.system.mfdaq/MFDAQ_TYPE
Help for ndr.reader.neo.mfdaq_channeltypes is inherited from superclass ndr.reader.base
mfdaq_prefix - Give the channel prefix for a channel type
PREFIX = MFDAQ_PREFIX(CHANNELTYPE)
Produces the channel name prefix for a given CHANNELTYPE.
Channel type: | MFDAQ_PREFIX:
---------------------------------------------------------
'analog_in', 'ai' | 'ai'
'analog_out', 'ao' | 'ao'
'digital_in', 'di' | 'di'
'digital_out', 'do' | 'do'
'time','timestamp','t' | 't'
'auxiliary','aux','ax', | 'ax'
'auxiliary_in' |
'mark', 'marker', or 'mk' | 'mk'
'text' | 'text'
'event' or 'e' | 'e'
'metadata' or 'md' | 'md'
'digital_in_event', 'de', | 'dep'
'digital_in_event_pos','dep'|
'digital_in_event_neg','den'| 'den'
'digital_in_mark','dimp', | 'dimp'
'digital_in_mark_pos','dim' |
'digital_in_mark_neg','dimn'| 'dimn'
See also: ndi.daq.system.mfdaq/MFDAQ_TYPE
Help for ndr.reader.neo.mfdaq_prefix is inherited from superclass ndr.reader.base
mfdaq_type - Give the preferred long channel type for a channel type
TYPE = MFDAQ_TYPE(CHANNELTYPE)
Produces the preferred long channel type name for a given CHANNELTYPE.
Channel type: | MFDAQ_TYPE:
---------------------------------------------------------
'analog_in', 'ai' | 'analog_in'
'analog_out', 'ao' | 'analog_out'
'digital_in', 'di' | 'digital_in'
'digital_out', 'do' | 'digital_out'
'time','timestamp','t' | 'time'
'auxiliary','aux','ax', | 'auxiliary'
'auxiliary_in' |
'mark', 'marker', or 'mk' | 'mark'
'event' or 'e' | 'event'
See also: ndi.daq.system.mfdaq/MFDAQ_PREFIX
Help for ndr.reader.neo.mfdaq_type is inherited from superclass ndr.reader.base
neo - ndr.reader.neo/neo is a constructor.
self = neo(varargin)
Documentation for ndr.reader.neo/neo
doc ndr.reader.neo
readchannels_epochsamples - read the data based on specified channels
DATA = READ_CHANNELS(MYDEV, CHANNELTYPE, CHANNEL, EPOCH ,S0, S1)
CHANNELTYPE is the type of channel to read
CHANNEL is a vector of the channel numbers to read, beginning from 1
EPOCH is the epoch number to read from.
DATA will have one column per channel.
Help for ndr.reader.neo/readchannels_epochsamples is inherited from superclass ndr.reader.base
readevents_epochsamples_native - read events or markers of specified channels for a specified epoch
[DATA] = READEVENTS_EPOCHSAMPLES_NATIVE(NDR_READER_BASE_OBJ, CHANNELTYPE, CHANNEL, EPOCHFILES, T0, T1)
CHANNELTYPE is the type of channel to read
('event','marker', etc). It must be a string (not a cell array of strings).
CHANNEL is a vector with the identity of the channel(s) to be read.
EPOCH is the epoch number or epochID
DATA is a two-column vector; the first column has the time of the event. The second
column indicates the marker code. In the case of 'events', this is just 1. If more than one channel
is requested, DATA is returned as a cell array, one entry per channel.
TIMEREF is an ndi.time.timereference with the NDI_CLOCK of the device, referring to epoch N at time 0 as the reference.
Help for ndr.reader.neo/readevents_epochsamples_native is inherited from superclass ndr.reader.base
reload_python - ndr.reader.neo.reload_python is a function.
samplerate - GET THE SAMPLE RATE FOR SPECIFIC CHANNEL
SR = SAMPLERATE(NDR_READER_BASE_OBJ, EPOCHSTREAMS, EPOCH_SELECT, CHANNELTYPE, CHANNEL)
SR is an array of sample rates from the specified channels
CHANNELTYPE can be either a string or a cell array of
strings the same length as the vector CHANNEL.
If CHANNELTYPE is a single string, then it is assumed that
that CHANNELTYPE applies to every entry of CHANNEL.
Help for ndr.reader.neo/samplerate is inherited from superclass ndr.reader.base
t0_t1 - return the t0_t1 (beginning and end) epoch times for an epoch
T0T1 = T0_T1(NDR_READER_BASE_OBJ, EPOCHSTREAMS, EPOCH_SELECT)
Return the beginning (t0) and end (t1) times of the epoch defined by EPOCHSTREAMS and EPOCH_SELECT.
The abstract class always returns {[NaN NaN]}.
See also: ndr.time.clocktype, ndr.reader.neo/epochclock
Help for ndr.reader.neo/t0_t1 is inherited from superclass ndr.reader.base
underlying_datatype - get the underlying data type for a channel in an epoch
[DATATYPE,P,DATASIZE] = UNDERLYING_DATATYPE(NDR_READER_OBJ, EPOCHSTREAMS, EPOCH_SELECT, CHANNELTYPE, CHANNEL)
Return the underlying datatype for the requested channel.
DATATYPE is a type that is suitable for passing to FREAD or FWRITE
(e.g., 'float64', 'uint16', etc. See help fread.)
P is a matrix of polynomials that converts between the double data that is returned by
READCHANNEL. RETURNED_DATA = (RAW_DATA+P(i,1))*P(i,2)+(RAW_DATA+P(i,1))*P(i,3) ...
There is one row of P for each entry of CHANNEL.
DATASIZE is the sample size in bits.
CHANNELTYPE must be a string. It is assumed that
that CHANNELTYPE applies to every entry of CHANNEL.
Help for ndr.reader.neo/underlying_datatype is inherited from superclass ndr.reader.base