Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #118

Merged
merged 6 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 84 additions & 81 deletions README.md

Large diffs are not rendered by default.

Binary file modified doc/screenshots/IJ-Config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-Export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-Import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenshots/IJ-MC-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenshots/IJ-MC-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-Menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-OC-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-OC-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-PC-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-PC-input.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-PC-predictions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-PC-segmentation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-Track-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenshots/IJ-Track-inputProb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/screenshots/IJ-Track-inputRaw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/screenshots/IJ-Track-inputSeg.png
Binary file not shown.
Binary file modified doc/screenshots/IJ-Track-output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/screenshots/IJ-Train-Checkbox.png
Binary file not shown.
Binary file removed doc/screenshots/IJ-Train-Console.png
Binary file not shown.
Binary file removed doc/screenshots/MC-output.png
Binary file not shown.
Binary file removed doc/screenshots/multicut-dialog.png
Binary file not shown.
16 changes: 13 additions & 3 deletions examples/import.ijm
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
#@ File (label = "Input file", style = "file") input
// input = "/absolute/path/to/some/directory/src/test/resources/2d_cells_apoptotic_1channel.h5";
// Lines that start with "//" are comments.

// Lines that start with "#@" declare input parameters that interactively ask the user for values.
// You can remove those lines and set input parameters explicitly in order to run the macro without further user interaction.

#@ File (label = "Input file", style = "directory") dataDir
// dataDir = "/absolute/path/to/some/directory/with/h5-files/";

datasetname = "/data";
axisorder = "tzyxc";

run("Import HDF5", "select=[" + input + "] datasetname=[" + datasetname + "] axisorder=[" + axisorder + "]");
fileList = getFileList(dataDir);
for (i = 0; i < fileList.length; i++) {
// import image from the H5
fileName = dataDir + fileList[i];
run("Import HDF5", "select=[" + fileName + "] datasetname=[" + datasetname + "] axisorder=[" + axisorder + "]");
}
19 changes: 19 additions & 0 deletions examples/multicut.ijm
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Lines that start with "//" are comments.

// Lines that start with "#@" declare input parameters that interactively ask the user for values.
// You can remove those lines and set input parameters explicitly in order to run the macro without further user interaction.

#@ File (label = "Project file", style = "file") project
// project = "/absolute/path/to/some/directory/multicut.ilp";

#@ File (label = "Input file", style = "file") input
// input = "/absolute/path/to/some/directory/raw_data.tif";

#@ File (label = "Second input file", style = "file") secondInput
// secondInput = "/absolute/path/to/some/directory/boundary_Probabilities.tif";

type = "Probabilities";

open(input);
open(secondInput);
run("Run Multicut", "projectfilename=[" + input + "] boundarypredictionimage=[" + secondInput +"]");
7 changes: 7 additions & 0 deletions examples/object_classification.ijm
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// Lines that start with "//" are comments.

// Lines that start with "#@" declare input parameters that interactively ask the user for values.
// You can remove those lines and set input parameters explicitly in order to run the macro without further user interaction.

#@ File (label = "Project file", style = "file") project
// project = "/absolute/path/to/some/directory/obj_class_2d_cells_apoptotic.ilp";

Expand All @@ -10,4 +15,6 @@
type = "Probabilities";

open(input);
open(secondInput);

run("Run Object Classification Prediction", "projectfilename=[" + project + "] input=[" + input + "] inputproborsegimage=[" + secondInput + "] secondinputtype=[" + type + "]");
38 changes: 32 additions & 6 deletions examples/pixel_classification.ijm
Original file line number Diff line number Diff line change
@@ -1,10 +1,36 @@
#@ File (label = "Project file", style = "file") project
// Lines that start with "//" are comments.

// Lines that start with "#@" declare input parameters that interactively ask the user for values.
// You can remove those lines and set input parameters explicitly in order to run the macro without further user interaction.

#@ File (label = "Project file", style = "file") pixelClassificationProject
// project = "/absolute/path/to/some/directory/pixel_class_2d_cells_apoptotic.ilp";

#@ File (label = "Input file", style = "file") input
// input = "/absolute/path/to/some/directory/2d_cells_apoptotic.tif";
#@ File (label = "Input file", style = "directory") dataDir
// dataDir = "/absolute/path/to/some/directory/";

// set global variables
outputType = "Probabilities"; // or "Segmentation"
inputDataset = "data";
outputDataset = "exported_data";
axisOrder = "tzyxc";
compressionLevel = 0;

// process all H5 files in a given directory
fileList = getFileList(dataDir);
for (i = 0; i < fileList.length; i++) {
// import image from the H5
fileName = dataDir + fileList[i];
importArgs = "select=" + fileName + " datasetname=" + inputDataset + " axisorder=" + axisOrder;
run("Import HDF5", importArgs);

type = "Probabilities";
// run pixel classification
inputImage = fileName + "/" + inputDataset;
pixelClassificationArgs = "projectfilename=" + pixelClassificationProject + " saveonly=false inputimage=" + inputImage + " pixelclassificationtype=" + outputType;
run("Run Pixel Classification Prediction", pixelClassificationArgs);

open(input);
run("Run Pixel Classification Prediction", "projectfilename=[" + project + "] input=[" + input + "] pixelclassificationtype=[" + type + "]");
// export probability maps to H5
outputFile = dataDir + "output" + i + ".h5";
exportArgs = "select=" + outputFile + " datasetname=" + outputDataset + " compressionlevel=" + compressionLevel;
run("Export HDF5", exportArgs);
}
20 changes: 20 additions & 0 deletions examples/tracking.ijm
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Lines that start with "//" are comments.

// Lines that start with "#@" declare input parameters that interactively ask the user for values.
// You can remove those lines and set input parameters explicitly in order to run the macro without further user interaction.

#@ File (label = "Project file", style = "file") project
// project = "/absolute/path/to/some/directory/tracking.ilp";

#@ File (label = "Input file", style = "file") input
// input = "/absolute/path/to/some/directory/raw_data.tif";

#@ File (label = "Second input file", style = "file") secondInput
// secondInput = "/absolute/path/to/some/directory/probabilities.tif";

type = "Probabilities";

open(input);
open(secondInput);

run("Run Tracking", "projectfilename=[" + project + "] input=[" + input + "] inputproborsegimage=[" + secondInput + "] secondinputtype=[" + type + "]");