Interface AutofocusPlugin
- All Superinterfaces:
MMGenericPlugin, MMPlugin, org.scijava.plugin.SciJavaPlugin
This interface is used for a java-based autofocus plugin. Properly
compiled jars can be added to the mmplugins directory of Micro-Manager
and they will be loaded into the autofocus menu. It also wraps
autofocus devices implemented in C++ and exposed by the core, so both
java and C++ based autofocus plugins can be used by this common interface.
-
Method Summary
Modifier and TypeMethodDescriptionvoidPushes setting to the hardware or software autofocus.doublecomputeScore(ij.process.ImageProcessor impro) Computes a focus score for the given image.voidenableContinuousFocus(boolean enable) Turns on continuous autofocus.doubleRuns a full, one-shot autofocus protocol.doubleReturns the current focus "score" (goodness of focus).intReturns the number of images acquired.org.micromanager.internal.utils.PropertyItem[]Returns an array of the properties for this autofocus plugin.org.micromanager.internal.utils.PropertyItemgetProperty(String key) Returns the name and value of properties for the autofocus plugin.String[]Returns an array of the names of properties for this autofocus plugin.getPropertyValue(String name) Gets the value of a named property.Returns a detailed status of the autofocus plugin/device.doubleRuns a single, incremental focusing step.voidInitializes the plugin.booleanReturns true if continuous autofocus has been enabled.booleanReturns true if continuous autofocus is currently locked (successfully following the specimen).voidStores settings.voidsetProperty(org.micromanager.internal.utils.PropertyItem p) Sets the value of a particular property.voidsetPropertyValue(String name, String value) Sets the value of a named property.Methods inherited from interface MMPlugin
getCopyright, getHelpText, getName, getVersion, setContext
-
Method Details
-
initialize
void initialize()Initializes the plugin. Can be called multiple times, for instance after a change in hardware configuration. Conversely, the plugin can trust that the hardware never changes without a call to this function. -
applySettings
void applySettings()Pushes setting to the hardware or software autofocus. -
saveSettings
void saveSettings()Stores settings. -
fullFocus
-
incrementalFocus
-
getNumberOfImages
int getNumberOfImages()Returns the number of images acquired.- Returns:
- number of images for autofocussing
-
getVerboseStatus
String getVerboseStatus()Returns a detailed status of the autofocus plugin/device.- Returns:
- description of the autofocus Status
-
getProperties
org.micromanager.internal.utils.PropertyItem[] getProperties()Returns an array of the properties for this autofocus plugin.- Returns:
- array with Property descriptors, representing MMCore data
-
getPropertyNames
String[] getPropertyNames()Returns an array of the names of properties for this autofocus plugin.- Returns:
- array with the names of properties for this autofocus plugin
-
getProperty
Returns the name and value of properties for the autofocus plugin.- Parameters:
key- PropertyName for which we want the value- Returns:
- value for given property
- Throws:
Exception- thrown by MMCore when key is not found.
-
setProperty
-
getPropertyValue
-
setPropertyValue
-
getCurrentFocusScore
double getCurrentFocusScore()Returns the current focus "score" (goodness of focus).- Returns:
- focus score (goodness of focus)
-
enableContinuousFocus
-
isContinuousFocusEnabled
-
isContinuousFocusLocked
-
computeScore
double computeScore(ij.process.ImageProcessor impro) Computes a focus score for the given image.- Parameters:
impro- ImageProcessor to be used in the calculation.- Returns:
- calculated score
-