Package sc.fiji.snt.analysis.curation

Class PlausibilityCheck.LiveCheck

java.lang.Object

sc.fiji.snt.analysis.curation.PlausibilityCheck.LiveCheck

Direct Known Subclasses:

PlausibilityCheck.BranchAngle, PlausibilityCheck.ConstantRadii, PlausibilityCheck.DirectionContinuity, PlausibilityCheck.InterForkDistance, PlausibilityCheck.RadiusContinuity, PlausibilityCheck.SomaDistance, PlausibilityCheck.TerminalBranchLength, PlausibilityCheck.TortuosityConsistency

Enclosing class:

PlausibilityCheck

public abstract static class PlausibilityCheck.LiveCheck
extends Object

A lightweight check that evaluates the plausibility of a single fork operation (parent + child + branch index). Designed to execute in sub-millisecond time so it can run inline at Hook 2 (QUERY_KEEP).

Constructor Summary

Constructors

Constructor	Description
LiveCheck()

Method Summary

Modifier and Type	Method	Description
abstract List<PlausibilityCheck.Warning>	check(Path parent, Path child, int branchIndex)	Evaluates the plausibility of a child path forking from a parent.
abstract String	getName()
PlausibilityCheck.ImpactKind	impactKind()	Declares how this check's errors propagate.
boolean	isEnabled()
PlausibilityCheck.Measurements	measure(Collection<Path> paths)	Computes the full distribution of this check's metric across paths, without applying the warning threshold.
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LiveCheck

public LiveCheck()

Method Details

getName

public abstract String getName()

Returns:

a short human-readable name for this check

check

public abstract List<PlausibilityCheck.Warning> check(Path parent,
 Path child,
 int branchIndex)

Evaluates the plausibility of a child path forking from a parent.

Parameters:

parent - the parent path

child - the child (candidate) path

branchIndex - the node index in the parent where the fork occurs

Returns:

list of warnings (empty if the operation is plausible)

measure

public PlausibilityCheck.Measurements measure(Collection<Path> paths)

Computes the full distribution of this check's metric across paths, without applying the warning threshold. Default implementation returns PlausibilityCheck.Measurements.EMPTY; subclasses override to enable per-check histogram popups in the Curation Assistant.

Parameters:

paths - the paths to evaluate; null or empty yields PlausibilityCheck.Measurements.EMPTY.

Returns:

a PlausibilityCheck.Measurements record; never null.

impactKind

public PlausibilityCheck.ImpactKind impactKind()

Declares how this check's errors propagate. Default SUBTREE for live checks because most live checks (branch angle, direction, tortuosity, soma distance) catch topology problems whose consequences cascade downstream. Caliber-only checks (e.g., RadiusContinuity, ConstantRadii) override to PlausibilityCheck.ImpactKind.LOCAL.

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)