Name
get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo — Get information concerning a HALCON-operator.
With the help of the operator get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo the
online-texts concerning a certain operator can be called (see also
get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName). The form of information available for
all operators (SlotSlotSlotSlotSlotslot) can be called using the operator
query_operator_infoquery_operator_infoQueryOperatorInfoquery_operator_infoQueryOperatorInfoQueryOperatorInfo. For the time being the following slots
are available:
- 'short':
Short description of the operator.
- 'abstract':
Description of the operator.
- 'chapter':
Name(s) of the chapter(s) in the operator hierarchy (chapter,
subchapter in the HALCON manual).
- 'functionality':
Functionality is equivalent to the object class to which
the operator can be assigned.
- 'keywords':
Keywords of the operator (optional).
- 'example':
Example for the use of the operator (optional). The operator
'example.LANGUAGE'
calls up examples for a certain language if available. If the
language is not indicated or if no example is available in this
language, the TRIAS-example will be returned.
- 'complexity':
Complexity of the operator (optional).
- 'effect':
Not in use so far.
- 'parallelization'
Characteristic parallel behavior of an operator.
- 'parallel_method'
Method of automatic operator parallelization.
- 'alternatives':
Alternative operators (optional).
- 'see_also':
Operators containing further information (optional).
- 'predecessor':
Possible and sensible predecessor
- 'successor':
Possible and sensible successor
- 'result_state':
Return value of the operator (TRUE, FALSE, FAIL, VOID
or EXCEPTION).
- 'attention':
Restrictions and advice concering the correct use of the
operator (optional).
- 'parameter':
Names of the parameter of the operator (see also
get_param_infoget_param_infoGetParamInfoget_param_infoGetParamInfoGetParamInfo).
- 'references':
Literary references (optional).
- 'module':
The module to which the operator is assigned.
- 'html_path':
The directory where the HTML documentation of the operator resides.
- 'warning':
Possible warnings for using the operator.
- 'compute device':
List of compute devices supported by the operator.
The texts will be taken from the files operators_[LANG].ref,
operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num and
operators_[LANG].idx which will be searched by HALCON in the currently used
directory or in the directory 'help_dir' (respectively 'user_help_dir') (see
also get_systemget_systemGetSystemget_systemGetSystemGetSystem and set_systemset_systemSetSystemset_systemSetSystemSetSystem). By adding '.latex' after
the slotname, the text of slots containing textual information can be made
available in LaTeX notation.
The encoding of the result is ISO 8859-1 for English and German, and UTF-8
for Japanese.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Name of the operator on which more information
is needed.
Default value:
'get_operator_info'
"get_operator_info"
"get_operator_info"
"get_operator_info"
"get_operator_info"
"get_operator_info"
Desired information.
Default value:
'abstract'
"abstract"
"abstract"
"abstract"
"abstract"
"abstract"
List of values: 'abstract'"abstract""abstract""abstract""abstract""abstract", 'alternatives'"alternatives""alternatives""alternatives""alternatives""alternatives", 'attention'"attention""attention""attention""attention""attention", 'chapter'"chapter""chapter""chapter""chapter""chapter", 'chapter_id'"chapter_id""chapter_id""chapter_id""chapter_id""chapter_id", 'complexity'"complexity""complexity""complexity""complexity""complexity", 'compute_device'"compute_device""compute_device""compute_device""compute_device""compute_device", 'example'"example""example""example""example""example", 'functionality'"functionality""functionality""functionality""functionality""functionality", 'html_path'"html_path""html_path""html_path""html_path""html_path", 'keywords'"keywords""keywords""keywords""keywords""keywords", 'module'"module""module""module""module""module", 'parallel_method'"parallel_method""parallel_method""parallel_method""parallel_method""parallel_method", 'parallelization'"parallelization""parallelization""parallelization""parallelization""parallelization", 'predecessor'"predecessor""predecessor""predecessor""predecessor""predecessor", 'references'"references""references""references""references""references", 'result_state'"result_state""result_state""result_state""result_state""result_state", 'see_also'"see_also""see_also""see_also""see_also""see_also", 'short'"short""short""short""short""short", 'successor'"successor""successor""successor""successor""successor", 'warning'"warning""warning""warning""warning""warning"
Information (empty if no information is available)
The operator get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo returns the value 2 (H_MSG_TRUE) if the
parameters are correct and the helpfiles are availabe. Otherwise an
exception is raised.
get_keywordsget_keywordsGetKeywordsget_keywordsGetKeywordsGetKeywords,
search_operatorsearch_operatorSearchOperatorsearch_operatorSearchOperatorSearchOperator,
get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName,
query_operator_infoquery_operator_infoQueryOperatorInfoquery_operator_infoQueryOperatorInfoQueryOperatorInfo,
query_param_infoquery_param_infoQueryParamInfoquery_param_infoQueryParamInfoQueryParamInfo,
get_param_infoget_param_infoGetParamInfoget_param_infoGetParamInfoGetParamInfo
get_param_namesget_param_namesGetParamNamesget_param_namesGetParamNamesGetParamNames,
get_param_numget_param_numGetParamNumget_param_numGetParamNumGetParamNum,
get_param_typesget_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes
get_param_namesget_param_namesGetParamNamesget_param_namesGetParamNamesGetParamNames
query_operator_infoquery_operator_infoQueryOperatorInfoquery_operator_infoQueryOperatorInfoQueryOperatorInfo,
get_param_infoget_param_infoGetParamInfoget_param_infoGetParamInfoGetParamInfo,
get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName,
get_param_numget_param_numGetParamNumget_param_numGetParamNumGetParamNum,
get_param_typesget_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes
Foundation