get_system ( : : Query : Information )

Information concerning the currently used HALCON system parameter.

The operator get_system returns information concerning the currently activated HALCON system parameters. Some of these parameters can be changed dynamically by using the operator set_system. They are marked by a + in the list below. By passing the string '?' as the parameter Query, the names of all system parameters are provided with Information.

The following system parameters can be queried:

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

'version'
                HALCON version number, e.g.: 6.0
'last_update'
                Date of creation of the HALCON library
'revison'
                Revision number of the HALCON library, e.g.: 1

Upper Limits:
------------

'max_contour_length'
                Maximum number of contour respectively polygone
                control points of a region.
'max_images'
                Maximum total of images.
'max_channels'
                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.
'max_proc'
                Maximum number of HALCON-procedures (system defined +
                user defined).

Graphic:
--------

+'flush_graphic'
                Determines, whether the flush operation is called
                or not after each HALCON procedure.
+'int2_bits'
                Number of significant bits of int2 images.
                This number is used when scaling the gray values.
                If the values is -1 the gray values will be
                automatically scaled (default).
+'int_zooming'
                Determines if the zooming of images is done with
                integer arithmetic or with floating point
                arithmetic.
+'draw_mode'
                (no description available)
+'ignore_colormap'
                (no description available)
+'backing_store'
                Storage of the window contents in case of overlaps.
+'icon_name'
                (no description available)
+'window_name'
                (no description available)
+'default_font'
                Name of the font to set at opening a window.
+'single_lut'
                (no description available)
+'update_lut'
                (no description available)
+'x_package'
                Number of bytes which are sent to the X server during each
                transfer of data.
+'num_gray_4'
                Number of colors reserved under X-Window concerning the
                output of graylevels (disp_channel) on machines
                with 4 bitplanes (16 colors).
+'num_gray_6'
                Number of colors reserved under X-Window concerning the
                output of graylevels (disp_channel) on machines
                with 6 bitplanes (64 colors).
+'num_gray_8'
                Number of colors reserved under X-Window concerning the
                output of graylevels (disp_channel) on machines
                with 8 bitplanes (256 colors).
+'num_gray_percentage'
                Under X-windows HALCON reserves a certain number of
                available colors to allow the representation of
                graylevels (disp_channel). This shall
                interfere with other X applications as little as
                possible. However, if HALCON does not succeed in
                reserving a miminum percentage of
                'num_gray_percentage' of the necessary colors on the
                X-server, a certain amount of the lookup-table will
                be claimed for the HALCON graylevels regardless of
                the consequences for other applications.

                This may result in undesired shifts of color when
                switching between HALCON windows and windows of
                other applications, or if (outside HALCON) a
                window-dump is generated. The number of the real
                graylevels to be reserved depends on the number of
                available bitplanes on the output-machine (see also
                'num_gray_*'.

                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', 'gray', 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_gray_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_percentage'
                (no description available)
+'num_graphic_2'
                Number of the HALCON graphic colors reserved under X-Window
                (for disp_region etc.) on a machine with 2 bitplanes
                (4 colors).
+'num_graphic_4'
                Number of the HALCON graphic colors reserved under X-Window
                (for disp_region etc.) on a machine with 4 bitplanes
                (16 colors).
+'num_graphic_6'
                Number of the HALCON graphic colors reserved under X-Window
                (for disp_region etc.) on a machine with 6 bitplanes
                (64 colors).
+'num_graphic_8'
                Number of the HALCON graphic colors reserved under X-Window
                (for disp_region etc.) on a machine with 8 bitplanes
                (256 colors).

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

+'neighborhood'
                Using the 4 or 8 neighborhood.
+'only_lines'
                (no description available)
+'init_new_image'
                Initialization of images before applying grayvalue
                transformations.
+'no_object_result'
                Behavior for an empty object list.
+'empty_region_result'
                Reaction of procedures concerning input objects with
                empty regions which actually are not useful for such
                objects (e.g.\ certain region features, segmentation, etc.).
                Available values for Value:
                'true':       the error will be ignored if possible
                'false':      the procedure returns FALSE
                'fail':       the procedure returns FAIL
                'void':       the procedure returns VOID
                'exception':  an exception is raised
+'store_empty_region'
                Storing of objects with empty regions.
+'clip_region'
                Clipping of output regions so that they fit the global
                image size.
'width'
                Global maximum image width - in Standard-HALCON this 
                value contains the maximum image width of all HALCON image 
                objects which are currently stored in memory. In Parallel 
                HALCON this value contains the maximum image width of all 
                HALCON image objects which are or were in memory since the 
                start of the current HALCON session (this also includes 
                objects which may be deleted meanwhile).
'height'
                Global maximum image height - in Standard-HALCON this 
                value contains the maximum image height of all
                HALCON image objects which are currently stored in
                memory. In Parallel HALCON this value contains the
                maximum image height of all HALCON image objects
                which are or were in memory since the start of the
                current HALCON session (this also includes
                objects which may be deleted meanwhile).
'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.

Parallelization:
-----------------

+'parallelize_operators'
                 Determines whether Parallel HALCON uses an automatic 
                 parallelization to speed up the processing of operators 
                 on multiprocessor machines.
+'reentrant'
                 Denotes whether Parallel HALCON currently supports 
                 reentrancy (default case), or whether this feature 
                 has been switched off. Reentrancy is necessary for the 
                 automatic parallelization of Parallel HALCON and 
                 for calling and processing multiple HALCON operators 
                 in parallel within multithreaded applications.
'processor_num'
                 Returns the number of processors which Parallel
                 HALCON has found on the hardware it is running
                 on. This also indicates the number of processors
                 which is used by Parallel HALCON for the
                 automatic parallelization of operators.

File:
------

+'flush_file'
                Buffering of file ouput.
+'ocr_trainf_version'
                This parameter returns the file format used for writing 
                an OCR training file in the form of a version number.
                The operators write_ocr_trainf, write_ocr_trainf_image 
                and concat_ocr_trainf write training data in ASCII format
                for version number 1 or in binary format for version 
                number 2.

Directories:
------------

+'image_dir'
                Paths which will searched for the image file after the
                default directory (see also: read_image).
+'lut_dir'
                Path for the default-directory for color tables
                (see also: set_lut).
+'reference_dir'
                Path for the default directory concerning the postscript
                HALCON documentation.
+'help_dir'
                Path for the default help directory for the online help files:
                \{german,english\}.\{hlp,sta,idx,num,key\}.

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

+'do_low_error'
                Flag, if low level error should be printed.
'num_proc'
                Total number of all available HALCON 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
                'Extension Packages' manual).
'byte_order'
                Byte order of the processor ('msb_first' or 'lsb_first').
'operating_system'
                Name of the operating system of the computer on
                which the HALCON process is being executed.
'operating_system_version'
                Version number of the operating system of the
                computer on which the HALCON process is being
                executed.
+'clock_mode'
                 Method used for measuring the time in
                 count_seconds ('processor_time',
                 'elapsed_time', or 'performance_counter').
+'max_connection'
                 Maximum number of regions returned by
                 connection.
+'alloctmp_single_block'
                Flag for kind of temporary memory management.
+'alloctmp_max_blocksize'
                Maximum size of memory blocks to be allocated
                within temporary memory management.
                (No effect, if 'alloctmp_max_blocksize' == -1 or
                'alloctmp_single_block' == 'true')
+'extern_alloc_funct'
                Pointer to external function for memory allocation
                of result images.
+'extern_free_funct'
                Pointer to external function for memory deallocation
                of result images.
'temp_mem'
                Amount of temporary memory used by the last
                operator.  This feature is only supported by
                Standard-HALCON.  Instead of this, Parallel
                HALCON returns the amount of temporary memory used
                by get_system itself.
+'language'
                Language used for error messages ('english' or 'german').


Parameters

Query (input_control)
string(-array) -> string
Desired system parameter.
Default value: 'width'
List of values: ''?'', 'version', 'last_update', 'revision', 'max_images', 'max_channels', 'max_obj_per_par', 'max_inp_obj_par', 'max_outp_obj_par', 'max_inp_ctrl_par', 'max_outp_ctrl_par', 'max_window', 'max_window_types', 'max_proc', 'flush_graphic', 'int2_bits', 'int_zooming', 'draw_mode', 'ignore_colormap', 'backing_store', 'icon_name', 'window_name', 'default_font', 'single_lut', 'update_lut', 'x_package', 'num_gray_4', 'num_gray_6', 'num_gray_8', 'num_gray_percentage', 'num_graphic_2', 'num_graphic_4', 'num_graphic_6', 'num_graphic_8', 'num_graphic_percentage', 'neighborhood', 'only_lines', 'init_new_image', 'no_object_result', 'empty_region_result', 'store_empty_region', 'clip_region', 'width', 'height', 'obj_images', 'current_runlength_number', 'flush_file', 'ocr_trainf_version', 'image_dir', 'lut_dir', 'reference_dir', 'help_dir', 'num_proc', 'num_sys_proc', 'num_user_proc', 'temp_mem', 'alloctmp_single_block', 'alloctmp_max_blocksize', 'extern_alloc_funct', 'extern_free_funct', 'do_low_error', 'reentrant', 'parallelize_operators', 'processor_num', 'clock_mode', 'max_connection', 'byte_order', 'operating_system', 'operating_system_version', 'language'

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


Result

The operator get_system returns the value 2 (H_MSG_TRUE) if the parameters are correct. Otherwise an exception is raised.


Parallelization Information

get_system is local and processed completely exclusively without parallelization.


Possible Predecessors

reset_obj_db


Possible Successors

set_system


See also

set_system


Module

System



Copyright © 1996-2005 MVTec Software GmbH