get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_paramT_get_bead_inspection_param
Short description
get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_paramT_get_bead_inspection_param β Get the value of a parameter in a specific bead inspection model.
Signature
get_bead_inspection_param( bead_inspection_model BeadInspectionModel, attribute.name GenParamName, out attribute.value GenParamValue )get_bead_inspection_param( : : BeadInspectionModel, GenParamName : GenParamValue )void GetBeadInspectionParam( const HTuple& BeadInspectionModel, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetBeadInspectionParam( HTuple beadInspectionModel, HTuple genParamName, out HTuple genParamValue )def get_bead_inspection_param( bead_inspection_model: HHandle, gen_param_name: MaybeSequence[str] ) -> Sequence[Union[int, float, str]]
def get_bead_inspection_param_s( bead_inspection_model: HHandle, gen_param_name: MaybeSequence[str] ) -> Union[int, float, str]Herror T_get_bead_inspection_param( const Htuple BeadInspectionModel, const Htuple GenParamName, Htuple* GenParamValue )
HTuple HBeadInspectionModel::GetBeadInspectionParam( const HTuple& GenParamName ) const
HTuple HBeadInspectionModel::GetBeadInspectionParam( const HString& GenParamName ) const
HTuple HBeadInspectionModel::GetBeadInspectionParam( const char* GenParamName ) const
HTuple HBeadInspectionModel::GetBeadInspectionParam( const wchar_t* GenParamName ) const (Windows only)
HTuple HBeadInspectionModel.GetBeadInspectionParam( HTuple genParamName )
HTuple HBeadInspectionModel.GetBeadInspectionParam( string genParamName )
Description
The operator get_bead_inspection_paramGetBeadInspectionParam is used to query the values
of the different parameters of a bead inspection model. The names of the
desired parameters are passed in the parameter GenParamNamegenParamNamegen_param_name,
the corresponding values are returned in GenParamValuegenParamValuegen_param_value.
All these parameters can be set and changed at any time with the operator
set_bead_inspection_paramSetBeadInspectionParam. Multiple parameters can be queried
with a single call to get_bead_inspection_paramGetBeadInspectionParam.
The parameters that can be queried are 'target_thickness'"target_thickness",
'thickness_tolerance'"thickness_tolerance", 'position_tolerance'"position_tolerance",
'polarity'"polarity", 'sigma'"sigma" and 'threshold'"threshold".
Only the modelβs contour cannot
be queried. Refer to set_bead_inspection_paramSetBeadInspectionParam and
create_bead_inspection_modelCreateBeadInspectionModel for a detailed description of all
supported parameters.
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters
BeadInspectionModelbeadInspectionModelbead_inspection_model (input_control) bead_inspection_model β (handle)(handle)HTuple (HHandle)HBeadInspectionModel, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the bead inspection model.
GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) β (string)(string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)
Name of the model parameter that is queried.
Default: 'target_thickness'"target_thickness"
List of values: 'polarity', 'position_tolerance', 'sigma', 'target_thickness', 'thickness_tolerance', 'threshold'"polarity", "position_tolerance", "sigma", "target_thickness", "thickness_tolerance", "threshold"
GenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) β (integer / real / string)(integer / real / string)HTuple (Hlong / double / HString)HTuple (int / long / double / string)Sequence[Union[int, float, str]]Htuple (Hlong / double / char*)
Value of the queried model parameter.
Result
The operator get_bead_inspection_paramGetBeadInspectionParam returns the value 2 (H_MSG_TRUE)
if the given parameters are valid and within acceptable range.
Otherwise, an exception will be raised.
Combinations with other operators
Combinations
Possible predecessors
create_bead_inspection_modelCreateBeadInspectionModel, set_bead_inspection_paramSetBeadInspectionParam
Possible successors
apply_bead_inspection_modelApplyBeadInspectionModel, set_bead_inspection_paramSetBeadInspectionParam
See also
create_bead_inspection_modelCreateBeadInspectionModel, set_bead_inspection_paramSetBeadInspectionParam
Module
2D Metrology