Package org.anchoranalysis.image.bean.spatial.direction

Class AxisAlignedUnitVector

Object

org.anchoranalysis.bean.AnchorBean<DirectionVectorBean>

org.anchoranalysis.image.bean.spatial.direction.DirectionVectorBean

org.anchoranalysis.image.bean.spatial.direction.AxisAlignedUnitVector

public class AxisAlignedUnitVector
extends DirectionVectorBean

Creates a DirectionVector that is a unit-vector along a particular image-axis.

Author:

Owen

Constructor Summary

Constructors

Constructor	Description
AxisAlignedUnitVector()

Method Summary

Modifier and Type	Method	Description
org.anchoranalysis.spatial.orientation.DirectionVector	createVector()	Creates a vector in a particular direction.
String	getAxis()	Which axis the unit-vector will align with.
void	setAxis(String axis)	Which axis the unit-vector will align with.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AxisAlignedUnitVector

public AxisAlignedUnitVector()

Method Details

createVector

public org.anchoranalysis.spatial.orientation.DirectionVector createVector() throws CreateException

Description copied from class: DirectionVectorBean

Creates a vector in a particular direction.

Specified by:

createVector in class DirectionVectorBean

Returns:

the created vector.

Throws:

CreateException - if the vector cannot be successfully created.

getAxis

public String getAxis()

Which axis the unit-vector will align with. x or y or z

setAxis

public void setAxis(String axis)

Which axis the unit-vector will align with. x or y or z