org.hkijena.jipipe.extensions.clij2.datatypes

Class CLIJImageData

java.lang.Object

org.hkijena.jipipe.extensions.clij2.datatypes.CLIJImageData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData

public class CLIJImageData
extends Object
implements JIPipeData

Contains a CLIJ image

Constructor Summary

Constructors

Constructor and Description
CLIJImageData(net.haesleinhuepf.clij.clearcl.ClearCLBuffer image) Initializes a new instance from an existing buffer
CLIJImageData(CLIJImageData other) Makes a copy
CLIJImageData(ImagePlusData image) Initializes an instance by copying data from ImagePlusData

Method Summary

Modifier and Type	Method and Description
void	close()
JIPipeThumbnailData	createThumbnail(int width, int height, JIPipeProgressInfo progressInfo) This function generates a thumbnail for this data Can return null
void	display(String displayName, JIPipeWorkbench workbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
net.haesleinhuepf.clij.clearcl.ClearCLBuffer	getImage()
static CLIJImageData	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)
Component	preview(int width, int height) This function generates a preview component for usage within the GUI Can return null
ImagePlusData	pull() Extracts ImagePlusData from the GPU memory
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeData

exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, toDetailedString

Constructor Detail

CLIJImageData

public CLIJImageData(net.haesleinhuepf.clij.clearcl.ClearCLBuffer image)

Initializes a new instance from an existing buffer

Parameters:

image - the buffer

CLIJImageData

public CLIJImageData(ImagePlusData image)

Initializes an instance by copying data from ImagePlusData

Parameters:

image - the image

CLIJImageData

public CLIJImageData(CLIJImageData other)

Makes a copy

Parameters:

other - the original

Method Detail

importData

public static CLIJImageData importData(JIPipeReadDataStorage storage,
                                       JIPipeProgressInfo progressInfo)

exportData

public void exportData(JIPipeWriteDataStorage storage,
                       String name,
                       boolean forceName,
                       JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Saves the data to a folder

Specified by:

exportData in interface JIPipeData

Parameters:

storage - The storage where the data should be written

name - A name reference that can be used to generate filename(s)

forceName - If enabled, the data is saved potentially destructively. Generated files must always contain the name parameter. This is used to collect results for humans or other algorithms.

progressInfo - the progress

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JIPipeData

display

public void display(String displayName,
                    JIPipeWorkbench workbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Specified by:

display in interface JIPipeData

Parameters:

displayName - a name that can be used

workbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

preview

public Component preview(int width,
                         int height)

Description copied from interface: JIPipeData

This function generates a preview component for usage within the GUI Can return null

Specified by:

preview in interface JIPipeData

Parameters:

width - the target width

height - the target height

Returns:

the component or null if none should be available

createThumbnail

public JIPipeThumbnailData createThumbnail(int width,
                                           int height,
                                           JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

This function generates a thumbnail for this data Can return null

Specified by:

createThumbnail in interface JIPipeData

Parameters:

width - the width

height - the height

progressInfo - the progress info

Returns:

the thumbnail or null

pull

public ImagePlusData pull()

Extracts ImagePlusData from the GPU memory

Returns:

the ImagePlusData

getImage

public net.haesleinhuepf.clij.clearcl.ClearCLBuffer getImage()

toString

public String toString()

Overrides:

toString in class Object