Mira MX Script 8 User's Guide

Mira MX ScriptContentsTech SupportAbout this DocumentWorking with Scripts in MiraOverviewWorking with scriptsEditing scriptsRunning scriptsRunning scripts listed in this documentListing error messagesBenchmarksUsing the Script ManagerThe Scripting LanguageCreating a Simple ScriptComparison with C and C++Naming ConventionsProtocol for Using ClassesCreating ClassesMaster list of Script ClassesGoing Further with LuaError MessagesCompiler Error MessagesTypical Compiler MessagesScript ClassesMaster list of script classesFormat of class reference pagesCApphot ClassClass DescriptionClass PropertiesInitializationnewdeleteCopyOperationsGetImageParamsMeasureSetBgMethodAccessing ResultsX positionY positionGetErrMsgGetStatusCodeBgValueBgValueErrMagMagErrorMagErrorTNetCountNetCountErrNetCountErrTSNRSNRTCArray classClass DescriptionConstructionnewdeleteCopyOperationsCountDotEmptyExistsGetInitMaxIndexRemoveSetCCentroid classClass DescriptionClass PropertiesConstructionnewdeleteOperationsCalcXYGetStartingPosCColorRefClass DescriptionClass PropertiesConstructionnewdeleteOperationsChooseChoosePalGetInvertToGraySetOther TopicsVisual Response Weighted IntensityCFile classClass DescriptionClass PropertiesFile Access ModesConstructionnewdeleteOperationsReadReadBswapWriteWriteBswapCloseFilePosFlushGetPathOpenPrintfSeekCFileDlg classCFileDlg Class DescriptionClass propertiesConstructionnewdeleteOperationsOpenSaveStartNextCFindFiles classClass DescriptionFindFiles functionConstructionnewdeleteOperationsOpenStartNextCloseGetTableGetPathCFwhm classClass DescriptionClass PropertiesConstructionnewdeleteOperationsCalcBgPeakFwhmXYSetCentroidCGrid classClass DefinitionDefGrid global functionNewGrid global functionConstructionnewdeleteAttachGridAttachGrid ConfigurationSetDimSetNumColsSetNumRowsSetNumSheetsGetNumColsGetNumRowsGetNumSheetsSelectSheetDeleteSheetColumns, Rows, and CellsGetGetColGetRowSetSetColSetRowCGridView classClass DescriptionConstructionnewdeleteAttachAttachFromListGetViewPtrOperationsAttachHandleGetHandleCHistogram classClass DescriptionConstructionnewdeleteOperationsCalcSetBinAutoSetBinCountSetBinWidthSetCorrelatedRetrieving Binning ValuesGetBinCountGetBinWidthGetMaxGetMinCImage classClass DescriptionClass OperatorsDeprecated MethodsConstructionnewarraynewdeleteAttachAttachFromListCopyDupArray (create from array)Synthetic ImagesCreateSynthSynthGetStarSynthStarCountGetting and setting pixel valuesGetrSetrGetnSetnGetsGetSetWorking with image regionsSetRegionSetRegionValSetColumnSetColumnPartSetRowSetRowPartCompareEQCompareLECompareLTHeaders and KeywordsKwdDeleteKwdExistsKwdGetDmsKwdGetDmsExKwdGetHmsKwdGetHmsExKwdGetNumKwdGetNumExKwdGetSectKwdGetSectExKwdGetStrKwdGetStrExKwdGetValKwdGetValExKwdSetStrKwdSetBlankKwdSetBlankStrKwdSetBoolKwdSetCommentKwdSetDateKwdSetHistoryKwdSetNumKwdSetSectKwdSetTimeKwdSetValImage PropertiesAxesBytesColsDarktimeDatatypeDatatypeStrDateDateStrDimEqExptimeFilterGainImageTypeIsColorIsIntegerIsNumericIsRealLenObjectPathPixelBytesPixelsPlanesRowsTimeTimeStrGeneral MethodsCloseCreateDisplayGetImagePtrOpenSaveSaveAsSaveToImage MathAbsAddAddNoiseAddxBlendBlendxByteswapChsDivDivxExpExtractByteInterpLogLog10ModModxMulMulxPolyFitDivPolyFitSubPolyFitImagePowPowaPowabRecipRgbExtractScaleLinValScalePolyValSetDatatypeSqrtSubSubxXdivXsubCoordinatesCoordOfGetAxisLabelGetImageScaleGetImageScaleXyPosFindFirstPtInsideWcsIsEqWcsToXyXyToWcsXyToWcsStrImage GeometryAffineCropExpandExpand1dExpand2dExpandOffsetHflipImbedMirrorOffsetOffset1dOffset2dReorientRot90Rot180Rot270RotateRotatePtScaleScaleXyShiftTransposeVflipFiltering MethodsFilt KernelFiltBinomialFiltBlockAvgFiltBlockSumFiltClipHighFiltClipLowFiltEllipseFiltGaussianFiltGradientFiltKernelFiltLaplacianFiltLineFiltMaxFiltMedianFiltMinFiltPrewittFiltRankFiltRotGradFiltRectFiltSharpenFiltSobelFiltUnsharpMaskMeasurementsAngleAngleWcsAreaUnitsCoordUnitsDistanceDistanceWcsDistanceWcsStrDistanceUnitsPixGELEPixGEImage CalibrationApplyPixelMaskCreatePixelMaskCreatePixelMaskHighCreatePixelMaskLowDivFlatFrameDivFlatNormSetMaskedValueSubBiasFrameSubBiasRefSubBiasValSubBiasColSubBiasRowSubDarkFrameSubDarkOptSubDarkScaledCImageSet classClass DescriptionOperationsAppendInsertRemoveRemoveAtRemoveFirstRemoveLastAccessorsCountGetImageConstructionnewdeleteCopyCImageView classClass DescriptionConstructionnewdeleteAttachAttachFromListGetViewPtrImage Display MethodsAppendDisplayInsertImage Set OperationsCountFirstGetImageGetImagePtrGetImageSetGetIndexLastNextPrevRemoveSetIndexSwapNextSwapPrevImage CursorGetCursorPosGetCursorRectGetCursorStyleSetCursorExtentSetCursorHeightSetCursorPosSetCursorPosWcsSetCursorRectSetCursorStyleSetCursorWidthSettingsGetFlipFITSSetFlipFITSGetGraphSetGraphSetGetMeasureSetMeasureSetGetPlotAvgModeSetPlotAvgModeGetProcessSetProcessSetWindow OperationsCenterAtCenterAtWcsGetZoomSetZoomUpdateUpdateAllCImCombine classClass DefinitionCombining Images using CriteriaConstructionnewdeleteCopyRestoreStateSaveStateNormalizationSetRelRectSetNormMethodSetNormStatSetRectControl OptionsGetErrorMsgSetAdjustExptimeSetRefImageSetTitleSetVerboseWeighted MeansContraMeanGeometricMeanKwdWeightedMeanMaskedMeanMeanMedianRankSumWeightedMeanYpMeanRejection MeansAlphaClipMaxClipMmClipMtmSigmaClipRankClipSDevClipSigmaClipOther MethodsMaxMinMmClipRangeRangeRgbMergeSdevCImSynthInfo classClass DescriptionClass PropertiesConstructionnewdeleteMethodsOpenSaveCLabels classClass DescriptionConstructionnewdeleteAttachMethodsAddPreferencesCLsqFit classClass DescriptionQuick Fitting functionsFitLine functionFitPoly functionFitPoly2d functionLeast Squares TopicsUsing the CLsqFit ClassOverview of Least Squares EstimationBasis functionsUsing multiple independent variablesWorking with RGB dataRejecting outliers from the fitForcing coefficient valuesUsing CLsqFit with Image PixelsConstructionnewdeleteConfiguring the FitSetBasisFuncGetBasisFuncSetNumCoefsGetNumCoefsSetNumChannelsGetNumChannelsGetBasisDimComputing the FitFitDoRejectionGetStatusGetErrMsgGetErrChanUsing Data RejectionSetRejDefaultSetRejSigmaHighGetRejSigmaHighSetRejSigmaLowGetRejSigmaLowSetRejCyclesGetRejCyclesGetNumPtsUsedGetNumPtsRejectedGetNumPtsDeletedWorking with Fit ResultsGetSigmaFitEvalGetResidGetCovarGetRangeXGetRangeObsGetSampleMeanGetNumPtsGetNumPtsUsedGetNumPtsDeletedGetNumPtsRejectedCoefficients of the FitGetCoefGetCoefErrGetPolyCoefIndexForcing CoefficientsForceCoefUnforceCoefResetForcedCoefsIsCoefForcedWorking with Data pointsAddPtAddPtWtDeletePtUndeletePtFindPtResetPointsGetNumPtsPoint propertiesGePtXSetPtXGetPtObsSetPtObsGetPtWtSetPtWtGetPtStatusSetPtStatusRetrieving Table DataGetObsGetXGetWtCMatrix classClass DescriptionWorking with MatricesConstructionnewdeleteCopyDupOperationsColsCountDumpEmptyExistsGetGetRowInitMaxColsUsedMembersRemoveRemoveRowRowExistsRowsRowsUsedSetMath OperationsNormalizeVolumeCMatrixRowClass DescriptionConstructionnewdeleteCopyOperationsCountDotEmptyExistsGetInitMaxIndexRemoveSetCPlotView classClass DescriptionExample: Plotting a Least Squares FitPlot Series ModesPlot AttributesSetWindowTitleSetAutoscaleXSetLabelXSetMinXSetMaxXSetPosXSetAutoscaleYSetLabelYSetMaxYSetMinYSetPosYConstructionnewdeleteAttachGetViewPtrAttachHandleGetHandlePlot Series MethodsGetIndexSetIndexCountSeriesCountSeriesPointsSetSeriesModeGetSeriesModeSetCaptionGetCaptionSetDescriptionGetDescriptionData Array MethodsAddCountEmptyFindPointGetXGetYGetErrXGetErrYLineToLineToMarkerMarkerMoveToRemovePoint Plotting MethodsPlotPointsAddPointsAddSeriesMatrix Plotting MethodsPlotMatrixPlotMatrixRangeAddMatrixRangePlotMatrixLinePlotMatrixRangeLineAddMatrixRangeLineImage Plotting MethodsPlotImageColPlotImageRowPlotCursorColPlotCursorColAvgPlotCursorColRangePlotCursorRowPlotCursorRowAvgPlotCursorRowRangePlot LegendsSetLegendStyleGetLegendStyleSetLegendBoxEnableGetLegendBoxEnableSetLegendColorGetLegendColorSetLegendBoxColorGetLegendBoxColorSetLegendTextGeLegendTextSetLegendEnableGetLegendEnableCPlot3dView classClass DescriptionCPoint classClass DescriptionClass PropertiesClass OperatorsConstructionNewPoint global functionnewdeleteOperationsCeilFloorGetOffsetRoundSetCPolygonClass DescriptionClass PropertiesClass OperatorsConstructionNewPolygon global functionnewdeleteCopyStandard ConfigurationsCircleEllipseRectCalculated PropertiesAreaCalcCenterCalcRectDistancePathLenPerimeterPtInsideMathematical OperationsRotateScaleShiftSkewOperationsAddCopyPtsCountGetPtGetRectDeletePtEmptyInsertPtSetPtCRect classClass DescriptionClass PropertiesClass OperatorsConstructionNewRect global functionnewdeleteAccessorsGetSetSetToImageHeightSizeWidthOperationsCeilFloorInflateIntersectionNormalizeOffsetPtInsidePtInsideIntRectInsideRoundUnionCRegistry classClass DescriptionConstructionOpenClosenewdeleteOperationsGetBoolGetIntGetNumGetStrGetRgbGetWndSetBoolSetIntSetNumSetStrSetRgbSetWndDeleteKeyCSet classClass DefinitionConstructionnewdeleteCopyOperationsAddInsertRemoveRemoveFirstRemoveLastRemoveMemberAccessorsCountGetIndexGetMemberCSplitpath classClass DescriptionOverview of Path NamesConstructionnewdeleteAccessorsGetDirGetDriveGetExtGetExt2GetFilenameGetFilenameExtGetFolderGetFolder2GetNameOperationsMergeSetDirSetDriveSetExtSetFilenameSetFilenameExtSetFolderSetNameSetPathSetSubdirSplitCStats classClass DescriptionConstructionnewdeleteStandard EstimatorsContraMeanMeanMedianGeomMeanYpMeanData Rejection EstimatorsAlphaClipMeanMaxClipMeanMinClipMeanMinMaxClipMeanMtmSigmaClipMeanRankClipMeanSigmaClipMeanCharacterizing DistributionsMaxMaxPixMedianMinMinPixKurtosisMomentRankSkewnessSdevSdevClipSdevValueSdevClipValueInitialization and statusGetErrMsgGetStatusSetImage (deprecated)CStrTok classClass DescriptionConstructionnewdeleteOperationsInitSetDelimiterNextCTextView classClass DescriptionConstructionnewdeleteGetHandleAttachHandleOperationsPrintfGetWordwrapSetWordwrapTable FunctionsOverviewCountTGaussDevTHistTListTMaxTMeanTMedianTMinTNormTRandTReverseTSdevTSeriesTSortTSortRTSumVariable Argument List FunctionsOverview of functionsCountVMaxVMeanVMinVSumPlotting FunctionsGlobal Plotting FunctionsComparison of Global Plotting FunctionsPlotLinePlotConnectPlotPlotStepGlobal FunctionsAttachViewAttachViewFromListFindFilesFileOpenGaussDevGetFileNameOpenGetFileNameSaveGetFileNameOpenDate, Time, and Angle FunctionsAngles (degrees)DegToDmsDmsToDegFormatAngleFormatDmsStrParseDegreesParseDmsTime (hours)HrToHmsHmsToHrFormatTimeFormatHmsStrParseHoursParseHmsDatesCalcHJDCalcJDCalcMJDFormatDateFormatYmdStrParseYmdParseJDJDtoDateTimeDateToYmdCalculationsCalcAirmassCalcHJDCalcJDCalcLSTCalcMJDCalcSphAngleDayOfWeekBoolean Math FunctionsOverviewOperationsANDORXORNOTNANDNORBitTestConversionsDecimal to HexadecimalHexadecimal to DecimalHexadecimal to BinaryBinary to HexadeximalDecimal to BinaryBinary to DecimalTrim leading 0'sDialog FunctionsGetAbortRetryIgnoreGetChoiceGetFileNameGetItemGetItemStrGetNumberGetRetryCancelGetStringGetTextGetTrueFalseGetValueGetYesNoGetYesNoCancelText Formatting FunctionsListCreateTextWindowErrorMsgMsgBoxMsgMsg2PrintfSprintfWprintfMiscellaneous FunctionsAbbrevPathAssertBeepDatatypeToStrExitGetFileListGetFileOpenDlgTitleGetFileSaveDlgTitleGetFolderGetKeyStateGetMathErrValGetMathErrValStrGetViewportSizeIncludeRoundSetFileOpenDlgTitleSetFileSaveDlgTitleSetMathErrValSetResampleParamsStrToDatatypeStrToRgbData StructuresCSet classCArray classCMatrix classWorking with MatricesClassLibInfoResampleParamsSpecial ValuesniltruefalseInterface to MiraMira Data TypesImage SetsImage CursorPixel Mask FileGlossary of TermsCoordinate SystemsImage Coordinate SystemPixel Coordinate DefinitionSubpixel Coordinate DefinitionWorld Coordinate SystemAngle Measurement DefinitionImage Display OrientationFITS Image OrientationSample ScriptsScript ExamplesListing Image InformationUser-Defined Filter KernelAn Improved Filter Kernel Script