Package org.anchoranalysis.mpp.bean.proposer

Class OrientationProposer

Object

org.anchoranalysis.bean.AnchorBean<B>

org.anchoranalysis.bean.initializable.InitializableBean<T,MarksInitialization>

org.anchoranalysis.mpp.bean.MarksBean<OrientationProposer>

org.anchoranalysis.mpp.bean.proposer.OrientationProposer

All Implemented Interfaces:

CompatibleWithMark

public abstract class OrientationProposer
extends MarksBean<OrientationProposer>
implements CompatibleWithMark

An abstract base class for proposing orientations for marks.

Constructor Summary

Constructors

Constructor	Description
OrientationProposer()

Method Summary

Modifier and Type	Method	Description
abstract Optional<org.anchoranalysis.spatial.orientation.Orientation>	propose(Mark mark, Dimensions dimensions, RandomNumberGenerator randomNumberGenerator)	Proposes an orientation for a given mark.

Methods inherited from class org.anchoranalysis.mpp.bean.MarksBean

initializerForMarksBeans

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized, onInitialization

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

Methods inherited from interface org.anchoranalysis.mpp.mark.CompatibleWithMark

isCompatibleWith

Constructor Details

OrientationProposer

public OrientationProposer()

Method Details

propose

public abstract Optional<org.anchoranalysis.spatial.orientation.Orientation> propose(Mark mark, Dimensions dimensions, RandomNumberGenerator randomNumberGenerator) throws ProposalAbnormalFailureException

Proposes an orientation for a given mark.

Parameters:

mark - the mark for which to propose an orientation

dimensions - the dimensions of the space in which the mark exists

randomNumberGenerator - a random number generator for any stochastic processes

Returns:

an Optional containing the proposed Orientation, or empty if no orientation is proposed

Throws:

ProposalAbnormalFailureException - if the proposal fails abnormally