org.youscope.plugin.microplatemeasurement

Class XYAndFocusPosition

java.lang.Object

org.youscope.plugin.microplatemeasurement.XYAndFocusPosition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<XYAndFocusPosition>

Direct Known Subclasses:

PathOptimizerPosition

public class XYAndFocusPosition
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, java.lang.Comparable<XYAndFocusPosition>

Author:

langmo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XYAndFocusPosition() The default constructor.
XYAndFocusPosition(double x, double y) Constructor.
XYAndFocusPosition(double x, double y, double focus) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(XYAndFocusPosition otherPosition) Compares the two positions.
boolean	equals(java.lang.Object obj)
double	getFocus() Returns the focus position.
double	getX() Returns the value of the x-position in um.
double	getY() Returns the value of the y-position in um.
int	hashCode()
void	setFocus(double focus) Sets the focus position.
void	setX(double x) Sets the value of the x-position in um.
void	setY(double y) Sets the value of the y-position in um.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XYAndFocusPosition

public XYAndFocusPosition()

The default constructor. Initializes the x, y, and focus position to 0.

XYAndFocusPosition

public XYAndFocusPosition(double x,
                          double y)

Constructor. Sets the x, y position to the given values and focus to 0.

Parameters:

x - The x position.

y - The y position

XYAndFocusPosition

public XYAndFocusPosition(double x,
                          double y,
                          double focus)

Constructor. Sets the x, y, and focus position to the given values.

Parameters:

x - The x position.

y - The y position

focus - The focus position.

Method Detail

setFocus

public void setFocus(double focus)

Sets the focus position. The unit of this value depends on the focusing mechanism.

Parameters:

focus - the focus position.

getFocus

public double getFocus()

Returns the focus position. The unit of this value depends on the focusing mechanism.

Returns:

the focus position.

setX

public void setX(double x)

Sets the value of the x-position in um.

Parameters:

x - x-position in um.

getX

public double getX()

Returns the value of the x-position in um.

Returns:

x-position in um.

setY

public void setY(double y)

Sets the value of the y-position in um.

Parameters:

y - y-position in um.

getY

public double getY()

Returns the value of the y-position in um.

Returns:

y-position in um.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(XYAndFocusPosition otherPosition)

Compares the two positions. First, the x position, then the y position and finally the focus position is compared. In each of the three steps 1 is returned if the position of this object is greater than the one of the compared object, and -1 if it is smaller. If they are equal, the next value (x position -> y position -> focus position) is compared. If all three values are equal, 0 is returned.

Specified by:

compareTo in interface java.lang.Comparable<XYAndFocusPosition>

Parameters:

otherPosition - The object to which this object should be compared to.

Returns:

1 if this object is greater than the compared one, -1 if it is smaller, and zero if they are equal.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException