Package science.aist.imaging.api.domain.offset

Class RotationOffset

java.lang.Object

science.aist.imaging.api.domain.offset.TranslationOffset

science.aist.imaging.api.domain.offset.RotationOffset

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OrientationOffset

public class RotationOffset
extends TranslationOffset

Class for representing translation and rotational offset of two images.

Also contains a failure-value representing the correctness of the result.

• Failure < 0 means that correctness of the offsets was not determined
• Failure = 0 means offset is accurate.
• Failure > 0 means offset is not total accurate (the higher this value, the less it is sure that the offset is correct).

Since:

1.0

Author:

Christoph Praschl

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	rotationalOffset

Fields inherited from class science.aist.imaging.api.domain.offset.TranslationOffset

EPSILON, failure, xOffset, yOffset

Constructor Summary

Constructors

Constructor	Description
RotationOffset()
RotationOffset(double rotationalOffset)
RotationOffset(double xOffset, double yOffset, double rotationalOffset)
RotationOffset(double xOffset, double yOffset, double failure, double rotationalOffset)
RotationOffset(TranslationOffset offset, double rotationalOffset)

Method Summary

Modifier and Type	Method	Description
protected void	checkRotationValue(double rotation, String offsetName)
double	getRotationalOffset()	Getter of rotational offset (in degrees)
void	setRotationalOffset(double rotationalOffset)	Setter for of rotational offset (in degrees)
String	toString()	toString Overload for TranslationOffset class Printing the TranslationOffset with rounded values (6 digits after decimal point) Displays ? for not set values.

Methods inherited from class science.aist.imaging.api.domain.offset.TranslationOffset

equalDoubles, equalToMaxValue, equalToMinValue, getFailure, getXOffset, getYOffset, setFailure, setXOffset, setYOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

rotationalOffset

protected double rotationalOffset

Constructor Detail

RotationOffset

public RotationOffset()

RotationOffset

public RotationOffset(double rotationalOffset)

RotationOffset

public RotationOffset(double xOffset,
                      double yOffset,
                      double rotationalOffset)

RotationOffset

public RotationOffset(double xOffset,
                      double yOffset,
                      double failure,
                      double rotationalOffset)

RotationOffset

public RotationOffset(TranslationOffset offset,
                      double rotationalOffset)

Method Detail

getRotationalOffset

public double getRotationalOffset()

Getter of rotational offset (in degrees)

Returns:

Returns the rotational offset

setRotationalOffset

public void setRotationalOffset(double rotationalOffset)

Setter for of rotational offset (in degrees)

Parameters:

rotationalOffset - Value (in degrees) which should be set

checkRotationValue

protected void checkRotationValue(double rotation,
                                  String offsetName)

toString

public String toString()

toString Overload for TranslationOffset class Printing the TranslationOffset with rounded values (6 digits after decimal point) Displays ? for not set values. Excludes offset areas if no value in area is set

Overrides:

toString in class TranslationOffset

Returns:

the string representation of offset