Simulation Events

The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001-2005 by the University of Southern California (USC) and iLab at USC.

Major portions of the iLab Neuromorphic Vision C++ Toolkit are protected under the U.S. patent ``Computation of Intrinsic Perceptual Saliency in Visual Environments, and Applications'' by Christof Koch and Laurent Itti, California Institute of Technology, 2001 (patent pending; application number 09/912,225 filed July 23, 2001; see http://pair.uspto.gov/cgi-bin/final/home.pl for current status)

This file is part of the iLab Neuromorphic Vision C++ Toolkit.

The iLab Neuromorphic Vision C++ Toolkit is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the iLab Neuromorphic Vision C++ Toolkit; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

Table of contents:

1. Introduction

The purpose of this page is to gather all the SimEvents' definitions and usages.

2. Generic Simulation Events

Only declare very generic SimEvent derivatives here (basically, which may be used by many modules and depend only on very low-level things). For more specialized SimEvent derivatives, declare them in corresponding files in the appropriate directories. For example, Neuro/NeuroSimEvents.H

2.1. SimEventBreak

Purpose:

Request to break the simulation
Post this and the next SimEventQueue::evolve() we will return with a break status, usually resulting in terminating the simulation.

Defined in:

src/Simulation/SimEvents.H

Handlers in:

Posted from:

Checked from:

2.2. SimEventUserWait

Purpose:

Wait until user presses RETURN key
A SimModule may post this to request that the simulation be paused until the user presses the RETURN key. For example, this may be used after a bunch of images have been displayed, to give the user the time to examine them before continuing with the simulation. This event is handled directly at the very beginning of SimEventQueue::evolve(), just before we increment the clock. The event is displayed, plus a message to invite the user to press RETURN to continue.

Defined in:

src/Simulation/SimEvents.H

Handlers in:

Posted from:

Checked from:

2.3. SimEventShowMemStats

Purpose:

Requests that memory stats be shown now
A SimModule may post this to request that statistics about memory usage be displayed now. This requires that the user specified --mem-stats on the command-line, otherwise this event will be ignored. A frame number is optional, as well as an allocation unit to show the stats in.

Defined in:

src/Simulation/SimEvents.H

Handlers in:

Posted from:

Checked from:

2.4. SimEventSaveOutput

Purpose:

Save your outputs
SimOutputFrameSeries (or others) may post this when it is time to save the next round of outputs. SimModule objects may want to catch this if they have possible outputs to save. They should then use the ModelComponentSaveInfo data contained here in the event to decide how and where to save their stuff.

Defined in:

src/Simulation/SimEvents.H

Handlers in:

Posted from:

Checked from:

2.5. SimEventClockTick

Purpose:

Posted by SimEventQueue at the beginning of each clock tick
A SimModule that registers a callback for this event type will have its callback triggered at every clock tick.

Defined in:

src/Simulation/SimEvents.H

Handlers in:

Posted from:

Checked from:

3. Neuro Events

3.1. SimEventWTAwinner

Purpose:

The WinnerTakeAll selected a winner

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.2. SimEventTargetsHit

Purpose:

The TargetChecker hit a one or more targets

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.3. SimEventRetinaImage

Purpose:

A new image is available from the retina

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.4. SimEventRetinaCTImage

Purpose:

A new image is available from the a retina ct

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.5. SimEventVisualCortexOutput

Purpose:

A new output is available from the VisualCortex

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.6. SimEventSaliencyMapOutput

Purpose:

A new output is available from the SaliencyMap

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.7. SimEventGistOutput

Purpose:

A new output is available from the GistEstimator

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.8. SimEventTaskRelevanceMapOutput

Purpose:

A new output is available from the TaskRelevanceMap

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.9. SimEventAttentionGuidanceMapOutput

Purpose:

A new output is available from the AttentionGuidanceMap

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.10. SimEventAttentionGateOutput

Purpose:

A new output is available from the AttentionGate

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.11. SimEventAttentionGateStageTwoSegments

Purpose:

What was the frame number on our last attention gate;

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.12. SimEventShapeEstimatorOutput

Purpose:

A new output is available from the ShapeEstimator

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.13. SimEventSaccadeStatus

Purpose:

A SaccadeController may post this at every evolve
Note how you cannot implement an object of this type, since it contains a pure virtual function. Use SimEventSaccadeStatusEye or SimEventSaccadeStatusHead instead.

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.14. SimEventSaccadeStatusEye

Purpose:

An Eye SaccadeController may post this at every evolve

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.15. SimEventSaccadeStatusHead

Purpose:

An Head SaccadeController may post this at every evolve

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.16. SimEventEyeTrackerData

Purpose:

An EyeTrackerSaccadeController may post this

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.17. SimEventHandTrackerData

Purpose:

An TrackerHandController may post this

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.18. SimEventObjectToBias

Purpose:

Indicate which object we are biasing for (use for statistics)

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.19. SimEventTargetMask

Purpose:

A new target mask is available, TargetChecker will check for this and use the new mask

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

3.20. SimEventVisualBufferOutput

Purpose:

A new output is available from the VisualBuffer

Defined in:

src/Neuro/NeuroSimEvents.H

Handlers in:

Posted from:

Checked from:

4. Media Events

4.1. SimEventInputFrame

Purpose:

A new input frame is available
InputFrameSeries posts this event each time a new input frame has become available.

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.2. SimEventRequestSaveOutput

Purpose:

Request that outputs be saved now
Normally, SimOutputFrameSeries will save outputs at a fixed rate. However, it can also operate in an event-driven mode if a framerate has not been specified on the command line. SimModule objects may post SimEventSaveOutput events each time they generate events which they think warrant saving the outputs should the output frame series operate in event-driven mode. Any SimEventSaveOutput will be ignored if the output frame series is operating at a fixed framerate. An example is that when WinnerTakeAll has a new covert shift of attention, it will post a SimEventSaveOutput.

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.3. SimEventUserInput

Purpose:

Send the user mouse and keyboard events

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.4. SimEventInputDescription

Purpose:

Get a description of the current input
This message can be sent just after initialization so that downstream modules can be informed of the number of frames in the input, and the name of the input file.

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.5. SimEventRequestFrameNum

Purpose:

Request that the input module seek to a new frame

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.6. SimEventSceneDescription

Purpose:

A Description of the scene
Any module can use this event to post knowledge of the scene. For example gist recognition can determine the scene type and post this event.

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

4.7. SimEventObjectDescription

Purpose:

A Description of an object
Any module can use this event to post knowledge of an object. For example IT can determine the object type and post this event.

Defined in:

src/Media/MediaSimEvents.H

Handlers in:

Posted from:

Checked from:

5. Visual Tracker Events

5.1. SimEventVisualTracker

Purpose:

Callback for when a new input frame is available

Defined in:

src/Image/VisualTracker.H

Handlers in:

Posted from:

Checked from:

5.2. SimEventSetVisualTracker

Purpose:

Defined in:

src/Image/VisualTracker.H

Handlers in:

Posted from:

Checked from:

6. NeoVision II Events

6.1. SimEventFramePolygonData

Purpose:

Defined in:

src/Apps/neo2/NeoIISimEvents.H

Handlers in:

Posted from:

Checked from:

6.2. SimEventFrameKeyPointData

Purpose:

Defined in:

src/Apps/neo2/NeoIISimEvents.H

Handlers in:

Posted from:

Checked from:

6.3. SimEventTrackedKeyPointData

Purpose:

Defined in:

src/Apps/neo2/NeoIISimEvents.H

Handlers in:

Posted from:

Checked from:

Generated on Sun May 8 08:19:48 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3