Spike Acquisition Entity Commands

These commands are used to control how the spike acquisition entities process AD data and what it does with the data after processing.


 -ClearClusters <Acq Ent Name>
Clears all defined clusters for the specified acquisition entity.  Once cleared, all cluster definitions for this acquisition entity will be lost.

Example :    -ClearClusters SE1
Default: This command is an action, there is no default value.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity whose cluster definitions will be cleared. 

 -CreateSpikeAcqEnt <Acq Ent Name> <Hardware Sub System Name> <AD Channel Count>
Creates a new instance of a spike acquisition entity in __prod_name.  Spike acquisition entities will detect specific signals from the incoming neurological data base on the spike detection type (see -SetSpikeDetectionType).  If these specific signals are found on any of the electrodes related to this spike acquisition entity, the signal at that time will be extracted from the incoming signal from all electrodes related to this spike acquisition entity , and saved to a spike record.  Spikes are sometimes referred to as single units.  Spike acquisition entities can be created as single electrodes (SE), stereotrodes (ST, two electrodes), or tetrodes (TT, four electrodes).

Example :   -CreateSpikeAcqEnt TT1 DCDCB 4
Default: __prod_name does not start with any spike acquisition entities created.
Usage:  This command can be used only when __prod_name is idle.
Arguments
Acq Ent Name
The name of the spike acquisition entity you wish to create.  This name must be unique throughout the __prod_name system.  This name cannot be changed after the acquisition entity is created.
Hardware Sub System Name The name of the hardware sub system that you want the acquisition entity to be associated with.  This specifies which hardware setup will be providing data to the acquisition entity.
AD Channel Count This is the number of channels (electrodes) used to detect the spike.  This value must be 1 if creating a single electrode,  2 if creating a stereotrode or 4 if creating a tetrode.  Any other values will cause this command to fail.  The specific AD channel to use for each channel of the spike acquisition entity is set using the -SetADChannel command.

 -GetAcqEntReference <Acq Ent Name>
Gets the current reference ID used by an acquisition entity.

Example :   -GetAcqEntReference TT1
Default: N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name
The name of an acquisition entity.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The reference ID used as a reference by this acquisition entity. See -SetAcqEntReference for reference ID information.

 -GetVoltageConversion <Acq Ent Name>
Returns the voltage conversion factor of each sub channel  for the specified acquisition entity.

Example :   -GetVoltageConversion TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value(s) The conversion factor of each sub channel for the specified acquisition entity.

 -GetADRange <Acq Ent Name>
Returns the AD range for the specified acquisition entity.

Example :   -GetADRange ST5
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Max AD Value The maximum AD value for the specified acquisition entity's data.
Min AD Value The minimum AD value for the specified acquisition entity's data.

 -GetAcqEntProcessingEnabled <Acq Ent Name>
Returns the processing state for the specified acquisition entity.

Example :   -GetAcqEntProcessingEnabled TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Processing Enabled This value will be one of the following keywords:
  1. True :  Acquisition entity processing is enabled.
  2. False :  Acquisition entity processing is disabled.

 -GetChannelNumber <Acq Ent Name>
Returns the channel number(s) for the specified acquisition entity.

Example :   -GetChannelNumber SE1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Channel Number(s) This is the channel number list for the specified acquisition entity.  The length of the list is determined by the number of sub channels for the specified acquisition entity.  CSC's and single electrodes have 1, stereotrodes 2 and tetrodes 4.

 -GetDataFile <Acq Ent Name>
Returns the data file name and path for the specified acquisition entity.

Example :   -GetDataFile CSC1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value This is the data file name and path for the specified acquisition entity.

 -GetDiskWriteEnabled <Acq Ent Name>
Returns the disk writing status for the specified acquisition entity.

Example :   -GetDiskWriteEnabled SE1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value This value will be one of the following keywords:
  1. True :  Disk writing is enabled.
  2. False :  Disk writing is disabled.

 -GetDspHighCutFilterEnabled <Acq Ent Name>
Returns the DSP high cut filter state for the specified acquisition entity.

Example :   -GetDspHighCutFilterEnabled TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Enabled This value will be one of the following keywords:
  1. True :  DSP high cut filter is enabled.
  2. False :  DSP high cut filter is disabled.

 -GetDspHighCutFrequency <Acq Ent Name>
Returns the DSP high cut frequency for the specified acquisition entity.

Example :   -GetDspHighCutFrequency TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Frequency The frequency value of the DSP high cut filter for the specified acquisition entity.

 -GetDspHighCutNumberTaps <Acq Ent Name>
Returns the DSP high cut tap count for the specified acquisition entity.

Example :   -GetDspHighCutNumberTaps TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The number of taps of the DSP high cut filter for the specified acquisition entity.

 -GetDspLowCutFilterEnabled <Acq Ent Name>
Returns the DSP low cut filter state for the specified acquisition entity.

Example :   -GetDspLowCutFilterEnabled TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Enabled This value will be one of the following keywords:
  1. True :  DSP low cut filter is enabled.
  2. False :  DSP low cut filter is disabled.

 -GetDspLowCutFrequency <Acq Ent Name>
Returns the DSP low cut frequency for the specified acquisition entity.

Example :   -GetDspLowCutFrequency TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Frequency The frequency value of the DSP low cut filter for the specified acquisition entity.

 -GetDspLowCutNumberTaps <Acq Ent Name>
Returns the DSP low cut tap count for the specified acquisition entity.

Example :   -GetDspLowCutNumberTaps TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The number of taps of the DSP low cut filter for the specified acquisition entity.

 -GetInputInverted <Acq Ent Name>
Returns the signal inversion state for the specified acquisition entity.

Example :   -GetInputInverted TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Enabled This value will be one of the following keywords:
  1. True :  Input inversion is enabled.
  2. False :  Input inversion is disabled.

 -GetInputRange <Acq Ent Name>
Returns the input range(s) for the specified acquisition entity.

Example :   -GetInputRange TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Input Range(s) This is the input range list for the specified acquisition entity.  The length of the list is determined by the number of sub channels for the specified acquisition entity.  CSC's and single electrodes have 1, stereotrodes 2 and tetrodes 4.

 -GetSampleFrequency <Acq Ent Name>
Returns the sample frequency for the specified acquisition entity.

Example :   -GetSampleFrequency SE1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Sample Frequency The sample frequency for the specified acquisition entity.

 -GetSpikeAlignmentPoint <Acq Ent Name>
Returns the spike alignment point for the specified acquisition entity.

Example :   -GetSpikeAlignmentPoint TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The spike alignment point for the requested acquisition entity.

 -GetSpikeCellFiringCount <Acq Ent Name> <Cell Number>
Returns the number of spikes detected for the cell number of the specified acquisition entity.

Example :   -GetSpikeCellFiringCount TT1 3
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
Cell Number The cell number for which the data is being requested.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Count The number of spikes detected with the specified cell number for the specified Acq Ent.

 -GetSpikeDetectionType <Acq Ent Name>
Returns the spike detection type for the specified acquisition entity.

Example :   -GetSpikeDetectionType TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The spike detection type for the specified acquisition entity.  This value will be one of the following:
  1. Threshold :  Threshold spike detection is currently being used.
  2. Slope :  Slope spike detection is currently being used.

 -GetSpikeDualThresholding <Acq Ent Name>
Returns the thresholding state for the specified acquisition entity.

Example :   -GetSpikeDualThresholding TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Enabled This value will be one of the following keywords:
  1. True :  Dual thresholding is enabled.
  2. False :  Dual thresholding is disabled.

 -GetSpikeRetriggerTime <Acq Ent Name>
Returns the spike retrigger time for the specified acquisition entity.

Example :   -GetSpikeRetriggerTime TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The spike retrigger time for the requested acquisition entity.

 -GetSpikeSlope <Acq Ent Name> <Sub Channel Index>
Returns the slope spike detection parameters(Voltage Change, Time Change) for the specified acquisition entity.  

Example :   -GetSpikeSlope TT5 2
Default:  __prod_name defaults slope parameters to 100 micro volts for the voltage change and 160 microseconds for the time change.
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
Sub Channel Index The index of the spike channel whose setting you wish to retrieve.  Valid values are dependent on the type of the spike acquisition entity you are changing:
  1. Single Electrode: Value can only be 0.
  2. Stereotrode:  Value can be 0 or 1.
  3. Tetrode:  Value can be 0, 1, 2, or 3
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Voltage Change The change in voltage used to detect a spike.  If the input signal voltage change is higher than this value, __prod_name will classify the data as a spike and it will be stored in a spike record.  The voltage change value is in microvolts and must be between 5 and 5000 microvolts.  You want to set the voltage range high enough that noise will not trigger a spike detection, but low enough to see all events of interest.
Time Change The change in time used for calculating a voltage change in order to detect a spike.  If the input signal change in voltage meets or exceeds the above parameter within this specified time, __prod_name will classify that data as a spike.  The time change value must be between 64 and 1000 microseconds.

 -GetSpikeThreshold <Acq Ent Name>
Returns the threshold value(s) for the specified acquisition entity.

Example :   -GetSpikeThreshold TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Threshold This is the threshold value list for the specified acquisition entity.  The length of the list is determined by the number of sub channels for the specified acquisition entity.  Single electrodes have 1, stereotrodes 2 and tetrodes 4.

 -GetSubChannelEnabled <Acq Ent Name>
Gets the current enabled state of a subchannel of an acquisition entity.  A disabled subchannel causes __prod_name to not process any data on that subchannel.  Once all subchannels are disabled, acquisition entity processing will be disabled for the acquisition entity.

Example :   -GetSubChannelEnabled TT1
Default: N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name
The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value This is the enabled state list for the specified acquisition entity.  The length of the list is determined by the number of sub channels for the specified acquisition entity.  CSC's and single electrodes have 1, stereotrodes 2 and tetrodes 4.

The enabled state of an acquisition entity subchannel is one of the following.
  1. True: __prod_name is processing data for this acquisition entity subchannel.
  2. False:  __prod_name is not processing data for this acquisition entity subchannel.  For spike acquisition entities, if a spike is detected on another subchannel in this acquisition entity, the data recorded for disabled subchannels will be all zeroes.  This will not affect on the data for the AD channel that corresponds to the spike channel index that is disabled.  This means that any raw data file or CSC channels that also use this AD channel will be unaffected.

 -GetSubSamplingInterleave <Acq Ent Name>
Returns the sub sampling interleave for the specified acquisition entity.

Example :   -GetSubSamplingInterleave TT1
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Value The sub sampling interleave for the specified acquisition entity.

 -GetWaveformFeature <Acq Ent Name>  <Feature Index> 
Returns feature calculation parameters for the specified acquisition entity.

Example :   -GetWaveformFeature TT1 2
Default:  N/A
Usage:  This command should only be used from a NetCom client application after a connection to a server has been established.
Arguments
Acq Ent Name The name of the acquisition entity to retrieve information for.
Feature Index The index of this feature. Each spike record contains 8 features, therefore valid values are 0 through 7.
NetCom Reply
Error Code
If the command is successful, this value will be equal to 0.  Otherwise, the value will be equal to -1.
Feature Name The feature name can be one of the following:
  • Area - The area of a spike is the L1-Norm of spike sample values, divided by a normalization factor of 32.
  • DotProduct - The dot product feature represents the dot product calculation of a spike waveform and a user-defined vector of the same length (requires <Additional Parameters>).
  • Energy - The energy calculation represents the L2-Norm of the spike sample divided by a normalization factor of 32.
  • Height - The height is the difference between the maximum and minimum sample values in the spike and it always positive.
  • NormalizedPeak - The normalized peak feature is calculated by normalizing the maximum spike waveform sample value using the average peak value of all electrodes contributing to a spike channel. This feature is not applicable to single electrodes.
  • Peak - The peak is the maximum sample value in the spike waveform.
  • Sample - The sample feature is the spike sample value at a given point in the spike (requires <Additional Parameters>).
  • Valley - The valley is the minimum sample value in the spike waveform.
  • Width - The width is the difference in sample counts between the maximum spike sample value and the minimum spike sample value
Channel Index This specifies which channel of a multi-electrode acquisition entity is used for the feature calculation. Valid values are as follows:
  • Tetrode - 0,1,2,3
  • Stereotrode - 0,1
  • Single Electrode - 0
Index Range Start The index of the first sample to use of the spike waveform for calculating the feature.
Index Range End The index of the last sample to use of the spike waveform for calculating the feature.
Scaling Value The scaling value applied to the feature after it is calculated.
Additional Parameters Some features require additional parameters:
  • DotProduct - 32 Integers used for the dot product calculation.
  • Sample - A single value representing the index of the waveform to use as the feature.  Valid values are 0 through 31.

 - SetAcqEntProcessing Enabled <Acq Ent Name> <Value> 
Enables or disables the processing of data by the acquisition entity.  Acquisition entity processing consists of record processing.  If record processing is disabled, records will not be able to be displayed, sent to NetCom or saved to a file.  Raw data file processing will still occur if it is enabled (see -SetRawDataFile).  This command supersedes the -SetPlotEnabledcommand.and -SetDiskWriteEnabled commands.
 
Example :   -SetAcqEntProcessingEnabled SE1 true  
Default:  Acquisition entity processing is enabled when the acquisition entity is created.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value This value can be one of the following keywords:
  1. True :  Enables acquisition entity processing.
  2. False :  Disables acquisition entity processing.

 - SetAcqEntReference <Acq Ent Name> <ReferenceID> 
Sets the reference channel to use for all sub channels of an acquisition entity. This command only works on systems that have HRS boards.
 
Example :   -SetAcqEntReference TT1 31 
Default: All acquisition entities are referenced to the REF1 connection on their corresponding headstage. (i.e. SE33 using AD channel 33 will be referenced to the REF1 on source 2)
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
ReferenceID HRS boards can use any AD channel, source reference or HRS reference as the reference signal for any acquisition entity. However, the hardware limits the number of unique references that can be used at one time. This command will fail if those physical limitations prevent connection of the AD channels that are part of the acquisition entity to the desired reference. See the HRS Setup section for more information.

The reference ID is encoded via the following method:

Reference Channel
Encoding
Example
AD Channels
AD Channel number
AD Channel 33 = 33, AD Channel 129 = 129
Source Reference 1
32000000 + BoardIndex
HRS in slot 3 = 32000003
Source Reference 2
33000000 + BoardIndex
HRS in slot 5 = 33000005
Source Reference 3
34000000 + BoardIndex
HRS in slot 1 = 34000001
Source Reference 4
35000000 + BoardIndex
HRS in slot 7 = 35000007
Subject Ground
36000000 + BoardIndex
HRS in slot 9 = 36000009
Panel Ground
37000000 + BoardIndex
HRS in slot 11 = 37000011



 -SetAutoThresholdingSDMultiplier <Acq Ent Name> <Multiplier>
Sets the Auto Thresholding Standard Deviation Multiplier for the specified acquisition entity.

Example :   -SetAutoThresholdingSDMultiplier  TT1  2.5
Default:  Spike acquisition entities are created with the default of 2.5.
Usage:  This command can be used at any time.  This command is only valid for Spike acquisition entities. Valid input values are in the range 0.5 to 5.0.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Multiplier The Standard Deviation Multiplier will be used when calculating thresholds for spike acquitions entities during the Auto Thresholding process. The resulting threshold is the mean of the signal data received by the acquisition entity, plus the standard deviation of the signal multiplied by the Standard Deviation Multiplier. 

 -SetChannelNumber <Acq Ent Name> <Channel>  <Channel2> <Channel3> <Channel4>
Sets the AD channel number(s) for the specified acquisition entity.  The AD channel numbers correspond to signals on an individual wire.  Channel numbers and counts are dictated by your specific hardware setup.

Example :   -SetChannelNumber  ST1  0  1
Default:  Acquisition entities are created using the next available sequence of open AD channels (i.e. if the first acquisition entity created is a stereotrode, the channels it will initially use are 0 and 1).
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Channel The AD channel to be set for the first channel of the specified acquisition entity.  CSC and Single Electrode acquisition entities only have a single channel.  For the Cheetah160 and Cheetah64 sub systems, AD channel numbers can only be used once.  If the channel number specified is already in use, this command will fail.  All acquisition entity types require this argument.
Channel2 This argument is required if the acquisition entity is a stereotrode or a tetrode.  This command will fail if the acquisition entity is any other type.
Channel3 and Channel4 These arguments are required only if the acquisition entity is a tetrode.  This command will fail if the acquisition entity is any other type.

 - SetClusterBoundary <Acq Ent Name> <Cell Number> <Boundary Type> <Values> 
Cluster boundaries are used for online classification of spikes. Three boundary types are supported.
Waveform - 32 max/min pairs which define the waveform shape
Range - a max/min pair defining a range on a particular feature
Convex Hull - a variable size set of x,y coordinates defining a convex boundary in a 2-dimensional feature space

Example :    -SetClusterBoundary SE1 2 ConvexHull 5 7 1976 -236 2128 -8 2026 305 1456 247 1422 -77 1571 -199
Default: __prod_name does not define a cluster boundary when a spike acquisition entity is created.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Cell Number The cell or cluster number this boundary represents. Valid options are 1 through 31. Cluster 0 is always reserved for unclustered or "noise" data.
Boundary Type The Boundary Type must be one of the following:
  1. Range: Uses a min and max for the specified feature index to determine if a spike should be classified.
  2. Template: Uses a set of min/max pairs for each sample in the waveform to determine if the spike shall be classified.  The channel of the waveform to be used must also be specified.
  3. Convex Hull: Uses a set of coordinates (x/y pairs) to create a convex hull boundary which is used to determine if the spike should be classified.  The user must specify the feature index to be used for the x and y coordinate comparison.
Values The cluster definition string. Each boundary type has a different format:
Range <Feature Index> <Max> <Min>
Template <Electrode Index> <Max1> <Min1> <Max2> <Min2> ... <Max32> <Min32>
ConvexHull <X Feature Index> <Y Feature Index> <X1> <Y1> <X2> <Y2> ... <Xn> <Yn>

 -SetDataFile <Acq Ent Name> <File Name> 
Sets the data file for the specified acquisition entity.  All data records recorded for this acquisition entity will be saved to this file.  

Example :   -SetDataFile Events "C:\My Events.nev"
Default:  __prod_name will create a file using the name of the acquisition entity in the current data directory when the acquisition entity is created (i.e.__prod_name created Events.nev in the current data directory when the Events acquisition entity was created).
Usage:  This command can be used at any time.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
File Name Sets the file to use for data recording for the specified acquisition entity.  If only a filename is specified, __prod_name will create the file in the current data directory.  When the data directory is changed, the file's location will change with the data directory.

Example :   -SetDataFile  SE1 SE1.nse

If a complete path is specified, __prod_name will create the file in the specified location, and will not change the file's location when the data directory is changed.

  Example : -SetDataFile  CSC1 "C:\Data Directory\CSC1.ncs"

The directory C:\Data Directory must exist or this command will fail.  If the file CSC1.ncs exists, it will be overwritten.  The extension of the file will be changed to the appropriate Neuralynx extension for the specified acquisition entity type.  __prod_name will always create a file using the acquisition entity's name in the current data directory.  If this command is issued before any data is recorded, the file in the current data directory will only have header information.

 -SetDiskWriteEnabled <Acq Ent Name> <Value> 
Enables or disables disk writing of data records for the specified acquisition entity.  This command does not affect data records over NetCom or the data visible in all plots for this acquisition entity.  You may want to disable disk writing for control or stimulus signals that you want to see, but have no need for in data analysis.

Example :    -SetDiskWriteEnabled  CSC1  true  
Default:  __prod_name initially enables disk writing when an acquisition entity is created.
Usage:  This command can be used at any time.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value This value can be one of the following keywords:
  1. True :  Enables disk writing of data records.
  2. False :   Enables disk writing of data records. If disk writing is disabled prior to recording, a data file will be created for the specific acquisition entity, but only header information will be written to the file.  If disk writing is disabled after recording has begun, all records after disk writing has been disabled will not be written until disk writing is re-enabled.

 -SetDspHighCutFilter Enabled <Acq Ent Name> <Value> 
__prod_name has the ability to process all signals using digital signal processing (DSP).  This command will turn the high cut (low pass) DSP filter on or off for the specified acquisition entity.  This command does not affect the actual filter value (see -SetDspHighCutFrequency), it simply enables or disables the filter.  All channels of an acquisition entity are filtered using the same settings.  Disabling DSP filtering can be used to alleviate CPU load on high channel count systems or older computers.

Example :    -SetDspHighCutFilterEnabled  SE1     false  
Default:  Acquisition entities are created with the high cut filter enabled set to true.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value This value can be one of the following keywords:
  1. True :  Enables DSP high cut filtering on all channels of the specified acquisition entity..
  2. False :   Disables DSP high cut filtering on all channels of the specified acquisition entity..

 -SetDspHighCutFrequency <Acq Ent Name> <Value> 
Sets the frequency that __prod_name will use for the high cut (low pass) digital signal processing (DSP) filter on all channels of the specified acquisition entity.  The high cut filter frequency has no effect if high cut filtering is disabled (see -SetDspHighCutFilterEnabled).  High cut filters will only allow signals whose frequency is below this value to be recorded by __prod_name.  DSP filters have no effect on data being written to a raw data file (see -SetRawDataFile).
  
Example :    -SetDspHighCutFrequency  CSC1  9000    
Default: Spike acquisition entities are created with the high cut filter set to 6000Hz, while CSC acquisition entities are set to 9000Hz.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value The high cut frequency of the DSP filter to be set for the specified acquisition entity.  This value is in hertz, and can be any value (including decimal values) between 0.1 Hz and 10000.0 Hz..  All signals with a frequency below this value will be processed  by __prod_name.

Filter Type
Frequency Range (Hz)
Finite Impulse Response (FIR) 0.1 - 10000


 -SetDspHighCutNumberTaps <Acq Ent Name> <Value> 
Digital signal processing (DSP) taps determine the amount of roll off for the DSP filter.  If you notice the high cut filter is allowing signals that are too far above your high cut setting to be processed by __prod_name, you may want to increase this value.  __prod_name will normally select a tap value that is appropriate for the high cut filter frequency.  Lowering the number of taps can be useful to alleviate CPU load on large channel count systems or older computers.

Example :   -SetDspHighCutNumberTaps  CSC1  64      
Default:  Acquisition entities are created with the high cut taps set to 32.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value The following table shows the available taps at certain high cut filter frequencies:

Low Value (Hz) High Value (Hz) Taps Choices
0.1 199.99 256
200 499.99 128, 256
500 999.99 64,128, 256
1000 10000 32, 64, 128, 256

This command will fail if you try to change to a tap size that is not available given the current filter frequency.

 -SetDspLowCutFilter Enabled <Acq Ent Name> <Value> 
__prod_name has the ability to process all signals using digital signal processing (DSP).  This command will turn the low cut (high pass) DSP filter on or off for the specified acquisition entity.  This command does not affect the actual filter value (see -SetDspLowCutFrequency), it simply enables or disables the filter.  All channels of an acquisition entity are filtered using the same settings.  Disabling DSP filtering can be used to alleviate CPU load on high channel count systems or older computers.

Example :    -SetDspLowCutFilterEnabled  SE1     false    
Default:  Acquisition entities are created with the low cut filter enabled set to true..
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value This value can be one of the following keywords:
  1. True :  Enables DSP low cut filtering on all channels of the specified acquisition entity..
  2. False :   Disables DSP low cut filtering on all channels of the specified acquisition entity..

 -SetDspLowCutFrequency <Acq Ent Name> <Value> 
Sets the frequency that __prod_name will use for the low cut (high pass) digital signal processing (DSP) filter on all channels of the specified acquisition entity.  The low cut filter frequency has no effect if low cut filtering is disabled (see -SetDspLowCutFilterEnabled).  Low cut filters will only allow signals whose frequency is above this value to be recorded by __prod_name.  DSP filters have no effect on data being written to a raw data file (see -SetRawDataFile).
  
Example :   -SetDspLowCutFrequency  CSC1  100    
Default: Spike acquisition entities are created with the low cut filter set to 600Hz, while CSC acquisition entities are created with a low cut filter set to 0.1Hz.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value The low cut frequency of the DSP filter to be set for the specified acquisition entity.  This value is in hertz, and can be any value (including decimal values) between 0.1 Hz and 10000.0 Hz..  All signals with a frequency above this value will be processed  by __prod_name.

Filter Type
Frequency Range (Hz)
DC Offset (DCO) 0.1 - 149.99
Finite Impulse Response (FIR) 150 - 10000


 -SetDspLowCutNumberTaps <Acq Ent Name> <Value> 
Digital signal processing (DSP) taps determine the amount of roll off for the DSP filter.  If you notice the low cut filter is allowing signals that are too far beneath your low cut setting to be processed by __prod_name, you may want to increase this value.  __prod_name will normally select a tap value that is appropriate for the low cut filter frequency.  Lowering the number of taps can be useful to alleviate CPU load on large channel count systems or older computers.

Example :   -SetDspLowCutNumberTaps  CSC1  64      
Default: Spike acquisition entities are created with the low cut taps set to 64, while CSC acquisition entities are set to None.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value The following table shows the available taps at certain low cut filter frequencies:

Low Value (Hz) High Value (Hz) Taps Choices
0.1 149.99 None
150 199.99 256
200 499.99 128, 256
500 999.99 64,128, 256
1000 10000 32, 64, 128, 256

This command will fail if you try to change to a tap size that is not available given the current filter frequency.

 -SetInputInverted <Acq Ent Name> <Value> 
Enables or disables inversion of AD data for a specified acquisition entity.  
  
Example :   -SetInputInverted  CSC1  false      
Default:  Acquisition entities are created with the the input inversion set to true.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value The input inverted value can be one of the following:
  1. True:  __prod_name will automatically invert incoming AD data before it is processed.
  2. False:   __prod_name will not adjust the polarity of the incoming AD data before it is processed.

 -SetInputRange <Acq Ent Name> <Value>  <Value2> <Value3> <Value4>
Sets the input scaling for an acquisition entity.  Since there is only a certain number of bits available to digitize the incoming analog data, we need to scale the input voltages to get the most accurate values possible.  In order to improve accuracy, you can tell __prod_name what voltage range you are expecting.  __prod_name will then adjust the volts per bit setting for digitized data.

Example :   -SetInputRange  TT1     2000 2000 2000 2000  
Default: CSC acquisition entities are created with an input range of -1000 to 1000 microvolts.
               Spike acquisition entities are created with an input range of -500 to 500 microvolts.
Usage:  This command can be used at any time.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value The input range in microvolts to be used for the first channel of the specified acquisition entity.  A larger range will be able to record higher voltages without clipping, however the amount of detail captured is lower (i.e. a larger number of volts is represented by a single bit).   Smaller ranges will increase the detail, while sacrificing the ability to record large voltage values.  You should always try to have your input range set to the range of values that are expected.  Min and max input range values are based on hardware sub system type.  Please see the table below.

System Type Min Input Range Max Input Range
Digital Lynx SX 25 131072
Digital Lynx 25 131072
Cheetah 64 25 136986
Raw Data File 11 136986

CSC and Single Electrode acquisition entities only have a single channel.  All acquisition entity types require this argument.
Value2 This argument is required if the acquisition entity is a stereotrode or a tetrode.  This command will fail if the acquisition entity is any other type.
Value3 and Value4 These arguments are required only if the acquisition entity is a tetrode.  This command will fail if the acquisition entity is any other type.

 -SetSpikeAlignmentPoint <Acq Ent Name> <Value> 
All spike records contain 32 points of data per channel.  The alignment point is the position in those 32 points of the point of most interest (i.e. the peak of a spike when in Threshold spike detection mode).  Adjusting the alignment point will allow you to have more data before or after the point of interest saved to the spike record.

Example :    -SetAlignmentPoint SE1 8
Default: __prod_name normally sets the alignment point to 8.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value The index of a spike waveform for which the timestamp is used.  The value must be between 1 and 30.

Example:  Assume SE1 is using Threshold spike detection with a threshold of 5000 microvolts and an alignment point of  8.  This means that if an incoming signal is over 5000 microvolts, __prod_name will then try and find the peak of the signal following that threshold crossing.  Once that point is found, __prod_name will save the 7 points prior to the peak, and the 24 points following the peak for all channels to the spike record.

 -SetSpikeDetectionType <Acq Ent Name> <Type>
This command tells __prod_name how to look for spikes in the incoming neurological signal.

Example :    -SetSpikeDetectionType ST1 threshold
Default: __prod_name spike detection type is normally Threshold.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Type The spike detection type can be one of the following:
  1. Threshold:  __prod_name detect spikes by detecting a signal whose voltage is higher than a defined threshold (see -SetSpikeThreshold).  Any signal that crosses this threshold will be classified as a spike, and all channels of the acquisition entity for that time period will be saved to a spike record.
  2. Slope: __prod_name detects spikes by detecting a change in voltage higher than a defined value (see -SetSpikeSlope).  Any change in voltage that is higher than the defined value within a specified time will be classified as a spike, and all channels of the acquisition entity for that time period will be saved to a spike record.

 -SetSpikeDualThresholding <Acq Ent Name> <Value>
Sets dual spike thresholding for the specified acquisition entity.  This tells __prod_name that a spike can be either in the positive or negative direction.  

Example :    -SetSpikeDualThresholding ST1 true
Default: __prod_name normally has dual thresholding set to False.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.   The spike detection type must be Threshold.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value The dual thresholding processing state can be one of the following:
  1. True:  __prod_name detects spikes that are above the current threshold setting and below the negative of the threshold setting.
  2. False:   __prod_name will only detect spikes that are above the current threshold setting.

Example:  If the current threshold setting is 5000 microvolts, and dual thresholding is enabled, signals that have a value above 5000 microvolts and below -5000 microvolts will be classified as spikes.

 -SetSpikeRetriggerTime <Acq Ent Name> <Value> 
Sets the amount of time to wait after a spike has been detected before searching for the next spike.  This command can be useful if there are rapidly firing spikes, or echoes present on a particular acquisition entity.  The retrigger time is based off of the peak of the previous spike.

Example :    -SetSpikeRetriggerTime  SE 1 16
Default: __prod_name waits 750 microseconds after a spike is detected before searching for the next spike.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value This is the amount of time to wait after a spike is detected before searching for the next spike.  This can be any value between 250 and 1000000 microseconds.

 -SetSpikeSlope <Acq Ent Name> <Sub Channel Index> <Voltage Change> <Time Change>
Sets the spike slope parameters for the specified acquisition entity.  The spike detection type must be set to Slope (see -SetSpikeDetectionType) for this command to have an effect.  When the value of the incoming neurological data satisfies both the voltage change condition and the time change condition, __prod_name will classify that data as a spike. Slope can be detected in both the positive and negative direction simultaneously (see -SetSpikeDualThresholding).

Example :    -SetSpikeSlope TT1 2 500 200
Default:   __prod_name defaults slope parameters to 100 micro volts for the voltage change and 160 microseconds for the time change.
Usage:  This command can be used only when __prod_name is acquiring or idle, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Sub Channel Index The index of the spike channel whose setting you wish to change.  Valid values are dependent on the type of the spike acquisition entity you are changing:
  1. Single Electrode: Value can only be 0.
  2. Stereotrode:  Value can be 0 or 1.
  3. Tetrode:  Value can be 0, 1, 2, or 3
Voltage Change The change in voltage used to detect a spike.  If the input signal voltage change is higher than this value, __prod_name will classify the data as a spike and it will be stored in a spike record.  The voltage change value is in microvolts and must be between 5 and 5000 microvolts.  You want to set the voltage range high enough that noise will not trigger a spike detection, but low enough to see all events of interest.
Time Change The change in time used for calculating a voltage change in order to detect a spike.  If the input signal change in voltage meets or exceeds the above parameter within this specified time, __prod_name will classify that data as a spike.  The time change value must be between 64 and 1000 microseconds.

 -SetSpikeThreshold <Acq Ent Name> <Value> <Value2> <Value3> <Value4>
Sets the spike threshold for the specified acquisition entity.  This command is only allowed when the spike detection type (see -SetSpikeDetectionType) is set to Threshold,  otherwise it will fail.  When the value of the incoming neurological data is above the specified threshold, __prod_name will classify that data as a spike.  Thresholds can be detected in both the positive and negative direction simultaneously (see -SetSpikeDualThresholding).

Example :    -SetSpikeThreshold  ST1 500 400
Default: __prod_name creates all spike acquisition entities with a threshold of 250 microvolts.
Usage:  This command can be used when __prod_name is acquiring or idle, and is available for spike acquisition entities only.  The spike detection type must be Threshold.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Value The threshold to be used for the first channel of the specified acquisition entity.  An input signal must be higher than this value to be detected as a spike by __prod_name.  The threshold must be a value in microvolts that is within the current input range for this acquisition entity (see -SetInputRange).  If the input range is changed to a value lower than the current threshold, the threshold will be set to the value of the input range. You want to set the threshold high enough that noise will not trigger a spike detection, but low enough to see all events of interest.

Single Electrode acquisition entities only have a single channel.  All spike acquisition entities require this argument.
Value2 This argument is required if the acquisition entity is a stereotrode or a tetrode.  This command will fail if the acquisition entity is any other type.
Value3 and Value4 These arguments are required only if the acquisition entity is a tetrode.  This command will fail if the acquisition entity is any other type.

 -SetSubChannelEnabled <Acq Ent Name> <Channel Index> <Enabled>
Enables or disables a particular channel of an acquisition entity.  Disabling a channel will cause __prod_name to not process any data on that subchannel.  Once all subchannels are disabled, acquisition entity processing will be disabled for the acquisition entity.

Example :   -SetSubChannelEnabled TT1 3 False
Default: All subchannels of an acquisition entity are enabled when it is created.
Usage:  This command can be used at any time.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Channel Index The index of the subchannel whose setting you wish to change.  Valid values are dependent on the type of the acquisition entity you are changing:
  1. Single Electrode, CSC: Value can only be 0.
  2. Stereotrode:  Value can be 0 or 1.
  3. Tetrode:  Value can be 0, 1, 2, or 3
Enabled Tells __prod_name to enable or disable an acquisition entity subchannel.
  1. True: __prod_name will process data for this acquisition entity subchannel.
  2. False:  __prod_name will  not process data for this acquisition entity subchannel.  For spike acquisition entities, if a spike is detected on another subchannel in this acquisition entity, the data recorded for disabled subchannels will be all zeroes.  This will not affect on the data for the AD channel that corresponds to the spike channel index that is disabled.  This means that any raw data file or CSC channels that also use this AD channel will be unaffected.

 -SetSubSamplingInterleave <Acq Ent Name> <Value>
This command allows you to record data for a particular acquisition entity at a lower sampling rate than other acquisition entities.  The sub sampling interleave tells __prod_name to process only every Nth (where N is the Value specified) sample obtained from the recording hardware.  This can also be seen as a sampling divisor.

Example :   -SetSubSamplingInterleave  SE1 2      
Default:  Acquisition entities are created with the the sub sampling interleave set to 1.
Usage:  This command can only be used when __prod_name is idle.  This command is only valid for Spike and Continuously Sampled acquisition entities
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified. 
Value The value must be between 1 and 3 for spike acquisition entities and between 1 and 128 for csc acquisition entities.

Example:  A Digital Lynx system normally samples all channels at 32000 Hz.  Suppose you want to sample CSC1 at 8000 Hz.  You would issue the following command:

-SetSubSamplingInterleave CSC1 4

This will only process every 4th sample, giving an effective sampling rate of 8000 Hz.

 -SetWaveformFeature <Acq Ent Name> <Feature Name> <Feature Index> <Channel Index> <Index Range> <Scaling Factor> <Additional Parameters>  
Waveform features are values extracted from spike waveform shapes. These values can then be plotted in a multi-dimensional scatter plot to facilitate spike clustering. Each spike record contains 8 calculated features. This command allows the user to change which features are calculated and placed into the spike record.

Example :    -SetWaveformFeature SE1 Peak 0 1 0 31 1
Default:   Default values depend on the type of spike acquisition entity.
Usage:  This command can be used at any time, and is available for spike acquisition entities only.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified.
Feature Name The feature name can be one of the following:
  • Area - The area of a spike is the L1-Norm of spike sample values, divided by a normalization factor of 32.
  • DotProduct - The dot product feature represents the dot product calculation of a spike waveform and a user-defined vector of the same length (requires <Additional Parameters>).
  • Energy - The energy calculation represents the L2-Norm of the spike sample divided by a normalization factor of 32.
  • Height - The height is the difference between the maximum and minimum sample values in the spike and it always positive.
  • NormalizedPeak - The normalized peak feature is calculated by normalizing the maximum spike waveform sample value using the average peak value of all electrodes contributing to a spike channel. This feature is not applicable to single electrodes.
  • Peak - The peak is the maximum sample value in the spike waveform.
  • NthSample - The sample feature is the spike sample value at a given point in the spike (requires <Additional Parameters>).
  • Valley - The valley is the minimum sample value in the spike waveform.
  • Width - The width is the difference in sample counts between the maximum spike sample value and the minimum spike sample value
Feature Index The index of this feature. Each spike record contains 8 features, therefore valid values are 0 through 7.
Channel Index This specifies which channel of a multi-electrode acquisition entity is used for the feature calculation. Valid values are as follows:
  • Tetrode - 0,1,2,3
  • Stereotrode - 0,1
  • Single Electrode - 0
Index Range Two values that represent a range of sample indices to use when calculating a feature. All samples outside of this range will not be included in the feature calculation. Valid values are 0 through 31.  This can be used for all features except NthSample. These values default to 0 and 31 if not specified.
Scaling Factor Multiplier used after the feature value has been calculated. This value defaults to 1 if not specified.
Additional Parameters Some features require additional parameters:
  • DotProduct - 32 Integers used for the dot product calculation.
  • NthSample - A single value representing the index of the waveform to use as the feature.  Valid values are 0 through 31.