Class MarkWithIdentifierFactory
Object
A factory for creating marks with unique identifiers.
This class extends NullParametersBean, providing functionality to create marks with unique identifiers based on a template mark in the MPP (Marked Point Process) framework.
-
Constructor Summary
ConstructorsConstructorDescriptionMarkWithIdentifierFactory
(MarkFactory templateMark) Constructs a MarkWithIdentifierFactory with a specified template mark factory. -
Method Summary
Modifier and TypeMethodDescriptionA (maybe longer) description identifying the bean and perhaps its key parameters.double
The reference Poisson intensity for mark creation.A template mark factory from which all new marks are created.int
Generates a new unique identifier and increments the counter.Creates a new mark based on the template and assigns it a unique identifier.void
As there's no parameters we expose a different method.void
setReferencePoissonIntensity
(double referencePoissonIntensity) The reference Poisson intensity for mark creation.void
setTemplateMark
(MarkFactory templateMark) A template mark factory from which all new marks are created.Methods inherited from class org.anchoranalysis.bean.NullParametersBean
initializeRecursive, 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, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
-
Constructor Details
-
MarkWithIdentifierFactory
Constructs a MarkWithIdentifierFactory with a specified template mark factory.- Parameters:
templateMark
- the template mark factory to use for creating new marks
-
MarkWithIdentifierFactory
public MarkWithIdentifierFactory()
-
-
Method Details
-
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 classAnchorBean<MarkWithIdentifierFactory>
- Returns:
- either the short-name of the bean, or a longer description
-
onInitialization
Description copied from class:NullParametersBean
As there's no parameters we expose a different method.- Overrides:
onInitialization
in classNullParametersBean<MarkWithIdentifierFactory>
- Throws:
InitializeException
- if initialization does not successfully complete.
-
newTemplateMark
Creates a new mark based on the template and assigns it a unique identifier.- Returns:
- a new Mark object with a unique identifier
-
idAndIncrement
public int idAndIncrement()Generates a new unique identifier and increments the counter.- Returns:
- a new unique identifier
-
getReferencePoissonIntensity
public double getReferencePoissonIntensity()The reference Poisson intensity for mark creation. -
setReferencePoissonIntensity
public void setReferencePoissonIntensity(double referencePoissonIntensity) The reference Poisson intensity for mark creation. -
getTemplateMark
A template mark factory from which all new marks are created. -
setTemplateMark
A template mark factory from which all new marks are created.
-