Skip to content

Commit c7d664e

Browse files
authored
Update 4d-tools.md
v. 0.7 Added additional descriptions for added scripts and toolbar macro.
1 parent 507851e commit c7d664e

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

_pages/plugins/4d-tools.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: 4d Tools
33
description: 4d Tools is a set of macros/plugin for (1) import of legacy 4d datasets as movies (.MOV, .MP4, .AVI); (2) simplified import of Imaris .IMS and Micro-manager 1.4/2.0 datasets into Fiji; and (3) experimental playback of maximum-intensity projections on the fly as a crude attempt to recaptiulate legacy Perkin-Elmer UltraView software.
44
categories: [Import-Export,Stacks]
5-
release-date: August 23 2025
6-
release-version: 0.6.0
5+
release-date: September 1, 2025
6+
release-version: 0.7.0
77
dev-status: Active
88
support-status: Active
99
team-founders: "@jdhardin"
@@ -32,9 +32,11 @@ A "4d" submenu will be added to the "Import" menu in Fiji. Four items will be av
3232
1. **Classic 4d AVI to Hyperstack:** Imports a 4d AVI video as a Virtual Hyperstack. It looks for a plain text file with the same root name as video. If none is found the macro will ask for the number of focal planes.
3333
2. **Classic 4d Movie to Hyperstack:** Imports a 4d Quicktime .MOV or an MPEG4 .MP4 video as a 4d Virtual Hyperstack using FFMpeg. It looks for a plain text file with the same root name as the video. If none is found the macro will ask for the number of focal planes. FFmpeg is very versatile in terms of video formats; particularly valuable for classic QWuicktime movies, both MPEG will accept
3434
3. **Classic 4d Movie to Hyperstack Bio-Formats:** Imports a 4d Quicktime .MOV or an MPEG4 .MP4 video as a 4d Virtual Hyperstack using the Bio-Formats Importer built into Fiji. It looks for a plain text file with the same root name as the video. If none is found the macro will ask for the number of focal planes. NOTE #1: due to an issue with Bio-Formats virtual hyperstacks, the data is loaded into RAM. A warning dialog asks if this is OK. NOTE #2: For historical reasons, Bio-Formats focused on the Motion JPEG B codec (compression.decompression) format. Attempting to import MPEG A formatted video will throw an error.
35-
4. **Classic 4d Viewer to Hyperstack:** Imports classic 4d Viewer data (a folder of .MOV or .mov files) as a 4d Virtual Hyperstack using the Bio-Formats Importer built into Fiji. Rather than using the 4d Viewer info file, it simply counts the number of movie files, which are assumed to be the indivual focal planes. NOTE: this script only displays the movie data; displaying annotation/overlay information is not supported.
36-
5. **Imaris to Hyperstack:** Imports the highest-resolution dataset in an Imaris .IMS file (a variant of the HDF5 format) as a Virtual Hyperstack using the Bio-Formats Importer built into Fiji.
37-
6. **MM Images to Hyperstack:** Imports a Micro-Manager 1.4 or 2.0 dataset as a Virtual Hyperstack, using the metadata in the dataset.
35+
4. **Classic 4d Viewer to Hyperstack:** Imports classic 4d Viewer data (a folder of .MOV or .mov files) as a 4d Virtual Hyperstack using the Bio-Formats Importer built into Fiji. Rather than using the 4d Viewer info file, it simply counts the number of movie files, which are assumed to be the indivual focal planes. NOTE: this script only displays the movie data; displaying annotation/overlay information is not supported.
36+
5. **PE AVIs to Hyperstack:** Imports a series of AVIs exported from the old Perkin-Elmer UltraView LCI software into Fiji. The PE software doidn't pad the numbers in filenames with leading zeroes. Unless this is done prior to impoort misordering of images will occur. There ar emay platform-specific file renaming applications that will do this. For PE AVIs one easy way to pad filenames in Fiji is the [Pad Image Names macro tool](https://dev.mri.cnrs.fr/projects/imagej-macros/wiki/Pad_Image_Names).
37+
6. **PE TIFFs to Hyperstack:** Imports a TIFF data series geenrated using the old Perkin-Elmer UltraView LCI software into Fiji. This is actually just a wrapper for the [Bio-Formats Importer](https://imagej.net/formats/bio-formats) plugin with a couple of paramaters set via script.
38+
7. **Imaris to Hyperstack:** Imports the highest-resolution dataset in an Imaris .IMS file (a variant of the HDF5 format) as a Virtual Hyperstack using the Bio-Formats Importer built into Fiji.
39+
8. **MM Images to Hyperstack:** Imports a Micro-Manager 1.4 or 2.0 dataset as a Virtual Hyperstack, using the metadata in the dataset.
3840

3941
***Hyperstack Projector***
4042

@@ -68,18 +70,36 @@ A new "Hyperstack Projector" item will be added to the {% include bc path="Image
6870
4. A window with the focal plane and time point information should be visible.
6971
NOTE: this script only loads the movie data; annotation/overlay information is not supported.
7072

71-
### Imaris to Hyperstack
73+
### PE AVIs to Hyperstack
7274

73-
1. Select menu {% include bc path="Import|4d|Imaris to Hyperstack" %}.
74-
2. Specify the data file.
75-
3. The dataset will be loaded as a Virtual Hyperstack.
75+
1. Running the script will warn the user that the filenames must be numerically padded (...001.avi - ...010.avi, etc. vs. ..1.avi - ...010.avi). The PE software did not pad filenames. For PE AVIs one easy way to pad filenames in Fiji is the [Pad Image Names macro tool](https://dev.mri.cnrs.fr/projects/imagej-macros/wiki/Pad_Image_Names).
76+
2. Specify the first AVI.
77+
3. The script will examine filenames to guess if each AVI is a single focal plane over time or if it is a Z stack of a single time point and populate a dialog allowing the user to confirm the data structure.
78+
4. The dataset will be loaded as a Virtual Hyperstack.
79+
80+
### PE TIFFs to Hyperstack
81+
82+
1. Specify the first TIFF in the dataset.
83+
2. The dataset will be loaded as a Virtual Hyperstack.
7684

7785
### MM Images to Hyperstack
7886

7987
1. Select menu {% include bc path="Import|4d|MM Images to Hyperstack" %}.
8088
2. Specify the data directory.
8189
3. The dataset will be loaded as a Virtual Hyperstack.
8290

91+
### Imaris to Hyperstack
92+
93+
1. Select menu {% include bc path="Import|4d|Imaris to Hyperstack" %}.
94+
2. Specify the data file.
95+
3. The dataset will be loaded as a Virtual Hyperstack.
96+
97+
### Movie to Hyperstack macro tool
98+
99+
1. The Movie to Hypersrtack macro tool will be avialable as an option in the ImageJ toolbar (click the >> button to see a list of aviualble toolbars).
100+
2. Selecting "Movie to Hyperstack" will load the toolbar. Clicking the leftmost button provides easy selectino of the scripts in the {% include bc path="Import|4d" %} submenu.
101+
3. Mousing over the other buttons provides a description of the other buttons, which allow standard navigation through Hyperstacks fro the toolbar.
102+
83103
### Hyperstack Projector
84104

85105
1. With a 4d Hyperstack in the frontmost window, select menu {% include bc path="Import|Hyperstacks|Hyperstack Projector" %}.

0 commit comments

Comments
 (0)