get_ncc_model_paramsT_get_ncc_model_paramsGetNccModelParamsGetNccModelParamsget_ncc_model_params (Operator)

Name

get_ncc_model_paramsT_get_ncc_model_paramsGetNccModelParamsGetNccModelParamsget_ncc_model_params — Return the parameters of an NCC model.

Signature

get_ncc_model_params( : : ModelID : NumLevels, AngleStart, AngleExtent, AngleStep, 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)

def get_ncc_model_params(model_id: HHandle) -> Tuple[int, float, float, float, str]

Description

The operator get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsGetNccModelParamsGetNccModelParamsget_ncc_model_params returns the parameters of the NCC model ModelIDModelIDModelIDModelIDmodelIDmodel_id that were used to create it using create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model. In particular, this output can be used to check the parameters NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels and AngleStepAngleStepAngleStepAngleStepangleStepangle_step if they were determined automatically during the model creation with create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model. Furthermore, this output can be used to check the parameters if the model was read with read_ncc_modelread_ncc_modelReadNccModelReadNccModelReadNccModelread_ncc_model.

Execution Information

Parameters

ModelIDModelIDModelIDModelIDmodelIDmodel_id (input_control)  ncc_model HNCCModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

NumLevelsNumLevelsNumLevelsNumLevelsnumLevelsnum_levels (output_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of pyramid levels.

AngleStartAngleStartAngleStartAngleStartangleStartangle_start (output_control)  angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Smallest rotation of the pattern.

AngleExtentAngleExtentAngleExtentAngleExtentangleExtentangle_extent (output_control)  angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepAngleStepAngleStepAngleStepangleStepangle_step (output_control)  angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Step length of the angles (resolution).

Assertion: AngleStep >= 0

MetricMetricMetricMetricmetricmetric (output_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Match metric.

Result

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

Possible Predecessors

create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelCreateNccModelcreate_ncc_model, read_ncc_modelread_ncc_modelReadNccModelReadNccModelReadNccModelread_ncc_model

See also

find_ncc_modelfind_ncc_modelFindNccModelFindNccModelFindNccModelfind_ncc_model

Module

Matching