org.hkijena.jipipe.extensions.imagej2.io

Interface ImageJ2ModuleIO

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, Service, Versioned

All Known Subinterfaces:

DataSlotModuleIO, ParameterModuleIO

All Known Implementing Classes:

BooleanParameterImageJ2ModuleInput, BooleanParameterImageJ2ModuleOutput, ByteArrayParameterImageJ2ModuleInput, ByteParameterImageJ2ModuleInput, ByteParameterImageJ2ModuleOutput, DatasetImageJ2ModuleInput, DatasetImageJ2ModuleOutput, DataSlotModuleInput, DataSlotModuleOutput, DoubleArrayParameterImageJ2ModuleInput, DoubleParameterImageJ2ModuleInput, DoubleParameterImageJ2ModuleOutput, FloatArrayParameterImageJ2ModuleInput, FloatParameterImageJ2ModuleInput, FloatParameterImageJ2ModuleOutput, ImagePlusImageJ2ModuleInput, ImagePlusImageJ2ModuleOutput, IntegerArrayParameterImageJ2ModuleInput, IntegerParameterImageJ2ModuleInput, IntegerParameterImageJ2ModuleOutput, IntervalImageJ2ModuleInput, IntervalImageJ2ModuleOutput, IterableImageJ2ModuleInput, LongArrayParameterImageJ2ModuleInput, LongParameterImageJ2ModuleInput, LongParameterImageJ2ModuleOutput, OutOfBoundsFactoryImageJ2ModuleInput, ParameterImageJ2ModuleInput, ParameterImageJ2ModuleOutput, RandomAccessibleImageJ2ModuleInput, RandomAccessibleImageJ2ModuleOutput, RealTypeParameterImageJ2ModuleInput, RealTypeParameterImageJ2ModuleOutput, ServiceImageJ2ModuleIO, ShapeImageJ2ModuleInput, ShortArrayParameterImageJ2ModuleInput, ShortParameterImageJ2ModuleInput, ShortParameterImageJ2ModuleOutput, StringArrayParameterImageJ2ModuleInput, StringParameterImageJ2ModuleInput, StringParameterImageJ2ModuleOutput

public interface ImageJ2ModuleIO
extends Service

An object that is responsible for transferring inputs and outputs between JIPipe slots/parameters and ImageJ2 parameters

Method Summary

Modifier and Type	Method and Description
Class<?>	getAcceptedModuleFieldClass() The class used to store data inside a module
boolean	handlesInput()
boolean	handlesOutput()
void	install(ImageJ2OpNodeInfo nodeInfo, ModuleItem<?> moduleItem) Applies changes to an ImageJ2OpNodeInfo required for this IO
void	install(ImageJ2OpNode node, ModuleItem<?> moduleItem) Applies changes to an ImageJ2OpNode required for this IO
boolean	transferFromJIPipe(ImageJ2OpNode node, JIPipeDataBatch dataBatch, ModuleItem moduleItem, Module module, JIPipeProgressInfo progressInfo) Transfers data from JIPipe into the module
boolean	transferToJIPipe(ImageJ2OpNode node, JIPipeDataBatch dataBatch, ParametersData moduleOutputParameters, ModuleItem moduleItem, Module module, JIPipeProgressInfo progressInfo) Transfers data from JIPipe from the module

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

getAcceptedModuleFieldClass

Class<?> getAcceptedModuleFieldClass()

The class used to store data inside a module

Returns:

the class

handlesInput

boolean handlesInput()

handlesOutput

boolean handlesOutput()

install

void install(ImageJ2OpNodeInfo nodeInfo,
             ModuleItem<?> moduleItem)

Applies changes to an ImageJ2OpNodeInfo required for this IO

Parameters:

nodeInfo - the node info

moduleItem - the module

install

void install(ImageJ2OpNode node,
             ModuleItem<?> moduleItem)

Applies changes to an ImageJ2OpNode required for this IO

Parameters:

node - the node info

moduleItem - the module

transferFromJIPipe

boolean transferFromJIPipe(ImageJ2OpNode node,
                           JIPipeDataBatch dataBatch,
                           ModuleItem moduleItem,
                           Module module,
                           JIPipeProgressInfo progressInfo)

Transfers data from JIPipe into the module

Parameters:

node - the JIPipe node

dataBatch - the data batch

moduleItem - the module item

module - the module

progressInfo - the progress info

Returns:

if successful

transferToJIPipe

boolean transferToJIPipe(ImageJ2OpNode node,
                         JIPipeDataBatch dataBatch,
                         ParametersData moduleOutputParameters,
                         ModuleItem moduleItem,
                         Module module,
                         JIPipeProgressInfo progressInfo)

Transfers data from JIPipe from the module

Parameters:

node - the JIPipe node

dataBatch - the data batch

moduleOutputParameters - the module output parameters

moduleItem - the module item

module - the module

progressInfo - the progress info

Returns:

if successful