org.hkijena.jipipe.extensions.imagej2

Class ImageJ2OpNodeInfo

java.lang.Object

org.hkijena.jipipe.extensions.imagej2.ImageJ2OpNodeInfo

All Implemented Interfaces:

JIPipeNodeInfo

public class ImageJ2OpNodeInfo
extends Object
implements JIPipeNodeInfo

A JIPipeNodeInfo implementation that reads its information from an ImageJ2 Command

Constructor Summary

Constructors

Constructor and Description
ImageJ2OpNodeInfo(Context context, OpInfo opInfo, JIPipeProgressInfo progressInfo)

Method Summary

Modifier and Type	Method and Description
void	addInputSlotForModuleItem(ModuleItem<?> item, Class<? extends JIPipeData> dataClass)
void	addOutputSlotForModuleItem(ModuleItem<?> item, Class<? extends JIPipeData> dataClass)
JIPipeGraphNode	duplicate(JIPipeGraphNode algorithm) Copies an existing algorithm instance
List<String>	getAdditionalCitations() Returns a list of additional citations
JIPipeNodeTypeCategory	getCategory() Returns the algorithm category
Context	getContext()
Set<JIPipeDependency>	getDependencies() Returns all dependencies
HTMLText	getDescription() Returns the algorithm description
String	getId() Generates an Id for this info
Map<ModuleItem<?>,ImageJ2ModuleIO>	getInputModuleIO()
String	getInputSlotName(ModuleItem<?> moduleItem)
List<JIPipeInputSlot>	getInputSlots() Returns general input data.
Class<? extends JIPipeGraphNode>	getInstanceClass() The algorithm class that is generated
String	getMenuPath() Gets the menu path of this algorithm
String	getName() Returns the algorithm name
JIPipeDynamicParameterCollection	getNodeParameters()
OpInfo	getOpInfo()
DefaultJIPipeOutputSlot	getOrCreateParameterDataOutputSlot() Gets or creates the output slot for exported module parameters The slot has a data type ParametersData
Map<ModuleItem<?>,ImageJ2ModuleIO>	getOutputModuleIO()
String	getOutputSlotName(ModuleItem<?> moduleItem)
List<JIPipeOutputSlot>	getOutputSlots() Returns general output data.
boolean	hasParameterDataOutputSlot()
boolean	isHidden() Returns true if this algorithm should not appear in the list of available algorithms.
JIPipeGraphNode	newInstance() Creates a new node type instance

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.JIPipeNodeInfo

getAliases, getIcon, getIconURL, getPrimaryMenuLocation, getSortedList, groupByMenuPaths, hasInputSlot, hasOutputSlot, isRunnable

Constructor Detail

ImageJ2OpNodeInfo

public ImageJ2OpNodeInfo(Context context,
                         OpInfo opInfo,
                         JIPipeProgressInfo progressInfo)
                  throws InstantiableException

Throws:

InstantiableException

Method Detail

hasParameterDataOutputSlot

public boolean hasParameterDataOutputSlot()

getOrCreateParameterDataOutputSlot

public DefaultJIPipeOutputSlot getOrCreateParameterDataOutputSlot()

Gets or creates the output slot for exported module parameters The slot has a data type ParametersData

Returns:

the slot definition

addInputSlotForModuleItem

public void addInputSlotForModuleItem(ModuleItem<?> item,
                                      Class<? extends JIPipeData> dataClass)

addOutputSlotForModuleItem

public void addOutputSlotForModuleItem(ModuleItem<?> item,
                                       Class<? extends JIPipeData> dataClass)

getNodeParameters

public JIPipeDynamicParameterCollection getNodeParameters()

getId

public String getId()

Description copied from interface: JIPipeNodeInfo

Generates an Id for this info

Specified by:

getId in interface JIPipeNodeInfo

Returns:

The ID

getInstanceClass

public Class<? extends JIPipeGraphNode> getInstanceClass()

Description copied from interface: JIPipeNodeInfo

The algorithm class that is generated

Specified by:

getInstanceClass in interface JIPipeNodeInfo

Returns:

The algorithm class

newInstance

public JIPipeGraphNode newInstance()

Description copied from interface: JIPipeNodeInfo

Creates a new node type instance

Specified by:

newInstance in interface JIPipeNodeInfo

Returns:

Algorithm instance

duplicate

public JIPipeGraphNode duplicate(JIPipeGraphNode algorithm)

Description copied from interface: JIPipeNodeInfo

Copies an existing algorithm instance

Specified by:

duplicate in interface JIPipeNodeInfo

Parameters:

algorithm - Original algorithm instance

Returns:

Copied algorithm instance

getName

public String getName()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm name

Specified by:

getName in interface JIPipeNodeInfo

Returns:

The name

getDescription

public HTMLText getDescription()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm description

Specified by:

getDescription in interface JIPipeNodeInfo

Returns:

The description

getMenuPath

public String getMenuPath()

Description copied from interface: JIPipeNodeInfo

Gets the menu path of this algorithm

Specified by:

getMenuPath in interface JIPipeNodeInfo

Returns:

String containing menu entries separated by new-lines

getCategory

public JIPipeNodeTypeCategory getCategory()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm category

Specified by:

getCategory in interface JIPipeNodeInfo

Returns:

The category

getInputSlots

public List<JIPipeInputSlot> getInputSlots()

Description copied from interface: JIPipeNodeInfo

Returns general input data. Instances can have a configuration that is different from this configuration.

Specified by:

getInputSlots in interface JIPipeNodeInfo

Returns:

List of input slots

getOutputSlots

public List<JIPipeOutputSlot> getOutputSlots()

Description copied from interface: JIPipeNodeInfo

Returns general output data. Instances can have a configuration that is different from this configuration.

Specified by:

getOutputSlots in interface JIPipeNodeInfo

Returns:

List of output slots

getAdditionalCitations

public List<String> getAdditionalCitations()

Description copied from interface: JIPipeNodeInfo

Returns a list of additional citations

Specified by:

getAdditionalCitations in interface JIPipeNodeInfo

Returns:

additonal citations

getDependencies

public Set<JIPipeDependency> getDependencies()

Description copied from interface: JIPipeNodeInfo

Returns all dependencies

Specified by:

getDependencies in interface JIPipeNodeInfo

Returns:

List of dependencies

isHidden

public boolean isHidden()

Description copied from interface: JIPipeNodeInfo

Returns true if this algorithm should not appear in the list of available algorithms. This is useful if it is a structural algorithm

Specified by:

isHidden in interface JIPipeNodeInfo

Returns:

if this algorithm should not appear in the list of available algorithms

getInputModuleIO

public Map<ModuleItem<?>,ImageJ2ModuleIO> getInputModuleIO()

getOutputModuleIO

public Map<ModuleItem<?>,ImageJ2ModuleIO> getOutputModuleIO()

getOutputSlotName

public String getOutputSlotName(ModuleItem<?> moduleItem)

getInputSlotName

public String getInputSlotName(ModuleItem<?> moduleItem)

getOpInfo

public OpInfo getOpInfo()

getContext

public Context getContext()