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

Class OrientationOffset

java.lang.Object

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

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

science.aist.imaging.api.domain.offset.OrientationOffset

All Implemented Interfaces:

Serializable

public class OrientationOffset
extends RotationOffset

Class for representing different offset types (e.g. x-Axis offset, y-Axis offset, rotational offset, ...) of two images.

xOffset, yOffset, rotationOffset, horizontalAngleOffset and verticalAngleOffset == Double.MAX_Value means that the respective offset was not calculated

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 inherited from class science.aist.imaging.api.domain.offset.RotationOffset

rotationalOffset

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

EPSILON, failure, xOffset, yOffset

Constructor Summary

Constructors

Constructor	Description
OrientationOffset()
OrientationOffset(double xOffset, double yOffset)
OrientationOffset(double xOffset, double yOffset, double rotationalOffset)
OrientationOffset(double xOffset, double yOffset, double rotationalOffset, double failure)
OrientationOffset(RotationOffset offset, double horizontalAngleOffset, double verticalAngleOffset)
OrientationOffset(TranslationOffset offset, double rotation, double horizontalAngleOffset, double verticalAngleOffset)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
double	getHorizontalAngleOffset()	Getter of orientational offset on x-axis (in degrees)
double	getVerticalAngleOffset()	Getter of orientational offset on y-axis (in degrees)
int	hashCode()
void	setHorizontalAngleOffset(double horizontalAngleOffset)	Setter for orientational offset on x-axis (in degrees)
void	setVerticalAngleOffset(double verticalAngleOffset)	Setter for orientational offset on y-axis (in degrees)
String	toString()	toString Overload for OrientationOffset class Printing the OrientationOffset with rounded values (6 digits after decimal point) Displays ? for not set values.

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

checkRotationValue, getRotationalOffset, setRotationalOffset

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OrientationOffset

public OrientationOffset()

OrientationOffset

public OrientationOffset(double xOffset,
                         double yOffset)

OrientationOffset

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

OrientationOffset

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

OrientationOffset

public OrientationOffset(TranslationOffset offset,
                         double rotation,
                         double horizontalAngleOffset,
                         double verticalAngleOffset)

OrientationOffset

public OrientationOffset(RotationOffset offset,
                         double horizontalAngleOffset,
                         double verticalAngleOffset)

Method Detail

getHorizontalAngleOffset

public double getHorizontalAngleOffset()

Getter of orientational offset on x-axis (in degrees)

Returns:

Returns the orientational offset on x-axis (in degrees)

setHorizontalAngleOffset

public void setHorizontalAngleOffset(double horizontalAngleOffset)

Setter for orientational offset on x-axis (in degrees)

Parameters:

horizontalAngleOffset - Value (in degrees) which should be set

getVerticalAngleOffset

public double getVerticalAngleOffset()

Getter of orientational offset on y-axis (in degrees)

Returns:

Returns the orientational offset on y-axis (in degrees)

setVerticalAngleOffset

public void setVerticalAngleOffset(double verticalAngleOffset)

Setter for orientational offset on y-axis (in degrees)

Parameters:

verticalAngleOffset - Value (in degrees) which should be set

toString

public String toString()

toString Overload for OrientationOffset class Printing the OrientationOffset with rounded values (6 digits after decimal point) Displays ? for not set values. Excludes offset areas if no value in area is set (transformation area with x-, y- and rotational offset; and orientational area with vertical and horizontal offset)

Overrides:

toString in class RotationOffset

Returns:

the string representation of offset

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object