Mira Pro x64 Script User's Guide

Mira Pro x64 Script User's GuideContentsNew FeaturesMira SupportAbout this DocumentWorking with Scripts in MiraOverviewWorking with ScriptsScript Editor WindowRunning Scripts shown in the User's GuideUsing the Script ManagerBenchmarksThe Mira Pro Script LanguageCreating a Simple ScriptComparison with C and C++Using Classes in your ScriptsCreating ClassesMaster list of Script ClassesTables and Arrays in Mira Pro ScriptGoing Further with LuaScript ClassesMaster list of script classesCApphotClass DescriptionData MembersNon-class Creator Functionnew_apphotConstruction and DestructionnewdeleteOperationsCopyGetImageParamsMeasureSetBgMethodGetting Results and PropertiesX positionY positionGetErrMsgGetStatusCodeBgValueBgValueErrMagMagErrMagErrTNetCountNetCountErrNetCountErrTSNRSNRTCArrayClass DescriptionNon-class Creator Functionnew_arrayConstruction and DestructionnewdeleteOperationsCopyCountDotEmptyExistsGetInitMaxIndexRemoveSetCCentroidClass DescriptionNon-class Creator Functionnew_centroidConstruction and DestructionnewdeleteGetting Results and PropertiesGetSampleSetSampleGetSignSetSignGetTrackingSetTrackingXYOperationsCalcCColorRefClass DescriptionNon-class Creator Functionnew_colorrefConstruction and DestructionnewdeleteGetting PropertiesGetOperationsChooseChoosePalInvertToGraySetOther TopicsVisual Response Weighted IntensityCFileClass DescriptionNon-class Creator Functionnew_fileConstruction and DestructionnewdeleteOperationsReadReadBswapWriteWriteBswapCloseFilePosFlushGetPathOpenPrintfSeekFile Access ModesCFileDlgClass DescriptionClass PropertiesNon-class Creator Functionnew_filedlgConstruction and DestructionnewdeleteOperationsOpenSaveStartNextCFileListClass DescriptionNon-class Creator Functionnew_filelistConstructionnewdeleteOperationsCloseCountNextOpenStartCFindFilesClass DescriptionNon-class Creator Functionnew_findfilesConstruction and DestructionnewdeleteOperationsCloseGetPathNextOpenStartCFwhmClass DescriptionNon-class Creator Functionnew_fwhmConstruction and DestructionnewdeleteGetting Results and PropertiesBgPeakFwhmXYGetAutoCentroidSetAutoCentroidGetMaxRadiusSetMaxRadiusGetSampleSetSampleGetSignSetSignGetTrackingSetTrackingOperationsCalcCGridClass DescriptionGridParams TableNon-class Creator Functionsnew_gridnew_griddlgnew_griddlgmodalConstruction and DestructionnewdeleteMethodsMenusAddMenuAddMenuExecuteDeleteMenusGetting and Setting Cell ContentsGetSetSetSH_TitleSetSH_TitlesSetTH_TitleSetTH_TitlesSelecting CellsFindCellGotoCellSH_FindRowTH_FindColGetting and Setting Grid PropertiesGetNumColsGetNumRowsBestFitJoinCellsOptimizeOptimizeRangeSetBkColorSetHorzAlignSetColWidthSetSH_HorzAlignSetSH_WidthSetFontColorSetVertAlignSetRowStretchSetTH_RowStretchSetTH_VertAlignUnJoinCellsCGridViewClass DescriptionGridParams TableNon-class Creator Functionsnew_gridviewattach_gridviewattachlist_gridviewConstruction and DestructionnewdeleteAttachAttachFromListCloseMethodsClass DescriptionGetting Cell ContentsFindColFromTableGetColGetNumGetRectGetRowGetStrGetTypeGetValSetting Cell ContentsSetColSetNumSetRectSetRowSetStrSetTypeSetValToTableSelecting CellsFindColFindRowGotoCellGetCellStartGetCellEndGetCellDblClickGetting Grid PropertiesGetMaxColGetMaxRowGetNumColsGetNumRowsGetNumSheetsGetSheetGetTitleSetting Grid PropertiesAddSheetBestFitJoinCellsOptimizeRefreshSetBkColorSetHorzAlignSetFontColorSetNumColsSetNumRowsSetVertAlignSetTitleUnJoinCellsSheet PropertiesAddSheetGetNumSheetsGetSheetSelectSheetSetTabCHistogramClass DescriptionNon-class Creator Functionnew_histogramConstruction and DestructionnewdeleteOperationsCalcSetBinAutoSetBinCountSetBinWidthSetCorrelatedGetting Binning PropertiesGetBinCountGetBinWidthGetMaxGetMinCImageClass DescriptionMath operatorsNon-class Creator Functionsarraytoimageattachlist_imagenew_imageConstruction and DestructionnewdeleteCopyAttachFromListArray OperationsColToTableRowToTableRectToTableToTableTableToRectExtractByteExtractChanPixel OperationsGetValGetValStrSetValSetRegionValSetRegionValExcludePixGEPixGELEHeaders and KeywordsKwdDeleteKwdExistsKwdGetDmsKwdGetDmsExKwdGetHmsKwdGetHmsExKwdGetNumKwdGetNumExKwdGetSectKwdGetSectExKwdGetStrKwdGetStrExKwdGetValKwdGetValExKwdSetStrKwdSetBlankKwdSetBlankStrKwdSetBoolKwdSetCommentKwdSetDateKwdSetHistoryKwdSetNumKwdSetSectKwdSetTimeKwdSetValImage PropertiesAxesBytesColsDarktimePixelTypePixelTypeStrDateDateStrDimEqExptimeFilterGainImageTypeIsColorIsIntegerIsNumericIsRealObjectPathPixelBytesPixelTypePixelTypeStrPixelsRowsTimeTimeStrGeneral MethodsCloseCreateDisplayOpenSaveSaveAsSaveToImage MathAbsAddAddNoiseAddxBlendBlendxByteswapChsDivDivxExpLogLog10ModModxMulMulxPolyFitDivPolyFitSubPolyFitImagePowPowaPowabRecipRgbExtractScaleLinValScalePolyValSetPixelTypeSqrtSubSubxXdivXsubCoordinatesGetAxisLabelGetImageScaleGetImageScaleXyPtInsideGetWcsProjGetWcsTypeWcsIsEqWcsToXyWcsStrToXyXyToWcsXyToWcsStrImage GeometryAffineCropExpandHflipImbedReorientRot90Rot180Rot270RotateRotatePtScaleScaleXyShiftTransposeVflipFiltering MethodsFiltBinomialFiltBlockAvgFiltBlockSumFiltClipHighFiltClipLowFiltEllipseFiltGaussianFiltGradientFiltKernelFiltLaplacianFiltLineFiltMaxFiltMedianFiltMinFiltPrewittFiltRankFiltRotGradFiltRectFiltSharpenFiltSobelFiltUnsharpMaskMeasurementsAngleAngleWcsAreaUnitsCoordUnitsDistanceDistanceWcsDistanceWcsStrDistanceUnitsImage CalibrationApplyPixelMaskCreatePixelMaskCreatePixelMaskHighCreatePixelMaskLowDivFlatFrameDivFlatNormSetMaskedValueSubBiasFrameSubBiasRefSubBiasValSubBiasColSubBiasRowSubDarkFrameSubDarkOptSubDarkScaledCImageSetClass DescriptionNon-class Creator Functionnew_imagesetConstructionnewdeleteGetting Class PropertiesCountGetImageOperationsAppendCopyInsertRemoveRemoveAtRemoveFirstRemoveLastCImageViewClass DescriptionNon-Class Creator Functionsnew_imageviewattach_imageviewattachlist_imageviewConstruction and DestructionnewdeleteAttachAttachFromListCloseImage Display MethodsAppendDisplayInsertSaveUndoUndoSaveUndoAllUndoAllUpdateUpdateAllImage Set OperationsCountFirstGetImageGetImageSetGetIndexLastNextPrevRemoveSetIndexSwapNextSwapPrevImage CursorGetCursorPosSetCursorPosGetCursorRectSetCursorRectSetCursorExtentSetCursorWidthSetCursorHeightGetCursorStyleSetCursorStyleSetCursorPosWcsSettingsGetFlipFITSSetFlipFITSGetGraphSetGraphSetGetMeasureSetMeasureSetGetPlotAvgModeSetPlotAvgModeGetProcessSetProcessSetWindow OperationsCenterAtCenterAtWcsGetZoomSetZoomCImCombineClass DefinitionCombining Images using CriteriaNon-class Creator Functionnew_imcombineConstruction and DestructionnewdeleteOperationsCopyRestoreStateSaveStateWeighted MeansContraMeanGeometricMeanKwdWeightedMeanMaskedMeanMeanMedianRankSumWeightedMeanYpMeanRejection MeansAlphaClipMaxClipMmClipMtmSigmaClipRankClipSigmaClipAlignmentAlignWcsAlignWcs2AlignWcs3Other Combining MethodsMaxMinMmClipRangeRangeRgbMergeSdevNormalizationSetRelRectSetNormMethodSetNormStatSetRectMiscellaneous MethodsGetErrorMsgSetAdjustExptimeSetRefImageSetTitleSetVerboseCImExtractClass DescriptionImExtractParams TableSource Properties TableNon-class Creator Functionnew_mextractConstruction and DestructionnewdeleteMethodsCopyCountExtractGetObjectSetParamsCLabelsClass DescriptionLabelParams tableNon-class Creator Functionnew_labelsConstruction and DestructionnewdeleteMethodsAddAttachSetParamsCLsqFitClass DescriptionCLsqFit Class TopicsOverview of linear least squares estimationBasis functionsWorking with multiple independent variableWorking with RGB dataRejecting outliers from the fitForcing coefficient valuesExample: Using CLsqFit with Image PixelsNon-class Creator Functionnew_lsqfitConstruction and DestructionnewdeleteConfiguring the FitSetting the basis functionGetting the basis functionSetting the number of coefficientsGetting the number of coefficientsSetting the number of data channelsGetting the number of data channelsGetting the number of basis dimensionsComputing the FitExecuting the fitEnabling bad data rejectionGetting the error messageGetting the error channelUsing Data RejectionSetting default rejection parametersSetting the high sigma thresholdGetting the high sigma thresholdSetting the low sigma thresholdGetting the low sigma thresholdSetting the number of rejection cyclesGetting the number of rejection cyclesGetting the number of points usedGetting the number of points rejectedGetting the number of points deletedWorking with Fit ResultsGettng the fit standard deviationEvaluating new points using the fit resultsGetting the point residuals of the fitGetting covariance matrix valuesGetting the range of X valuesGetting the range of Y valuesGetting the sample meansGetting the total number of pointsGetting the number of points usedGetting the number of points deletedGetting the number of points rejectedCoefficients of the FitGetting the coefficient valuesGetting the coefficient errorsConverting polynomial indices to one indexForcing CoefficientsForcing a coefficient to a valueRestoring a forced coefficientRestoring all forced coefficientsDetermining if a coefficient is forcedWorking with Data pointsAdding a pointAdding a weighted pointDeleting a pointRestoring a deleted pointFinding a point from its coordinatesResetting the point sampleGetting the total number of pointsPoint propertiesGetting the independent variablesSetting the independent variablesGetting the observed valueSetting the observed valueGetting the point weightSetting the point weightGetting the point statusGetting the point status as a stringSetting the point statusRetrieving Table DataGetting an array of observation valuesGetting an array of x valuesGetting an array of weight valuesCMatrixClass DescriptionWorking with MatricesNon-class Creator Functionnew_matrixConstruction and DestructionnewdeleteOperationsColsColsUsedCopyCountDumpEmptyExistsGetGetRowInitMembersRemoveRemoveRowRowExistsRowsRowsUsedSetMath OperationsNormalizeVolumeCMeasureAnglesClass DescriptionAngleParams tableNon-class Creator Functionnew_measureanglesConstruction and DestructionnewdeleteMethodsAddAttachSetParamsCMeasureLinesClass DescriptionLineParams tableNon-class Creator Functionnew_measurelinesConstruction and DestructionnewdeleteMethodsAddAttachSetParamsCMeasurePointsClass DescriptionPointParams tableNon-class Creator Functionnew_measurepointsConstruction and DestructionnewdeleteMethodsAddAttachSetParamsCMeasureRegionsClass DescriptionRegionParams tableNon-class Creator Functionnew_measureregionsConstruction and DestructionnewdeleteMethodsAddAttachSetParamsCPlotClass DescriptionPlotPoint tableNon-class Creator Functionnew_plotConstruction and DestructionnewdeleteMethodsCountFindNearestXFindNearestYGetPtGetXGetXYGetYToTableCPlotViewClass DescriptionExample: Plotting a Least Squares FitComparison of non-Class Plotting FunctionsNon-class Creator Functionsnew_plotviewattach_plotviewattachlist_plotviewConstruction and DestructionnewdeleteAttachAttachFromListCloseGetTitlePlot Series MethodsGetPlotGetIndexSetIndexCountSeriesCountSeriesPointsSetting the series descriptionGetting the series descriptionData Array MethodsAddCountEmptyFindPointGetXGetYGetErrXGetErrYRemovePoint MethodsCountFindNearestXFindNearestYGetPtGetXGetXYGetYToTableData Plotting MethodsConnectPlotConnectedLinePlotLineScatterPlotScatterStepLinePlotStepLinePlotPointsAddPointsAddSeriesImage Plotting MethodsPlotImageColPlotImageRowPlotCursorColPlotCursorColAvgPlotCursorColRangePlotCursorRowPlotCursorRowAvgPlotCursorRowRangeMatrix Plotting MethodsPlotMatrixPlotMatrixRangeAddMatrixRangePlotMatrixLinePlotMatrixRangeLineAddMatrixRangeLineCPointClass DescriptionNon-class Creator Functionnew_pointConstruction and DestructionnewdeleteMath OperatorsMath OperatorsOperationsCeilFloorOffsetRoundSetCPolynomialClass DescriptionConstruction and DestructionnewdeleteCopyOperationsCountEmptyExistsGetInitMaxOrderRemoveSetCRectClass DescriptionNon-class Creator Functionnew_rectConstruction and DestructionnewdeleteGetting and Setting PropertiesGetSetSetToImageXminXmaxSetXminXmaxSetXmaxYminSetYminYmaxSetYmaxHeightSizeWidthOperationsFloorInflateIntersectionNormalizeOffsetPtInsidePtInsideIntRectInsideRoundUnionCRegistryClass DescriptionNon-class Creator Functionnew_registryConstruction and DestructionnewdeleteOperationsOpenCloseGetBoolGetIntGetNumGetStrGetRgbSetBoolSetIntSetNumSetStrSetRgbCSetClass DefinitionNon-class Creator Functionnew_setConstruction and DestructionnewdeleteOperationsAppendCopyInsertRemoveRemoveFirstRemoveLastRemoveMemberGetting PropertiesCountGetIndexGetMemberCSplitpathClass DescriptionNon-class Creator Functionnew_splitpathConstruction and DestructionnewdeleteGetting Path ComponentsGetDirGetDriveGetExtGetExt2GetFilenameGetFilenameExtGetFolderGetFolder2GetNameOperationsMergeSetDirSetDriveSetExtSetFilenameSetFilenameExtSetFolderSetNameSetPathSetSubdirSplitCStatsClass DescriptionNon-class Creator Functionnew_statsConstruction and DestructionnewdeleteOperationsAlphaClipMeanAlphaClipMeanSdevContraMeanContraMeanSdevGeomMeanGeomMeanSdevKurtosisMaxMaxXYMaxPixMaxClipMeanMaxClipMeanSdevMeanMeanSdevMedianMedianSdevMinMinXYMinPixMinClipMeanMinClipMeanSdevMinMaxClipMeanMinMaxClipMeanSdevMtmSigmaClipMeanMtmSigmaClipMeanSdevRankRankSdevRankClipMeanRankClipMeanSdevSdevSdevValueSigmaClipMeanSigmaClipMeanSdevStats - returns an indexed tableStatsStr - returns a member tableSkewnessSumYpMeanYpMeanSdevGetting MessagesGetErrMsgGetStatusCStrTokClass DescriptionNon-class Creator Functionnew_strtokConstruction and DestructionnewdeleteOperationsInitSetDelimiterNextCTextViewClass DescriptionNon-Class Creator Functionnew_textviewattach_textviewattachlist_textviewConstruction and Destructionnew_textview functionnewdeleteAttachAttachFromListCloseOperationsClearGetTitleGetWordwrapPrintfSaveSaveAsSetWordwrapCValueSetClass DescriptionNon-class Creator Functionnew_valuesetConstruction and DestructionnewdeleteOperationsAddCopyCountEmptyGetGetAtGetKeyAtGetTypeGetValueAtInsertAtListRemoveRemoveAtSetSetAtSetTypeSortSortKeyToTableTable and Array FunctionsOverviewTables and arrays in Mira Pro ScriptArray FunctionsOverviewaddarraytoimagedivdotgaussdevhistlistmaxmaxxymeanmeansdevmedianmediansdevminminxymulnormrandomreversesdevseriessortsortrstatssubsumTable FunctionsOverviewaddndivnflattenflattennharmeannharmeansdevnismultidimlistmaxnmaxxmaxxymeannmeansdevmeansdevnmediannmediansdevmediansdevnminnminxymulnnormnranknsdevnsdevxnsubnsumntcountnxdivnNon-Class Creator FunctionsOverviewattach_gridviewattach_imageviewattach_plotviewattach_textviewattachlist_gridviewattachlist_imageattachlist_imageviewattachlist_plotviewattachlist_textviewnew_apphotnew_arraynew_centroidnew_colorrefnew_filenew_filedlgnew_filelistnew_findfilesnew_fwhmnew_gridnew_griddlgnew_griddlgmodalnew_gridviewnew_histogramnew_imagenew_imagesetnew_imageviewnew_imcombinenew_imextractnew_labelsnew_lsqfitnew_matrixnew_measureanglesnew_measurelinesnew_measurepointsnew_measureregionsnew_plotnew_plotviewnew_pointnew_rectnew_registrynew_setnew_splitpathnew_statsnew_strtoknew_textviewnew_valuesetPlotting FunctionsOverview of Plotting FunctionsComparison of non-Class Plotting FunctionsCPlotView classCPlot classhistplotconnectconnecterrlinelineerrscatterscattererrsteplinesteplineerrplot (alias for connected plot)Date, Time, and Angle FunctionsOverview of date, time, and angle functionsDate functionsCalcHJDCalcJDCalcMJDFormatDateFormatYmdStrParseYmdParseJDJDtoDateTimeDateToYmdTime functionsDegToHmsHrToHmsHmsToDegHmsToHrFormatTimeFormatHmsStrParseHoursParseHmsAngle functionsDegToDmsDmsToDegFormatAngleFormatDmsStrParseDegreesParseDmsCalculationsCalcAirmassCalcHJDCalcJDCalcLSTCalcMJDCalcSphAngleDayOfWeekText Formatting FunctionsOverview of text formatting functionsCreateTextWindowMsgBoxMsgMsg2PrintfSprintfWprintfPixelTypeToStrStrToPixelTypeDirectory FunctionsOverview of directory functionsGetFileListGetFileNameGetFolderchange_dirchange_dir_upget_diris_diris_filemake_dirmake_fileremove_dirremove_filerename_fileDialog FunctionsOverview of dialog functionsGetAbortRetryIgnoreGetChoiceGetFileNameGetFolderGetItemGetItemStrGetNumberGetRetryCancelGetStringGetTextGetTrueFalseGetValueGetYesNoGetYesNoCancelBoolean Math FunctionsOverviewOperationsANDORXORNOTNANDNORBitTestConversionsDecimal to HexadecimalHexadecimal to DecimalHexadecimal to BinaryBinary to HexadeximalDecimal to BinaryBinary to DecimalTrim leading 0'sMiscellaneous FunctionsOverviewAbbrevPathAssertBeepbooltostrExitFileOpenGetFileListGetFileNameGetFolderGetFileOpenDlgTitleGetFileSaveDlgTitleGetKeyStateGetMathErrValGetMathErrValStrGetViewportSizeIncludePixelTypeToStrroundSetFileOpenDlgTitleSetFileSaveDlgTitleSetMathErrValSetResampleParamsStrToPixelTypeData StructuresAngleParams TableClassLibInfo TableGridParams TableImExtractParams TableLabelParams TableLineParams TablePointParams TableRegionParams TableResampleParams TableCoordinate SystemsImage Coordinate SystemPixel Coordinate DefinitionSubpixel Coordinate DefinitionWorld Coordinate SystemAngle Measurement DefinitionImage Display OrientationFITS Image OrientationSpecial ValuesniltruefalseInterface to MiraMira Data TypesImage SetsImage CursorPixel Mask FileGlossary of TermsSample ScriptsExamplesListing Image InformationUser-Defined Filter KernelAn Improved Filter Kernel ScriptError MessagesCompiler Error MessagesTypical Compiler Messages