org.youscope.common.microscope

Interface StageDevice

All Superinterfaces:

Device, java.rmi.Remote

public interface StageDevice
extends Device

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Point2D.Double	getPosition() Returns the current position of the plate.
double	getUnitMagnifier() Returns the magnification factor from native stage device units to micro meters: microMeters = units * unitMagnifier
boolean	isTransposeX() Returns if the x-direction is transposed (x -> -x).
boolean	isTransposeY() Returns if the y-direction is transposed (y -> -y).
void	setPosition(double x, double y) Sets the absolute position of the stage.
void	setRelativePosition(double dx, double dy) Sets the position of the stage relative to the current position.
void	setTransposeX(boolean transpose) Sets if the x-direction should be transposed.
void	setTransposeY(boolean transpose) Sets if the y-direction should be transposed.
void	setUnitMagnifier(double unitMagnifier) Sets the magnification factor from native stage device units to micro meters: microMeters = units * unitMagnifier

Methods inherited from interface org.youscope.common.microscope.Device

getDeviceID, getDriverID, getEditableProperties, getExplicitDelay, getLibraryID, getProperties, getProperty, getType, setExplicitDelay, waitForDevice

Method Detail

getPosition

java.awt.geom.Point2D.Double getPosition()
                                  throws java.rmi.RemoteException,
                                         MicroscopeException,
                                         java.lang.InterruptedException

Returns the current position of the plate.

Returns:

Position of the plate.

Throws:

java.rmi.RemoteException

MicroscopeException

java.lang.InterruptedException

setPosition

void setPosition(double x,
                 double y)
          throws java.rmi.RemoteException,
                 MicroscopeLockedException,
                 MicroscopeException,
                 java.lang.InterruptedException

Sets the absolute position of the stage. Same as setPosition(x, y, true).

Parameters:

x - X-position of the stage in mu.

y - Y-Position of the stage in mu.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

setRelativePosition

void setRelativePosition(double dx,
                         double dy)
                  throws java.rmi.RemoteException,
                         MicroscopeLockedException,
                         MicroscopeException,
                         java.lang.InterruptedException

Sets the position of the stage relative to the current position.

Parameters:

dx - relative X-position of the stage.

dy - relative Y-Position of the stage.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

setTransposeX

void setTransposeX(boolean transpose)
            throws java.rmi.RemoteException,
                   MicroscopeLockedException

Sets if the x-direction should be transposed. If true, all x-coordinates are replaced by their negative value (x -> -x). This is done automatically for all position related functions.

Parameters:

transpose - True, if the x-direction should be transposed.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

setTransposeY

void setTransposeY(boolean transpose)
            throws java.rmi.RemoteException,
                   MicroscopeLockedException

Sets if the y-direction should be transposed. If true, all y-coordinates are replaced by their negative value (y -> -y). This is done automatically for all position related functions.

Parameters:

transpose - True, if the y-direction should be transposed.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

isTransposeX

boolean isTransposeX()
              throws java.rmi.RemoteException

Returns if the x-direction is transposed (x -> -x). This function is for information only, the change of the direction is done automatically.

Returns:

True, if the x-direction is transposed.

Throws:

java.rmi.RemoteException

isTransposeY

boolean isTransposeY()
              throws java.rmi.RemoteException

Returns if the y-direction is transposed (y -> -y). This function is for information only, the change of the direction is done automatically.

Returns:

True, if the y-direction is transposed.

Throws:

java.rmi.RemoteException

getUnitMagnifier

double getUnitMagnifier()
                 throws java.rmi.RemoteException

Returns the magnification factor from native stage device units to micro meters: microMeters = units * unitMagnifier

Returns:

Magnification factor for native stage unit to micro meter conversion.

Throws:

java.rmi.RemoteException

setUnitMagnifier

void setUnitMagnifier(double unitMagnifier)
               throws java.rmi.RemoteException,
                      MicroscopeLockedException

Sets the magnification factor from native stage device units to micro meters: microMeters = units * unitMagnifier

Parameters:

unitMagnifier - Magnification factor for native stage unit to micro meter conversion.

Throws:

java.rmi.RemoteException

MicroscopeLockedException