Skip to content

get_ncc_model_paramsGetNccModelParamsGetNccModelParamsget_ncc_model_paramsT_get_ncc_model_params🔗

Short description🔗

get_ncc_model_paramsGetNccModelParamsGetNccModelParamsget_ncc_model_paramsT_get_ncc_model_params — Return the parameters of an NCC model.

Signature🔗

get_ncc_model_params( ncc_model ModelID, out integer NumLevels, out angle.rad AngleStart, out angle.rad AngleExtent, out angle.rad AngleStep, out string Metric )void GetNccModelParams( const HTuple& ModelID, HTuple* NumLevels, HTuple* AngleStart, HTuple* AngleExtent, HTuple* AngleStep, HTuple* Metric )static void HOperatorSet.GetNccModelParams( HTuple modelID, out HTuple numLevels, out HTuple angleStart, out HTuple angleExtent, out HTuple angleStep, out HTuple metric )def get_ncc_model_params( model_id: HHandle ) -> Tuple[int, float, float, float, str]

Herror T_get_ncc_model_params( const Htuple ModelID, Htuple* NumLevels, Htuple* AngleStart, Htuple* AngleExtent, Htuple* AngleStep, Htuple* Metric )

Hlong HNCCModel::GetNccModelParams( double* AngleStart, double* AngleExtent, double* AngleStep, HString* Metric ) const

int HNCCModel.GetNccModelParams( out double angleStart, out double angleExtent, out double angleStep, out string metric )

Description🔗

The operator get_ncc_model_paramsGetNccModelParams returns the parameters of the NCC model ModelIDmodelIDmodel_id that were used to create it using create_ncc_modelCreateNccModel. In particular, this output can be used to check the parameters NumLevelsnumLevelsnum_levels and AngleStepangleStepangle_step if they were determined automatically during the model creation with create_ncc_modelCreateNccModel. Furthermore, this output can be used to check the parameters if the model was read with read_ncc_modelReadNccModel.

Execution information🔗

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🔗

ModelIDmodelIDmodel_id (input_control) ncc_model → (handle)HTuple (HHandle)HNCCModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

NumLevelsnumLevelsnum_levels (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of pyramid levels.

AngleStartangleStartangle_start (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Smallest rotation of the pattern.

AngleExtentangleExtentangle_extent (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepangleStepangle_step (output_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Step length of the angles (resolution).

Assertion: AngleStep >= 0

Metricmetricmetric (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Match metric.

Result🔗

If the handle of the model is valid, the operator get_ncc_model_paramsGetNccModelParams returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_ncc_modelCreateNccModel, read_ncc_modelReadNccModel

See also

find_ncc_modelFindNccModel

Module🔗

Matching