ClassesClasses | | Operators

get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsGetNccModelParams (Operator)

Name

get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsGetNccModelParams — Return the parameters of an NCC model.

Signature

get_ncc_model_params( : : ModelID : NumLevels, AngleStart, AngleExtent, AngleStep, Metric)

Herror get_ncc_model_params(const Hlong ModelID, Hlong* NumLevels, double* AngleStart, double* AngleExtent, double* AngleStep, char* Metric)

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

void GetNccModelParams(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

static void HOperatorSet.GetNccModelParams(HTuple modelID, out HTuple numLevels, out HTuple angleStart, out HTuple angleExtent, out HTuple angleStep, out HTuple metric)

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

Description

The operator get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsGetNccModelParamsGetNccModelParams returns the parameters of the NCC model ModelIDModelIDModelIDModelIDmodelID that were used to create it using create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModel. In particular, this output can be used to check the parameters NumLevelsNumLevelsNumLevelsNumLevelsnumLevels and AngleStepAngleStepAngleStepAngleStepangleStep if they were determined automatically during the model creation with create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModel. Furthermore, this output can be used to check the parameters if the model was read with read_ncc_modelread_ncc_modelReadNccModelReadNccModelReadNccModel.

Execution Information

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control)  ncc_model HNCCModel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the model.

NumLevelsNumLevelsNumLevelsNumLevelsnumLevels (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of pyramid levels.

AngleStartAngleStartAngleStartAngleStartangleStart (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Smallest rotation of the pattern.

AngleExtentAngleExtentAngleExtentAngleExtentangleExtent (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepAngleStepAngleStepAngleStepangleStep (output_control)  angle.rad HTupleHTupleHtuple (real) (double) (double) (double)

Step length of the angles (resolution).

Assertion: AngleStep >= 0

MetricMetricMetricMetricmetric (output_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Match metric.

Result

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

Possible Predecessors

create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModel, read_ncc_modelread_ncc_modelReadNccModelReadNccModelReadNccModel

See also

find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModel

Module

Matching


ClassesClasses | | Operators