Package org.anchoranalysis.plugin.points.bean.fitter

Class Reference

Object

AnchorBean<PointsFitter>

InitializableBean<PointsFitter,PointsInitialization>

PointsBean<PointsFitter>

PointsFitter

Reference

All Implemented Interfaces:

CompatibleWithMark

public class Reference
extends PointsFitter

A PointsFitter that references another PointsFitter by its ID.

Constructor Summary

Constructors

Constructor	Description
Reference()

Method Summary

Modifier and Type	Method	Description
void	fit(List<Point3f> points, Mark mark, Dimensions dimensions)	Fits a mark to a set of points within given dimensions.
String	getId()	The ID of the referenced PointsFitter.
boolean	isCompatibleWith(Mark testMark)	Tests if the implementing object is compatible with a mark of a particular type.
void	onInitialization(PointsInitialization so)	Called after initialization.
void	setId(String id)	The ID of the referenced PointsFitter.

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

Constructor Details

Reference

public Reference()

Method Details

onInitialization

public void onInitialization(PointsInitialization so)
                      throws InitializeException

Description copied from class: InitializableBean

Called after initialization. An empty implementation is provided, to be overridden as needed in the sub-classes.

Overrides:

onInitialization in class InitializableBean<PointsFitter,PointsInitialization>

Parameters:

so - parameters used for initialization.

Throws:

InitializeException - if initialization does not successfully complete.

isCompatibleWith

public boolean isCompatibleWith(Mark testMark)

Description copied from interface: CompatibleWithMark

Tests if the implementing object is compatible with a mark of a particular type.

Parameters:

testMark - the mark to test for compatibility

Returns:

true if the implementing object is compatible with the given mark, false otherwise

fit

public void fit(List<Point3f> points,
 Mark mark,
 Dimensions dimensions)
         throws PointsFitterException,
InsufficientPointsException

Description copied from class: PointsFitter

Fits a mark to a set of points within given dimensions.

Specified by:

fit in class PointsFitter

Parameters:

points - the list of points to fit the mark to

mark - the mark to be fitted (will be modified)

dimensions - the dimensions within which the fitting occurs

Throws:

PointsFitterException - if an error occurs during the fitting process

InsufficientPointsException - if there are not enough points to perform the fitting

getId

public String getId()

The ID of the referenced PointsFitter.

setId

public void setId(String id)

The ID of the referenced PointsFitter.