Package org.anchoranalysis.mpp.bean.proposer

Class PointsProposer

Object

AnchorBean<PointsProposer>

InitializableBean<PointsProposer,NullInitialization>

NullParametersBean<PointsProposer>

PointsProposer

All Implemented Interfaces:

CompatibleWithMark

public abstract class PointsProposer
extends NullParametersBean<PointsProposer>
implements CompatibleWithMark

An abstract base class for proposing a list of points based on a given point and mark.

Constructor Summary

Constructors

Constructor	Description
PointsProposer()

Method Summary

Modifier and Type	Method	Description
abstract Optional<List<Point3i>>	propose(Point3d point, Mark mark, Dimensions dimensions, RandomNumberGenerator randomNumberGenerator, ErrorNode errorNode)	Proposes a list of points based on the given parameters.

Methods inherited from class org.anchoranalysis.bean.NullParametersBean

initializeRecursive, onInitialization, onInitialization

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

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

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

PointsProposer

public PointsProposer()

Method Details

propose

public abstract Optional<List<Point3i>> propose(Point3d point,
 Mark mark,
 Dimensions dimensions,
 RandomNumberGenerator randomNumberGenerator,
 ErrorNode errorNode)
                                         throws ProposalAbnormalFailureException

Proposes a list of points based on the given parameters.

Parameters:

point - the reference point for the proposal

mark - the mark associated with the proposal

dimensions - the dimensions of the space in which the points are proposed

randomNumberGenerator - a random number generator for any stochastic processes

errorNode - an error node for reporting any errors during the proposal process

Returns:

an Optional containing a List of proposed Point3i, or empty if no proposal is made

Throws:

ProposalAbnormalFailureException - if the proposal fails abnormally