相比于CMMore（MMC）对象，MMC对象允许对MicroManager进行相对较低级别的功能性使用，而gui对象则使其更容易完成更复杂的任务。ScriptInterface以下简称GUI。接口在主面板中执行命令。由MMStudio实现，可作为Beanshell脚本面板中的gui对象使用。大多数函数抛出MMScriptException异常。简单来说，GUI对象也可完成Micromanager用户界面上的大部分操作。该接口的介绍还是比较详细的
|
|
请求为指定的毫秒数暂停程序执行。
参数: ms -- 以毫秒为单位的时间请求暂停
void message(java.lang.String text)
在脚本控制台输出窗口中显示文本
void clearMessageWindow()
清除脚本控制台输出窗口
void refreshGUI()
使GUI与mmcore中的最新变化保持一致。
void refreshGUIFromCache()
使GUI与mmcore中的最新变化保持一致。不与硬件通信，只检查缓存
void snapSingleImage()
捕捉图像并在AcqWindow中显示。当当前的AcqWindow未打开时，打开一个新的AcqWindow。调用此函数与MM GUI界面上的“Snap”按钮相同。
void openAcquisition(java.lang.String name, java.lang.String rootDir, int nrFrames, int nrChannels, int nrSlices, int nrPositions,
boolean show, boolean save)
打开一个新的采集数据集
参数：
name - ---数据集的名称
rootDir - ---将要创建新数据集的目录
nrFrames - -- 本次采集中的帧数
nrChannels - --此次采集的渠道数目
nrSlices - - 这次采集中切片数量(z 位置)
nrPositions - -本次采集中(XY)位置的数目
show - -是否展示这次采集
save -- 在采集期间是否储存数据
java.lang.String createAcquisition(org.json.JSONObject summaryMetadata, boolean diskCached,boolean displayOff)
该方法已注销
void initializeAcquisition(java.lang.String name, int width, int height, int bytesPerPixel, int bitDepth)
为已打开的数据集设置图像物理尺寸。一旦设置了图像的维度，就不能更改它们，即对此方法的后续调用将产生错误。通常不需要调用此方法，除非在插入第一个图像之前必须设置显示选项。如果在openAcquisition()之后未显式调用此方法，则将根据插入到数据集中的第一幅图像自动初始化图像维度。
参数:
name - - --数据集的名称
width - - --像素的图像宽度
height - - --像素高度图像
bytesPerPixel - - --每像素的字节数
bitDepth - - --每像素位的动态范围
void addImageToAcquisition(java.lang.String name, int frame, int channel, int slice, int position, TaggedImage taggedImg)
将图像插入数据集
参数:
name - - --采集名称
frame - - - 0基的帧号码
channel - ---0基频道号码
slice - - -0基(z)的切片数
position - - 0基位置号码
taggedImg - Tagged Image(图像与相关元数据)
void setAcquisitionAddImageAsynchronous(java.lang.String name)
更改采集，以便异步添加图像。 所有对例如addImageToAcquisition()和其他类似函数的调用几乎都会立即返回。
参数:
name - 数据集名称
void snapAndAddImage(java.lang.String name, int frame, int channel, int z, int position)
按照当前设置拍摄图像，并将像素放置在Micro-Manager Image viewer的指定位置
Parameters: 参数:
name -- 采集名称
frame --应插入该图像的帧数(时间点，0基)
channel --插入此图像的通道号(0基)
z --插入此图像的切片数(0基)
position -- 插入该图像的位置号(0基)
org.micromanager.acquisition.MMAcquisition getAcquisition(java.lang.String name)
已失效
java.lang.String getUniqueAcquisitionName(java.lang.String stem)
返回以尚未使用的STEM开头的名称。
参数:
stem - 用于构造唯一名称的基名
返回：
一个尚未使用的stem开头的名字
java.lang.String getCurrentAlbum()
返回当前相册的名称(即最近创建的相册)除了通过脚本接口使用外,也可在MM主窗口中"Camera -- Album“”使用"Album"按钮，以及 snap / live 窗口上的"Album"按钮
返回：
最新相册名称
void addToAlbum(mmcorej.TaggedImage image)
throws org.micromanager.utils.MMScriptException
将TaggedImage添加到相册中；如果图像和当前相册在图像尺寸、每个像素的位数、每个像素的字节数或通道数上不匹配，则创建新的相册。也可以在MM主窗口上的"Camera--Album"按钮和 snap / live window"--Album"按钮得到同样功能。
参数:
image - ---加入Alnum的TaggedImage
java.lang.Boolean acquisitionExists(java.lang.String name)
检查是否已经存在带有给定名称的采集
参数:
name --测试是否存在的名字
返回:
当名字已经存在的时候返回“真”
void closeAcquisition(java.lang.String name)
结束采集。 在此命令后的元数据完成后，对此数据集的所有引用都被清除，并且无法在采集中添加其他图像
参数:
name - - 关闭采集名称
void closeAllAcquisitions()
关闭所有当前开放的采集
java.lang.String[] getAcquisitionNames()
获取一个数组，其中包含所有开放采集的名称
int getAcquisitionImageWidth(java.lang.String acqName)
返回图像的宽度(以像素为单位)
int getAcquisitionImageHeight(java.lang.String acqName)
返回图像的高度(以像素为单位)
int getAcquisitionImageBitDepth(java.lang.String acqName)
返回每像素使用的位数
int getAcquisitionImageByteDepth(java.lang.String acqName)
返回每个像素所使用的字节数
int getAcquisitionMultiCamNumChannels(java.lang.String acqName)
返回指定的在此获取中使用了多个摄像机
void setAcquisitionProperty(java.lang.String acqName, java.lang.String propertyName, java.lang.String value)
设置附加到采集概览的自定义属性
void setImageProperty(java.lang.String acqName, int frame, int channel, int slice, String propName, String value)
Sets property attached to an individual image. 设置附加到单个图像上的属性
java.lang.String runAcquisition()
使用当前设置执行获取，将在获取对话框未打开时打开，但在获取完成后返回。注意，此功能不应在EDT(即运行UI的线程)上执行。
返回：
创建的采集名称
java.lang.String runAcquisition(java.lang.String name, java.lang.String root)
使用当前设置执行采集，但允许更改数据路径。 当采集对话框尚未打开时，将打开它。 采集完成后返回。 请注意，这个函数不应该在 EDT (运行 UI 的线程)上执行
参数:
name - - 这次采集的名称
root - - 将数据存储在文件系统中的位置
返回:
创建的采集名称
void loadAcquisition(java.lang.String path)
从文件中获取对话框的加载设置并在尚未打开的情况下打开采集对话框
void setPositionList(PositionList pl)
将此设置为“当前”PositionList，即获取协议所使用的列表将替换PositionList窗口中的列表。如果该列表尚未打开，它将打开一个位置列表对话框。
PositionList getPositionList()
返回当前 PositionList 的副本，这是一个采集协议使用的
setChannelColor
void setChannelColor(java.lang.String title, int channel, java.awt.Color color)
设置Image Viewer中指定信道的颜色。 只对有两个或多个通道的图像有效
void setChannelName(java.lang.String title, int channel, java.lang.String name)
设置通道名称(标签)
参数:
title --采集名称
channel - - --频道索引
name - ---频道标签
void setChannelExposureTime(java.lang.String channelGroup, java.lang.String channel, double exposure)
更新与给定预设值关联的曝光时间，如果通道组和通道名称与当前状态匹配，则曝光时间也将被更新。
void setChannelContrast(java.lang.String title, int channel, int min, int max)
throws org.micromanager.utils.MMScriptException
为每个通道设置最小(黑色)和最大(白色或通道颜色)像素值剪裁级别。
参数:
title - - --采集名称
channel - ---信道索引(如果只有一个通道，则使用0)
min - - --黑色剪切水平
max - ---白色剪切级别
void setContrastBasedOnFrame(java.lang.String title, int frame, int slice)
基于当前切片和帧像素值的当前位置的每个通道，自动标定对比度
参数:
title - - --采集名称
frame - - 帧号
slice - - - 切片号
double getChannelExposureTime(java.lang.String channelGroup, java.lang.String channel, double defaultExp)
返回给定通道组中所需的预设置的曝光时间-从首选项获取其信息-MDA窗口中使用的是相同的东西，但是该类保留自己的副本
返回:
曝光时间
void closeAcquisitionWindow(java.lang.String acquisitionName)
关闭与采集相对应的图像窗口。 如果与closeAcquisitiion()取得一起使用，应该首先调用此方法
参数:
acquisitionName - -- 采集名称
java.awt.geom.Point2D.Double getXYStagePosition()
获得当前的 XY 级位置。 返回设备坐标中的一个点(仪微米为单位)
void setStagePosition(double z)
移动默认焦点(Z)并阻止直到完成
参数:
z - - 绝对 z 位置
void setRelativeStagePosition(double z)
相对于当前位置移动默认焦点(Z)并堵塞直到完成
void setXYStagePosition(double x, double y)
移动默认的 XY 平台并堵塞直到完成
void setRelativeXYStagePosition(double x, double y)
将默认的 XY 平台相对于当前位置移动并堵塞直到完成
java.lang.String getXYStageName()
系统中可以有多个 XY 设备。 此函数返回当前活动的函数的名称
void setXYOrigin(double x, double y)
将默认xy平台的当前阶段位置指定为(x，y)，从而抵消所有其他位置的坐标。
void saveConfigPresets()
保存当前配置
ij.gui.ImageWindow getSnapLiveWin()
返回 ImageJ ImageWindow 实例，该实例用于 Snap 和 Live 显示
ImageCache getCacheForWindow(ij.gui.ImageWindow window)
给出一个 ImageWindow，返回与它相关的 ImageCache
java.lang.String installAutofocusPlugin(java.lang.String className)
从类路径安装一个自动对焦插件类
mmcorej.CMMCore getMMCore()
提供对核心及其功能的访问
Autofocus getAutofocus()
当前活动的自动对焦设备(可以是 Java 或 c + + 编码设备)
void showAutofocusDialog()
在对话框中显示当前活动的自动对焦设备的选项
void logMessage(java.lang.String msg)
向 micromanager 日志(在 Corelogtxt 找到)添加一条消息
msg - ---将要添加到日志中的消息
void showMessage(java.lang.String msg)
在用户界面中显示消息
参数:
msg - - --要显示的信息
void showMessage(java.lang.String msg,
在用户界面中显示消息
参数:
msg - ---要显示的信息
void logError(java.lang.Exception e,
java.lang.String msg)
将堆栈跟踪和消息写入MicroManager日志(corelog.txt)。
参数:
e - ---需要记录的 Java 异常
msg - --要显示的信息
void logError(java.lang.Exception e)
将堆栈跟踪写入MM日志
参数:
e - --需要记录的 Java 异常
void logError(java.lang.String msg)
将错误写入MM日志(与 logMessage 相同)
参数:
msg - - -需要记录的消息
void showError(java.lang.Exception e, java.lang.String msg)
在用户界面中显示错误，并将堆栈跟踪显示到MM日志
参数:
e - ---可显示和记录的 Java 异常
msg - ---要显示和记录错误消息
void showError(java.lang.Exception e)
.显示和记录一个 Java 异常
参数:
e - - --需要显示和记录的 Java异常
void showError(java.lang.String msg)
在用户界面中显示错误消息，并将日志显示给MM日志
void showError(java.lang.Exception e, java.lang.String msg, java.awt.Component parent)
在用户界面中显示错误，并将 stacktrace 显示到MM日志
Parameters: 参数:
e - --可显示和记录的 Java 异常
msg - - --要显示和记录错误消息
parent - - --用于显示对话框的框架，或调用方的空格
void showError(java.lang.Exception e, java.awt.Component parent)
void showError(java.lang.String msg, java.awt.Component parent)
void addMMListener(MMListenerInterface newL)
允许MMListener注册自己，以便接收MMListenerInterface中定义的警报
void removeMMListener(MMListenerInterface oldL)
void addMMBackgroundListener(java.awt.Component frame)
让Component自己注册，以便它们的背景可以被MM用户界面所操纵。
void removeMMBackgroundListener(java.awt.Component frame)
java.awt.Color getBackgroundColor()
回主窗口的当前颜色，以便它也可以用于派生的窗口 / 插件
boolean displayImage(mmcorej.TaggedImage image)
在Snap/Live窗口中显示TaggedImage(使用当前相机设置来确定图像的形状)
参数:
image -- 将显示的TaggedImage(像素数据和元数据标签)
boolean isLiveModeOn()
确定live模式是否正在运行
Returns: 返回页首:
void enableLiveMode(boolean b)
打开或关闭live模式(相当于按下 Live 模式按钮)
java.awt.Rectangle getROI()
获取默认相机的 ROI
返回:
默认相机的 ROI
void setROI(java.awt.Rectangle r)
设置默认相机的 ROI
ImageCache getAcquisitionImageCache(java.lang.String acquisitionName)
获取与采集关联的ImageCache对象的引用。
参数:
acquisitionName --采集名称
返回:
与采集相关的 ImageCache 对象
void markCurrentPosition()
未打开时打开XYPositionList。将当前位置添加到列表中(与按XYPositionList中的“Mark”按钮相同)
org.micromanager.dialogs.AcqControlDlg getAcqDlg()
已注销
org.micromanager.positionlist.PositionListDlg getXYPosListDlg()
已注销
boolean isAcquisitionRunning()
当前正在运行获取时返回true(注意：如果当前正在运行Live模式、Snap或“Camera->Album，则该函数将不返回true。)
boolean versionLessThan(java.lang.String version)
显示错误消息，如果运行时微型管理器版本小于指定的版本，则返回true。MicroManager中的版本的格式是：mainor.minor.min Date，其中可以省略“Date”示例：1.4.6 1.4.6 20110831如果将日期追加到版本号，它将比没有日期的同一版本更新。
参数:
version - - --运行这个代码需要的最小版本
void logStartupProperties()
将 MM 和操作系统的各种属性写入日志
void makeActive()
org.micromanager.utils.AutofocusManager getAutofocusManager()
返回:
目前选择的 AutoFocusManger 对象
java.lang.String getBackgroundStyle()
返回:
t当前的微观管理者MM风格——"Day"或"Night"
java.lang.String getVersion()
返回:
目前正在运行的 micro- manager 版本
void setBackgroundStyle(java.lang.String backgroundType)
将 GUI 及其所有注册组件的背景颜色设置为选定的 backGroundType
参数:
backgroundType - "Day" or "Night" -
void setConfigChanged(boolean status)
让GUI知道当前配置已经更改。激活“保存”按钮，它的状态为“真”。
void showXYPositionList()
显示位置列表对话框
java.lang.String openAcquisitionData(java.lang.String location, boolean inRAM)
打开一个现有的数据集。 在窗口显示采集
返回:
java.lang.String openAcquisitionData(java.lang.String location, boolean inRAM, boolean show)
打开一个现有的数据集
void enableRoiButtons(boolean enabled)
启用或禁用主窗口上的 ROI 按钮
void setImageSavingFormat(java.lang.Class imageSavingClass)
设置将图像保存到磁盘的格式。图像可以写入磁盘，每个文件一个或每个文件多个图像。在大多数系统上，对每个文件使用多个图像应该更快。
参数:
imageSavingClass - -对于单个图像文件使用org.micromanager.acquisition.TaggedImageStorageDiskDefault.class，对于多图像文件使用org.micromanager.acquisition.TaggedImageStorageMultipageTiff.class。
IAcquisitionEngine2010 getAcquisitionEngine2010()
boolean getHideMDADisplayOption()
addImageProcessor
void addImageProcessor(DataProcessor<mmcorej.TaggedImage> processor)
将图像处理器添加到 DataProcessor 管道中
void removeImageProcessor(DataProcessor<mmcorej.TaggedImage> taggedImageProcessor)
从 DataProcessor 管道中移除图像处理器
java.util.List<DataProcessor<mmcorej.TaggedImage>> getImageProcessorPipeline()
索引当前 DataProcessor 管道的副本
void setImageProcessorPipeline(java.util.List<DataProcessor<mmcorej.TaggedImage>> pipeline)
用所提供的管道替换当前的 DataProcessor 管道
void registerProcessorClass(java.lang.Class< extends DataProcessor<mmcorej.TaggedImage>> processorClass,
java.lang.String name)
用采集引擎注册一个新的 DataProcessor 类。 例如，如果您的处理器类被命名为 MyProcessor，那么您将称此函数为: gui.registerProcessorClass (MyProcessor.class,"My Processor") ;
void setPause(boolean state)
暂停 / 暂停一次正在进行的采集
boolean isPaused()
如果目前暂停采集，则返回 true
void attachRunnable(int frame, int position, int channel, int slice, java.lang.Runnable runnable)
将可运行的引擎连接到采集引擎上。 可以指定每个索引(f，p，c，s)。 传递-1的值应该导致在该索引的所有值上附加可运行的值。 例如，如果第一个参数是 -1，那么 runnable 应该在每个帧上执行
void clearRunnables()
从采集引擎中删除运行中的应用程序
SequenceSettings getAcquisitionSettings()
返回当前的采集设置
void setAcquisitionSettings(SequenceSettings settings)
应用新的采集设置
java.lang.String getAcquisitionPath()
返回当前的采集路径，如果不适用，则返回 null
void promptToSaveAcquisition(java.lang.String name, boolean prompt)
显示对话框以保存当前打开的采集数据
void registerForEvents(java.lang.Object obj)
请求将给定的对象添加到我们的EventBus中，以便通知发生的事件。订阅者可以侦听的可用事件类型位于org.microManager.api.Events包中。
void unregisterForEvents(java.lang.Object obj)
将给定的对象从 EventBus 标记中取消注册
void autostretchCurrentWindow()
自动拉伸当前活动窗口的每个直方图，就好像每个窗口的“自动”按钮都被单击了一样。