PointsProposer (anchor-mpp 0.2.1 API)

org.anchoranalysis.bean.AnchorBean<B>

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

org.anchoranalysis.bean.NullParametersBean<PointsProposer>

org.anchoranalysis.mpp.bean.proposer.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<org.anchoranalysis.spatial.point.Point3i>>`	`propose(org.anchoranalysis.spatial.point.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<org.anchoranalysis.spatial.point.Point3i>> propose(org.anchoranalysis.spatial.point.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