BioGTK 5.1.1

dotnet add package BioGTK --version 5.1.1
NuGet\Install-Package BioGTK -Version 5.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BioGTK" Version="5.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BioGTK --version 5.1.1
#r "nuget: BioGTK, 5.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BioGTK as a Cake Addin
#addin nuget:?package=BioGTK&version=5.1.1

// Install BioGTK as a Cake Tool
#tool nuget:?package=BioGTK&version=5.1.1

BioGTK

BioGTK

A .NET application & library for editing & annotating various microscopy image formats. Supports all bioformats supported images. Integrates with ImageJ, running ImageJ filters & macro functions. Check out the wiki for library usage. or check out the documentation. Supports Windows, Linux and Mac. For Windows & Mac see installation instructions. For Discussion check out the new Discord Server. https://discord.gg/tdeyc6fgpv

NuGet version (BioGTK) NuGet version (BioGTK) DOI

Features

  • C# scripting with sample tool-script and other sample scripts in "/Scripts/" folder. See samples.

  • Supports running ImageJ macro commands on images open in Bio. Console to run ImageJ macro commands and Bio C# scripts.

  • Supports viewing & creating pyramidal images with multiple resolutions. Like whole slide images.

  • Stitch images at varying resolutions into single pyramidal image with multiple resolutions.

  • Multiple view modes like Emission, and Filtered. ROI's shown for each channel can be configured in ROI Manager.

  • Supports drawing shapes & colors onto 16 bit & 48 bit images, unlike System.Drawing.Graphics.

  • Convenient viewing of image stacks with scroll wheel moving Z-plane and mouse side buttons scrolling C-planes.

  • Editing & saving ROI's in images to OME format image stacks.

  • Copy & Paste to quickly annotate images and name them easily by right click.

  • Select multiple points by holding down control key, and move them by holding down control key.

  • Exporting ROI's from each OME image in a folder of images to CSV.

  • Easy segmentation with Segment Anything (SAM). Required model files downloadable from Releases.

Dependencies

Scripting

  • Save scripts into "StartupPath/Scripts" with ".cs" ending.
  • Open script editor and recorder from menu.
  • Scripts saved in Scripts folder will be loaded into script runner.
  • Use Script recorder to record program function calls and script runner to turn recorder text into working scripts. (See sample scripts

Plugins

  • Save plugin DLL's into "StartupPath/Plugins"
  • Add plugins from Github repositories by clicking Update and add the url of the repository which you want to add.
  • See example plugin to create your own plugins.
  • Add the BioGTK plugin repository "https://github.com/BiologyTools/BioGTK-Plugins" to your updater list.

Models

  • Save models into "StartupPath/Models" supports BioImage.IO models.
  • Supports ONNX (".onnx") and PyTorch models (".pt"). For PyTorch models include the ".yaml" metadata file with the same name as the model file in the models folder.

Mac Installation

  • Install Mac package manager homebrew.
  • From brew install GTK3.
  • Download the BioGTK application for either OSX-x64 or OSX-Arm from releases.
  • Make the .app bundle executable by opening terminal in the Contents/MacOS folder then run "chmod 755 BioGTKApp"
  • Optionally install OpenSlide for better navigation of whole-slide-images.
  • Optionally install LibVips for increased performance and functions with whole-slide-images.
  • Optionally for SAM install ONNX Runtime by running "brew install onnxruntime".

Windows Installation

  • Install package manager MSYS2. to install package GTK3. (Required for GTK Apps.)
  • Download the BioGTK Windows installer from releases.
  • Optionally install OpenSlide for better navigation of whole-slide-images. Be sure to set the PATH variable correctly.

Linux Installation

  • Download the latest tarball(tar.gz) from Releases as linux already includes GTK3 package.
  • Extract the tarball and go to the "Glade" folder and select all the glade files and change permissions to read-write.
  • Optionally install LibVips for increased performance and functions with whole-slide-images.
  • Optionally install OpenSlide for better navigation of whole-slide-images.

Examples

First you need to setup your project as a GTK project with .NET 8.0 as the target. Then in between Gtk.Application.Init() and Gtk.Application.Run() use the library as you please. Here is an example for opening a new NodeView from BioGTKApp program.cs.

Console.WriteLine("Initializing GTK.");
Gtk.Application.Init();
Console.WriteLine("Creating NodeView.");
BioGTK.NodeView node = BioGTK.NodeView.Create(args);
node.Show();
Gtk.Application.Run();

Another example on how to open an image with a new ImageView

Gtk.Application.Init();
//Since we will be using the GUI we call App.Initialize();
App.Initialize();
BioImage bm = BioImage.OpenFile("F:\\TESTIMAGES\\CZI\\16Bit-ZStack.czi");
ImageView v = ImageView.Create(bm);
v.Show();
Gtk.Application.Run();

Usage

//If you want to initialize the application call app initialize. 
//This will initialize Bioformats library as well as the rest of the application.
App.Initialize();

//Or you can create a new NodeView which will initialize the application
//as well as parse any command line arguments.
NodeView nodes = NodeView.Create(new string[]{"file"});

//You can also call BioImage.Initialize to 
//initialize just the Bioformats library.
BioImage.Initialize();

//Once initialized you can open OME, ImageJ tiff files, and Bio Tiff files with:
BioImage b = BioImage.OpenFile("file");

//Or if you want to use specifically the OME image reader you can use BioImage.OpenOME
BioImage b = BioImage.OpenOME("file");

//If you are working with a pyramidal image you can open a portion of a tiled image with OpenOME.
//BioImage.OpenOME(string file, int serie, bool tab, bool addToImages, bool tile, int tilex, int tiley, int tileSizeX, int tileSizeY)

//You can specify whether to open in a newtab as well as whether to add the image to 
//the Images.images table. As well as specify whether to open as a tile with the specified 
//tile X,Y position & tile width & height.    
BioImage.OpenOME("file",0,false,false,true,0,0,600,600);
//This will open a portion of the image as a tile and won't add it to the Images table.

//Once you have opened a tiled image with BioImage.OpenOME you can call the 
//GetTile(BioImage b, ZCT coord, int serie, int tilex, int tiley, int tileSizeX, int tileSizeY) method
// to quickly get another tile from different portion of the image. For BioGTK & BioLib
Bitmap bm = GetTile(b, new ZCT(0,0,0), 0, 100, 100, 600, 600);

//You can display an image with the ImageView control which can display
// Pyramidal, Whole-Slide, and Series of images.
ImageView v = ImageView.Create(b);

//To get the current coordinate of the ImageView you can call GetCoordinate.
ZCT cord = v.GetCoordinate();
//or to set the current coordinate
v.SetCoordinate(new ZCT(1,1,1));

//To create a point as well as any other ROI type you can call the ROI create methods.
ROI p = ROI.CreatePoint(cord, 0, 0);
ROI rect = ROI.CreateRectangle(cord, 0, 0, 100, 100);

//Usage of Graphics class for 16 & 48 bit images as well as regular bit depth images
//is very similar to System.Graphics.
//We create a new Graphics object by passing the Bitmap for BioGTK & BioLib and BufferInfo for BioCore
Graphics g = Graphics.FromImage(b.Buffers[0]);

//Then we create a pen by passing a ColorS which represent a Color with, 
//a higher bit depth (unsigned short) rather than a byte.
g.pen = new Pen(new ColorS(ushort.MaxValue, ushort.MaxValue, ushort.MaxValue));

//Then we can call the familiar methods DrawLine, DrawPolygon, FillPolygon etc.
g.DrawLine(0,0,100,100);
//Finally we dispose the Graphics object.
g.Dispose();

//Then to update the image in the viewer once we have made changes to the image we call:
v.UpdateImage();
//This will update the images of the viewer in the current coordinate plane.
v.UpdateView();

//We can also save the resulting image given the ID of the image in the Images table.
//All images opened with BioImage.OpenFile or BioImage.OpenOME are added to the 
//Images.images table with the filename as an ID.
BioImage.SaveFile("file","path");

//To convert between different pixel formats we can call for example To24Bit.
b.To24Bit();

Sample Plugin

using AForge;
using BioGTK;
using Gdk;
using Gtk;
using SkiaSharp.Views.Desktop;
namespace PluginExample
{
    public class PluginExample : BioGTK.Plugin.IPlugin
    {
        public string Name => "PluginExample";
        public string MenuPath => "Tools/" + Name + ".dll";
        public bool ContextMenu => false;
        public void Execute(string[] args)
        {
        }
        public void KeyUpEvent(object o, KeyPressEventArgs e)
        {
        }
        public void KeyDownEvent(object o, KeyPressEventArgs e)
        {
        }
        public void ScrollEvent(object o, ScrollEventArgs args)
        {
        }
        public void Render(object sender, SKPaintSurfaceEventArgs e)
		{
		}
        public void MouseMove(object o, PointD e, MotionNotifyEventArgs buts)
        {
        }
        public void MouseUp(object o, PointD e, ButtonReleaseEventArgs buts)
        {
        }
        public void MouseDown(object o, PointD e, ButtonPressEventArgs buts)
        {
        }
        
    }
}

Sample Tool Script

//css_reference BioGTK.dll; 
using System; 
using BioGTK;
using System.Threading;
using AForge;
using Gdk;
public class Loader {

//Point ROI Tool Example
public string Load()
{
	int ind = 1;
	do
	{
		BioGTK.Scripting.State s = BioGTK.Scripting.GetState();
		if (s != null)
		{
			if (!s.processed)
			{
				if (s.type == BioGTK.Scripting.Event.Down && s.buts == 1)
				{
					ZCT cord = BioGTK.App.viewer.GetCoordinate();
					BioGTK.Scripting.LogLine(cord.ToString() + " Coordinate");
					BioGTK.ROI an = BioGTK.ROI.CreatePoint(cord, s.p.X, s.p.Y);
					BioGTK.ImageView.SelectedImage.Annotations.Add(an);
					BioGTK.Scripting.LogLine(cord.ToString() + " Coordinate");
					an.Text = "Point" + ind;
					ind++;
					BioGTK.Scripting.LogLine(s.ToString() + " Point");
				}
				else
				if (s.type == BioGTK.Scripting.Event.Up)
				{
					BioGTK.Scripting.LogLine(s.ToString());
				}
				else
				if (s.type == BioGTK.Scripting.Event.Move)
				{
					BioGTK.Scripting.LogLine(s.ToString());
				}
				if(s.key == Key.r)
				{
					BioGTK.Scripting.LogLine("KeyDown");
				}
				s.processed = true;
			}
		}
		if(BioGTK.Scripting.Exit("test.cs"))
		{	
			return "OK";
		}
	} while (true);
	return "OK";
}
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.1.1 50 5/7/2024
5.1.0 46 4/29/2024
5.0.1 54 4/21/2024
5.0.0 48 4/17/2024
4.9.0 69 3/8/2024
4.8.1 52 3/6/2024
4.8.0 97 3/6/2024
4.7.1 89 2/27/2024
4.7.0 74 2/25/2024
4.6.0 96 2/19/2024
4.5.2 96 2/17/2024
4.5.1 93 2/15/2024
4.5.0 99 2/13/2024
4.4.0 97 2/10/2024
4.3.0 79 2/2/2024
4.2.0 139 1/14/2024
4.1.0 159 1/4/2024
4.0.0 120 12/26/2023
3.9.1 115 12/2/2023
3.9.0 97 12/1/2023
3.8.1 122 11/8/2023
3.8.0 94 11/2/2023
3.7.1 242 10/26/2023
3.7.0 258 10/22/2023
3.6.2 265 8/30/2023
3.6.1 268 8/22/2023
3.6.0 316 8/19/2023
3.5.3 240 8/17/2023
3.5.1 296 8/12/2023
3.5.0 418 8/10/2023
3.4.0 306 8/6/2023
3.3.3 371 8/4/2023
3.3.2 322 8/1/2023
3.3.1 344 7/6/2023
3.3.0 305 7/4/2023
3.2.0 337 6/29/2023
3.1.1 262 6/28/2023
3.0.0 249 6/20/2023
2.9.0 275 6/13/2023
2.8.0 240 5/15/2023
2.7.2 277 5/5/2023
2.7.1 290 4/29/2023
2.7.0 274 4/29/2023
2.6.2 432 4/3/2023
2.6.1 391 4/1/2023
2.6.0 395 3/12/2023
2.5.0 435 3/7/2023
2.4.1 371 3/4/2023
2.4.0 490 2/28/2023
2.3.0 458 2/27/2023
2.2.0 234 2/23/2023
2.1.1 212 2/17/2023
2.1.0 226 2/15/2023
1.2.0 273 1/31/2023
1.1.0 254 1/29/2023
1.0.0 258 1/29/2023

Multi page tiff bug fix. As well as better Bioimage.IO model support.