ClassesClassesClassesClasses | | | | Operators

get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsget_ncc_model_paramsGetNccModelParamsGetNccModelParams (Operator)

Name

get_ncc_model_paramsget_ncc_model_paramsGetNccModelParamsget_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)

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

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

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

void HOperatorSetX.GetNccModelParams(
[in] VARIANT ModelID, [out] VARIANT* NumLevels, [out] VARIANT* AngleStart, [out] VARIANT* AngleExtent, [out] VARIANT* AngleStep, [out] VARIANT* Metric)

Hlong HNCCModelX.GetNccModelParams(
[out] double* AngleStart, [out] double* AngleExtent, [out] double* AngleStep, [out] BSTR* Metric)

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_paramsGetNccModelParamsget_ncc_model_paramsGetNccModelParamsGetNccModelParams returns the parameters of the NCC model ModelIDModelIDModelIDModelIDModelIDmodelID that were used to create it using create_ncc_modelcreate_ncc_modelCreateNccModelcreate_ncc_modelCreateNccModelCreateNccModel. In particular, this output can be used to check the parameters NumLevelsNumLevelsNumLevelsNumLevelsNumLevelsnumLevels and AngleStepAngleStepAngleStepAngleStepAngleStepangleStep if they were determined automatically during the model creation with create_ncc_modelcreate_ncc_modelCreateNccModelcreate_ncc_modelCreateNccModelCreateNccModel. Furthermore, this output can be used to check the parameters if the model was read with read_ncc_modelread_ncc_modelReadNccModelread_ncc_modelReadNccModelReadNccModel.

Parallelization

Parameters

ModelIDModelIDModelIDModelIDModelIDmodelID (input_control)  ncc_model HNCCModel, HTupleHTupleHNCCModel, HTupleHNCCModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the model.

NumLevelsNumLevelsNumLevelsNumLevelsNumLevelsnumLevels (output_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Number of pyramid levels.

AngleStartAngleStartAngleStartAngleStartAngleStartangleStart (output_control)  angle.rad HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Smallest rotation of the pattern.

AngleExtentAngleExtentAngleExtentAngleExtentAngleExtentangleExtent (output_control)  angle.rad HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Extent of the rotation angles.

Assertion: AngleExtent >= 0

AngleStepAngleStepAngleStepAngleStepAngleStepangleStep (output_control)  angle.rad HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Step length of the angles (resolution).

Assertion: AngleStep >= 0

MetricMetricMetricMetricMetricmetric (output_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Match metric.

Result

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

Possible Predecessors

create_ncc_modelcreate_ncc_modelCreateNccModelcreate_ncc_modelCreateNccModelCreateNccModel, read_ncc_modelread_ncc_modelReadNccModelread_ncc_modelReadNccModelReadNccModel

See also

find_ncc_modelfind_ncc_modelFindNccModelfind_ncc_modelFindNccModelFindNccModel

Module

Matching


ClassesClassesClassesClasses | | | | Operators