NeuroscopeView Class Reference

The NeuroscopeView class provides the view widgets for the document instance (NeuroscopeDoc instance) and is displayed as a MDI child window in the main view area of the NeuroscopeApp class instance. More...

#include <neuroscopeview.h>

Collaboration diagram for NeuroscopeView:

[legend]List of all members.

Public Slots
void	slotChannelsSelected (const QValueList< int > &selectedIds)
	Informs listener that the channels selectedIds have been selected.
void	setStartAndDuration (long start, long duration)
	Sets the starting time and the time window in miliseconds.
void	slotEventModified (QString providerName, int selectedEventId, double time, double newTime)
	Informs the application that an event has been modified.
void	slotEventRemoved (QString providerName, int selectedEventId, double time)
	Informs the application that an event has been removed.
void	slotEventAdded (QString providerName, QString addedEventDescription, double time)
	Informs that an event has been added.
void	updateWaveformInformation (int nbSamplesBefore, int nbSamplesAfter, bool active)
	Updates the description of a spike waveform.
void	updatePositionInformation (int width, int height, QImage backgroundImage, bool newOrientation, bool active)
	Updates the information needed to draw the position of the animal.
void	positionDockClosed (QWidget *view)
	Takes care of the closing of the PositionView.
void	setEventsInPositionView (bool shown)
	Sets if events are displayed in the PositionView.
void	updateTraceBackgroundImage (QImage traceBackgroundImage, bool active)
	Updates the background image.
void	slotChannelsSelected (const QValueList< int > &selectedIds)
	Informs listener that the channels selectedIds have been selected.
void	setStartAndDuration (long start, long duration)
	Sets the starting time and the time window in miliseconds.
void	slotEventModified (QString providerName, int selectedEventId, double time, double newTime)
	Informs the application that an event has been modified.
void	slotEventRemoved (QString providerName, int selectedEventId, double time)
	Informs the application that an event has been removed.
void	slotEventAdded (QString providerName, QString addedEventDescription, double time)
	Informs that an event has been added.
void	updateWaveformInformation (int nbSamplesBefore, int nbSamplesAfter, bool active)
	Updates the description of a spike waveform.
void	updatePositionInformation (int width, int height, QImage backgroundImage, bool newOrientation, bool active)
	Updates the information needed to draw the position of the animal.
void	positionDockClosed (QWidget *view)
	Takes care of the closing of the PositionView.
void	setEventsInPositionView (bool shown)
	Sets if events are displayed in the PositionView.
void	updateTraceBackgroundImage (QImage traceBackgroundImage, bool active)
	Updates the background image.
Signals
void	changeBackgroundColor (QColor color)
void	updateContents ()
void	greyScale (bool geyScale)
void	clusterWaveformsDisplay (bool waveforms)
void	clusterRasterDisplay (bool raster)
void	clusterVerticalLinesDisplay (bool lines)
void	multiColumnsDisplay (bool multi)
void	channelsSelected (const QValueList< int > &selectedIds)
void	modeToSet (BaseFrame::Mode selectedMode, bool active)
void	showChannels (const QValueList< int > &channelsToShow)
void	channelColorUpdate (int channelId, bool active)
void	groupColorUpdate (int groupId, bool active)
void	increaseAllAmplitude ()
void	decreaseAllAmplitude ()
void	increaseAmplitude (const QValueList< int > &selectedIds)
void	decreaseAmplitude (const QValueList< int > &selectedIds)
void	updateGains (int gain, int acquisitionGain)
void	updateDrawing ()
void	groupsHaveBeenModified (bool)
void	channelsToBeSelected (const QValueList< int > &selectedIds)
void	resetChannelOffsets (const QMap< int, int > &selectedChannelDefaultOffsets)
void	resetChannelGains (const QValueList< int > &selectedChannels)
void	drawTraces ()
void	reset ()
void	showLabels (bool show)
void	displayCalibration (bool show, bool active)
void	newClusterProvider (ClustersProvider *clustersProvider, QString name, ItemColors *clusterColors, bool active, QValueList< int > &clustersToShow, QMap< int, QValueList< int > > *displayGroupsClusterFile, QMap< int, int > *channelsSpikeGroups, int nbSamplesBefore, int nbSamplesAfter, const QValueList< int > &clustersToSkip)
void	newSamplingRate (long long recordingLength)
void	clusterProviderRemoved (QString name, bool active)
void	showClusters (QString name, QValueList< int > &clustersToShow)
void	clusterColorUpdated (QString name, int clusterId, bool active)
void	nextCluster ()
void	previousCluster ()
void	print (QPainter &printPainter, QPaintDeviceMetrics &metrics, QString filePath, bool whiteBackground)
void	newEventProvider (EventsProvider *eventsProvider, QString name, ItemColors *eventColors, bool active, QValueList< int > &eventsToShow, const QValueList< int > &eventsToSkip)
void	eventProviderRemoved (QString name, bool active, bool lastFile)
void	showEvents (QString name, QValueList< int > &eventsToShow)
void	eventColorUpdated (QString name, int eventId, bool active)
void	nextEvent ()
void	previousEvent ()
void	eventModified (QString providerName, int selectedEventId, double time, double newTime)
void	updateEvents (bool active, QString providerName, double time, double newTime)
void	eventToRemove ()
void	eventRemoved (QString providerName, int selectedEventId, double time)
void	updateEvents (bool active, QString providerName, double time)
void	newEventProperties (QString providerName, QString eventId)
void	eventAdded (QString providerName, QString addedEventDescription, double time)
void	updateEvents (QString providerName, QValueList< int > &eventsToShow, bool active)
void	waveformInformationUpdated (int nbSamplesBefore, int nbSamplesAfter, bool active)
void	positionInformationUpdated (int width, int height, QImage backgroundImage, bool newOrientation, bool active)
void	timeChanged (long start, long duration)
void	positionViewClosed ()
void	clusterProviderUpdated (bool active)
void	noneBrowsingClusterListUpdated (QString providerName, const QValueList< int > &clustersToNotBrowse)
void	noneBrowsingEventListUpdated (QString providerName, const QValueList< int > &eventsToNotBrowse)
void	skipStatusChanged (const QValueList< int > &skippedChannels)
void	decreaseTheRasterHeight ()
void	increaseTheRasterHeight ()
void	updateEventDisplay ()
void	eventsShownInPositionView (bool shown)
void	traceBackgroundImageUpdate (QImage traceBackgroundImage, bool active)
void	changeBackgroundColor (QColor color)
void	updateContents ()
void	greyScale (bool geyScale)
void	clusterWaveformsDisplay (bool waveforms)
void	clusterRasterDisplay (bool raster)
void	clusterVerticalLinesDisplay (bool lines)
void	multiColumnsDisplay (bool multi)
void	channelsSelected (const QValueList< int > &selectedIds)
void	modeToSet (BaseFrame::Mode selectedMode, bool active)
void	showChannels (const QValueList< int > &channelsToShow)
void	channelColorUpdate (int channelId, bool active)
void	groupColorUpdate (int groupId, bool active)
void	increaseAllAmplitude ()
void	decreaseAllAmplitude ()
void	increaseAmplitude (const QValueList< int > &selectedIds)
void	decreaseAmplitude (const QValueList< int > &selectedIds)
void	updateGains (int gain, int acquisitionGain)
void	updateDrawing ()
void	groupsHaveBeenModified (bool)
void	channelsToBeSelected (const QValueList< int > &selectedIds)
void	resetChannelOffsets (const QMap< int, int > &selectedChannelDefaultOffsets)
void	resetChannelGains (const QValueList< int > &selectedChannels)
void	drawTraces ()
void	reset ()
void	showLabels (bool show)
void	displayCalibration (bool show, bool active)
void	newClusterProvider (ClustersProvider *clustersProvider, QString name, ItemColors *clusterColors, bool active, QValueList< int > &clustersToShow, QMap< int, QValueList< int > > *displayGroupsClusterFile, QMap< int, int > *channelsSpikeGroups, int nbSamplesBefore, int nbSamplesAfter, const QValueList< int > &clustersToSkip)
void	newSamplingRate (long long recordingLength)
void	clusterProviderRemoved (QString name, bool active)
void	showClusters (QString name, QValueList< int > &clustersToShow)
void	clusterColorUpdated (QString name, int clusterId, bool active)
void	nextCluster ()
void	previousCluster ()
void	print (QPainter &printPainter, QPaintDeviceMetrics &metrics, QString filePath, bool whiteBackground)
void	newEventProvider (EventsProvider *eventsProvider, QString name, ItemColors *eventColors, bool active, QValueList< int > &eventsToShow, const QValueList< int > &eventsToSkip)
void	eventProviderRemoved (QString name, bool active, bool lastFile)
void	showEvents (QString name, QValueList< int > &eventsToShow)
void	eventColorUpdated (QString name, int eventId, bool active)
void	nextEvent ()
void	previousEvent ()
void	eventModified (QString providerName, int selectedEventId, double time, double newTime)
void	updateEvents (bool active, QString providerName, double time, double newTime)
void	eventToRemove ()
void	eventRemoved (QString providerName, int selectedEventId, double time)
void	updateEvents (bool active, QString providerName, double time)
void	newEventProperties (QString providerName, QString eventId)
void	eventAdded (QString providerName, QString addedEventDescription, double time)
void	updateEvents (QString providerName, QValueList< int > &eventsToShow, bool active)
void	waveformInformationUpdated (int nbSamplesBefore, int nbSamplesAfter, bool active)
void	positionInformationUpdated (int width, int height, QImage backgroundImage, bool newOrientation, bool active)
void	timeChanged (long start, long duration)
void	positionViewClosed ()
void	clusterProviderUpdated (bool active)
void	noneBrowsingClusterListUpdated (QString providerName, const QValueList< int > &clustersToNotBrowse)
void	noneBrowsingEventListUpdated (QString providerName, const QValueList< int > &eventsToNotBrowse)
void	skipStatusChanged (const QValueList< int > &skippedChannels)
void	decreaseTheRasterHeight ()
void	increaseTheRasterHeight ()
void	updateEventDisplay ()
void	eventsShownInPositionView (bool shown)
void	traceBackgroundImageUpdate (QImage traceBackgroundImage, bool active)
Public Member Functions
	NeuroscopeView (NeuroscopeApp &mainWindow, QString label, long startTime, long duration, QColor backgroundColor, int wflags, KStatusBar *statusBar, QValueList< int > *channelsToDisplay, bool greyScale, TracesProvider &tracesProvider, bool multiColumns, bool verticalLines, bool raster, bool waveforms, bool labelsDisplay, int unitGain, int acquisitionGain, ChannelColors *channelColors, QMap< int, QValueList< int > > *groupsChannels, QMap< int, int > *channelsGroups, QValueList< int > offsets, QValueList< int > channelGains, QValueList< int > selected, QMap< int, bool > skipStatus, int rasterHeight, QString backgroundImagePath, QWidget *parent=0, const char *name=0)
	Parameters: mainWindow  a reference on the main window of the application.
	~NeuroscopeView ()
	Destructor for the main view.
void	print (KPrinter *pPrinter, QString filePath, bool whiteBackground)
	Contains the implementation for printing functionality.
void	setGains (int gain, int acquisitionGain)
	Sets the unit gain and the acquisition system gain.
void	updateBackgroundColor (QColor color)
	Updates the background color used in the views.
void	documentFeaturesModified ()
	Informs all the child widgets that one of the features for the document have changed.
void	samplingRateModified (long long recordingLength)
	Informs all the child widgets that the sampling rate for the document has changed.
void	setChannelNb (int nb)
	Updates the number of channels in the child widgets.
void	showAllWidgets ()
	Show all the encapsulated widgets contain in the view.
void	setGreyScale (bool grey)
	All the channels of the display are now display either in a gradation of grey or in color.
bool	getGreyScale () const
	Retuns true if the channels of the display are display in a gradation of grey, false if they are display in color.
void	shownChannelsUpdate (const QValueList< int > &channelsToShow)
	Updates the list of channels shown with channelsToShow.
const QValueList< int > &	channels () const
	Returns the list of the channels presented in the view.
void	shownClustersUpdate (QString name, QValueList< int > &clustersToShow)
	Updates the list of clusters for the cluster provider name shown with clustersToShow.
void	shownEventsUpdate (QString name, QValueList< int > &eventsToShow)
	Updates the list of events for the event provider name shown with eventsToShow.
void	setMultiColumns (bool multiple)
	Sets the mode of presentation to single or multiple columns.
void	setClusterVerticalLines (bool lines)
	Displays or hides vertical lines to show the clusters.
void	setClusterRaster (bool raster)
	Displays or hides a raster to show the clusters.
void	setClusterWaveforms (bool waveforms)
	Displays or hides the cluster waveforms on top of the traces.
bool	getMultiColumns () const
	Returns true if traces are displayed on multiple columns, false otherwise.
bool	getClusterVerticalLines () const
	Returns true if vertical lines are displayed to show the clusters, false otherwise.
bool	getClusterRaster () const
	Returns true if a raster is drawn to show the clusters, false otherwise.
bool	getClusterWaveforms () const
	Returns true if waveforms are drawn on top of the traces, false otherwise.
const QValueList< int > *	getSelectedClusters (QString name) const
	Returns the list containing the selected clusters for the given cluster provider identified by name.
const QValueList< int > *	getSelectedEvents (QString name) const
	Returns the list containing the selected events for the given event provider identified by name.
void	setMode (BaseFrame::Mode selectedMode, bool active)
	Updates the selected tool, methode call after the user selected a tool.
bool	isSelectionTool ()
	Tests if the currently selected tool is the selection one.
void	singleChannelColorUpdate (int channelId, bool active)
	Changes the color of a channel.
void	channelGroupColorUpdate (int groupId, bool active)
	Changes the color of a group of channels.
void	increaseAllChannelsAmplitude ()
	Triggers the increase of the amplitude of all the channels.
void	decreaseAllChannelsAmplitude ()
	Triggers the decrease of the amplitude of all the channels.
void	increaseSelectedChannelsAmplitude (const QValueList< int > selectedIds)
	Triggers the increase of the amplitude of the selected channels.
void	decreaseSelectedChannelsAmplitude (const QValueList< int > selectedIds)
	Triggers the decrease of the amplitude of the selected channels.
void	updateViewContents ()
	Update all the encapsulated widgets contain in the view.
void	groupsModified (bool active)
	Triggers the update of the display due to a change in the display groups.
void	selectChannels (const QValueList< int > &selectedIds)
	Selects the channels in the TraceView.
void	resetOffsets (const QValueList< int > &selectedIds)
	Resets the offset of the selected channels.
void	resetGains (const QValueList< int > &selectedIds)
	Resets the gain of the selected channels.
const QValueList< int > &	getChannelOffset () const
	Returns the list containing the offset for each channel.
const QValueList< int > &	getGains () const
	Returns the list containing the exponents used to compute the drawing gain for each channel.
const QValueList< int > &	getSelectedChannels () const
	Returns the list containing the selected channels.
void	setSelectedChannels (const QValueList< int > &selectedIds)
	Sets the channels selected in the channel palettes.
void	setTabName (QString newLabel)
	Sets the label for the display when in tab page mode.
QString	getTabName ()
	Gets the label for the display when in tab page mode.
long	getStartTime ()
	Gets the starting time in miliseconds.
long	getTimeWindow ()
	Gets the time window in miliseconds.
void	showLabelsUpdate (bool status)
	Displays or hides the labels next to the traces.
bool	getLabelStatus () const
	Returns true if labels are drawn next to the traces, false otherwise.
void	showCalibration (bool show, bool active)
	Shows or hides the calibration bar.
void	setClusterProvider (ClustersProvider *clustersProvider, QString name, ItemColors *clusterColors, bool active, QValueList< int > &clustersToShow, QMap< int, QValueList< int > > *displayGroupsClusterFile, QMap< int, int > *channelsSpikeGroups, int nbSamplesBefore, int nbSamplesAfter, const QValueList< int > &clustersToSkip)
	Adds a new provider of cluster data.
void	removeClusterProvider (QString name, bool active)
	Removes a provider of cluster data.
void	clusterColorUpdate (QString name, int clusterId, bool active)
	Changes the color of a cluster.
void	ignoreWaveformInformation ()
	Hides the cluster waveforms on top of the traces but keep the setting of displaying or hidding them.
void	showNextCluster ()
	Retrieves the next cluster.
void	showPreviousCluster ()
	Retrieves the previous cluster.
void	setEventProvider (EventsProvider *eventsProvider, QString name, ItemColors *eventColors, bool active, QValueList< int > &eventsToShow, const QValueList< int > &eventsToSkip)
	Adds a new provider of event data.
void	removeEventProvider (QString name, bool active, bool lastFile)
	Removes a provider of event data.
void	eventColorUpdate (QString name, int eventId, bool active)
	Changes the color of a event.
void	showNextEvent ()
	Retrieves the next event.
void	showPreviousEvent ()
	Retrieves the previous event.
void	updateEvents (QString providerName, int selectedEventId, float time, float newTime, bool active)
	Updates the traceView if concerned by the modification of the event.
void	removeEvent ()
	Deletes the selected event.
void	updateEventsAfterRemoval (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the suppression of the event.
void	updateEventsAfterAddition (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the addition of the event.
void	updateEvents (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the modification of the event.
void	eventToAddProperties (QString providerName, QString eventDescription)
	Informs the traceView of the properties for the next event to be added.
void	updateSelectedEventsIds (QString providerName, QMap< int, int > &oldNewEventIds, int addedEventId, bool active, bool added)
	Updates the ids of the selected events due to the modification of event ids due to the addition or suppression of an event description.
void	removePositionProvider (QString name, bool active)
	Removes the position provider.
bool	isPositionView () const
	Returns true if a position view is displayed, false otherwise.
void	addPositionView (PositionsProvider *positionsProvider, QImage backgroundImage, QColor backgroundColor, long startTime, long duration, int width, int height, bool showEvents)
	Adds a PositionView to the display.
void	addPositionView (PositionsProvider *positionsProvider, QImage backgroundImage, QColor backgroundColor, int width, int height)
	Adds a PositionView to the display.
void	removePositionView ()
	Removes the PositionView from the display.
void	updateClusterData (bool active)
	Updates the cluster information presented on the display.
const QValueList< int > *	getClustersNotUsedForBrowsing (QString name) const
	Returns the list of clusters to not be used for browsing for the given cluster provider identified by name.
const QValueList< int > *	getEventsNotUsedForBrowsing (QString name) const
	Returns the list of events to be not used for browsing for the given event provider identified by name.
void	updateNoneBrowsingEventList (QString providerName, const QValueList< int > &eventsToNotBrowse)
	Updates the list of events to not use while browsing.
void	updateNoneBrowsingClusterList (QString providerName, const QValueList< int > &clustersToNotBrowse)
	Updates the list of clusters to not use while browsing.
void	updateSkipStatus (const QValueList< int > &skippedChannels)
	Updates the list of skipped channels.
void	increaseRasterHeight ()
	Increases the height of the rasters.
void	decreaseRasterHeight ()
	Decreases the height of the rasters.
int	getRasterHeight ()
	Returns the height of the rasters.
int	isEventsInPositionView () const
	Returns if events are displayed in the PositionView.
	NeuroscopeView (NeuroscopeApp &mainWindow, QString label, long startTime, long duration, QColor backgroundColor, int wflags, KStatusBar *statusBar, QValueList< int > *channelsToDisplay, bool greyScale, TracesProvider &tracesProvider, bool multiColumns, bool verticalLines, bool raster, bool waveforms, bool labelsDisplay, int unitGain, int acquisitionGain, ChannelColors *channelColors, QMap< int, QValueList< int > > *groupsChannels, QMap< int, int > *channelsGroups, QValueList< int > offsets, QValueList< int > channelGains, QValueList< int > selected, QMap< int, bool > skipStatus, int rasterHeight, QString backgroundImagePath, QWidget *parent=0, const char *name=0)
	Parameters: mainWindow  a reference on the main window of the application.
	~NeuroscopeView ()
	Destructor for the main view.
void	print (KPrinter *pPrinter, QString filePath, bool whiteBackground)
	Contains the implementation for printing functionality.
void	setGains (int gain, int acquisitionGain)
	Sets the unit gain and the acquisition system gain.
void	updateBackgroundColor (QColor color)
	Updates the background color used in the views.
void	documentFeaturesModified ()
	Informs all the child widgets that one of the features for the document have changed.
void	samplingRateModified (long long recordingLength)
	Informs all the child widgets that the sampling rate for the document has changed.
void	setChannelNb (int nb)
	Updates the number of channels in the child widgets.
void	showAllWidgets ()
	Show all the encapsulated widgets contain in the view.
void	setGreyScale (bool grey)
	All the channels of the display are now display either in a gradation of grey or in color.
bool	getGreyScale () const
	Retuns true if the channels of the display are display in a gradation of grey, false if they are display in color.
void	shownChannelsUpdate (const QValueList< int > &channelsToShow)
	Updates the list of channels shown with channelsToShow.
const QValueList< int > &	channels () const
	Returns the list of the channels presented in the view.
void	shownClustersUpdate (QString name, QValueList< int > &clustersToShow)
	Updates the list of clusters for the cluster provider name shown with clustersToShow.
void	shownEventsUpdate (QString name, QValueList< int > &eventsToShow)
	Updates the list of events for the event provider name shown with eventsToShow.
void	setMultiColumns (bool multiple)
	Sets the mode of presentation to single or multiple columns.
void	setClusterVerticalLines (bool lines)
	Displays or hides vertical lines to show the clusters.
void	setClusterRaster (bool raster)
	Displays or hides a raster to show the clusters.
void	setClusterWaveforms (bool waveforms)
	Displays or hides the cluster waveforms on top of the traces.
bool	getMultiColumns () const
	Returns true if traces are displayed on multiple columns, false otherwise.
bool	getClusterVerticalLines () const
	Returns true if vertical lines are displayed to show the clusters, false otherwise.
bool	getClusterRaster () const
	Returns true if a raster is drawn to show the clusters, false otherwise.
bool	getClusterWaveforms () const
	Returns true if waveforms are drawn on top of the traces, false otherwise.
const QValueList< int > *	getSelectedClusters (QString name) const
	Returns the list containing the selected clusters for the given cluster provider identified by name.
const QValueList< int > *	getSelectedEvents (QString name) const
	Returns the list containing the selected events for the given event provider identified by name.
void	setMode (BaseFrame::Mode selectedMode, bool active)
	Updates the selected tool, methode call after the user selected a tool.
bool	isSelectionTool ()
	Tests if the currently selected tool is the selection one.
void	singleChannelColorUpdate (int channelId, bool active)
	Changes the color of a channel.
void	channelGroupColorUpdate (int groupId, bool active)
	Changes the color of a group of channels.
void	increaseAllChannelsAmplitude ()
	Triggers the increase of the amplitude of all the channels.
void	decreaseAllChannelsAmplitude ()
	Triggers the decrease of the amplitude of all the channels.
void	increaseSelectedChannelsAmplitude (const QValueList< int > selectedIds)
	Triggers the increase of the amplitude of the selected channels.
void	decreaseSelectedChannelsAmplitude (const QValueList< int > selectedIds)
	Triggers the decrease of the amplitude of the selected channels.
void	updateViewContents ()
	Update all the encapsulated widgets contain in the view.
void	groupsModified (bool active)
	Triggers the update of the display due to a change in the display groups.
void	selectChannels (const QValueList< int > &selectedIds)
	Selects the channels in the TraceView.
void	resetOffsets (const QValueList< int > &selectedIds)
	Resets the offset of the selected channels.
void	resetGains (const QValueList< int > &selectedIds)
	Resets the gain of the selected channels.
const QValueList< int > &	getChannelOffset () const
	Returns the list containing the offset for each channel.
const QValueList< int > &	getGains () const
	Returns the list containing the exponents used to compute the drawing gain for each channel.
const QValueList< int > &	getSelectedChannels () const
	Returns the list containing the selected channels.
void	setSelectedChannels (const QValueList< int > &selectedIds)
	Sets the channels selected in the channel palettes.
void	setTabName (QString newLabel)
	Sets the label for the display when in tab page mode.
QString	getTabName ()
	Gets the label for the display when in tab page mode.
long	getStartTime ()
	Gets the starting time in miliseconds.
long	getTimeWindow ()
	Gets the time window in miliseconds.
void	showLabelsUpdate (bool status)
	Displays or hides the labels next to the traces.
bool	getLabelStatus () const
	Returns true if labels are drawn next to the traces, false otherwise.
void	showCalibration (bool show, bool active)
	Shows or hides the calibration bar.
void	setClusterProvider (ClustersProvider *clustersProvider, QString name, ItemColors *clusterColors, bool active, QValueList< int > &clustersToShow, QMap< int, QValueList< int > > *displayGroupsClusterFile, QMap< int, int > *channelsSpikeGroups, int nbSamplesBefore, int nbSamplesAfter, const QValueList< int > &clustersToSkip)
	Adds a new provider of cluster data.
void	removeClusterProvider (QString name, bool active)
	Removes a provider of cluster data.
void	clusterColorUpdate (QString name, int clusterId, bool active)
	Changes the color of a cluster.
void	ignoreWaveformInformation ()
	Hides the cluster waveforms on top of the traces but keep the setting of displaying or hidding them.
void	showNextCluster ()
	Retrieves the next cluster.
void	showPreviousCluster ()
	Retrieves the previous cluster.
void	setEventProvider (EventsProvider *eventsProvider, QString name, ItemColors *eventColors, bool active, QValueList< int > &eventsToShow, const QValueList< int > &eventsToSkip)
	Adds a new provider of event data.
void	removeEventProvider (QString name, bool active, bool lastFile)
	Removes a provider of event data.
void	eventColorUpdate (QString name, int eventId, bool active)
	Changes the color of a event.
void	showNextEvent ()
	Retrieves the next event.
void	showPreviousEvent ()
	Retrieves the previous event.
void	updateEvents (QString providerName, int selectedEventId, float time, float newTime, bool active)
	Updates the traceView if concerned by the modification of the event.
void	removeEvent ()
	Deletes the selected event.
void	updateEventsAfterRemoval (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the suppression of the event.
void	updateEventsAfterAddition (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the addition of the event.
void	updateEvents (QString providerName, int eventId, float time, bool active)
	Updates the traceView if concerned by the modification of the event.
void	eventToAddProperties (QString providerName, QString eventDescription)
	Informs the traceView of the properties for the next event to be added.
void	updateSelectedEventsIds (QString providerName, QMap< int, int > &oldNewEventIds, int addedEventId, bool active, bool added)
	Updates the ids of the selected events due to the modification of event ids due to the addition or suppression of an event description.
void	removePositionProvider (QString name, bool active)
	Removes the position provider.
bool	isPositionView () const
	Returns true if a position view is displayed, false otherwise.
void	addPositionView (PositionsProvider *positionsProvider, QImage backgroundImage, QColor backgroundColor, long startTime, long duration, int width, int height, bool showEvents)
	Adds a PositionView to the display.
void	addPositionView (PositionsProvider *positionsProvider, QImage backgroundImage, QColor backgroundColor, int width, int height)
	Adds a PositionView to the display.
void	removePositionView ()
	Removes the PositionView from the display.
void	updateClusterData (bool active)
	Updates the cluster information presented on the display.
const QValueList< int > *	getClustersNotUsedForBrowsing (QString name) const
	Returns the list of clusters to not be used for browsing for the given cluster provider identified by name.
const QValueList< int > *	getEventsNotUsedForBrowsing (QString name) const
	Returns the list of events to be not used for browsing for the given event provider identified by name.
void	updateNoneBrowsingEventList (QString providerName, const QValueList< int > &eventsToNotBrowse)
	Updates the list of events to not use while browsing.
void	updateNoneBrowsingClusterList (QString providerName, const QValueList< int > &clustersToNotBrowse)
	Updates the list of clusters to not use while browsing.
void	updateSkipStatus (const QValueList< int > &skippedChannels)
	Updates the list of skipped channels.
void	increaseRasterHeight ()
	Increases the height of the rasters.
void	decreaseRasterHeight ()
	Decreases the height of the rasters.
int	getRasterHeight ()
	Returns the height of the rasters.
int	isEventsInPositionView () const
	Returns if events are displayed in the PositionView.

---

Detailed Description

The NeuroscopeView class provides the view widgets for the document instance (NeuroscopeDoc instance) and is displayed as a MDI child window in the main view area of the NeuroscopeApp class instance.

The document instance keeps a list of all views that represent the document contents as there can be more than one view. Views get created in NeuroscopeApp::createDisplay() and automatically added to the list of views. The NeuroscopeView class inherits QWidget as a KDockArea to give it the ability to contains dockWidgets.

Author:

Lynn Hazan

---

Constructor & Destructor Documentation

NeuroscopeView::NeuroscopeView	(	NeuroscopeApp &	mainWindow,
		QString	label,
		long	startTime,
		long	duration,
		QColor	backgroundColor,
		int	wflags,
		KStatusBar *	statusBar,
		QValueList< int > *	channelsToDisplay,
		bool	greyScale,
		TracesProvider &	tracesProvider,
		bool	multiColumns,
		bool	verticalLines,
		bool	raster,
		bool	waveforms,
		bool	labelsDisplay,
		int	unitGain,
		int	acquisitionGain,
		ChannelColors *	channelColors,
		QMap< int, QValueList< int > > *	groupsChannels,
		QMap< int, int > *	channelsGroups,
		QValueList< int >	offsets,
		QValueList< int >	channelGains,
		QValueList< int >	selected,
		QMap< int, bool >	skipStatus,
		int	rasterHeight,
		QString	backgroundImagePath,
		QWidget *	parent = 0,
		const char *	name = 0
	)

Parameters:

mainWindow

a reference on the main window of the application.

Parameters:

	label	label for the display when in tab page mode.
	startTime	starting time in miliseconds.
	duration	time window in miliseconds.
	backgroundColor	color used as background.
	wflags	common QWidget flags.
	statusBar	a reference to the application status bar.
	channelsToDisplay	list of channel to be shown at the opening of the view.
	greyScale	true if all the channels are display either in a gradation of grey false if they are display in color.
	tracesProvider	provider of the channels data.
	multiColumns	true if the traces are displayed on multiple columns, false otherwise.
	verticalLines	true if vertical lines are displayed to show the clusters, false otherwise.
	raster	true if a raster is drawn to show the clusters, false otherwise
	waveforms	true if waveforms are drawn on top of the traces, false otherwise.
	labelsDisplay	true if labels are drawn next to the traces, false otherwise.
	unitGain	initial gain use to draw the traces in the TraceView.
	acquisitionGain	acquisition gain.
	channelColors	a pointer on the list of colors for the channels.
	groupsChannels	a pointer on the map given the list of channels for each group.
	channelsGroups	a pointer on the map given to which group each channel belongs.
	offsets	list containing the offset for each channel.
	channelGains	list of the exponents used to compute the drawing gain for each channel.
	selected	list of the currently selected channels.
	skipStatus	map given the skip status of the channels.
	rasterHeight	height of the rasters in the world coordinate system.
	backgroundImagePath	path of the image used as background.
	parent	the parent QWidget.
	name	name of the widget (can be used for introspection).

NeuroscopeView::NeuroscopeView	(	NeuroscopeApp &	mainWindow,
		QString	label,
		long	startTime,
		long	duration,
		QColor	backgroundColor,
		int	wflags,
		KStatusBar *	statusBar,
		QValueList< int > *	channelsToDisplay,
		bool	greyScale,
		TracesProvider &	tracesProvider,
		bool	multiColumns,
		bool	verticalLines,
		bool	raster,
		bool	waveforms,
		bool	labelsDisplay,
		int	unitGain,
		int	acquisitionGain,
		ChannelColors *	channelColors,
		QMap< int, QValueList< int > > *	groupsChannels,
		QMap< int, int > *	channelsGroups,
		QValueList< int >	offsets,
		QValueList< int >	channelGains,
		QValueList< int >	selected,
		QMap< int, bool >	skipStatus,
		int	rasterHeight,
		QString	backgroundImagePath,
		QWidget *	parent = 0,
		const char *	name = 0
	)

Parameters:

mainWindow

a reference on the main window of the application.

Parameters:

	label	label for the display when in tab page mode.
	startTime	starting time in miliseconds.
	duration	time window in miliseconds.
	backgroundColor	color used as background.
	wflags	common QWidget flags.
	statusBar	a reference to the application status bar.
	channelsToDisplay	list of channel to be shown at the opening of the view.
	greyScale	true if all the channels are display either in a gradation of grey false if they are display in color.
	tracesProvider	provider of the channels data.
	multiColumns	true if the traces are displayed on multiple columns, false otherwise.
	verticalLines	true if vertical lines are displayed to show the clusters, false otherwise.
	raster	true if a raster is drawn to show the clusters, false otherwise
	waveforms	true if waveforms are drawn on top of the traces, false otherwise.
	labelsDisplay	true if labels are drawn next to the traces, false otherwise.
	unitGain	initial gain use to draw the traces in the TraceView.
	acquisitionGain	acquisition gain.
	channelColors	a pointer on the list of colors for the channels.
	groupsChannels	a pointer on the map given the list of channels for each group.
	channelsGroups	a pointer on the map given to which group each channel belongs.
	offsets	list containing the offset for each channel.
	channelGains	list of the exponents used to compute the drawing gain for each channel.
	selected	list of the currently selected channels.
	skipStatus	map given the skip status of the channels.
	rasterHeight	height of the rasters in the world coordinate system.
	backgroundImagePath	path of the image used as background.
	parent	the parent QWidget.
	name	name of the widget (can be used for introspection).

---

Member Function Documentation

void NeuroscopeView::print	(	KPrinter *	pPrinter,
		QString	filePath,
		bool	whiteBackground
	)

Contains the implementation for printing functionality.

Parameters:

	pPrinter	pointer on the printer object.
	filePath	path of the opened document.
	whiteBackground	true if the printed background has to be white, false otherwise.

void NeuroscopeView::setGains	(	int	gain,
		int	acquisitionGain
	)			[inline]

Sets the unit gain and the acquisition system gain.

Parameters:

	gain	initial gain use to draw the traces in the TraceView.
	acquisitionGain	acquisition gain.

void NeuroscopeView::updateBackgroundColor

(

QColor

color

)

[inline]

Updates the background color used in the views.

Parameters:

color

color of the new background.

void NeuroscopeView::documentFeaturesModified

(

)

[inline]

Informs all the child widgets that one of the features for the document have changed.

The features are: the initial offset or the acquisition system resolution.

void NeuroscopeView::samplingRateModified

(

long long

recordingLength

)

[inline]

Informs all the child widgets that the sampling rate for the document has changed.

Parameters:

recordingLength

the newly computed length of the document.

void NeuroscopeView::setChannelNb

(

int

nb

)

Updates the number of channels in the child widgets.

Parameters:

nb

the new number of channels.

void NeuroscopeView::showAllWidgets

(

)

[inline]

Show all the encapsulated widgets contain in the view.

The widgets know how to draw themselves.

void NeuroscopeView::setGreyScale

(

bool

grey

)

[inline]

All the channels of the display are now display either in a gradation of grey or in color.

Parameters:

grey

true if the channels have to be displayed in grey false otherwise.

void NeuroscopeView::shownChannelsUpdate

(

const QValueList< int > &

channelsToShow

)

Updates the list of channels shown with channelsToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

channelsToShow

new list of channels to be shown.

const QValueList<int>& NeuroscopeView::channels

(

)

const [inline]

Returns the list of the channels presented in the view.

Returns:

list of channels ids.

void NeuroscopeView::shownClustersUpdate	(	QString	name,
		QValueList< int > &	clustersToShow
	)

Updates the list of clusters for the cluster provider name shown with clustersToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

	name	name use to identified the cluster provider containing the clusters to show.
	clustersToShow	list of clusters to be shown.

void NeuroscopeView::shownEventsUpdate	(	QString	name,
		QValueList< int > &	eventsToShow
	)

Updates the list of events for the event provider name shown with eventsToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

	name	name use to identified the event provider containing the events to show.
	eventsToShow	list of events to be shown.

void NeuroscopeView::setMultiColumns

(

bool

multiple

)

Sets the mode of presentation to single or multiple columns.

Parameters:

multiple

true if the traces are presented on multiple columns, false if they are presented on a single column.

void NeuroscopeView::setClusterVerticalLines

(

bool

lines

)

Displays or hides vertical lines to show the clusters.

Parameters:

lines

true if the vertical lines are drawn for each cluster, false otherwise.

void NeuroscopeView::setClusterRaster

(

bool

raster

)

Displays or hides a raster to show the clusters.

Parameters:

raster

true if a raster is drawn, false otherwise.

void NeuroscopeView::setClusterWaveforms

(

bool

waveforms

)

Displays or hides the cluster waveforms on top of the traces.

Parameters:

waveforms

true if the waveforms are drawn, false otherwise.

const QValueList<int>* NeuroscopeView::getSelectedClusters

(

QString

name

)

const [inline]

Returns the list containing the selected clusters for the given cluster provider identified by name.

Parameters:

name

name use to identified the cluster provider containing selected the clusters.

Returns:

the list of selected clusters.

const QValueList<int>* NeuroscopeView::getSelectedEvents

(

QString

name

)

const [inline]

Returns the list containing the selected events for the given event provider identified by name.

Parameters:

name

name use to identified the event provider containing selected the events.

Returns:

the list of selected events.

void NeuroscopeView::setMode	(	BaseFrame::Mode	selectedMode,
		bool	active
	)			[inline]

Updates the selected tool, methode call after the user selected a tool.

Parameters:

	selectedMode	the new mode.
	active	true if the view is the active one, false otherwise.

bool NeuroscopeView::isSelectionTool

(

)

[inline]

Tests if the currently selected tool is the selection one.

@ return true if the current tool is the selection one, false otherwise.

void NeuroscopeView::singleChannelColorUpdate	(	int	channelId,
		bool	active
	)			[inline]

Changes the color of a channel.

Parameters:

	channelId	id of the channel to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::channelGroupColorUpdate	(	int	groupId,
		bool	active
	)			[inline]

Changes the color of a group of channels.

Parameters:

	groupId	id of the group for which the color have been changed.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateViewContents

(

)

[inline]

Update all the encapsulated widgets contain in the view.

The widgets know how to draw themselves.

void NeuroscopeView::groupsModified

(

bool

active

)

[inline]

Triggers the update of the display due to a change in the display groups.

Parameters:

active

true if the view is the active one, false otherwise.

void NeuroscopeView::selectChannels

(

const QValueList< int > &

selectedIds

)

[inline]

Selects the channels in the TraceView.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::resetOffsets

(

const QValueList< int > &

selectedIds

)

Resets the offset of the selected channels.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::resetGains

(

const QValueList< int > &

selectedIds

)

[inline]

Resets the gain of the selected channels.

Parameters:

selectedIds

ids of the selected channels.

const QValueList<int>& NeuroscopeView::getChannelOffset

(

)

const [inline]

Returns the list containing the offset for each channel.

Returns:

the list of the offsets.

const QValueList<int>& NeuroscopeView::getGains

(

)

const [inline]

Returns the list containing the exponents used to compute the drawing gain for each channel.

Returns:

the list of gains.

const QValueList<int>& NeuroscopeView::getSelectedChannels

(

)

const [inline]

Returns the list containing the selected channels.

Returns:

the list of selected channels.

void NeuroscopeView::setSelectedChannels

(

const QValueList< int > &

selectedIds

)

[inline]

Sets the channels selected in the channel palettes.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::setTabName

(

QString

newLabel

)

[inline]

Sets the label for the display when in tab page mode.

Parameters:

newLabel

the new label for the display.

QString NeuroscopeView::getTabName

(

)

[inline]

Gets the label for the display when in tab page mode.

Returns:

newLabel the new label for the display.

long NeuroscopeView::getStartTime

(

)

[inline]

Gets the starting time in miliseconds.

Returns:

starting time.

long NeuroscopeView::getTimeWindow

(

)

[inline]

Gets the time window in miliseconds.

Returns:

duration time window.

void NeuroscopeView::showLabelsUpdate

(

bool

status

)

[inline]

Displays or hides the labels next to the traces.

Parameters:

status

true if the labels have to be drawn, false otherwise.

void NeuroscopeView::showCalibration	(	bool	show,
		bool	active
	)			[inline]

Shows or hides the calibration bar.

This bar is meaningful only when all the channels have the same amplification.

Parameters:

	show	true if the bar has to be shown false otherwise.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::setClusterProvider	(	ClustersProvider *	clustersProvider,
		QString	name,
		ItemColors *	clusterColors,
		bool	active,
		QValueList< int > &	clustersToShow,
		QMap< int, QValueList< int > > *	displayGroupsClusterFile,
		QMap< int, int > *	channelsSpikeGroups,
		int	nbSamplesBefore,
		int	nbSamplesAfter,
		const QValueList< int > &	clustersToSkip
	)

Adds a new provider of cluster data.

Parameters:

	clustersProvider	provider of cluster data.
	name	name use to identified the cluster provider.
	clusterColors	list of colors for the clusters.
	active	true if the view is the active one, false otherwise.
	clustersToShow	list of clusters to be shown.
	displayGroupsClusterFile	map between the anatomatical groups and the cluster files.
	channelsSpikeGroups	map between the channel ids and the spike group ids.
	nbSamplesBefore	number of samples before the sample of the peak are contained in the waveform of a spike.
	nbSamplesAfter	number of samples after the sample of the peak are contained in the waveform of a spike.
	clustersToSkip	list of clusters to be skipped while browsing.

void NeuroscopeView::removeClusterProvider	(	QString	name,
		bool	active
	)

Removes a provider of cluster data.

Parameters:

	name	name use to identified the cluster provider.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::clusterColorUpdate	(	QString	name,
		int	clusterId,
		bool	active
	)			[inline]

Changes the color of a cluster.

Parameters:

	name	name use to identified the cluster provider containing the updated cluster.
	clusterId	id of the cluster to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::setEventProvider	(	EventsProvider *	eventsProvider,
		QString	name,
		ItemColors *	eventColors,
		bool	active,
		QValueList< int > &	eventsToShow,
		const QValueList< int > &	eventsToSkip
	)

Adds a new provider of event data.

Parameters:

	eventsProvider	provider of event data.
	name	name use to identified the event provider.
	eventColors	list of colors for the events.
	active	true if the view is the active one, false otherwise.
	eventsToShow	list of events to be shown.
	eventsToSkip	list of clusters to be skipped while browsing.

void NeuroscopeView::removeEventProvider	(	QString	name,
		bool	active,
		bool	lastFile
	)

Removes a provider of event data.

Parameters:

	name	name use to identified the event provider.
	active	true if the view is the active one, false otherwise.
	lastFile	true if the event file removed is the last event provider, false otherwise.

void NeuroscopeView::eventColorUpdate	(	QString	name,
		int	eventId,
		bool	active
	)			[inline]

Changes the color of a event.

Parameters:

	name	name use to identified the event provider containing the updated event.
	eventId	id of the event to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEvents	(	QString	providerName,
		int	selectedEventId,
		float	time,
		float	newTime,
		bool	active
	)

Updates the traceView if concerned by the modification of the event.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	selectedEventId	id of the modified event.
	time	initial time of the modified event.
	newTime	new time of the modified event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEventsAfterRemoval	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)

Updates the traceView if concerned by the suppression of the event.

Parameters:

	providerName	name use to identified the event provider containing the removed event.
	eventId	id of the removed event.
	time	initial time of the removed event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEventsAfterAddition	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)

Updates the traceView if concerned by the addition of the event.

Parameters:

	providerName	name use to identified the event provider containing the added event.
	eventId	id of the added event.
	time	initial time of the added event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEvents	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)			[inline]

Updates the traceView if concerned by the modification of the event.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	eventId	id of the modified event.
	time	initial time of the modified event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::eventToAddProperties	(	QString	providerName,
		QString	eventDescription
	)			[inline]

Informs the traceView of the properties for the next event to be added.

Parameters:

	providerName	name use to identified the event provider which will contain the added event.
	eventDescription	description of the next event to be created.

void NeuroscopeView::updateSelectedEventsIds	(	QString	providerName,
		QMap< int, int > &	oldNewEventIds,
		int	addedEventId,
		bool	active,
		bool	added
	)

Updates the ids of the selected events due to the modification of event ids due to the addition or suppression of an event description.

Parameters:

	providerName	provider identifier.
	oldNewEventIds	map between the previous eventIds and the new ones.
	addedEventId	id corresponding to the new event description added.
	active	true if the view is the active one, false otherwise.
	added	true if an event description has been added, false if it has been removed.

void NeuroscopeView::removePositionProvider	(	QString	name,
		bool	active
	)

Removes the position provider.

Parameters:

	name	name use to identified the position provider.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::addPositionView	(	PositionsProvider *	positionsProvider,
		QImage	backgroundImage,
		QColor	backgroundColor,
		long	startTime,
		long	duration,
		int	width,
		int	height,
		bool	showEvents
	)

Adds a PositionView to the display.

Parameters:

	positionsProvider	provider of position data.
	backgroundImage	image used as a background for the position view.
	backgroundColor	color used as background if no image is set.
	startTime	starting time in miliseconds.
	duration	time window in miliseconds.
	width	video image width.
	height	video image height.
	showEvents	1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::addPositionView	(	PositionsProvider *	positionsProvider,
		QImage	backgroundImage,
		QColor	backgroundColor,
		int	width,
		int	height
	)			[inline]

Adds a PositionView to the display.

Parameters:

	positionsProvider	provider of position data.
	backgroundImage	image used as a background for the position view.
	backgroundColor	color used as background if no image is set.
	width	video image width.
	height	video image height.

void NeuroscopeView::updateClusterData

(

bool

active

)

[inline]

Updates the cluster information presented on the display.

Parameters:

active

true if the view is the active one, false otherwise.

const QValueList<int>* NeuroscopeView::getClustersNotUsedForBrowsing

(

QString

name

)

const [inline]

Returns the list of clusters to not be used for browsing for the given cluster provider identified by name.

Parameters:

name

name use to identified the cluster provider containing the clusters to skip.

Returns:

the list of skipped clusters.

const QValueList<int>* NeuroscopeView::getEventsNotUsedForBrowsing

(

QString

name

)

const [inline]

Returns the list of events to be not used for browsing for the given event provider identified by name.

Parameters:

name

name use to identified the event provider containing the events to skip.

Returns:

the list of skipped events.

void NeuroscopeView::updateNoneBrowsingEventList	(	QString	providerName,
		const QValueList< int > &	eventsToNotBrowse
	)

Updates the list of events to not use while browsing.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	eventsToNotBrowse	new list of events to not use while browsing.

void NeuroscopeView::updateNoneBrowsingClusterList	(	QString	providerName,
		const QValueList< int > &	clustersToNotBrowse
	)

Updates the list of clusters to not use while browsing.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	clustersToNotBrowse	new list of clusters to not use while browsing.

void NeuroscopeView::updateSkipStatus

(

const QValueList< int > &

skippedChannels

)

[inline]

Updates the list of skipped channels.

Parameters:

skippedChannels

list of skipped channels

int NeuroscopeView::getRasterHeight

(

)

Returns the height of the rasters.

Returns:

raster height.

int NeuroscopeView::isEventsInPositionView

(

)

const [inline]

Returns if events are displayed in the PositionView.

Returns:

1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::slotChannelsSelected

(

const QValueList< int > &

selectedIds

)

[inline, slot]

Informs listener that the channels selectedIds have been selected.

Parameters:

selectedIds

the list of channels selected by the user in a view.

void NeuroscopeView::setStartAndDuration	(	long	start,
		long	duration
	)			[inline, slot]

Sets the starting time and the time window in miliseconds.

Parameters:

	start	starting time.
	duration	time window.

void NeuroscopeView::slotEventModified	(	QString	providerName,
		int	selectedEventId,
		double	time,
		double	newTime
	)			[inline, slot]

Informs the application that an event has been modified.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	selectedEventId	id of the modified event.
	time	initial time of the modified event.
	newTime	new time of the modified event.

void NeuroscopeView::slotEventRemoved	(	QString	providerName,
		int	selectedEventId,
		double	time
	)			[inline, slot]

Informs the application that an event has been removed.

Parameters:

	providerName	name use to identified the event provider containing the removed event.
	selectedEventId	id of the removed event.
	time	initial time of the removed event.

void NeuroscopeView::slotEventAdded	(	QString	providerName,
		QString	addedEventDescription,
		double	time
	)			[inline, slot]

Informs that an event has been added.

Parameters:

	providerName	name use to identified the event provider containing the added event.
	addedEventDescription	description of the added event.
	time	time of the added event.

void NeuroscopeView::updateWaveformInformation	(	int	nbSamplesBefore,
		int	nbSamplesAfter,
		bool	active
	)			[inline, slot]

Updates the description of a spike waveform.

Parameters:

	nbSamplesBefore	number of samples contained in the waveform of a spike before the sample of the peak.
	nbSamplesAfter	number of samples contained in the waveform of a spike after the sample of the peak.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updatePositionInformation	(	int	width,
		int	height,
		QImage	backgroundImage,
		bool	newOrientation,
		bool	active
	)			[inline, slot]

Updates the information needed to draw the position of the animal.

Parameters:

	width	video image width.
	height	video image height.
	backgroundImage	image used as a background for the position view.
	newOrientation	true if the image has been transformed (rotate and or flip), false otherwise.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::positionDockClosed

(

QWidget *

view

)

[slot]

Takes care of the closing of the PositionView.

Parameters:

view

the PositionView to be closed.

void NeuroscopeView::setEventsInPositionView

(

bool

shown

)

[slot]

Sets if events are displayed in the PositionView.

Parameters:

shown

1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::updateTraceBackgroundImage	(	QImage	traceBackgroundImage,
		bool	active
	)			[inline, slot]

Updates the background image.

Parameters:

	traceBackgroundImage	image to be used as background.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::print	(	KPrinter *	pPrinter,
		QString	filePath,
		bool	whiteBackground
	)

Contains the implementation for printing functionality.

Parameters:

	pPrinter	pointer on the printer object.
	filePath	path of the opened document.
	whiteBackground	true if the printed background has to be white, false otherwise.

void NeuroscopeView::setGains	(	int	gain,
		int	acquisitionGain
	)			[inline]

Sets the unit gain and the acquisition system gain.

Parameters:

	gain	initial gain use to draw the traces in the TraceView.
	acquisitionGain	acquisition gain.

void NeuroscopeView::updateBackgroundColor

(

QColor

color

)

[inline]

Updates the background color used in the views.

Parameters:

color

color of the new background.

void NeuroscopeView::documentFeaturesModified

(

)

[inline]

Informs all the child widgets that one of the features for the document have changed.

The features are: the initial offset or the acquisition system resolution.

void NeuroscopeView::samplingRateModified

(

long long

recordingLength

)

[inline]

Informs all the child widgets that the sampling rate for the document has changed.

Parameters:

recordingLength

the newly computed length of the document.

void NeuroscopeView::setChannelNb

(

int

nb

)

Updates the number of channels in the child widgets.

Parameters:

nb

the new number of channels.

void NeuroscopeView::showAllWidgets

(

)

[inline]

Show all the encapsulated widgets contain in the view.

The widgets know how to draw themselves.

void NeuroscopeView::setGreyScale

(

bool

grey

)

[inline]

All the channels of the display are now display either in a gradation of grey or in color.

Parameters:

grey

true if the channels have to be displayed in grey false otherwise.

void NeuroscopeView::shownChannelsUpdate

(

const QValueList< int > &

channelsToShow

)

Updates the list of channels shown with channelsToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

channelsToShow

new list of channels to be shown.

const QValueList<int>& NeuroscopeView::channels

(

)

const [inline]

Returns the list of the channels presented in the view.

Returns:

list of channels ids.

void NeuroscopeView::shownClustersUpdate	(	QString	name,
		QValueList< int > &	clustersToShow
	)

Updates the list of clusters for the cluster provider name shown with clustersToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

	name	name use to identified the cluster provider containing the clusters to show.
	clustersToShow	list of clusters to be shown.

void NeuroscopeView::shownEventsUpdate	(	QString	name,
		QValueList< int > &	eventsToShow
	)

Updates the list of events for the event provider name shown with eventsToShow.

Makes the different views update their drawing if need it. This method is called only on the active view.

Parameters:

	name	name use to identified the event provider containing the events to show.
	eventsToShow	list of events to be shown.

void NeuroscopeView::setMultiColumns

(

bool

multiple

)

Sets the mode of presentation to single or multiple columns.

Parameters:

multiple

true if the traces are presented on multiple columns, false if they are presented on a single column.

void NeuroscopeView::setClusterVerticalLines

(

bool

lines

)

Displays or hides vertical lines to show the clusters.

Parameters:

lines

true if the vertical lines are drawn for each cluster, false otherwise.

void NeuroscopeView::setClusterRaster

(

bool

raster

)

Displays or hides a raster to show the clusters.

Parameters:

raster

true if a raster is drawn, false otherwise.

void NeuroscopeView::setClusterWaveforms

(

bool

waveforms

)

Displays or hides the cluster waveforms on top of the traces.

Parameters:

waveforms

true if the waveforms are drawn, false otherwise.

const QValueList<int>* NeuroscopeView::getSelectedClusters

(

QString

name

)

const [inline]

Returns the list containing the selected clusters for the given cluster provider identified by name.

Parameters:

name

name use to identified the cluster provider containing selected the clusters.

Returns:

the list of selected clusters.

const QValueList<int>* NeuroscopeView::getSelectedEvents

(

QString

name

)

const [inline]

Returns the list containing the selected events for the given event provider identified by name.

Parameters:

name

name use to identified the event provider containing selected the events.

Returns:

the list of selected events.

void NeuroscopeView::setMode	(	BaseFrame::Mode	selectedMode,
		bool	active
	)			[inline]

Updates the selected tool, methode call after the user selected a tool.

Parameters:

	selectedMode	the new mode.
	active	true if the view is the active one, false otherwise.

bool NeuroscopeView::isSelectionTool

(

)

[inline]

Tests if the currently selected tool is the selection one.

@ return true if the current tool is the selection one, false otherwise.

void NeuroscopeView::singleChannelColorUpdate	(	int	channelId,
		bool	active
	)			[inline]

Changes the color of a channel.

Parameters:

	channelId	id of the channel to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::channelGroupColorUpdate	(	int	groupId,
		bool	active
	)			[inline]

Changes the color of a group of channels.

Parameters:

	groupId	id of the group for which the color have been changed.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateViewContents

(

)

[inline]

Update all the encapsulated widgets contain in the view.

The widgets know how to draw themselves.

void NeuroscopeView::groupsModified

(

bool

active

)

[inline]

Triggers the update of the display due to a change in the display groups.

Parameters:

active

true if the view is the active one, false otherwise.

void NeuroscopeView::selectChannels

(

const QValueList< int > &

selectedIds

)

[inline]

Selects the channels in the TraceView.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::resetOffsets

(

const QValueList< int > &

selectedIds

)

Resets the offset of the selected channels.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::resetGains

(

const QValueList< int > &

selectedIds

)

[inline]

Resets the gain of the selected channels.

Parameters:

selectedIds

ids of the selected channels.

const QValueList<int>& NeuroscopeView::getChannelOffset

(

)

const [inline]

Returns the list containing the offset for each channel.

Returns:

the list of the offsets.

const QValueList<int>& NeuroscopeView::getGains

(

)

const [inline]

Returns the list containing the exponents used to compute the drawing gain for each channel.

Returns:

the list of gains.

const QValueList<int>& NeuroscopeView::getSelectedChannels

(

)

const [inline]

Returns the list containing the selected channels.

Returns:

the list of selected channels.

void NeuroscopeView::setSelectedChannels

(

const QValueList< int > &

selectedIds

)

[inline]

Sets the channels selected in the channel palettes.

Parameters:

selectedIds

ids of the selected channels.

void NeuroscopeView::setTabName

(

QString

newLabel

)

[inline]

Sets the label for the display when in tab page mode.

Parameters:

newLabel

the new label for the display.

QString NeuroscopeView::getTabName

(

)

[inline]

Gets the label for the display when in tab page mode.

Returns:

newLabel the new label for the display.

long NeuroscopeView::getStartTime

(

)

[inline]

Gets the starting time in miliseconds.

Returns:

starting time.

long NeuroscopeView::getTimeWindow

(

)

[inline]

Gets the time window in miliseconds.

Returns:

duration time window.

void NeuroscopeView::showLabelsUpdate

(

bool

status

)

[inline]

Displays or hides the labels next to the traces.

Parameters:

status

true if the labels have to be drawn, false otherwise.

void NeuroscopeView::showCalibration	(	bool	show,
		bool	active
	)			[inline]

Shows or hides the calibration bar.

This bar is meaningful only when all the channels have the same amplification.

Parameters:

	show	true if the bar has to be shown false otherwise.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::setClusterProvider	(	ClustersProvider *	clustersProvider,
		QString	name,
		ItemColors *	clusterColors,
		bool	active,
		QValueList< int > &	clustersToShow,
		QMap< int, QValueList< int > > *	displayGroupsClusterFile,
		QMap< int, int > *	channelsSpikeGroups,
		int	nbSamplesBefore,
		int	nbSamplesAfter,
		const QValueList< int > &	clustersToSkip
	)

Adds a new provider of cluster data.

Parameters:

	clustersProvider	provider of cluster data.
	name	name use to identified the cluster provider.
	clusterColors	list of colors for the clusters.
	active	true if the view is the active one, false otherwise.
	clustersToShow	list of clusters to be shown.
	displayGroupsClusterFile	map between the anatomatical groups and the cluster files.
	channelsSpikeGroups	map between the channel ids and the spike group ids.
	nbSamplesBefore	number of samples before the sample of the peak are contained in the waveform of a spike.
	nbSamplesAfter	number of samples after the sample of the peak are contained in the waveform of a spike.
	clustersToSkip	list of clusters to be skipped while browsing.

void NeuroscopeView::removeClusterProvider	(	QString	name,
		bool	active
	)

Removes a provider of cluster data.

Parameters:

	name	name use to identified the cluster provider.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::clusterColorUpdate	(	QString	name,
		int	clusterId,
		bool	active
	)			[inline]

Changes the color of a cluster.

Parameters:

	name	name use to identified the cluster provider containing the updated cluster.
	clusterId	id of the cluster to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::setEventProvider	(	EventsProvider *	eventsProvider,
		QString	name,
		ItemColors *	eventColors,
		bool	active,
		QValueList< int > &	eventsToShow,
		const QValueList< int > &	eventsToSkip
	)

Adds a new provider of event data.

Parameters:

	eventsProvider	provider of event data.
	name	name use to identified the event provider.
	eventColors	list of colors for the events.
	active	true if the view is the active one, false otherwise.
	eventsToShow	list of events to be shown.
	eventsToSkip	list of clusters to be skipped while browsing.

void NeuroscopeView::removeEventProvider	(	QString	name,
		bool	active,
		bool	lastFile
	)

Removes a provider of event data.

Parameters:

	name	name use to identified the event provider.
	active	true if the view is the active one, false otherwise.
	lastFile	true if the event file removed is the last event provider, false otherwise.

void NeuroscopeView::eventColorUpdate	(	QString	name,
		int	eventId,
		bool	active
	)			[inline]

Changes the color of a event.

Parameters:

	name	name use to identified the event provider containing the updated event.
	eventId	id of the event to redraw.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEvents	(	QString	providerName,
		int	selectedEventId,
		float	time,
		float	newTime,
		bool	active
	)

Updates the traceView if concerned by the modification of the event.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	selectedEventId	id of the modified event.
	time	initial time of the modified event.
	newTime	new time of the modified event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEventsAfterRemoval	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)

Updates the traceView if concerned by the suppression of the event.

Parameters:

	providerName	name use to identified the event provider containing the removed event.
	eventId	id of the removed event.
	time	initial time of the removed event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEventsAfterAddition	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)

Updates the traceView if concerned by the addition of the event.

Parameters:

	providerName	name use to identified the event provider containing the added event.
	eventId	id of the added event.
	time	initial time of the added event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updateEvents	(	QString	providerName,
		int	eventId,
		float	time,
		bool	active
	)			[inline]

Updates the traceView if concerned by the modification of the event.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	eventId	id of the modified event.
	time	initial time of the modified event.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::eventToAddProperties	(	QString	providerName,
		QString	eventDescription
	)			[inline]

Informs the traceView of the properties for the next event to be added.

Parameters:

	providerName	name use to identified the event provider which will contain the added event.
	eventDescription	description of the next event to be created.

void NeuroscopeView::updateSelectedEventsIds	(	QString	providerName,
		QMap< int, int > &	oldNewEventIds,
		int	addedEventId,
		bool	active,
		bool	added
	)

Updates the ids of the selected events due to the modification of event ids due to the addition or suppression of an event description.

Parameters:

	providerName	provider identifier.
	oldNewEventIds	map between the previous eventIds and the new ones.
	addedEventId	id corresponding to the new event description added.
	active	true if the view is the active one, false otherwise.
	added	true if an event description has been added, false if it has been removed.

void NeuroscopeView::removePositionProvider	(	QString	name,
		bool	active
	)

Removes the position provider.

Parameters:

	name	name use to identified the position provider.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::addPositionView	(	PositionsProvider *	positionsProvider,
		QImage	backgroundImage,
		QColor	backgroundColor,
		long	startTime,
		long	duration,
		int	width,
		int	height,
		bool	showEvents
	)

Adds a PositionView to the display.

Parameters:

	positionsProvider	provider of position data.
	backgroundImage	image used as a background for the position view.
	backgroundColor	color used as background if no image is set.
	startTime	starting time in miliseconds.
	duration	time window in miliseconds.
	width	video image width.
	height	video image height.
	showEvents	1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::addPositionView	(	PositionsProvider *	positionsProvider,
		QImage	backgroundImage,
		QColor	backgroundColor,
		int	width,
		int	height
	)			[inline]

Adds a PositionView to the display.

Parameters:

	positionsProvider	provider of position data.
	backgroundImage	image used as a background for the position view.
	backgroundColor	color used as background if no image is set.
	width	video image width.
	height	video image height.

void NeuroscopeView::updateClusterData

(

bool

active

)

[inline]

Updates the cluster information presented on the display.

Parameters:

active

true if the view is the active one, false otherwise.

const QValueList<int>* NeuroscopeView::getClustersNotUsedForBrowsing

(

QString

name

)

const [inline]

Returns the list of clusters to not be used for browsing for the given cluster provider identified by name.

Parameters:

name

name use to identified the cluster provider containing the clusters to skip.

Returns:

the list of skipped clusters.

const QValueList<int>* NeuroscopeView::getEventsNotUsedForBrowsing

(

QString

name

)

const [inline]

Returns the list of events to be not used for browsing for the given event provider identified by name.

Parameters:

name

name use to identified the event provider containing the events to skip.

Returns:

the list of skipped events.

void NeuroscopeView::updateNoneBrowsingEventList	(	QString	providerName,
		const QValueList< int > &	eventsToNotBrowse
	)

Updates the list of events to not use while browsing.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	eventsToNotBrowse	new list of events to not use while browsing.

void NeuroscopeView::updateNoneBrowsingClusterList	(	QString	providerName,
		const QValueList< int > &	clustersToNotBrowse
	)

Updates the list of clusters to not use while browsing.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	clustersToNotBrowse	new list of clusters to not use while browsing.

void NeuroscopeView::updateSkipStatus

(

const QValueList< int > &

skippedChannels

)

[inline]

Updates the list of skipped channels.

Parameters:

skippedChannels

list of skipped channels

int NeuroscopeView::getRasterHeight

(

)

Returns the height of the rasters.

Returns:

raster height.

int NeuroscopeView::isEventsInPositionView

(

)

const [inline]

Returns if events are displayed in the PositionView.

Returns:

1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::slotChannelsSelected

(

const QValueList< int > &

selectedIds

)

[inline, slot]

Informs listener that the channels selectedIds have been selected.

Parameters:

selectedIds

the list of channels selected by the user in a view.

void NeuroscopeView::setStartAndDuration	(	long	start,
		long	duration
	)			[inline, slot]

Sets the starting time and the time window in miliseconds.

Parameters:

	start	starting time.
	duration	time window.

void NeuroscopeView::slotEventModified	(	QString	providerName,
		int	selectedEventId,
		double	time,
		double	newTime
	)			[inline, slot]

Informs the application that an event has been modified.

Parameters:

	providerName	name use to identified the event provider containing the modified event.
	selectedEventId	id of the modified event.
	time	initial time of the modified event.
	newTime	new time of the modified event.

void NeuroscopeView::slotEventRemoved	(	QString	providerName,
		int	selectedEventId,
		double	time
	)			[inline, slot]

Informs the application that an event has been removed.

Parameters:

	providerName	name use to identified the event provider containing the removed event.
	selectedEventId	id of the removed event.
	time	initial time of the removed event.

void NeuroscopeView::slotEventAdded	(	QString	providerName,
		QString	addedEventDescription,
		double	time
	)			[inline, slot]

Informs that an event has been added.

Parameters:

	providerName	name use to identified the event provider containing the added event.
	addedEventDescription	description of the added event.
	time	time of the added event.

void NeuroscopeView::updateWaveformInformation	(	int	nbSamplesBefore,
		int	nbSamplesAfter,
		bool	active
	)			[inline, slot]

Updates the description of a spike waveform.

Parameters:

	nbSamplesBefore	number of samples contained in the waveform of a spike before the sample of the peak.
	nbSamplesAfter	number of samples contained in the waveform of a spike after the sample of the peak.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::updatePositionInformation	(	int	width,
		int	height,
		QImage	backgroundImage,
		bool	newOrientation,
		bool	active
	)			[inline, slot]

Updates the information needed to draw the position of the animal.

Parameters:

	width	video image width.
	height	video image height.
	backgroundImage	image used as a background for the position view.
	newOrientation	true if the image has been transformed (rotate and or flip), false otherwise.
	active	true if the view is the active one, false otherwise.

void NeuroscopeView::positionDockClosed

(

QWidget *

view

)

[slot]

Takes care of the closing of the PositionView.

Parameters:

view

the PositionView to be closed.

void NeuroscopeView::setEventsInPositionView

(

bool

shown

)

[slot]

Sets if events are displayed in the PositionView.

Parameters:

shown

1 if events are displayed in the PositionView, 0 otherwise.

void NeuroscopeView::updateTraceBackgroundImage	(	QImage	traceBackgroundImage,
		bool	active
	)			[inline, slot]

Updates the background image.

Parameters:

	traceBackgroundImage	image to be used as background.
	active	true if the view is the active one, false otherwise.

---

The documentation for this class was generated from the following files:

• debug/src/neuroscopeview.h
• src/neuroscopeview.h
• debug/src/neuroscopeview.cpp
• debug/src/neuroscopeview.moc.cpp
• src/neuroscopeview.cpp
• src/neuroscopeview.moc.cpp

---