Go up one levelGo to Previous Go to Next

Rtd(n)

NAME

 
 Rtd - real-time image display application class

NAMESPACE

 
 rtd

PARENT CLASS

 
 util::TopLevelWidget

SYNOPSIS

 
 Rtd <path> ?options?

DESCRIPTION

 
 This class defines the top level window for the rtd (real-time image
 display) application.  The window contains a menubar with rtd related
 items, an RtdImageCtrl widget for displaying the image, and related
 info and a short help window.

 The easiest way to use this class is via the "start" method (inherited
 from TopLevelWidget).  This creates an instance of this class and
 passes any command line options as public variables to the class and
 waits for window to be exited. Alternatively, you can create the
 instance in the usual way for itcl classes and withdraw the main window
 ".", if it is not being used.

 One global variable is assumed to have been defined:

 rtd_library - dir containing Rtd Tcl sources.


ITK COMPONENTS

 
 icon
        Optional RtdImage image icon.

 image
        RtdImageCtrl(n) widget containing image and control panel.

WIDGET OPTIONS

 
 -camera
        Camera name: default: $env(RTD_CAMERA), if set, otherwise
        RTDSIMULATOR.

 -color_scale
        Set the default color scale algorithm to one of: {linear log sqrt
        histeq}.

 -colorramp_height
        Height of the colorramp subwindow.

 -debug
        Debugging flag: enables real-time simulation with $testProg
        (below).

 -default_cmap
        Default (midas) colormap.

 -default_itt
        Default (midas) intensity transfer table.

 -disp_image_icon
        Flag: if true, display a copy (view) of the image as an icon.

 -dozoom
        Flag: if true, turn on zoom window.

 -drag_scroll
        Flag: if true, set bindings to scroll with the middle mouse
        button.

 -file
        Image file to display.

 -float_panel
         Float the control panel (better real estate control on small
         displays).

 -interval
        For testing: interval between updates in ms.

 -max_colors
        Specify the max number of colors to allocate before using a
        private colormap (not impl.).

 -max_scale
        Maximum allowed scale value.

 -min_colors
        Specify the min number of colors to allocate before using a
        private colormap (not impl.).

 -min_scale
        Minimum allowed scale value.

 -noop
        Dummy option, used when cloning the main window, in place of
        "-file".

 -pan_height
        Height of panning window.

 -pan_width
        Width of panning window.

 -panel_layout
        Panel layout order: set to one of {saoimage reverse default} to
        change the layout ordering of the panel windows.  "saoimage" puts
        the info first, followed by pan and zoom, "reverse" reverses the
        default order, which is {zoom info pan}.

 -pickobjectorient
        -orient option for Pick Object window.

 -port
        Default port for remote connections (0 means system chooses a
        port).

 -scrollbars
        Flag: if true, display scrollbars to scroll the image.

 -shm_data
        This flag controls whether the FITS image data is kept in sysV
        shared memory (see the rtdRemote interface for use of this).

 -shm_header
        This flag controls whether the FITS image header is kept in sysV
        shared memory (see the rtdRemote interface for use of this).

 -subsample
        Flag: if true, use faster subsampling algorithm when shrinking
        images, otherwise use max pixel algorithm.

 -testprog
        For testing: name of test program used to generate real-time
        updates.

 -use_zoom_view
        Flag: if true, use a "view" of the main image for the zoom window
        otherwise zoom directly from the X display.  The advantage of the
        first approach (-use_zoom_view 1) is that the zoom is accurate
        even when the main image is shrunken.  The second (-use_zoom_view
        0) is faster and allows more accurate positioning.

 -usexshm
        Flag: if true, try to use X shared memory for images.

 -usexsync
        Lag: if true, try to use X synchronisation.

 -verbose
        Flag: if true, print diagnostic messages.

 -with_colorramp
        Flag: if true (default), show the color ramp window.

 -with_grid
        Option to include grid button (default to off, since it doesn't
        work well yet on some images).

 -with_pan_window
        Flag: if true (default) make a panning window.

 -with_perftest
        With performance tester utility in menu bar.

 -with_warp
        Option to warp the mouse pointer.

 -with_zoom_window
        Flag: if true (default) make a zoom window .

 -xscale
        Default scaling factor (just for backwards compatibility with
        tcscam; don't use!).

 -zoom_factor
        Zooming factor.

 -zoom_height
        Height of zoom window.

 -zoom_view_propagate
        Flag: if true, changes in main image scale will propagate to the
        zoom window, otherwise controls are displayed so the user can
        manually change it (ZoomView only).

 -zoom_width
        Width of zoom window.

PUBLIC METHODS

 
 attach_camera {}
        Attach the current camera.

 clear {}
        Called for "Clear" menu item. Clear the image and delete all
        graphics.

 clone {}
        Make a new main window.

 detach_camera {}
        Detach the current camera.

 feedback {msg}
        This method can be redefined in a subclass to get feedback during
        startup.

 quit {}
        Quit the application.

 record {}
        Methods for the playing and recording of images.

 setXdefaults {}
        Set default X resources for colors and fonts, and set some default
        key bindings. This is done in a method so that it can be
        overridden by a subclass.  These are built-in defaults that the
        user can also override in the ~/.Xdefaults file.

 set_camera {}
        Popup a window to query for new camera.

PROTECTED METHODS

 
 add_file_menu {}
        Add the File menubutton and menu.

 add_graphics_menu {}
        Add the Graphics menubutton and menu.

 add_menubar {}
        Add the menubar at the top of the window.

 add_realtime_menu {}
        Add the Real-time menubutton and menu.

 add_view_menu {}
        Add the VIew menubutton and menu.

 init {}
        This method is called after the options have been evaluated.

 make_rtdimage {}
        Create the rtd image widget.

 make_short_help {}
        Add the short help window and add some help texts for the menu
        buttons.

 rapid_frame_command {frameId name op x y w h}
        This method is called when the user creates, moves, resizes or
        deletes a rapid frame.

        The args are:

         frameId = unique rapid frame id for use with rtdServer

         name = unique name for the frame

         op  = {move,resize or delete},

         x, y = coords of upper left corner of frame in image

         w, h = dimensions of frame.

PROTECTED VARIABLES

 
 image_
        Name of main image (class RtdImageCtrl or a derived class).

 rapid_pid_
        Pid of test prog used to generate rapid frames (debug).

SEE ALSO

 
 TopLevelWidget(n)

 


- - - - - -
Last change: 07 May 99

 


Go up one levelGo to Previous Go to Next

Please send questions or comments to abrighto@eso.org.
Copyright © 1998 ESO - European Southern Observatory