Chapter 2. A Quick-Start session

We will now describe a typical session with YaTiSeWoBe, introducing you with the general manipulations you can expect to perform with the application. You will be presented with demo data, generating typical graphics.

[Note]Note

As soon as the data collection feature will be implemented, we will provide different data files and documents for demo purposes. For now, only a single file is provided with the package.

The following session described in this section supposes that you have installed and launched YaTiSeWoBe according to the platform-specific details explained in Section 4.2, “Installation”. If the package is installed on your Local Area Network (LAN) by your system administrator, consult the site-specific instructions or the local guru.

[Note]Note

If you ignore which ones to follow, we highly recommend that you use the Java WebStart procedures in Section 4.2.1, “Using Java WebStart” because they are the simplest and will keep the software and documentation up-to-date each time you launch the application.

Procedure 2.1. A simple session

  1. Launch YaTiSeWoBe

    After the initial start-up of the application, you will be presented with the main window. The largest portion of the window is dedicated to displaying the views, one view for each white rectangle, called "plot".

    When you click on a plot, its border changes color, denoting it has just been selected. All manipulations are applied to the selected plots of the selected document. The Selection menu helps you to manipulate this selection.

    Click on Select All in Selection menu.

  2. Import data

    [Note]Note

    For now, the only data format supported by YaTiSeWoBe is the one proposed at the end of this guide in Appendix D, Data format.

    The first step to undertake is to import data from a data repository (like your file system) to the application data store.

    1. Using demonstration data

      If you don't have any file in a valid format, you can use the demonstration data that can be imported by simply selecting Load demo data from the Help menu.

    2. Using your own data

      You can select the data file to import from your file system using Import File from the Data menu. For the sake of this simple session, we will use details we know about the demonstration file to guide you through the manipulations. After reading this section completely, you should be able to extrapolate to your own data.

    If the check box labeled Task Monitor is checked in the Windows menu, a progress bar will indicate what is going on, until the data has been completely read and parsed. If the check box labeled Episode Type Selector is checked in the Windows, a new data source will appear in the list, labeled demo.txt or the name of the file you chose, depending on the origin of the data.

    [Note]Note

    The Windows menu controls which window plug-ins are active at any time. You can read more about plug-ins in Section 3.3, “Plug-ins”.

  3. Selecting events

    In the "Episode Type Selector", clicking on the handle at the left of the file icon will display a synthetic view of the contents of the data file, where episode types are sorted according to their code and qualifier in a tree-like structure.

    There are two tabs to the "Episode Type Selector" window plug-in: Event and Trigger.

    EventEvents are the subject of the views. Depending on the view, one or several of them can be interpreted.

    TriggerTriggers are the episode types, usually external to the system, around which the views have to interpret the events, e.g. analyzing the activity of neurons (events) around the emission of a stimuli (trigger).

    In the Event tab, open the demo.txt data source branch by clicking on the handle, and check the square to the left of the episode code 1. This selects all the 4 known types with code 1 in one click.

    In the Trigger tab, open the demo.txt data source branch by clicking on the handle, open the episode type branch for episode code 53 by clicking on the handle, and check the square to the left of the episode type 53, 1.

    Leave Duration to 5000 time steps and press the Apply button.

    You have just taught the first 4 selected plots to draw 5000 time steps around the triggers 53, 1 respectively for events 1, 2, 1, 4, 1, 6 and 1, 7.

    1. Creating selectors

      Using hand-made selectors, you may merge episode types on-the-fly to create new ones that result from the union of all the times for each episode type.

      [Important]Future feature

      As of version 0.1.2, functionalities described in this section have not been fully implemented yet, but are already planned for future releases of YaTiSeWoBe. See Section 6.8.2, “Forseable releases” for more details.

  4. Modifying the default document

    For now, nothing has changed for the plots, because by default, they are set to use the "None" view plug-in by default.

    With the mouse pointer, open the Selection menu, open the Views sub-menu, and click on the item labeled Raster Plot.

    By changing the view plug-in, you have triggered the reconstruction of the plot views. After the necessary time to draw the graphics, the first four plots will display the raster plots for the selected episode types.

    The red line corresponds to the pilling of the occurrences of the trigger event (53, 1) while the black tics correspond to the timings of the episode types around those events (e.g. 1, 2 for the top left plot).

  5. Changing offset

    If the check box labeled Offset Changer is checked in the Windows menu, you can use the slider to move the relative timing of the trigger pile: the slider to the left will display what happened 5000 time steps after the trigger events; the slider completely to the right will display what happened 5000 time steps before the trigger times.

  6. Styles and style-sheets

    to be written...

    1. Defining new styles

      to be written...

  7. Saving a document

    to be written...

  8. Finding help

    Documentation for YaTiSeWoBe is available from several locations: in HTML format, on-line from the application web-site [57]; in JavaHelp format, within the application by selecting Contents from the Help menu; in HTML and PDF format, from the installation directory doc/html/index.html or doc/pdf/UsersGuide.pdf. We consider this documentation as part of the source code of the application, and will be happy to consider your comments, suggestions and contributions to enhance it. You will find the tools to leave your comments from the application web-site [57].