*************************************************************************
************		Welcome to VirtualRetina	*****************
************			version 2.1	 	*****************
*************************************************************************

		Spiking, large-scale retina simulation software.

			Author : Adrien Wohrer
			Institution : ODYSSEE, INRIA Sophia Antipolis
			Contact : Adrien.Wohrer@sophia.inria.fr
			Project started december 2004.


***************** Source Directory  src/ ***************************

Contains sources for the virtual_retina library :


//Filtering objects:

baserecfilter.h			Temporal recursive filters and simple operations between
				 filters (sum,convolution..)

basemapfilter.h			A recursive filtering on images, to perform spatio-temporal
				separable filtering.

retinamapfilter.h		Linear filtering by a layer of retinal cells, including a
				spatial blur. Can have a radial structure.

condcellmap.h			Layer of retinal cells with possible CONDUCTANCE-inputs
				(non-linear effects)

//Radial objects:

radialscheme.h			Base class that defines a radially variant structure for the
				retina.

logpolarscheme.h		Specialization of the preceding. Log-polar density.

radialfilter.h			Implement a recursive approximation for radially-variant
				gaussian blur, or filtering by first or second derivative of a
				 gaussian. Inspired from Tan-etl, 2003, Real Time Imaging.

//Synapses, conductances:

instantsynapse.h		Defines a generic type of synaptic transmission

cellporthandler.h		Defines inputs for a cell or map of cells, some conductance
				inputs, others direct current inputs, and all associated to
				input synapses.

//Spiking objects:

spik_units.h			Defines conductance-driven spiking neurons (CondNeuron_cpm),
				and their extension (IntegratorNeuron_cpm) to integrate
				analogic inputs (like ganglion cells in the retina).

basespikingchannel.h		Generic array of IntegratorNeuron_cpm.

rd_spikingchannel.h		Extension of the preceding. Circular array that can follow a
				non-homogenous retinal density.

sq_spikingchannel.h		Other possible extension. Square array with uniform density.

//Aaaaaand:

retina.h			Defines a whole retinal architecture from the preceding objects.

reconstruct.h			Helper functions used in ReconstructRetina.cc




******************** Tool Directory    src/tools/  ********************

Contains sources for the retina_tools library

More general tools. Include little mathematical operations, small personnal extensions of CImg.h, random numbers, object factory, drawing facilities... kind of specialized for these programs... 

One of them *might* be useful to you in another context:

cimg_tools.h			Small extensions and wrappers for program CImg.h... includes
				class CImgSignalDrawer, a wrapper for the signal-drawing function
				of CIng that can handle the drawing of axis, of different signals
				in the figure...

TODO: (maybe) turn it into a cimg plugin with new version of CImg !?




**************** Appli directory   src/appli/ ***************************

contains the code for the executables. It also contains an old README explaining the executables. As far as I know, you better directly read the pdf tutorial...

