org.hkijena.jipipe.extensions.imagejalgorithms.nodes

Class MacroWrapperAlgorithm

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

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.imagejalgorithms.nodes.MacroWrapperAlgorithm

All Implemented Interfaces:

JIPipeSlotConfiguration.SlotConfigurationChangedEventListener, JIPipeFunctionallyComparable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

public class MacroWrapperAlgorithm
extends JIPipeIteratingAlgorithm

An algorithm that wraps around an ImageJ macro

Nested Class Summary

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

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.BaseDirectoryChangedEventEmitter, JIPipeGraphNode.BaseDirectoryChangedEventListener, JIPipeGraphNode.NodeSlotsChangedEvent, JIPipeGraphNode.NodeSlotsChangedEventEmitter, JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeGraphNode.Serializer

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static Class<?>[]	ALLOWED_PARAMETER_CLASSES

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

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
MacroWrapperAlgorithm(JIPipeNodeInfo info)
MacroWrapperAlgorithm(MacroWrapperAlgorithm other) Copies the algorithm

Method Summary

Modifier and Type	Method and Description
ImageJMacro	getCode()
int	getExportDelay()
int	getImportDelay()
InputSlotMapParameterCollection	getInputToImageJExporters()
JIPipeDynamicParameterCollection	getMacroParameters()
OutputSlotMapParameterCollection	getOutputFromImageJImporters()
void	reportValidity(JIPipeValidationReportContext context, JIPipeValidationReport report) Generates a validity report
protected void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setCode(ImageJMacro code)
void	setExportDelay(int exportDelay)
void	setImportDelay(int importDelay)

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

createUIInputSlotIconDescriptionMenuItems, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, onParameterChanged, run

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

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

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

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDependencies, getDisplayName, getExternalEnvironments, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getNodeSlotsChangedEventEmitter, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDataDirs, getProjectDirectory, getRuntimeProject, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getTextDescription, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onDeserialized, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setRuntimeProject, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, setUiLocked, toggleSlot, toJson, updateGraphNodeSlots

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter

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.nodes.JIPipeAdaptiveParametersAlgorithm

installUIOverrideParameterEditor, installUIParameterOptions

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

emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, setParameter

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

generateValidityReport

Field Detail

ALLOWED_PARAMETER_CLASSES

public static Class<?>[] ALLOWED_PARAMETER_CLASSES

Constructor Detail

MacroWrapperAlgorithm

public MacroWrapperAlgorithm(JIPipeNodeInfo info)

Parameters:

info - the info

MacroWrapperAlgorithm

public MacroWrapperAlgorithm(MacroWrapperAlgorithm other)

Copies the algorithm

Parameters:

other - the original

Method Detail

getImportDelay

public int getImportDelay()

setImportDelay

public void setImportDelay(int importDelay)

getExportDelay

public int getExportDelay()

setExportDelay

public void setExportDelay(int exportDelay)

getInputToImageJExporters

public InputSlotMapParameterCollection getInputToImageJExporters()

getOutputFromImageJImporters

public OutputSlotMapParameterCollection getOutputFromImageJImporters()

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

reportValidity

public void reportValidity(JIPipeValidationReportContext context,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeAlgorithm

report - the report to be added to

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 ImageJMacro getCode()

setCode

public void setCode(ImageJMacro code)

getMacroParameters

public JIPipeDynamicParameterCollection getMacroParameters()