Spike Plot Commands

These commands will modify how individual spike plots display their data.  Some display options can only be changed at the spike window level.  See the spike window commands for more information (including adding plots to a window).

-SetClusterDisplay <Window Name> <Acq Ent Name> <Cluster Number> <Value>

If spike definitions have been imported into __prod_name from Spike Sort 3D, spikes will be classified into cluster (aka cell) numbers as they are detected.  Classified spikes will appear in a different color (corresponding to their cell number) than unclassified spikes.  You may choose to only display certain cells in a spike plot to better view cells of interest.  As spikes are detected and sent to the spike plot to be displayed, __prod_name will check to see if the cell should be shown before plotting the waveform.  This command only takes effect as spikes are drawn, and will not remove or show previously displayed waveforms.   No data is cleared when this value is changed, and only the specified spike plot is affected. Example :  -SetClusterDisplay Spikewindow SE1 3 on Default:  All cells have their display set to On as soon as they are defined. Usage:  This command can be used at any time.  This command only affects Spike plots.

Arguments

Window Name The name of the window that contains the plot you want to change. Acq Ent Name The name of the acquisition entity whose plot you want to change.  If the window does not contain a plot for the specified acquisition entity, this command will fail.  This is also referred to as the plot name. Cluster Number The cluster whose drawing state you wish to change.  This value must be between 0 and 31.  Cluster 0 is for all unclassified spikes. Value The value can be one of the following keywords: On:  All incoming spikes that are classified with the specified cluster number will be shown. Off:  All incoming spikes that are classified with the specified cluster number will be hidden.

-SetFeaturePlotSources <Window Name> <Acq Ent Name> <Feature Plot Number> <X Source> <Y Source>

This command is used to change the data that is displayed in each of the feature plots of a Spike plot.  All data in the feature plot will be cleared when the feature sources are changed. Example :  -SetFeaturePlotSources Spikewindow SE1 2 0 1 Default:  All feature plots are created with the X source set to 0 and Y source set to 1. Usage:  This command can be used at any time.  This command only affects Spike plots.

Arguments

Window Name The name of the window that contains the plot you want to change. Acq Ent Name The name of the acquisition entity whose plot you want to change.  If the window does not contain a plot for the specified acquisition entity, this command will fail.  This is also referred to as the plot name. Feature Plot Number The feature plot to be modified.  This value must be between 1 and 9.  If  the index of the feature plot you change is not visible, no data will be cleared from the display. X Source The feature index to be used on the X axis of the feature plot.  This value must be between 1 and 8.  The exact data that is referenced by the feature index can be different for each acquisition entity.  See the -SetWaveformFeature command for more information. Y Source The feature index to be used on the Y axis of the feature plot.  This value must be between 1 and 8.  The exact data that is referenced by the feature index can be different for each acquisition entity.  See the -SetWaveformFeature command for more information.

-SetFeaturePlotView <Window Name> <Acq Ent Name> <Feature Plot Number> <Left> <Top> <Right> <Bottom>

This command allows you to change the data ranges visible in a single feature plot.  No data is cleared when the view is changed.  It is recommended that the feature plot view be adjusted using one of the graphical methods in __prod_name, as calculating the normalized AD counts necessary for this command is sometimes cumbersome. Example :  -SetFeaturePlotView Spikewindow SE1 1 1000 1500 2000 0 Default:  All feature plots are created using the full view.  They are as follows:  Left: -32767  Top: 32767  Right: 32767  Bottom: -32767 Usage:  This command can be used at any time.  This command only affects Spike plots.

Arguments

Window Name The name of the window that contains the plot you want to change. Acq Ent Name The name of the acquisition entity whose plot you want to change.  If the window does not contain a plot for the specified acquisition entity, this command will fail.  This is also referred to as the plot name. Feature Plot Number The feature plot to be modified.  This value must be between 1 and 9. Left The smallest X value that will be displayed in the feature plot.  This value is in normalized AD counts and can be any whole number between -32767 and 32768. Top The largest Y value that will be displayed in the feature plot.  This value is in normalized AD counts and can be any whole number between -32767 and 32768. Right The largest X value that will be displayed in the feature plot.  This value is in normalized AD counts and can be any whole number between -32767 and 32768. Bottom The smallest Y value that will be displayed in the feature plot.  This value is in normalized AD counts and can be any whole number between -32767 and 32768.

-SetPlotEnabled <Window Name> <Acq Ent Name> <Enabled>

This command is used if you want to stop plotting data for only a single acquisition entity's plot  in a window, but do not want to remove the plot from the window.  This is similar to a freeze for only a single plot (see -SetPlotWindowFrozen).  This command works like a Pause button on a DVD player.  It will lock in whatever is currently displayed in the plot.  If an action is taken that will clear the plot, the last data displayed will be cleared.  No data will be added to the plot while it is disabled, but otherwise is processed normally.   Example : -SetPlotEnabled "Spike Window 1" SE1 True Default:  All plots are enabled when they are created.. Usage:  This command can be used at any time.  This command only affects Spike and Time plots.

Arguments

Window Name The name of the window that contains the plot you want to change. Acq Ent Name The name of the acquisition entity whose plot you want to change.  If the window does not contain a plot for the specified acquisition entity, this command will fail.  This is also referred to as the plot name. Enabled The enabled value can be one of the following keywords: True:  Only the specified plot will be disabled and no new data will be plotted.  To begin plotting new data, reissue this command with enabled set to false. False:  Only the specified plot will begin to plot new data.  If a plot was disabled prior to this command being issued, all of the data visible in the disabled display will be cleared.

-SetPlotLabel <Window Name> <Acq Ent Name> <Value>

Sets a label to the plot in the specified window.  This label is used only for display purposes.  Not all plots will show the label  on the plot itself, but all plot labels will be visible in the Property Dialog's tree view.  The data in only the plot whose label is set will be cleared when the plot label is changed. Example : -SetPlotLabel "Spike Window 1" SE1 "My Label" Default:  All plots are created with no label. Usage:  This command can be used at any time.

Arguments

Window Name The name of the window that contains the plot you want to change. Acq Ent Name The name of the acquisition entity whose plot you want to change.  If the window does not contain a plot for the specified acquisition entity, this command will fail.  This is also referred to as the plot name. Value The label to use for this plot.