org.micromanager

Interface CompatibilityInterface

public interface CompatibilityInterface

Legacy interface that implements some methods from the old 1.4 API. Available in the Beanshell scripting interface as "mm.compat()" or "mm.getCompatibilityInterface()".

Method Summary

Modifier and Type	Method and Description
java.awt.geom.AffineTransform	getCameraTransform(java.lang.String config) Deprecated. - Use core.getPixelSizeAffineByID(config) instead
java.lang.String	getVersion()
void	setCameraTransform(java.awt.geom.AffineTransform transform, java.lang.String config) Deprecated. - Use core.setPixelSizeAffine(config, DoubleVector transform) instead
boolean	versionLessThan(java.lang.String version) Displays an error message and returns true if the run-time Micro-Manager version is less than the one specified.

Method Detail

versionLessThan

boolean versionLessThan(java.lang.String version)
                 throws java.lang.NumberFormatException

Displays an error message and returns true if the run-time Micro-Manager version is less than the one specified. Versions in Micro-Manager are of the format: major.minor.minute date where ' date' can be omitted Examples: 1.4.6 1.4.6 20110831 When a date is appended to a version number, it will be newer than the same version without a date

Parameters:

version - - minimum version needen to run this code

Returns:

true if the run-time Micro-Manager version is less than the one specified

Throws:

java.lang.NumberFormatException - if the version number is not in the format expected.

getVersion

java.lang.String getVersion()

Returns:

the currently running Micro-Manager version

getCameraTransform

@Deprecated
java.awt.geom.AffineTransform getCameraTransform(java.lang.String config)

Deprecated. - Use core.getPixelSizeAffineByID(config) instead

Retrieve the affine transform describing how the camera image maps to stage coordinates, for a given pixel size config. This method will pull information from the profile if available, and failing that will look in the Java Preferences. Will return null if no transform is found.

Parameters:

config - The configuration (per core.getCurrentPixelSizeConfig()) to find the affine transform for.

Returns:

The transform describing how the camera maps to the stage.

setCameraTransform

@Deprecated
void setCameraTransform(java.awt.geom.AffineTransform transform,
                                    java.lang.String config)

Deprecated. - Use core.setPixelSizeAffine(config, DoubleVector transform) instead

Set a new affine transform for describing how the camera image maps to the stage coordinates. The value will be stored in the user's profile.

Parameters:

transform - The new transform to use.

config - The configuration (per core.getCurrentPixelSizeConfig()) to set the affine transform for.