[Next] [Previous] [Top]

Freud User Manual

CHAPTER 1 Introduction

Overview
On-line help
Quick start for the impatient
User interface overview
Mouse buttons
Window buttons
Menus
Freud window layout
Starting Freud
Base window
Defaults
Colors

Overview

Freud is a user interface for visualizing datasets. This document describes how to use Freud. It is assumed that Freud has been installed on your computer.

It is much easier to learn Freud by doing rather than reading. It is highly recommended that you try out some of the things you read about when you read about them.

Freud is based on objects. Each object in Freud represents a particular kind of plot. For instance, a map object is used to generate a background map. A contour object is used to generate a contour plot. An object is either a background object, or an overlay object. Background objects affect other objects; overlay objects exist independently of other objects. If, for example, you generate a map object (which is a background object), and then a contour object (which is an overlay object), the map object is used to generate the coordinate system used for plotting the contours described by the contour object. There are currently four objects in Freud-two background objects (map, xy) and two overlay objects (contours,vectors).

An object is a programming abstraction. It represents the Platonic ideal of the real object. If you want to do anything useful, you have to instantiate the object. An instantiation is the physical realization of an object. In Freud, an instantiation occurs when you click on an icon representing a particular object. Once this is done, you can physically manipulate this representation of an object. An object can have multiple instantiations. For instance, you can overlay several contour plots; each of the plots is described by an instantiation of the contour object.

On-line help

If you have access to the World Wide Web, and if the person responsible for installing Freud has configured it for access to the Web, online help is available while you are using Freud. Just select Freud manual (online) from the menu attached to the Help button. Your Web browser will start up loaded with the index to the latest version of the on-line Freud manual.

Quick start for the impatient

Try the following to display a simple contour plot with Freud:

freud&
/usr/local/lib/freud/sample/gfdl_v830.mean.pkd

User interface overview

Freud is based on the Motif user interface. If you don't have experience with Motif, you probably should read some documentation on it before using Freud. The following section provides a very brief introduction to Motif.

Mouse buttons

In Motif one mouse button (usually the left button) is used to interact with a window. Since some window systems use different mouse buttons to activate a button or pull down a menu, this document uses two terms to refer to the same Motif mouse button. SELECT is used when describing a mouse button action that selects a Motif objects or activates a window button. MENU is used when describing actions that invoke menus or select menu items. The term "click" means to press and then release a button. The term "double click" means that you should rapidly click twice.

Window buttons

A window button (not to be confused with a mouse button) is a marked area on the display screen that produces some action when activated.

The button can be activated by clicking on it. After you click on the button, something will happen; a new window might appear, or the appearance of the button might change.

Menus

Menus allow you to choose from a list of options. A menu is invoked by pressing and holding down MENU over a Motif object. If you wish to choose one of the menu items, release the MENU button while the cursor is over the item you wish to choose.

Menus can have submenus. A submenu is indicated by an arrow to the right of the menu item. To view a submenu, first invoke the main menu by pressing and holding down MENU over an object with an attached menu; while continuing to hold down the mouse button, move the mouse until the item with the submenu is highlighted; slide the mouse to the right and the submenu will appear. An item on the submenu can be chosen by releasing the MENU button while the item is highlighted.

A menu item can also have an associated accelerator key. An accelerator key allows the user to access menu items without having to move from the keyboard to the mouse. An accelerator key is indicated by text on the right hand side of a given menu item; for instance, all windows (except the main window) can be closed by simultaneously pressing the control key and the c key; this is indicated by the text `Control+c' on the right hand side of the Close menu item.

Freud window layout

Every object in Freud has an associated popup window. Every major popup window has a menu bar at the top. All objects have a File button in this menu bar with an attached menu; menu items in this menu allow you to open a data file and associate it with a given object, save or restore the state of an object, or close the window associated with the object.

There are two other buttons that commonly appear in the menu bar. The Edit button has an attached menu that allows you to change the state of an object. The Data button associates the data browser with a given object.

Starting Freud

Start Freud by typing:

freud

If you don't want access to Freud's command line interface type:

freud &

After a few moments, the base window for Freud will appear (see Fig. 1)

You may get a message stating that some fonts cannot be found; this means that either the X server font search path is not set correctly, or that the Motif fonts have not been correctly installed on your system. Talk to your system administrator to resolve this.

Base window

The base window is divided into four regions-a menu bar, an action bar, an instance bar, and a drawing area.

The menu bar contains buttons with attached menus that control attributes of Freud.

The action bar allows you to instantiate overlays, and provides some shortcut buttons. The first two buttons on the left allow you to set up the background of your plot. If you choose a map background, your data will be superimposed on a map background in one of several map projections. If you choose a xy background, your data is superimposed on a standard xy display, and you can control the appearance of labels and tick marks on the background.

The next two buttons allow you to superimpose contour or vector plots over your chosen background.

The next three buttons allow you to plot in the drawing area, print to a file or printer, or interrupt a plot that is in progress.

The next three buttons control, respectively, the number and position of plots on a page, the data to be loaded for contour or vector plots, and the labeling of the plot.

The active plot menu selects the active frame on a page; the position and number of frames on a page can be set by pressing the Layout button.

The instance bar contains buttons that allow you to popup windows used to control the attributes of map, xy, vector, or contour instantiations.

Any plots you create are displayed in the drawing area.

You must have at least one instantiation of a background object. If you have specified an overlay object, but no background objects, a map object will be automatically created when you press the Plot button. If there are multiple instantiations, then attributes from the first instantiation are used to determine how to project the contours or vectors from the overlay objects.

Instances can be deleted by selected the instance to delete from the Delete instances menu attached to the Edit button.

Defaults

The state of any object in Freud can be saved and then restored at a later time. Defaults for all objects are saved by choosing Defaults Save As from the File menu in the object window. A file selection dialog box will appear that allows you to choose the name of the defaults file. The defaults file can be restored by choosing the Defaults Open item on the same menu.

The state of the entire application can be saved by choosing Defaults Save As from the File menu in the base window. Unlike earlier versions of Freud, you don't have to save the defaults for each instance before saving the global defaults.

Colors

Colors are set by means of a color

menu. The menu contains a set of static and dynamic colors.

Static colors are set at the time you create a plot. They can only be changed by selecting a new color from the menu, and then replotting.

Dynamic colors are changed by changing the current colormap with the colormap menu.The colormap menu is accessible from the View menu in the Freud base window. The colormap determines which colors are displayed in the dynamic portion of the color menu. If a colormap is changed, not only are the colors in the dynamic portion of the menu changed, but also any colors in the plot that were selected from this portion of the color menu. The default colormap is gray scale.


Freud User Manual - 02 FEB 96
[Next] [Previous] [Top]

Generated with CERN WebMaker