maskLabel

Computes a masked image by applying a label mask to an image.

All pixel values x of image X will be copied to the destination image in case pixel value m at the same position in the label_map image has the right index value i.

f(x,m,i) = (x if (m == i); (0 otherwise))

Categories: Binary, Filter, Labels

Availability: Available in Fiji by activating the update sites clij and clij2. This function is part of clij2_-2.5.0.1.jar.

maskLabel often follows after

connectedComponentsLabeling (1)
create2D (1)

Usage in ImageJ macro

Ext.CLIJ2_maskLabel(Image source, Image label_map, Image destination, Number label_index);

Usage in object oriented programming languages

Java

// init CLIJ and GPU
import net.haesleinhuepf.clij2.CLIJ2;
import net.haesleinhuepf.clij.clearcl.ClearCLBuffer;
CLIJ2 clij2 = CLIJ2.getInstance();

// get input parameters
ClearCLBuffer source = clij2.push(sourceImagePlus);
ClearCLBuffer label_map = clij2.push(label_mapImagePlus);
destination = clij2.create(source);
float label_index = 1.0;

// Execute operation on GPU
clij2.maskLabel(source, label_map, destination, label_index);

// show result
destinationImagePlus = clij2.pull(destination);
destinationImagePlus.show();

// cleanup memory on GPU
clij2.release(source);
clij2.release(label_map);
clij2.release(destination);

Matlab

% init CLIJ and GPU
clij2 = init_clatlab();

% get input parameters
source = clij2.pushMat(source_matrix);
label_map = clij2.pushMat(label_map_matrix);
destination = clij2.create(source);
label_index = 1.0;

% Execute operation on GPU
clij2.maskLabel(source, label_map, destination, label_index);

% show result
destination = clij2.pullMat(destination)

% cleanup memory on GPU
clij2.release(source);
clij2.release(label_map);
clij2.release(destination);

Icy JavaScript

// init CLIJ and GPU
importClass(net.haesleinhuepf.clicy.CLICY);
importClass(Packages.icy.main.Icy);

clij2 = CLICY.getInstance();

// get input parameters
source_sequence = getSequence();
source = clij2.pushSequence(source_sequence);
label_map_sequence = getSequence();
label_map = clij2.pushSequence(label_map_sequence);
destination = clij2.create(source);
label_index = 1.0;

// Execute operation on GPU
clij2.maskLabel(source, label_map, destination, label_index);

// show result
destination_sequence = clij2.pullSequence(destination)
Icy.addSequence(destination_sequence);
// cleanup memory on GPU
clij2.release(source);
clij2.release(label_map);
clij2.release(destination);

clEsperanto Python (experimental)

import pyclesperanto_prototype as cle

cle.mask_label(source, label_map, destination, label_index)

Example scripts

intensity_per_label.ijm

Back to CLIJ2 reference Back to CLIJ2 documentation

Imprint