Skip to content

Commit 4c2ada4

Browse files
authored
Create page for Timebar plugin
1 parent c3e77a1 commit 4c2ada4

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

_pages/plugins/timebar.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Timebar
3+
description: A time-stamper plugin for ImageJ/Fiji
4+
categories: [Image Annotation]
5+
source-url: https://github.com/remiberthoz/imagej-timebar
6+
source-label: GitHub
7+
license-url: /licensing/gpl
8+
license-label: GPLv3
9+
release-url: https://github.com/remiberthoz/imagej-timebar/releases/latest
10+
dev-status: Stable
11+
support-status: Active
12+
team-founders: Rémi Berthoz | https://github.com/remiberthoz
13+
team-developers: Rémi Berthoz | https://github.com/remiberthoz
14+
---
15+
16+
A time-stamper plugin for ImageJ/Fiji
17+
=====================================
18+
19+
This plugin is intended for stacks with a temporal dimension (2D+T, 3D+T, etc.).
20+
Frames in the time series will be decorated with a timestamp and, optionally, a progressing bar.
21+
22+
Here's a demo with the *Tracks for TrackMate* sample:
23+
24+
![A demo of the plugin](https://github.com/remiberthoz/imagej-timebar/blob/main/figure/Demo_FakeTracks.gif)
25+
26+
The plugin's menu entry is next to the Scalebar entry: `Analyze > Tools > Time Bar...`. The configuration window that opens lets the user chose a few options:
27+
28+
- [x] The progress bar can be disabled
29+
- [x] The time units can be replaced by symbols (ie: `3-23:15:42.695` instead of `3d23h15m42.695s`)
30+
- [x] The time format can be modified (`D-HH:MM:ss.SSS` or `D-HH:MM` or `HH:MM:ss` or `ss.SSS` and many more!)
31+
- [ ] A well suited time format is automatically selected based on the time interval and the total duration
32+
- [x] The time can be offset, such that the first frame displays a non-zero timecode (positive or negative)
33+
34+
And just like the scale bar :
35+
36+
- [x] The progress bar thickness can be changed
37+
- [x] The font can be made Bold or Serif, the font size can be changed
38+
- [x] The location can be modified (all four corners, or at the selection)
39+
- [x] Font and background color can be changed
40+
41+
The frame interval information is extracted from the image's metadata (`Image > Properties... > Frame interval`). Units in this field can be one of `h/hr/hrs/hour/hours` for hours, `m/min/minute/minutes` for minutes, `s/sec/second/seconds` for seconds, `ms/milisecond/miliseconds` for miliseconds.
42+
43+
## How to install
44+
45+
You can add this Plugin to your ImageJ/Fiji installation either by configuring an [Update Site](https://imagej.net/update-sites/) in ImageJ/Fiji, or by installing it manually.
46+
47+
**8 clicks procedure:** the easiest way is to use the Update Site.
48+
49+
- As stated in the [official ImageJ documentation](https://imagej.net/update-sites/following), you can navigate in ImageJ's menu to `Help > Update...`.
50+
- Then click on the `Manage update sites` button and the `Add update site` button.
51+
- This will add a blank entry in the table. You will have fill in the two first fields: `Name` can be set to anything of your choice (I would recommend `Timebar`), and `URL` must be set to `https://sites.imagej.net/Timebar/`.
52+
- Make sure that the checkbox is ticked, and close the dialog.
53+
- Fiji will now display the changes it has to perform to install the plugin. If the list is very long, I would recommend reading [this page](https://imagej.net/update-sites/following#choose-and-download-plugins) on ImageJ's wiki. Otherwise, simply click on `Apply changes`, restart ImageJ, and you're done.
54+
55+
**Manual installation**: even-though the procedure is described with less steps, it requires more autonomy from your side. With this method, you can install any version of the plugin, but it will no be updated automatically by ImageJ.
56+
57+
- Head on to the [Releases page](https://github.com/remiberthoz/imagej-timebar/releases) here on GitHub.
58+
- Download the `.jar` file for the latest version (or another one).
59+
- Copy this file into your ImageJ/Fiji plugins directory. This directory is located in your ImageJ/Fiji installation, but I cannot tell where that is as it depends on the systems.
60+
- Restart ImageJ, and you're done.
61+

0 commit comments

Comments
 (0)