org.hkijena.jipipe.api.nodes

Class JIPipeIteratingAlgorithm

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeIteratingAlgorithm

All Implemented Interfaces:

JIPipeValidatable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

Direct Known Subclasses:

AnalyzeSkeleton2D3DAlgorithm, AnnotateByImageStatisticsExpressionAlgorithm, AnnotateDataWithTableValues, AnnotateWithData, AnnotateWithOverlapMeasureLabelsAlgorithm, AutoThreshold2DAlgorithm, AverageKeyValueThresholdStatisticsGenerator, BitwiseLogicalOperationAlgorithm, BlendImagesAlgorithm, ChangeRoiNameFromExpressionsAndMeasurementsAlgorithm, ChangeRoiPropertiesFromExpressionsAlgorithm, ClassicWatershedSegmentationAlgorithm, Clij2ExecuteKernelIterating, CLIJCommandNode, Coloc2Node, ColorRoiByStatisticsAlgorithm, ConcatenatePaths, ConvolveByImage2DAlgorithm, CopyPath, CropToRoiAlgorithm, CustomAutoThreshold2D16UAlgorithm, CustomAutoThreshold2D32FAlgorithm, CustomAutoThreshold2D8UAlgorithm, DrawOvalRoiAlgorithm, DrawRectangleRoiAlgorithm, DrawScaleBarRoiAlgorithm, DrawTextRoiAlgorithm, ExportData, ExportImage2Algorithm, ExportImageAlgorithm, ExportROIAlgorithm, ExportTableAlgorithm, ExtractFromROIAlgorithm, ExtractImageInRoiAlgorithm, ExtractLabelStatisticsAlgorithm, FastKeyValueThresholdStatisticsGenerator, FilterAndMergeRoiByStatisticsScriptAlgorithm, FilterLabelsByMaskAlgorithm, FilterLabelsByOverlapAlgorithm, FilterLabelsByStatisticsAlgorithm, FilterROIByOverlapAlgorithm, FilterRoiByStatisticsAlgorithm, FilterRoiByStatisticsScriptAlgorithm, FollowSpotsPerTrackNode, GeodesicDistanceMap2DAlgorithm, GetRoiImageAlgorithm, GrayscaleAttributeFiltering2DAlgorithm, GrayscaleAttributeFiltering3DAlgorithm, ImageCalculator2DAlgorithm, ImageCalculator2DExpression, ImageJ2OpNode, ImageStatisticsAlgorithm, ImageStatisticsExpressionAlgorithm, ImportWekaModelFromFileAlgorithm, ImposeMaxima2DAlgorithm, ImposeMaxima3DAlgorithm, IteratingJythonScriptAlgorithm, IteratingPythonScriptAlgorithm, IteratingRScriptAlgorithm, IterativeThresholdByROIStatistics2DAlgorithm, KeyValueAveragesGenerator, KeyValueHistogramGenerator, KeyValueThresholdPartitionAveragesGenerator, KeyValueThresholdPartitionGenerator, KeyValueThresholdStatisticsGenerator, LocalImageCalculator2DExpression, MacroWrapperAlgorithm, MergeAnnotations, MergeChannelsAlgorithm, MergeImagesAlgorithm, MergeLabelsAlgorithm, MergeParametersAlgorithm, MergeSmallLabelsAlgorithm, MergeTableColumnsSupplementAlgorithm, MontageToStackAlgorithm, MorphologicalReconstruction2DAlgorithm, MorphologicalReconstruction3DAlgorithm, OMEImageFromImagePlus, OverlapMeasureLabelsAlgorithm, OverlayImagesAlgorithm, OverwriteAnnotations, PathsToJIPipeProjectParametersAlgorithm, ReferencedAppendRectangularRoiAlgorithm, ReferencedDefineRectangularRoiAlgorithm, RelativizePaths, RemoveBorderRoisAlgorithm, RoiFloodFillAlgorithm, RoiStatisticsAlgorithm, ROIToLabelsByNameAlgorithm, ROIToLabelsExpressionAlgorithm, RoiToMaskAlgorithm, RoiToRGBAlgorithm, RunProcessIteratingAlgorithm, SeededWatershedSegmentationAlgorithm, SetLUTFromImageAlgorithm, SetOverlayAlgorithm, SetRoiImageAlgorithm, SetRoiMetadataByStatisticsAlgorithm, SetROIMetadataFromTableAlgorithm, SimpleImageAndRoiIteratingAlgorithm, SortAndExtractRoiByStatisticsAlgorithm, SortAndExtractRoiByStatisticsAlgorithm2, SortRoiListByExpressionsAndMeasurementsAlgorithm, SplitRoiConnectedComponentsAlgorithm, SpotDetectorNode, SpotsToRGBNode, StackCombinerAlgorithm, StackToMontageAlgorithm, TrackingNode, TracksToRGBNode, TransformEqualizeDimensionsAlgorithm, TransformExpandCanvas2DAlgorithm, Warp2DAlgorithm, WekaClassification2DAlgorithm, WekaClassification3DAlgorithm, WekaTrainingLabels2DAlgorithm, WekaTrainingMask2DAlgorithm, WekaTrainingROI2DAlgorithm, WekaTrainingROI3DAlgorithm

public abstract class JIPipeIteratingAlgorithm
extends JIPipeParameterSlotAlgorithm
implements JIPipeParallelizedAlgorithm, JIPipeDataBatchAlgorithm, JIPipeAdaptiveParametersAlgorithm

An JIPipeAlgorithm that iterates through each data row. This algorithm utilizes the JIPipeDataBatch class to iterate through input data sets. It offers various parameters that control how data sets are matched. If your algorithm only has one input and will never have more than one input slot, we recommend using JIPipeSimpleIteratingAlgorithm instead that comes without the additional data set matching strategies

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

JIPipeAlgorithm.StateSerializer

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.Serializer

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

Fields inherited from class org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
JIPipeIteratingAlgorithm(JIPipeIteratingAlgorithm other) Copies the algorithm
JIPipeIteratingAlgorithm(JIPipeNodeInfo info) Creates a new instance
JIPipeIteratingAlgorithm(JIPipeNodeInfo info, JIPipeSlotConfiguration slotConfiguration) Creates a new instance

Method Summary

Modifier and Type	Method and Description
List<JIPipeMergingDataBatch>	generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo) Generates data batches.
JIPipeAdaptiveParameterSettings	getAdaptiveParameterSettings()
JIPipeIteratingAlgorithmDataBatchGenerationSettings	getDataBatchGenerationSettings()
JIPipeDataBatchGenerationSettings	getGenerationSettingsInterface() Returns the batch generation settings as interface
int	getParallelizationBatchSize() Returns how many threads the actual algorithm requires.
boolean	isParallelizationEnabled()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter) Allows to override the visibility of sub-parameters inside the UI
protected abstract void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	runParameterSet(JIPipeProgressInfo progressInfo, List<JIPipeTextAnnotation> parameterAnnotations) Runs a parameter set iteration
protected void	runPassThrough(JIPipeProgressInfo progressInfo, JIPipeDataBatch dataBatch) A pass-through variant for iterating algorithms.
void	setParallelizationEnabled(boolean parallelizationEnabled) User-defined parameter to control if parallelization is enabled
boolean	supportsParallelization() Indicates to the algorithm base implementation if parallelization is supported.

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, run

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

canAutoPassThrough, canPassThrough, getStateId, getThreadPool, isEnabled, isPassThrough, isPostprocessor, isPreprocessor, loadExample, reportValidity, runPassThrough, setEnabled, setPassThrough, setThreadPool

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDependencies, getDisplayName, getEventBus, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDirectory, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, onSlotConnected, onSlotDisconnected, registerSubParameter, renderInputSlots, renderOutputSlots, setAllSlotsVirtual, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots, updateSlotInheritance

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JIPipeIteratingAlgorithm

public JIPipeIteratingAlgorithm(JIPipeNodeInfo info,
                                JIPipeSlotConfiguration slotConfiguration)

Creates a new instance

Parameters:

info - Algorithm info

slotConfiguration - Slot configuration override

JIPipeIteratingAlgorithm

public JIPipeIteratingAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - Algorithm info

JIPipeIteratingAlgorithm

public JIPipeIteratingAlgorithm(JIPipeIteratingAlgorithm other)

Copies the algorithm

Parameters:

other - The original

Method Detail

getGenerationSettingsInterface

public JIPipeDataBatchGenerationSettings getGenerationSettingsInterface()

Description copied from interface: JIPipeDataBatchAlgorithm

Returns the batch generation settings as interface

Specified by:

getGenerationSettingsInterface in interface JIPipeDataBatchAlgorithm

Returns:

batch generation settings as interface

generateDataBatchesDryRun

public List<JIPipeMergingDataBatch> generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots,
                                                              JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeDataBatchAlgorithm

Generates data batches. This is a dry-run function that should never throw errors

Specified by:

generateDataBatchesDryRun in interface JIPipeDataBatchAlgorithm

Parameters:

slots - the data slots

progressInfo - the progress

Returns:

the batches

runPassThrough

protected void runPassThrough(JIPipeProgressInfo progressInfo,
                              JIPipeDataBatch dataBatch)

A pass-through variant for iterating algorithms. Passes the data batch to the single output

Parameters:

progressInfo - progress info

dataBatch - the data batch

runParameterSet

public void runParameterSet(JIPipeProgressInfo progressInfo,
                            List<JIPipeTextAnnotation> parameterAnnotations)

Description copied from class: JIPipeParameterSlotAlgorithm

Runs a parameter set iteration

Specified by:

runParameterSet in class JIPipeParameterSlotAlgorithm

Parameters:

progressInfo - progress info from the run

parameterAnnotations - parameter annotations

getAdaptiveParameterSettings

public JIPipeAdaptiveParameterSettings getAdaptiveParameterSettings()

Specified by:

getAdaptiveParameterSettings in interface JIPipeAdaptiveParametersAlgorithm

getDataBatchGenerationSettings

public JIPipeIteratingAlgorithmDataBatchGenerationSettings getDataBatchGenerationSettings()

supportsParallelization

public boolean supportsParallelization()

Description copied from interface: JIPipeParallelizedAlgorithm

Indicates to the algorithm base implementation if parallelization is supported. Use this function to indicate to the algorithm to conditionally enable/disable parallelization.

Specified by:

supportsParallelization in interface JIPipeParallelizedAlgorithm

Returns:

If the algorithm supports automated parallelization.

getParallelizationBatchSize

public int getParallelizationBatchSize()

Description copied from interface: JIPipeParallelizedAlgorithm

Returns how many threads the actual algorithm requires. Based on this value, the base algorithm creates batches.

Specified by:

getParallelizationBatchSize in interface JIPipeParallelizedAlgorithm

Returns:

number of threads used by the workload

isParallelizationEnabled

public boolean isParallelizationEnabled()

Specified by:

isParallelizationEnabled in interface JIPipeParallelizedAlgorithm

Returns:

if parallelization is enabled by user

setParallelizationEnabled

public void setParallelizationEnabled(boolean parallelizationEnabled)

Description copied from interface: JIPipeParallelizedAlgorithm

User-defined parameter to control if parallelization is enabled

Specified by:

setParallelizationEnabled in interface JIPipeParallelizedAlgorithm

Parameters:

parallelizationEnabled - if parallelization is enabled

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterCollection subParameter)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of sub-parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeParameterSlotAlgorithm

Parameters:

tree - the parameter tree that is used to access this parameter

subParameter - a sub parameter

Returns:

if the parameter is visible inside the UI

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeAlgorithm

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

runIteration

protected abstract void runIteration(JIPipeDataBatch dataBatch,
                                     JIPipeProgressInfo progressInfo)

Runs code on one data row

Parameters:

dataBatch - The data interface

progressInfo - the progress info from the run