get_system ( : : Query : Information )

Information concerning the currently used HORUS system parameter.

The operator get_system returns information concerning the currently activated HORUS system parameters. Some of these parameters can be changed dynamically by using the operator set_system. If the string '?' is passed together with Query, the names of all system parameters are provided under Information.

The following system parameters can be queried:

Versions:
----------

'version'
                HORUS\ version number, e.g.: 3.08
'last_update'
                Date of creation of the HORUS\ library 

Upper limits:
------------

'max_contour_length'
                Maximum number of contour respectively polygone control points 
                of a region.
'max_images'
                Maximum total of images.
'max_object_images'
                Maximum number of channels of an image.
'max_obj_per_par'
                Maximum number of image objects which may be used during one 
                call per parameter.
'max_inp_obj_par'
                Maximum number of input parameters.
'max_outp_obj_par'
                Maximum number of output parameters.
'max_inp_ctrl_par'
                Maximum number of input control parameters.
'max_outp_ctrl_par'
                Maximum number of output control parameters.
'max_window'
                Maximum number of windows.
'max_window_types'
                Maximum number of window systems (e.g.\ 'X Window',
                'Starbase', etc.).
'max_proc'
                Maximum number of HORUS-procedures (system defined +
                user defined).

Host language:
-------------

'min_integer'
                Smallest representable integer. 
'max_integer'
                Biggest representable integer..
+'compact_obj'
                Some host languages like Prolog allow modifications of the 
                processing mode for object images (see also
                count_relation): 
                'true': A common key for all result objects of a procedure
                is created.
                'false': Each object receives its own key. 

Graphic:
--------

+'flush_graphic'
                Determines, whether the flush operation is called
                or not after each HORUS\ procedure.
+'backing_store'
                Storage of the window contents in case of overlaps.
+'default_font'
                Name of the font to set at opening a window. 
+'lut_dir'      
                Path for the default-directory for color tables
                (see also: set_lut).
+'x_package'    
                Number of bytes which are sent to the X server during each
                transfer of data.
+'last_pixel'   
                Largest color table index which may be used.
+'num_grey_4' 
                Number of colors reserved under X-Windows concerning the
                output of graylevels (disp_grey) on machines
                with 4 bitplanes (16 colors).           
+'num_grey_6' 
                Number of colors reserved under X-Windows concerning the
                output of graylevels (disp_grey) on machines
                with 6 bitplanes (64 colors).
+'num_grey_8' 
                Number of colors reserved under X-Windows concerning the
                output of graylevels (disp_grey) on machines
                with 8 bitplanes (256 colors).
+'num_grey_percentage'
                Under X-windows HORUS\ reserves a certain number of available
                colors to allow the representation of graylevels
                (disp_grey). This shall interfere with other
                X applications as little as possible. However, if HORUS\ does 
                not succeed in reserving a miminum percentage of
                'num_grey_percentage' of the necessary colors on the X-server,
                a certain amount of the lookup-table will be claimed for the
                HORUS\ graylevels regardless of the consequences for other
                applications.

                This may result in undesired shifts of color when switching
                between HORUS\ windows and windows of other applications,
                or if (outside HORUS) a window-dump is generated. The number
                of the real graylevels to be reserved depends on the number of 
                available bitplanes on the outputmachine (see also 'num_grey_*'.
                Naturally no colors will be reserved on monochrome machines - 
                the graylevels will instead be dithered when displayed. If 
                graylevel-displays are used, only different shades of gray
                will be applied ('black', 'white', 'grey', etc.). 
                Machines with 2 or 3 bitplanes will be considered monochrome
                machines, machines with 5 (7) bitplanes like machines with 4 (6)
                bitplanes, and machines having more than 8 bitplanes like
                machines with 8 bitplanes. A special case are machines providing
                a 24 bit display (true color machines). Naturally no colors are
                reserved for the display of graylevels in this case.

                Note: Before the first window on a machine with x bitplanes is
                opened, num_grey_x indicates the number of colors which have to
                be reserved for the display of graylevels, afterwards, however,
                it will indicate the number of colors which actually have been
                reserved. 
+'num_graphic_2' 
                Number of the HORUS\ graphic colors reserved under X-Windows 
                (for disp_region etc.) on a machine with 2 bitplanes
                (4 colors).
+'num_graphic_4' 
                Number of the HORUS\ graphic colors reserved under X-Windows 
                (for disp_region etc.) on a machine with 4 bitplanes 
                (16 colors).
+'num_graphic_6' 
                Number of the HORUS\ graphic colors reserved under X-Windows 
                (for disp_region etc.) on a machine with 6 bitplanes 
                (64 colors).
+'num_graphic_8' 
                Number of the HORUS\ graphic colors reserved under X-Windows 
                (for disp_region etc.) on a machine with 8 bitplanes 
                (256 colors).
+'graphic_colors'
                All colors under X Windows which can be used by HORUS. From this
                list the first num_graphic_x colors will be reserved as graphic
                colors. On default, HORUS\ supplies in this case the same list
                as by calling query_all_colors. However, the list can
                be adapted individually with the help of the operator
                set_system.

                Note: In case of a graylevel machine, not the first x colors
                will be reserved from the list, but the first graylevels.
               

Image Processing:
-----------------

+'neighbourhood'
                Using the 4 or 8 neighborhood.
+'image_dir'
                Path which will searched for the image file after the 
                default directory (see also: read_image).
+'init_new_image'
                Initialization of images before applying grayvalue
                transformations.
+'store_empty_region'
                Storing of objects with empty regions. 
+'no_object_result'
                Behavior for an empty object list.
+'empty_object_result'
                Behavior for an empty input region.
+'clip_region'
                Clipping of output regions so that they fit the global
                image size.
'width'
                Current image width. 
'height'
                Current image height.
'obj_images'
                Current number of grayvalue components per image object.
+'current_runlength_number'
                Currently used number of chords which can be used
                for the encoding of regions. 

File:
------

'flush_file'
                Buffering of file ouput. 

Other:
----------

'num_proc'
                Total number of all available HORUS\ procedures. 
                ('num_sys_proc' + 'num_user_proc').
'num_sys_proc'
                Number of the system procedures (supported procedures).
'num_user_proc'
                Number of the user-defined procedures (see also C interface).
+'latex_dir'     
                Path for the default directory concerning the LaTex sources 
                of the HORUS\ documentation.
+'help_dir'      
                Path for the default help directory for the online help files: 
                \{german,english\}.\{hlp,sta,idx,num,key\}.
+'user_help_dir'      
                Path for the user help directory for the online help files:
                \{german,english\}\[.user\].\{hlp,sta,idx,num,key\}.


Parameters

Query (input_control)
string(-array) -> string
Desired system parameter.
Default value: 'width'
List of values: 'version', 'last_update', 'max_images', 'max_obj_per_par', 'max_inmp_obj_par', 'max_outp_obj_par', 'max_inp_ctrl_par', 'max_outp_ctrl_par', 'max_window', 'max_window_type', 'max_proc', 'min_integer', 'max_integer', 'compact_obj', 'flush_graphic', 'backing_store', 'default_font', 'lut_dir', 'x_package', 'last_pixel', 'num_grey_4', 'num_grey_6', 'num_grey_8', 'num_grey_percentage', 'num_graphic_2', 'num_graphic_4', 'num_graphic_6', 'num_graphic_8', 'num_graphic_percentage', 'graphic_colors', 'neighbourhood', 'image_dir', 'init_new_image', 'store_empty_region', 'no_object_result', 'empty_region_result', 'clip_region', 'width', 'height', 'obj_images', 'current_runlength_number', 'flush_file', 'num_proc', 'num_sys_proc', 'num_user_proc', 'latex_dir', 'help_dir', 'user_help_dir'

Information (output_control)
integer(-array) -> integer / real / string
Current value of the system parameter.


Result

The operator get_system returns the value TRUE if the parameters are correct. Otherwise an exception is raised.


Possible Predecessors

init_horus


Possible Successors

set_system


See also

set_system



Copyright © 1996-1997 MVTec Software GmbH