Package org.anchoranalysis.mpp.bean.bound.rotation

Class BoundRotation2D

Object

AnchorBean<BoundRotation>

BoundRotation

BoundRotation2D

public class BoundRotation2D
extends BoundRotation

Creates a randomly-generated orientation in 2D by uniformally sampling a scalar rotation angle

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
BoundRotation2D()

Method Summary

Modifier and Type	Method	Description
String	describeBean()	A (maybe longer) description identifying the bean and perhaps its key parameters.
Bound	getRotationAngle()
Orientation	randomOrientation(RandomNumberGenerator randomNumberGenerator, Optional<Resolution> resolution)	Generates a random orientation within the defined bounds.
void	setRotationAngle(Bound rotationAngle)

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, 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

BoundRotation2D

public BoundRotation2D()

Method Details

randomOrientation

public Orientation randomOrientation(RandomNumberGenerator randomNumberGenerator,
 Optional<Resolution> resolution)

Description copied from class: BoundRotation

Generates a random orientation within the defined bounds.

Specified by:

randomOrientation in class BoundRotation

Parameters:

randomNumberGenerator - the random number generator to use

resolution - an optional resolution to consider when generating the orientation

Returns:

a randomly generated Orientation within the defined bounds

describeBean

public String describeBean()

Description copied from class: AnchorBean

A (maybe longer) description identifying the bean and perhaps its key parameters.

By default, it returns the same as AnchorBean.getBeanName() but beans can optionally override it

Overrides:

describeBean in class AnchorBean<BoundRotation>

Returns:

either the short-name of the bean, or a longer description

getRotationAngle

public Bound getRotationAngle()

setRotationAngle

public void setRotationAngle(Bound rotationAngle)