Package sc.fiji.snt.analysis.curation

Record Class PlausibilityCheck.Warning

java.lang.Object

java.lang.Record

sc.fiji.snt.analysis.curation.PlausibilityCheck.Warning

Record Components:

checkName - the name of the check that produced this warning

severity - the severity level

message - human-readable description of the issue

location - the spatial location of the issue (may be null)

affectedPaths - the paths involved in this warning (never null, may be empty)

value - the measured value that triggered the warning

threshold - the threshold that was exceeded

impact - normalized fraction in [0, 1] indicating what portion of the reconstruction is affected if this warning is a true error. Double.NaN when not yet computed. See PlausibilityCheck.ImpactKind.

All Implemented Interfaces:

Comparable<PlausibilityCheck.Warning>

Enclosing class:

PlausibilityCheck

public static record PlausibilityCheck.Warning(String checkName, PlausibilityCheck.Severity severity, String message, PointInImage location, List<Path> affectedPaths, double value, double threshold, double impact)
extends Record
implements Comparable<PlausibilityCheck.Warning>

A plausibility warning produced by a check.

Constructor Summary

Constructors

Constructor	Description
Warning(String checkName, PlausibilityCheck.Severity severity, String message, PointInImage location, List<Path> affectedPaths, double value, double threshold)	Convenience constructor for callers that don't yet know the impact (filled in later by PlausibilityMonitor).
Warning(String checkName, PlausibilityCheck.Severity severity, String message, PointInImage location, List<Path> affectedPaths, double value, double threshold, double impact)	Compact constructor: guarantees affectedPaths is never null.

Method Summary

Modifier and Type	Method	Description
List<Path>	affectedPaths()	Returns the value of the affectedPaths record component.
String	checkName()	Returns the value of the checkName record component.
int	compareTo(PlausibilityCheck.Warning other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
double	impact()	Returns the value of the impact record component.
PointInImage	location()	Returns the value of the location record component.
String	message()	Returns the value of the message record component.
PlausibilityCheck.Severity	severity()	Returns the value of the severity record component.
double	threshold()	Returns the value of the threshold record component.
final String	toString()	Returns a string representation of this record class.
double	value()	Returns the value of the value record component.
PlausibilityCheck.Warning	withImpact(double newImpact)	Returns a copy of this warning with impact replaced.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Warning

public Warning(String checkName,
 PlausibilityCheck.Severity severity,
 String message,
 PointInImage location,
 List<Path> affectedPaths,
 double value,
 double threshold,
 double impact)

Compact constructor: guarantees affectedPaths is never null.

Warning

public Warning(String checkName,
 PlausibilityCheck.Severity severity,
 String message,
 PointInImage location,
 List<Path> affectedPaths,
 double value,
 double threshold)

Convenience constructor for callers that don't yet know the impact (filled in later by PlausibilityMonitor).

Method Details

withImpact

public PlausibilityCheck.Warning withImpact(double newImpact)

Returns a copy of this warning with impact replaced.

compareTo

public int compareTo(PlausibilityCheck.Warning other)

Specified by:

compareTo in interface Comparable<PlausibilityCheck.Warning>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

checkName

public String checkName()

Returns the value of the checkName record component.

Returns:

the value of the checkName record component

severity

public PlausibilityCheck.Severity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

location

public PointInImage location()

Returns the value of the location record component.

Returns:

the value of the location record component

affectedPaths

public List<Path> affectedPaths()

Returns the value of the affectedPaths record component.

Returns:

the value of the affectedPaths record component

value

public double value()

Returns the value of the value record component.

Returns:

the value of the value record component

threshold

public double threshold()

Returns the value of the threshold record component.

Returns:

the value of the threshold record component

impact

public double impact()

Returns the value of the impact record component.

Returns:

the value of the impact record component