Skip to content

Commit de796ca

Browse files
authored
Update FRETENATOR.md
Fix links, update plugin info, add extra info to frontmatter
1 parent 844a103 commit de796ca

1 file changed

Lines changed: 41 additions & 74 deletions

File tree

_pages/plugins/FRETENATOR.md

Lines changed: 41 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
11
---
22
title: FRETENATOR
3-
description: Fiji plugins for segmentation, quantification and ratiometric analysis of FRET biosensors. Includes a live updating GUI interface, a headless mode, a batch mode, object labelling, object classifier training and application and Trackmate 7 integration.
3+
description: Fiji plugins for segmentation, object classification, ratiometric analysis and intensiometric analysis. Includes a live updating GUI interface, a headless mode, a batch mode, object labelling, object classifier training and application and Trackmate 7 integration. This is under active development (as of 2026).
4+
update-site: FRETENATOR
5+
source-url: https://github.com/JimageJ/FRETENATOR2
6+
release-version: 2.5
7+
dev-status: Active
8+
support-status: Active
49
categories: [Segmentation, Ratiometric Imaging, 3D, Analysis]
510
---
11+
612
# FRETENATOR2- Comprehensive segmenation and ratiometric analysis
713

8-
Latest version of FRETENATOR segmentation and ratiometric analysis suite. This is currently under active development (2026 05 06).
14+
Fiji plugins for segmentation, object classification, ratiometric analysis and intensiometric analysis. Includes a live updating GUI interface, a headless mode, a batch mode, object labelling, object classifier training and application and Trackmate 7 integration. This is under active development with latest notes on this [github repository](https://github.com/JimageJ/FRETENATOR2) (as of 2026).
915

1016
New FRETENATOR2.5 implemented features:
1117

12-
* Improved user interface,
13-
* Background subtraction (Global mean or Local label based)
14-
* Pixel by pixel processing
15-
* Setting saving/reloading
16-
* Headless mode for batch
17-
* 2D image processing
18-
* WEKA based label classifier training, using graph features for context
19-
* WEKA based label classification
20-
* Re-editing and annotation through ROI labeller
21-
* Bug fixes
18+
* Improved user interface
19+
* Background subtraction (Global mean or Local label based)
20+
* Pixel by pixel processing
21+
* Segmentation settings saving/loading and importing from files
22+
* Headless mode for batch
23+
* 2D image processing
24+
* WEKA based label classifier training and classification, using graph features for context
25+
* Re-editing and annotation through ROI labeller
26+
* Help button linking to tutorials (this github readme)
27+
* Replaced default 'Max projection' with 'Average projection'
28+
* 32 bit emission ratio image outputs (no 1000X multiplied 16 bit images) with background now assigned as NaN allowing manual ROI quantification
29+
* Improved pixel by pixel processing - Z projections will be an average projection of the ratioed 3D image rather than Z sum projections ratioed
30+
* Quickload segmentation settings buttons
31+
* Bug fixes
32+
* Separate 'Segment and intensity' plugin implementation to quantify the intensity of each channel for every ROI.
2233

2334
Planned features:
24-
* Video tutorials of new interface/features
25-
* 32 bit emission ratio image outputs (no 1000X multiplication)
26-
* Quick segmentation settings button
27-
* Separate 'Segment and quantify' plugin implementation
35+
* Video tutorials of new interface/features
2836

2937
### **Installation**
3038

@@ -38,7 +46,7 @@ Install activating update sites:
3846
* Scroll down to I and make sure the IJPB is selected
3947
* Accept the dialogs, allow installation, then restart ImageJ
4048

41-
## **FRETENATOR2_Segment_and_ratio**
49+
## **_FRETENATOR2_Segment_and_ratio_**
4250

4351

4452
![nlsABACUS2 confocal image](https://github.com/JimageJ/FRETENATOR2/blob/main/imagefiles/image20.gif)
@@ -48,64 +56,23 @@ Install activating update sites:
4856

4957
## **Usage**:
5058

51-
*FN2 Segment and ratio* is a powerful plugin to quickly perform ratiometric analysis of 2D, 3D or 4D microscopy images, with an new user interface and a live updating preview. The plugin performs full 3D segmentation of images, which means you don't analyse background, and does all the analysis, ready for you to plot and interpret. The algorithm can be used to analyse punctate sensors (e.g. nuclear localised) on a per object basis, or diffuse sensors (e.g. cytoplasmic) on a pixel by pixel basis, with guideline settings below. Saturated pixels are automatically removed. Settings can be saved and used for headless processing, or even batch (alpha).
52-
53-
• Results Table: ◦ Includes the ratiometric calculation (emission ratio) your channel quantifications, and x, y, z positions. This can be saved as a .csv and then analysed in python, R or excel.
54-
55-
• Threshold map: ◦ An image of the initial thresholding use for analysis
56-
57-
• Label map: ◦ An image in which every nucleus is given a value that corresponds to the “label” in the results table.
58-
59-
• Emission ratio map: ◦ An image in which every nucleus is given the value of it’s emission ratio X 1000
60-
61-
• Max Z projected emission ratio map: ◦ A maximum Z projection of the emission ratio map
62-
63-
• Nearest point emission ratio map: ◦ A nearest point projection of the emission ratio map, with outlines added between the nuclei NB: the scale of this image is different to the original image and other images, allowing thin outlines to be drawn.
59+
*FN2 Segment and ratio* is a powerful plugin to quickly perform ratiometric analysis of 2D, 3D or 4D microscopy images, with an new user interface and a live updating preview. The plugin performs full 3D segmentation of images, which means you don't analyse background, and does all the analysis, ready for you to plot and interpret. The algorithm can be used to analyse punctate sensors (e.g. nuclear localised) on a per object basis, or diffuse sensors (e.g. cytoplasmic) on a pixel by pixel basis, with quickload settings buttons. Saturated pixels are automatically removed. Settings can be saved and used for headless processing, or even batch (alpha).
6460

65-
• Log: ◦ Details of the image file and exact analysis settings used to keep with your metadata. Savable as a .txt file
61+
• Results Table: ◦ Includes the ratiometric calculation (emission ratio) your channel quantifications, and x, y, z positions. This can be saved as a .csv and then analysed in python, R or excel.
62+
• Label map: ◦ An image in which every nucleus is given a value that corresponds to the “label” in the results table.
63+
• Emission ratio map: ◦ An image in which every nucleus is given the value of it’s emission ratio
64+
• Average Z projected emission ratio map: ◦ An average Z projection of the emission ratio map
65+
• Nearest point emission ratio map: ◦ A nearest point projection of the emission ratio map, with outlines added between the nuclei NB: the scale of this image is different to the original image and other images, allowing thin outlines to be drawn.
66+
• Log: ◦ Details of the image file and exact analysis settings used to keep with your metadata. Savable as a .txt file
6667

6768

68-
### **FN2 SEGMENT AND RATIO TUTORIAL**
69+
### **_FN2 Segment and ratio_ tutorial**
6970

70-
https://www.youtube.com/watch?v=OdPR_2kKuzg
71+
[On youtube.](https://www.youtube.com/watch?v=OdPR_2kKuzg)
7172

7273
### **Setting LUTs and making a colourbar**
7374

74-
https://www.youtube.com/watch?v=rTH1vWirORI
75-
76-
77-
78-
### **Settings for localised sensors, e.g. Nuclei**
79-
80-
81-
Switch on 'Difference of Gaussian instead of Gaussian'
82-
83-
Set the small DoG filter between 0.5-1.2, and the large DoG filter about half the diameter of a typical nucleus in pixels
84-
85-
Autosegmentation method : Otsu
86-
87-
Switch on 'Watershed Object splitting' if your nuclei are close together
88-
89-
Switch OFF 'Use pixel by pixel analysis' to allow quantification to be performed on a per object basis
90-
91-
Max intensity: 4094 for 12 bit images, 65534 for 16 bit images
92-
93-
94-
95-
### **Settings for diffuse sensors (e.g. cytoplasmic)**
96-
97-
98-
Switch OFF 'Difference of Gaussian instead of Gaussian'
99-
100-
Set the small DoG filter between 0.5-1.2 the large DoG filter isn't used
101-
102-
Autosegmentation method : Otsu
103-
104-
Switch OFF 'Watershed Object splitting'
105-
106-
Switch ON 'Use pixel by pixel analysis' to allow quantification to be performed on a per pixel basis
107-
108-
Max intensity: 4094 for 12 bit images, 65534 for 16 bit images
75+
[On youtube.](https://www.youtube.com/watch?v=rTH1vWirORI)
10976

11077

11178

@@ -127,34 +94,34 @@ The "nearest point Z projection" option has outline drawing between segmented ob
12794

12895
There are two background subtraction methods. Global mean subtraction, subtracts the average intensity of the are excluded from segmentation in each channel from each pixel before performing calculation - this is good for the global background signal that is present in many camera/detector types. Local label based subtraction will process each ROI object individually, subtracting the average intensity of nearby pixels in the excluded area surrounding it, which is good for global background as well as local background such as light scattering/autofluorescence.
12996

130-
## **FN2_SaR_Headless**
97+
## **_FN2_SaR_Headless_**
13198

13299
Uses the last saved settings of FRETENATOR2_Segment_and_ratio, and performs analysis without opening a dialog box (faster).
133100

134101

135-
## **FN_SaR_Batch (alpha)**
102+
## **_FN_SaR_Batch_ (alpha)**
136103

137104
*Currently only reliable when run from the script editor* Uses the last saved settings of FRETENATOR2_Segment_and_ratio, and performs analysis on all images in a user defined folder, then exports the analysis into another user defined folder.
138105

139106

140-
## **FN_ROI_Labeller (Beta)**
107+
## **_FN_ROI_Labeller_**
141108

142109
### Implementation and usage
143110

144111
A follow on tool for after segmentations where users can categorise the ROI in their segmented images. As a work in progress, it currently works on single timepoint 3D label images, allowing users to visually assign labels to one of 10 categories. Results are either output to an existing results table or can be used to measure a chosen image. ***Alpha functionality:*** In the latest version, time course analysis can be performed, but usage asumes the same label usage through time (making it compatable with Trackmate exported files - see below).
145112

146113
**Usage:**
147114
FRETENATOR ROI Labeller tutorial
148-
https://www.youtube.com/watch?v=EKXR4z5g8Pg
115+
[On youtube.](https://www.youtube.com/watch?v=EKXR4z5g8Pg)
149116

150-
## **FN_Trackmate_Bridge (Alpha)**
117+
## **_FN_Trackmate_Bridge_ (Alpha)**
151118

152119
A simple plugin to allow **Trackmate 7** analysed label images (Analyse the FRETENATOR label map for tracking then export the tracked label map as dots) to be combined with **FRETENATOR_Segment_and_ratio** output. This adds TrackIDs to the results table and creats a new TrackID labelmap that can be analysed with the ROI manager.
153120

154121
![Stomata](https://github.com/JimageJ/FRETENATOR2/blob/main/imagefiles/image29.gif)
155122
![Stomata ROI labeled image after tracking with Trackmate](https://github.com/JimageJ/ImageJ-Tools/blob/master/images/labeled%20stomata.gif)
156123

157-
## **FRETENATOR2_Segment_and_ratio_BT (Alpha)**
124+
## **_FRETENATOR2_Segment_and_ratio_BT_ (Alpha)**
158125

159126
A specialised version of FRETENATOR2_Segment_and_ratio, developed for Tang et al 2025, which measures the fluorescence of an additional channel, in a dilated area surrounding and including the original ROI. This allows nearby fluorescence to be quantified and is included on the results table. Please select 'Local Label Based' from the "Background Subtraction Method" to use this functionality. This will be added as a new column to the results table.
160127

0 commit comments

Comments
 (0)