LabAnalyst X

FILE menu

LabAnalyst X has five menus, plus on-line instructions in the "Special" menu and three functions in the "LabAnalyst X" menu.

 FILE  EDIT  ANALYZE  VIEW  SCRIPTS  SPECIAL
Open Warthog

Import submenu
     Warthog format file
     Non-Warthog text file
     Sable file
 Merge submenu
     Warthog file
     Sable file

Save
Save as

Show file data

Print file image
   File image preview

 Send results submenu
     Printer
     Tabular file
     Text file
     Output results
     Close | print file

Appearance of loaded files LabHelper / LabAnalyst formats


   OPEN WARTHOG...  +O         For loading standard data files produced by LabHelper for LabAnalyst X. These include four types (each shown with its icons for both 'classic' and OS X):

 Warthog-format text files (chart or oscilloscope)

  LabHelper binary chart data

  LabHelper binary scope data

  LabAnalyst binary edited data

The file opening box only displays these types.  Note that there are two binary formats for LabHelper and edited LabAnalyst X files: the older Binary-Coded Decimal (BCD) and Floating-Point (FP).  Both versions show the same icons, which can be confusing.  LabAnalyst X will transparently read both types, but will only write in FP format -- which cannot be read by older (early 1990s) LabAnalyst versions.  The only difference in loading files is one of speed: BCD files are loaded fairly slowly (since they are read and converted one sample at a time), while FP files are loaded very quickly (since entire channels are read directly from disk into memory).

If you click the 'Open' button on the toolbar, you will get this window if you've not specified in the 'Preferences' window that only Warthog files will be shown:

This gives you the choice of Warthog, ASCII (text) or Sable SSCF files (see below).

 

   IMPORT       This selection has a submenu with three items:

   WARTHOG-FORMAT TEXT FILE...      For loading data files of any type -- as long as they are in Warthog binary format or Warthog text format. WARNING: only files with these formats will load properly.

   NON-WARTHOG TEXT FILE...     Loads text (ASCII) files with variables in spreadsheet format delimited by commas or tabs (note that spaces do not work as delimiters).  The first 8 or so cases of the file are shown on the screen , including symbols for delimiters.  You can specify where to start reading data (to avoid non-numeric text headers, etc.), and elect to ignore selected variables in the 'list'; some of which (as in the example below) don't contain useful data.  You need to specify the correct time interval and enter appropriate variable names, start time, start date, and comments.  The program will automatically read all of the data up to the user-set maximum size (limit of one million cases).  The text file import window looks like this:

This example contains 6 variables (only 5 of which are used; the fifth is ignored) and the user has specified that data input should begin at line 3 and that line 1 will be used as variable names.  Also, the user has specified a sample interval of 5 seconds.
    • Note: the newest (2008) versions show a slightly different window with a horizonal grow tab at lower right (if you have a big enough monitor).

   SABLE FILE...     Loads Sable Systems data files in the standard Sable format (SSCF).  This routine will handle nearly all Sable files, except those which have more than 24 variables (channels).  It assumes your Mac can read PC-format disks, or you have some other method for moving the Sable data to your computer.  The maximum number of markers in LabAnalyst X is about 20,000; Sable files can (theoretically; very rarely in practice) exceed that limit.  The converter will read the first 20,000 markers only.  Sable files do not include channel labels, so after the completion of file loading you are prompted to provide your own labels.  Also, the values for mass, flow rate, effective volume, and so forth are arbitrary and may have to be edited.

If you save SSCF files from LabAnalyst X, or if SSCF files are created by LabHelper, they will appear (on a Mac) with a custom icon, depending on which OS is in use. The small one is for 'classic' operating systems and the large one is for OS X.          

Back to top

   MERGE       This selection has a submenu with two items:

  WARTHOG FILE...    
  SABLE FILE...      Merges a Warthog-format file (either text or binary) or a Sable SSCF file with the currently loaded file.

The new file is appended to the last case of the current file (so if you merge a file containing 1000 samples with a file containing 2000 samples, you get a new file totaling 3000 samples).  The program checks to make sure the merged file will not exceed the current maximum file size (a warning is shown if this is the case), but it does not check to make sure the channels match in the current and new files.  Thus it is quite possible to create a new file that contains two (or more) types of data in a single channel (i.e., first a set of temperature data from the initial file, then some gas concentration data from the second file, then wind speed data from the third file, etc.).

Needless to say, this can cause considerable confusion unless you are careful to avoid merging files with differing channel types.  To help avoid such mistakes, the computer provides a graphical display of the old and new data.  In this example, the file to be merged has 5 channels and the current file contains 6 channels, and after a merge there will be space for another 20,860 cases before the maximum size limit is exceeded.
    • Note: newer versions have much more space than is indicated by this screenshot of an early version.

LabAnalyst X will allow access to the maximum number of channels in either the current or new file.  Sable files don't contain channel labels, so if you merge them you HAVE to know ahead of time what the channel structure is.

Back to top


     Screen display basics

After a file is loaded, the 'plot area' in the top part of the screen displays either the first channel of the file (single channel mode) or several user-selected channels (multi-channel mode); see the VIEW menu for details.  The screen appearance in single-channel mode is approximately as shown below -- but note that immediately after loading, no block will be selected and no data will appear in the results or block windows.  The colors of the plot area and block window are user-selectable (VIEW menu) and may differ from this example.   Also, newer versions can use OS X style windows, with 'pinstripe' backgrounds instead of plain gray.

The major components are the plot area (top half of the screen), data bar (upper left; white background in OS X as shown here; yellow in OS 8/9/classic), channel indicator (upper right), screen selection slider (bottom edge of plot area), 'toolbar' menu buttons (across the center, just below the screen selection slider), comments window (middle right), block window (lower right), and analysis window (lower left).  A selected block appears as a color-inverted segment of the plot area.

The appearance of the plot area depends on the screenwidth (the width of the screen in pixels) and the number of cases.  If the file contains <= screenwidth cases, data are plotted 1 pixel per case (if the number of cases is < 50% of screenwidth, the plot is expanded, with more than 1 pixel per case).  If the total number of cases is more than screenwidth, the X-axis will be scaled to fit within the screen dimensions.  'Screens' (consisting of screenwidth cases) are indicated by vertical lines, with a crossbar at the top of the active screen.  The example above shows a file containing about 45 screenwidths of data. 

If there are more than screenwidth cases, the bottom of the plot area will show a screen selection slider. The currently 'active' segment of the file -- the active screen - is indicated by the slider position.  Use the slider (or the left and right arrow keys) to change the active screen.  To view the active screen only (necessary for some manipulation and analysis operations), hit the shift or return keys.  Do this again to go back to viewing the entire file (this example shows the 'entire file' mode).  Any markers are shown as vertical dashed lines (this file contains numerous markers, but they are not shown; see the VIEW menu).  While in the plot area, the cursor is a cross-hair; out of the area it is an arrow.  The data bar has a readout of case number, elapsed time, and the value of the currently active channel at the cursor position. The time of day is shown (24-hour scale) along the bottom of the plot area, with optional hour indicators (vertical dotted lines).

To perform analyses and many transformations, you need to select a data block. This can be done by the normal Macintosh 'click-hold-and-drag' method (the cursor must be within the plot area).  A second method uses individual clicks: move the cursor to the desired beginning point and click once; repeat for the end point (which may be on either side of the start point).  Alternately, blocks of defined width can be selected with single clicks (see the BLOCK WIDTH option in the ANALYZE menu).  If there is sufficient space, you can 'shift' blocks to the left or right with the BLOCK SHIFT commands (also in the ANALYZE menu).
     Data blocks can include multiple screens.  If a single screen is shown, mark the start of the block with a single click, then shift screens with the screen buttons until the end of the block can be marked.  A selected block is indicated as a color-inverted rectangle in the plot area, and is scaled to fit within the block window (discrete data points on the block window only appear if the number of included points is small).   You can select blocks in 'entire file' or in 'active screen only' mode.

Back to top

  SAVE...    +S     Stores the current file including any modifications you made.  Note that binary files saved from LabAnalyst X have different icons than the 'raw' data files generated by LabHelper

  SAVE AS...      Stores the current file -- or optionally a marked block -- with any modifications you made.  You may save all channels or a subset.  Files are stored in the standard Warthog LabHelper / LabAnalyst format, either in text (file type 'data') or floating-point binary (file type 'WHog') format, in Sable format (SSCF) format, or as ASCII text files. The 'default save' button saves the existing file (with any modifications you have made with transformations, smoothing, etc.) under the existing file name -- in other words, it replaces the original file.  Note that there are no warnings that the old file will be replaced.
     If 'default save' was not clicked, after selecting the channels to save, the file format selection window appears, as shown below:

If you save files in the Warthog text format, you will retain almost all of the data that can be contained in binary files.  The major exception is in the 'comment' text.  The floating-point binary format allows very extensive comments (up to 32K of text), and the comments can include carriage returns.  When saved in Warthog text format, comments are stripped of carriage returns (these are replaced with a single space) and limited to a total of 252 characters.
As mentioned above, Sable SSCF files do not include channel labels.  They also lack values for mass, flow rate, barometric pressure, temperature, and effective volume (unless written in the comments), and comments are limited to a total of 240 characters.

If you select the ASCII option, you have two formatting choices:

  • Timing data are stored with each case (elapsed time since acquisition began, and time of day).  This option is useful for sending files to spreadsheets or plotting programs where time data are important. 
  • The sample interval and start time are stored in the comment string (the first line in the file). 
  • You can also perform a 'conditional' save, which lets you save only those cases that meet a Boolean selection criterion (see below). 

The 'Conditional save' option lets you filter data case by case and save only the cases that meet the selection conditions. You need to specify which channel is to be tested (it is not necessary that the tested channel will be saved), one of five Boolean criteria (<, =<, =, >=, >), and a selection criterion (a number against which the individual case values in the tested channel are compared).
     In this example, only cases where the value of channel 13 (wheel#1 speed in RPM) is greater than 0.5 will be saved.

Data files (other than ASCII) that have been saved by LabAnalyst X have these icons (shown for OS X and 'classic'; the 'classic' icons are used automatically in OS X if the icon size selected by the user is small):

  binary files

  Warthog text files

  SSCF files

LabAnalyst X saves some other file types, shown here:

  Preference files

  Script files

   SHOW FILE DATA     Opens a window below the plot area showing the labels of all the channels, the sample interval, the time and date of storage, etc., and the conversions used by the LabHelper acquisition program to change raw voltages into appropriate units (temperature, gas concentrations, speed, etc.).  The type of conversion equation ("fn") and the number of samples averaged for each recorded point ("N") are also shown.

The following example shows the file data for a 15 channel file.

Conversion equations:

Most conversion equations used by LabHelper are 2-order polynomials (shown as "poly" in the fn column):

value = A + B*volts + C*volts2

Note that a C of zero produces a linear conversion.  Occasionally a power function is used:

value = A + B*voltsC

Note that in a power function a non-integer C will produce meaningless data if the voltage is negative; in this condition, LabHelper sets the results to zero.  A C value of 1 produces a linear conversion.

LabHelper allows use of the keyboard as an event recorder, and a single channel can use a 3-degree polynomial conversion.  If data have been transformed or copied into a new channel, no coefficients are shown.

Back to top

   PRINT FILE IMAGE...     Sends a graphical image of the file to the printer port.  You can usually do this by hitting the 's' key. If you have selected a block, you have the option of printing an image of the block or of the entire file.

Before printing begins you are presented with 'Page Setup' boxes for whatever printer driver is in use.  Note that for 'US LETTER' (or similar) sized paper, you must use the landscape mode for large image sizes (maximum image sizes are about 70% for portrait mode and 80% for landscape mode).  If you use other paper sizes, the recommended image sizes may be too large to fit on the page or smaller than the available space.

If the file is longer than the screenwidth in pixels, the printed output will match the segment of the file shown in the on-screen viewing mode (Entire File or Active Screen).  A file displayed in the "Compacted and Averaged" format will be printed in that format.  If a block has been selected, you have the option of printing only the block.

You can select which features will appear in the printout, such as labeling, file information, comments, and markers.  If the file has more than one channel, you can print any subset of the channels.

If you click the 'non-standard plot heights' button, a window will open to allow customization of the height of each printed channel:

The window contains a diagram of the printed page.  You select the relative height of each channel in sequence by moving the cursor on the diagram to the desired height, and then clicking the mouse ONCE.  The channels will be redrawn one by one as their heights are selected.  Note that there is a fixed amount of room on the page, so that enlarging one channel requires shrinking one or more of the others.  Consequently, the computer reserves an amount of space necessary for plotting the remaining channels at the minimum possible height (and will not let you exceed that limit).  You must select plot heights for all the channels.  When done, you can accept the results, redo the plot height selection, or revert to the normal setting (all channels plotted with equal heights).

  • The speed of printing depends on the number of points and channels to be plotted, CPU speed, the printer interface, the presence or absence of a print spooler, and the size and selected printing resolution of the image.

   FILE IMAGE PREVIEW... like the above routine, but it send the image to the screen in a preview form instead of directly to the printer (you can re-route the previewed image to the printer if you like).

Back to top


   SEND RESULTS TO    This selection has a submenu with three items.

   PRINTER     Selecting this option tells LabAnalyst X to route the data in the Results Window to the temporary printer file 'printfile' whenever the 'P' (or 'p') key is struck.  Actual printing occurs when you close this file with PRINT \ CLOSE FILE.  After printing the 'printfile' remains available (it is overwritten if any additional printing is performed).

   TABULAR FILE...      Opens a tabular (spreadsheet-format) text file for storing results generated by analysis menu operations. Data are saved in a tab-delineated format readable by many spreadsheet programs or statistical packages. Optionally, you can save results to an Excel-format file (double-clickable directly into Excel, with an appropriate Excel icon). Besides the results data, the spreadsheet file also contains column labels. Mean, SD, N, and variable name are always saved; other parameters (start of block, end of block, start and end time, elapsed time, analysis type, mass, and channel number and file name) are user-selectable. You can also enter one or two user-typed 'notes' with each case (edit fields appear in a window over the COMMENTS window when the 'p' key is struck; hit 'return' or click the window close button when the values are correct). Certain analyses, such as regressions, do not fit this format and cannot be put into tabular files.

The default is one set of analysis results per line in the spreadsheet, but if you've selected Microsoft Excel format you can use the 'Multiple results per line' option to save the results from two to 15 different analyses per line. You need to specify how many results you want to save initially (you can't change this when the file is in use). Therefore, you need to keep track of the order of analyses so as to avoid confusion later on (scripting can help here). If you elect to use notes or store animal mass, these items are saved only once per spreadsheet line (not every time you save an analysis result).

Here is a general format for one line from a file with 2 results per line, with both user notes selected and mass saved:

Note1 · Note2 · M1 · SD1 · N1 · var1 · anal1 · mass · M2 · SD2 · N2 · var2 · anal2 <CR>

where · is a tab character, <CR> is a carriage return character, M1 = mean of the first result, SD1 = SD of first result, N1 = sample size of first result, var1 = variable for first result, anal1 = analysis for first result, mass = body mass, M2 = mean of the second result, etc.

Storage of results (in memory) occurs when you press the 'p' key (with the Results window open), or select OUTPUT RESULTS. The spreadsheet file is not saved to disk until you exit from LabAnalyst X or use the PRINT | CLOSE FILE option.

Some additional considerations:

    • Certain analyses, such as regressions and integration, do not fit this format and cannot be put into tabular files. 
    • Note that when doing waveforms or pairs-difference, pressing the 'p' key stores BOTH frequency and amplitude data.  If you want to store one or the other, press the 'f' key to store frequency data only, or the 'a' key to store amplitude data only.

  TEXT FILE...     Opens a text file for storing the contents of the Results Window.  The format of the disk file is similar to that shown in the Results Window and is identical to the format of data sent to the printer.

    • Actual storage occurs when you press the 'P' or 'p' key, or select OUTPUT RESULTS.

Back to top


In OS X, the ABOUT..., PREFERENCES and QUIT options are in the 'LabAnalyst X' menu, just to the right of the apple icon in the menu bar.

Back to top


go back to the LabAnalyst page

go to the Warthog Systems page

go to Mark Chappell's page