fiji.plugin.trackmate.util

Class DetectionPreview.Builder

java.lang.Object

fiji.plugin.trackmate.util.DetectionPreview.Builder

Enclosing class:

DetectionPreview

public static final class DetectionPreview.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
DetectionPreview.Builder	axisLabel(String axisLabel) Sets the axis label to appear on the histogram.
DetectionPreview.Builder	detectionSettingsSupplier(Supplier<Map<String,Object>> detectionSettingsSupplier) Sets the supplier function that will return the detector settings to use for the preview.
DetectionPreview.Builder	detectorFactory(SpotDetectorFactoryBase<?> detectorFactory) Sets the detector factory to use for the preview.
DetectionPreview.Builder	frameSupplier(Supplier<Integer> frameSupplier) Sets the supplier function that will return the frame to run the preview on.
DetectionPreview	get()
DetectionPreview.Builder	model(Model model) Sets the model to update with the preview action.
DetectionPreview.Builder	settings(Settings settings) Sets the Settings object to use for preview.
DetectionPreview.Builder	thresholdKey(String thresholdKey) Sets the key to the parameters that thresholds the quality values displayed on the histogram.
DetectionPreview.Builder	thresholdTextField(JFormattedTextField ftf) Sets the JFormattedTextField to update when the user changes the threshold value on the quality histogram.
DetectionPreview.Builder	thresholdUpdater(DoubleConsumer thresholdUpdater) Sets the consumer function that will be called with the threshold value sets by the user on the quality histogram.

Methods inherited from class java.lang.Object

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

Method Detail

model

public DetectionPreview.Builder model(Model model)

Sets the model to update with the preview action.

The spots field of the specified model will be updated with the spots found by the preview action and the model will be notified.

Parameters:

model - the model to update. If null, the preview will run but won't update a model.

Returns:

this builder.

settings

public DetectionPreview.Builder settings(Settings settings)

Sets the Settings object to use for preview.

Only the Settings.imp field and the ROI methods will be used to generate the preview. Settings.imp cannot be null.

Parameters:

settings - the settings to use. Cannot be null.

Returns:

this builder.

detectorFactory

public DetectionPreview.Builder detectorFactory(SpotDetectorFactoryBase<?> detectorFactory)

Sets the detector factory to use for the preview. Can be different from the one stored in the settings(Settings).

Parameters:

detectorFactory - the detector factory to use for the preview. Cannot be null.

Returns:

this builder.

frameSupplier

public DetectionPreview.Builder frameSupplier(Supplier<Integer> frameSupplier)

Sets the supplier function that will return the frame to run the preview on. This function is called when the user pressed the 'preview' button on the preview panel.

By default, the current frame is read from the image in the settings field using:

 () -> ( settings.imp.getFrame() - 1 )
 

Parameters:

frameSupplier - the frame supplier function. Cannot be null. Must return a valid frame number.

Returns:

this builder.

detectionSettingsSupplier

public DetectionPreview.Builder detectionSettingsSupplier(Supplier<Map<String,Object>> detectionSettingsSupplier)

Sets the supplier function that will return the detector settings to use for the preview. This function is called when the user pressed the 'preview' button on the preview panel.

Parameters:

detectionSettingsSupplier - the supplier function that will return the detector settings to use for the preview. Cannot be null. Must return a settings map valid for the detector set by detectorFactory(SpotDetectorFactoryBase).

Returns:

this builder.

thresholdUpdater

public DetectionPreview.Builder thresholdUpdater(DoubleConsumer thresholdUpdater)

Sets the consumer function that will be called with the threshold value sets by the user on the quality histogram. Setting it to null makes the histogram non-interactive.

Parameters:

thresholdUpdater - the consumer function called with the threshold value sets by the user on the quality histogram. If null then the histogram plot won't be interactive.

Returns:

this builder.

See Also:

thresholdTextField(JFormattedTextField)

thresholdTextField

public DetectionPreview.Builder thresholdTextField(JFormattedTextField ftf)

Sets the JFormattedTextField to update when the user changes the threshold value on the quality histogram.

Parameters:

ftf - the consumer formatted field that will be updated when the user sets the threshold value on the quality histogram.

Returns:

this builder.

See Also:

thresholdUpdater

axisLabel

public DetectionPreview.Builder axisLabel(String axisLabel)

Sets the axis label to appear on the histogram. By default: 'Quality histogram'.

Parameters:

axisLabel - the axis label to appear on the histogram

Returns:

this builder.

thresholdKey

public DetectionPreview.Builder thresholdKey(String thresholdKey)

Sets the key to the parameters that thresholds the quality values displayed on the histogram. If not-null and if this key can be found in the detector settings, then the quality histogram will display all quality values for all spots, and show the value above threshold with a marker.

By default it is DetectorKeys.KEY_THRESHOLD. Can be tuned to another value for detectors that threshold quality using another parameter. If the key does not exist in the detector settings, this is simply ignored.

Parameters:

thresholdKey - the parameter key to use for thresholding.

Returns:

this builder.

get

public DetectionPreview get()