Continuously Sampled Acquisition Entity Commands

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


 -CalculateCSCMeasurementData <Timeframe>
Starts RMS, min/max/average value calculation and outputs results to the logfile.  This is done for all CSC’s in the system.

Example :   -CalculateCSCMeasurementData 30
Default: N/A
Usage:  This command can be used at any time.  This command only applies to CSC AEs.
Arguments
Timeframe
The amount of time the data will be analyzed before the results are output to the logfile.  This value must be an integer and be between 1 and 60 inclusive.

 -CreateContinuousSignalGroupAcqEnt <Acq Ent Name> <Hardware Sub System Name> <Channel Count> <Channel Names>
Creates a new instance of a continuous signal group (CSG) acquisition entity in __prod_name.  CSGs are designed to continuously process the incoming waveform for multiple channels.

Example :   -CreateContinuousSignalGroupAcqEnt  CSG1 AcqSystem1 16 X1 T1
Default: __prod_name does not create any CSG acquisition entities if this command is not issued.
Usage:  This command can be used only when __prod_name is idle.  This command only applies to CSG AEs.
Arguments
Acq Ent Name
The name of the CSG 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.
Channel Count
The number of channels that will be in this group. This value must be less than or equal to the number of AD channels available in the HWSS identified by HWSS Name.
Channel Names The list of names used as part of each channel name.  These parameters are optional.  The number of channel names specified  must be less than or equal to the Channel Count parameter.  If names are not specified for all channels, the default naming scheme will be used based on the index of the channel.  Each name specified will be appended after the AE name and @ symbol.  In the case of the example above the channel name at index 0 would be CSG1@X1 and the channel name at index 2 would be CSG1@002.

 -CreateCscAcqEnt <Acq Ent Name> <Hardware Sub System Name>
Creates a new instance of a continuously sampled channel (CSC) acquisition entity in __prod_name.  CSCs are designed to continuously process the incoming waveform.

Example :   -CreateCSCAcqEnt CSC1 AcqSystem1
Default: __prod_name does not create any CSC acquisition entities if this command is not issued.
Usage:  This command can be used only when __prod_name is idle.  This command only applies to CSC AEs.
Arguments
Acq Ent Name
The name of the CSC 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.

 -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 conversion factor value of each sub channel  for the specified acquisition entity.

Example :   -GetVoltageConversion 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 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 CSC5
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 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.  This command does not apply to CSG objects.
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 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.
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 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 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 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.
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 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.
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 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 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 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.
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 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.
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 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 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 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.
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 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.
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 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.
Sample Frequency The sample frequency for the specified acquisition entity.

 -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 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 The sub sampling interleave for the specified acquisition entity.


 - 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 -SetPlotEnabled command.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 Channel 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 CSC1 31 
Default: All acquisition entities are referenced to the REF1 connection on their corresponding headstage. (i.e. CSC33 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



 -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.

 -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.
Note:  To enable/disable CSC writing for all channels, the wildcard character * may be used.
ie: -SetDiskWriteEnabled "CSC*" false
This applies only to CSC entities, and not Video files.
Arguments
Acq Ent Name
The name of the acquisition entity which will be modified, or * for all CSC entities.
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.

 -SetSubChannelEnabled <Acq Ent Name> <Channel Index> <Enabled>
Enables or disables a particular subchannel of an acquisition entity.  Disabling a subchannel 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.