org.hkijena.jipipe.api.nodes

Class JIPipeAlgorithm

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

All Implemented Interfaces:

JIPipeFunctionallyComparable, JIPipeValidatable, JIPipeParameterCollection

Direct Known Subclasses:

DefineParametersAlgorithm, DefineParametersTableAlgorithm, DefineRectangularRoiAlgorithm, DefineTablesAlgorithm, ExportDataByParameter, ExtractParametersAlgorithm, FileDataSource, FileListDataSource, FilterByAnnotation, FolderDataSource, FolderListDataSource, FormGeneratorAlgorithm, GraphWrapperAlgorithm, ImageTypeConverter, IOInterfaceAlgorithm, IteratingFormProcessorAlgorithm, JIPipeParameterlessSimpleIteratingAlgorithm, JIPipeParameterSlotAlgorithm, MergeDataSlots, MergingFormProcessorAlgorithm, ModifyAndMergeTablesScript, OutputFolderDataSource, PathDataSource, PathListDataSource, SimpleIteratingFormProcessorAlgorithm, SplitByAnnotation, TablesFromScript

public abstract class JIPipeAlgorithm
extends JIPipeGraphNode

An JIPipeGraphNode that contains a non-empty workload. This class contains additional parameters to control the workload behavior. Please prefer to use this class or its derivatives if you write your algorithms.

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
JIPipeAlgorithm(JIPipeAlgorithm other) Creates a copy
JIPipeAlgorithm(JIPipeNodeInfo info) Initializes a new node type instance
JIPipeAlgorithm(JIPipeNodeInfo info, JIPipeSlotConfiguration slotConfiguration) Initializes a new node type instance and sets a custom slot configuration

Method Summary

Modifier and Type	Method and Description
protected boolean	canAutoPassThrough() Returns true if the algorithm can automatically apply pass-through This is only possible if there is at most one input and at most one output.
protected boolean	canPassThrough() Returns true if the algorithm can apply pass-through.
boolean	functionallyEquals(Object other) Returns true if this node and the other node are functionally equal (i.e. they have the same functional parameters).
JIPipeFixedThreadPool	getThreadPool()
boolean	isEnabled()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isPassThrough()
boolean	isPostprocessor() Indicates if the node should be run after all other nodes.
boolean	isPreprocessor() Indicates if the node should be run before all other nodes.
void	loadExample(JIPipeNodeExample example) Loads an example.
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	run(JIPipeProgressInfo progressInfo) Runs the workload
protected void	runPassThrough(JIPipeProgressInfo progressInfo) Runs the pass through.
void	setEnabled(boolean enabled)
void	setPassThrough(boolean passThrough)
void	setThreadPool(JIPipeFixedThreadPool threadPool) Sets the thread pool.

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

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, createUIInputSlotIconDescriptionMenuItems, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDataInputSlots, getDependencies, getDisplayName, getEventBus, getFirstInputSlot, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots

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, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JIPipeAlgorithm

public JIPipeAlgorithm(JIPipeNodeInfo info,
                       JIPipeSlotConfiguration slotConfiguration)

Initializes a new node type instance and sets a custom slot configuration

Parameters:

info - The algorithm info

slotConfiguration - The slot configuration

JIPipeAlgorithm

public JIPipeAlgorithm(JIPipeNodeInfo info)

Initializes a new node type instance

Parameters:

info - The algorithm info

JIPipeAlgorithm

public JIPipeAlgorithm(JIPipeAlgorithm other)

Creates a copy

Parameters:

other - the original

Method Detail

run

public void run(JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Specified by:

run in class JIPipeGraphNode

Parameters:

progressInfo - progress passed from the runner

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Parameters:

report - the report to be added to

runPassThrough

protected void runPassThrough(JIPipeProgressInfo progressInfo)

Runs the pass through. Override this for custom implementations if you want

Parameters:

progressInfo - the progress

canAutoPassThrough

protected boolean canAutoPassThrough()

Returns true if the algorithm can automatically apply pass-through This is only possible if there is at most one input and at most one output. Input must be compatible to the output.

Returns:

if the algorithm can automatically apply pass-through

canPassThrough

protected boolean canPassThrough()

Returns true if the algorithm can apply pass-through. Override this method to implement your own checks

Returns:

true if the algorithm can apply pass-through

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isPassThrough

public boolean isPassThrough()

setPassThrough

public void setPassThrough(boolean passThrough)

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 JIPipeGraphNode

Parameters:

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

access - the parameter

Returns:

if the parameter is visible inside the UI

functionallyEquals

public boolean functionallyEquals(Object other)

Description copied from class: JIPipeGraphNode

Returns true if this node and the other node are functionally equal (i.e. they have the same functional parameters). For non-functional nodes, this determines if the JIPipeNodeInfo is equal

Specified by:

functionallyEquals in interface JIPipeFunctionallyComparable

Overrides:

functionallyEquals in class JIPipeGraphNode

Parameters:

other - the other node

Returns:

if the nodes are functionally equal

isPreprocessor

public boolean isPreprocessor()

Indicates if the node should be run before all other nodes. Only applies if there is no input. Defaults to false.

Returns:

If the node should behave like a preprocessor.

isPostprocessor

public boolean isPostprocessor()

Indicates if the node should be run after all other nodes. Only applies if the output is not used or there is no output. Defaults to false

Returns:

If the node should behave like a postprocessor.

getThreadPool

public JIPipeFixedThreadPool getThreadPool()

setThreadPool

public void setThreadPool(JIPipeFixedThreadPool threadPool)

Sets the thread pool. Depending on the implementation, the pool is just ignored.

Parameters:

threadPool - can be null (forces single-threaded run)

loadExample

public void loadExample(JIPipeNodeExample example)

Loads an example. Warning: This method will not ask for confirmation

Parameters:

example - the example