org.hkijena.jipipe.extensions.python.algorithms

Class IteratingPythonScriptAlgorithm

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

org.hkijena.jipipe.extensions.python.algorithms.IteratingPythonScriptAlgorithm

All Implemented Interfaces:

JIPipeValidatable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

public class IteratingPythonScriptAlgorithm
extends JIPipeIteratingAlgorithm

An algorithm that allows to run Python code

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
IteratingPythonScriptAlgorithm(IteratingPythonScriptAlgorithm other) Creates a copy
IteratingPythonScriptAlgorithm(JIPipeNodeInfo info) Creates a new instance

Method Summary

Modifier and Type	Method and Description
JIPipeTextAnnotationMergeMode	getAnnotationMergeStrategy()
PythonScript	getCode()
OptionalPythonEnvironment	getOverrideEnvironment()
JIPipeDynamicParameterCollection	getScriptParameters()
boolean	isCleanUpAfterwards()
protected void	onDeserialized(com.fasterxml.jackson.databind.JsonNode node, JIPipeIssueReport issues, JIPipeNotificationInbox notifications) Override this method to add operations to be run after deserialization from JSON
void	reportValidity(JIPipeIssueReport report) Generates a validity report
protected void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setCleanUpAfterwards(boolean cleanUpAfterwards)
void	setCode(PythonScript code)
void	setOverrideEnvironment(OptionalPythonEnvironment overrideEnvironment)

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

generateDataBatchesDryRun, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getParallelizationBatchSize, isParallelizationEnabled, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, setParallelizationEnabled, supportsParallelization

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, 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, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, onSlotConnected, onSlotDisconnected, registerSubParameter, renderInputSlots, renderOutputSlots, setAllSlotsVirtual, 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

IteratingPythonScriptAlgorithm

public IteratingPythonScriptAlgorithm(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

IteratingPythonScriptAlgorithm

public IteratingPythonScriptAlgorithm(IteratingPythonScriptAlgorithm other)

Creates a copy

Parameters:

other - the info

Method Detail

isCleanUpAfterwards

public boolean isCleanUpAfterwards()

setCleanUpAfterwards

public void setCleanUpAfterwards(boolean cleanUpAfterwards)

getOverrideEnvironment

public OptionalPythonEnvironment getOverrideEnvironment()

setOverrideEnvironment

public void setOverrideEnvironment(OptionalPythonEnvironment overrideEnvironment)

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

Parameters:

report - the report to be added to

runIteration

protected void runIteration(JIPipeDataBatch dataBatch,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeIteratingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeIteratingAlgorithm

Parameters:

dataBatch - The data interface

progressInfo - the progress info from the run

setBaseDirectory

public void setBaseDirectory(Path baseDirectory)

Description copied from class: JIPipeGraphNode

Sets the current work directory of this algorithm. This is used internally to allow loading data from relative paths. This triggers a JIPipeGraphNode.BaseDirectoryChangedEvent that can be received by JIPipeDataSlot instances to adapt to the work directory.

Overrides:

setBaseDirectory in class JIPipeGraphNode

Parameters:

baseDirectory - The work directory. Can be null

getCode

public PythonScript getCode()

setCode

public void setCode(PythonScript code)

getScriptParameters

public JIPipeDynamicParameterCollection getScriptParameters()

getAnnotationMergeStrategy

public JIPipeTextAnnotationMergeMode getAnnotationMergeStrategy()

setAnnotationMergeStrategy

public void setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)

onDeserialized

protected void onDeserialized(com.fasterxml.jackson.databind.JsonNode node,
                              JIPipeIssueReport issues,
                              JIPipeNotificationInbox notifications)

Description copied from class: JIPipeGraphNode

Override this method to add operations to be run after deserialization from JSON

Overrides:

onDeserialized in class JIPipeGraphNode

Parameters:

node - the JSON node where the data was loaded

issues - issues during deserialization. if you want to notify the user about potential issues that can be acted upon, use the notification inbox

notifications - additional notifications for the user. these can be acted upon