Applications
IMPORTANT NOTICE
Dear user, if you own a permanent Imaris license (versions 10.0 or 10.1) you must re-Install the Imaris licenses. The re-install process consists of 3 simple steps:
If you re-Install your licenses before 7 Sep 2024 they will continue working as normal. If you don’t, Imaris license will temporarily stop working from 8 Sep 2024 until you follow the above-mentioned steps.
Welcome to our frequently asked questions page, please find answers to commonly asked questions here covering topics including Hardware, License and Installation, File Import/Export, Visualisation, Analysis, Imaris XT, Settings and Troubleshooting. If your question isn't answered on this page please contact our customer support team, who will be happy to assist you further.
Since Version 10.0
The graphics card and its driver are crucial for the stability and performance of Imaris.
Please check our System Requirements for supported graphics cards. And please update the driver regularly, at least every time you install a new Imaris version.
If you plan to work with large time series we recommend investing in more than 6 GB of graphics RAM. This will allow the graphics card to cache all textures for the display so you can browse much faster through the frames.
For deconvolution, GPU processing is supported on AMD and NVIDIA cards. NVIDIA is preferred because of better performance with CUDA.
Since Version 10.2
Imaris has been improved to run interactive on high resolution monitors. The interactivity may be compromised due to the higher rendering calculation requirement.
Up to Version 10.1
While you can run Imaris with high resolution monitor, the interactivity may be compromised due to the higher rendering calculation requirement.
Since Version 9.3
Imaris implemented GPU-accelerated calculation for the ClearView deconvolution function.
GPU processing is supported on both AMD and NVIDIA cards. NVIDIA is preferred because of better performance with CUDA.
The image size that Imaris can handle is not limited by RAM. If the data size/calculation requirement exceeds computer RAM, Imaris performs data caching to a hard drive.
However, data caching can slow down the processing speed. For better performance, we recommend having RAM at least twice the size of your image file.
The image size that Imaris Stitcher can handle is RAM limited. The minimum RAM requirement is around ten times the size of the largest volume overlap region. For additional Stitcher technical implementation details, please see here.
Since Version 9.3
Please check System Requirements for the latest information on hardware and operating systems.
As a rule of thumb the Minimum System works for datasets within 1GB, Recommended System for datasets up to ~5 GB, and High End System for dataset 10 GB or above. The requirement may vary depending on the file shape (i.e. long time lapse or large 3D volume) and the analysis workflow.
Please contact Imaris Support if you would like to discuss your specific need.
Since Version 10.1
Imaris is a multi-threaded application and many of the processing functions make effective use of multiple CPU cores. While we are working on optimizing algorithms to utilize the full power of multi-core systems with each new release, there remain some steps that are not yet fully multi-threaded. Thus, we recommend a balance between CPU speed and number of cores.
In general, we recommend fast (3.3 GHz+) CPUs with 16 cores (32 threads) or higher. Tested up to 32 cores (64 threads). Please check our System Requirements.
Since Versions 7.0 - 9.9
Imaris is a multi-threaded application and many of the processing functions make effective use of multiple CPU cores. While we are working on optimizing algorithms to utilize the full power of multi-core systems with each new release, there remain some steps that are not yet fully multi-threaded. Thus, we recommend a balance between CPU speed and number of cores.
In general, we recommend fast (3 GHz+) CPUs with eight cores (16 threads) or higher. Please check our System Requirements.
If your multi-core CPU is not running at 100% in Windows Task Manager, not all cores are used.
It may be due to (1) the calculation is not fully multi-threaded, or (2) Imaris may need to load image data from the disk into RAM for processing. In general, disk access in Imaris will only use one thread per disk.
Since Version 9.3
If you are using Windows 10 Build 1903 and newer, you can use Imaris in Windows Remote Desktop session (RDP) assuming you have a dedicated 3D NVIDIA or AMD card.
For earlier Windows 10 build (180x and earlier) or Windows 7/8 or 8.1 the only way to get Imaris working in RDP sessions is to use an NVIDIA Quadro M-Series or newer (e.g., M4000, P4000). The Quadro card driver supports OpenGL independent of the Windows version.
There are other remote desktop solutions (TeamViewer, Anydesk, etc.) that do not rely on OpenGL and may work for your system.
Please consult your IT department before installing remote desktop solutions as there might be network restrictions in place.
Please check Imaris Packages for the package feature comparison.
To explore additional features, please contact your local sales engineers.
From Version 7.0
Help > License > Available License provides the list of Imaris licenses with expiration date. If you have a permanent license, Expiration column would show ‘Never.’
Please see this step by step satellite license tutorial and the written guide below. Core facility users, please check with your core facility manager regarding your core’s specific satellite license usage policy.
(1) Go to the Imaris Customer Portal
(2) Log in with your registered email
(3) On the left-hand side, click on 'Satellite Licensing'
(4) Follow the instructions for generating the order-id for the satellite license
(5) Now follow the Installation Instructions for installation and licensing guidance.
Note: Satellite license duration is set under the Manage User page, but only the site manager has access to the Manage User page within the Customer Portal
Please contact us for Imaris license migrations and we will follow up to complete the process with you:
In the email, please include the following information:
You can access Imaris Installers from the Customer Portal on the Download page.
To access earlier versions, go to the Download page and click on the “Software release archive”.
Yes! However, please be aware that some functions/analyses may not be compatible across different versions.
Please see the Imaris release notes for changes by version.
Yes! Imaris Viewer is a FREE 3D/4D microscopy image viewer for viewing raw images as well as those analysed within Imaris and saved in the IMS format. Imaris Viewer lets you visualize raw images as well as images and objects generated in Imaris.
Please follow these instructions to learn how to set up Imaris in the Multi-User environment.
The IMS file format is based on the Hierarchical Data Format (HDF5) that is designed to work with huge multidimensional data and is optimized to allow extremely fast visualization of huge volume data. To facilitate this, the format stores not only the original image data but also lower resolution versions of the original data.
For additional information, please see here.
Yes! ImarisWriter allows you to quickly write image files suitable for high performance visualization and analysis in the Imaris5 File Format.
Since Version 9.3
Imaris can export Surfaces in the *.wrl and *.iv formats (by 3D View > Export Selected Objects. These formats are compatible with MeshLab and other 3D animation softwares. This short tutorial shows the export and import steps of wireframe models.
Since Version 9.3
When converting an image file into the IMS format either in Imaris Arena or by the ImarisFileConverter, new IMS file is generated with the same name as the original image file without modifying or deleting original image file.
If both files exist in the same folder, then only the IMS file will appear in the Arena view.
In most cases you will be able to read IMS files written by older Imaris versions into later ones. There are some limits:
IMS files written in newer software versions may not be read in earlier Imaris versions. When you have problems, you might have partial success by using ‘Save As’ or ‘Export’ where you can choose an older file format in the ‘Save as type’ field in the newer version. It is likely that not all parts of the Imaris scene will be saved in the older format.
Since Version 9.3
Imaris supports file conversion from most proprietary files from major microscopy vendors. The complete list of files that can be directly converted is located at: Help > Reference Manual > Supported File Formats.
To open an image file in Imaris it first needs to be converted into the IMS format using the Imaris File Converter or within Imaris Arena.
Since Version 9.9
Yes, Imaris supports direct import of segmentation results (of H5 or Tiff labelled images) into Imaris surfaces. For example, you can export the segmentation results from the open-source pixel classification algorithms in ilastik or Labkit and import them into Imaris as surfaces, Imaris can also load spots and tracks created in MaMuT or TrackMate.
Since Version 8.4
In Imaris open File > Preferences > Creation Parameter. Select the creation parameter you want to save, use the export button, and save them to the specified location.
Since Version 8.4
In Imaris open File > Preferences > Creation Parameter. Use the ‘Import’ Button and browse to the stored creation parameter. In the corresponding object creation wizard, you can select the imported creation parameter via the Drop-Down menu.
There are several ways of importing data into Imaris. In this video you will find shortened instructions. The detailed version of the video, covering some additional issues, such as: Arena, Imaris File Converter and BioFormats can be found here.
Since Version 7.6
This tutorial shows one way to create a simple animation going up and down through your 3D image.
Since Version 5.7
This tutorial shows how to create a customized color look up table (LUT) for your data.
Since Version 8.4
(1) For version 9.5 and older ensure that Offscreen Rendering is checked ON under File > Preferences > Display > ‘Offscreen Rendering (for saving Snapshots and Movies)’.
(2) File > Preferences > Snapshot > check ‘Transparent Background.’ Select either ‘TIFF’ or ‘PNG’ as file type.
Since Version 7.0
You can turn on or off Scale bar display from File > Preferences > Display > Coordinate Axis/ Scale Bar / TimeColor Bar section.
Move the cursor close to the scale bar and you will see it change shape. Now drag left/right to decrease/increase scale bar length.
Move the cursor close to the scale bar and drag up/down to increase/decrease scale bar thickness and the font size of the scale bar label.
Since Version 8.0
You can control the image angle and zoom using the following steps:
Since Version 9.1
You can load multiple datasets using File > Add Image. Each image’s position can be controlled by its corresponding Frame and object detection can be done on all available channels.
For additional tutorials and application examples, please see Imaris 9.1 Release Notes.
Since Version 10.1
Imaris 10.1 brings native machine learning segmentation to Imaris, where you can train the AI pixel classifier to segment the image by simply painting some foreground pixels and some background pixels and letting the machine learning system infer the rules that fit your painting. This is a very intuitive and easy way to set up segmentation that is significantly more versatile than a simple threshold. For additional information, please see Imaris 10.1 release notes, AI trainable segmentation webinar and this training tips tutorial.
Since Version 10.0
In Imaris 10.0 Filament Tracer, the proven autopath method for tree-like structures, is enhanced with machine learning (multi-scale) seed points and segments classification for more versatile, accurate and repeatable detection. For further information, please see Imaris 10 release notes, AI powered Filament Tracer release webinar, and this detailed Filament Tracer tutorial.
Since Version 9.6
Imaris allows you to classify objects by machine learning that utilizes all standard statistics calculated by Imaris and additional ‘machine learning statistics,’ that provide more information about the local intensity landscape. For additional tutorials and application examples, please see the Imaris 9.6 release notes and this Home School recording.
Three things to consider when deciding which object works the best for your analysis:
For additional details, please watch this Home School recording that provides an overview of all Imaris objects.
Since Version 7.0
(1) Go to File > Preferences > Statistics, and check if specific statistical values are selected.
(2) Go to the Statistics tab under the component of interest, select the statistic value, and click ‘Export Statistics on Tab Display to File.’ Alternatively, you can export all available statistics by clicking ‘Export All Statistics to File.’
(3) Statistics can also be saved from Vantage for the values used for plotting.
Since Version 7.6
This tutorial walks you through the process of creating a custom-shaped region in your 2D or 3D image.
For more in-depth discussion on the Surface Contour topic, please watch this Home School recording.
Since Version 7.6
Follow this tutorial to learn how to precisely position the vertices of contour lines, how to edit only a few vertices of an otherwise complete contour, and how to translate, rotate, and scale contour lines.
Since Version 5.7
Filter offers a quick and easy way to find objects with certain statistical values. The selected objects can be labelled, duplicated, or removed for various application needs.
This tutorial shows you the various ways to use the Filter tool.
Since Version 9.3
If you run Batch analysis, the aggregated statistics results can be accessed from Arena > Folder Batch History > Export Statistics to csv file.
If you have manually segmented several images, or segmented them automatically one-by-one, it is still possible to aggregate the statistics from several different images into a single .xls/.csv/.xml by following these steps.
Since Version 8.0
(1) After creating an object, go back to the Creation tab
(2) Click ‘Store Parameters for Batch...,’ check Store Location ‘Favorite Creation Parameters’
(3) Go to File > Preferences > Creation Parameters, click ‘Export...’, share the saved *.icpx file
(4) *.icpx file can be imported to other computers with Imaris by File > Preferences > Creation Parameters > Import...
Imaris provides many tools to study colocalization. Depending on the signal characteristics you can choose to use either intensity-based colocalizations tools to quantify diffuse signals or object-based colocalization tools for structures that can be represented as objects.
This short tutorial video shows the comparison between intensity and object-based colocalization. For more in-depth tutorials and application examples, please see here.
Since Version 9.3
For more details on Vantage plot comparison, please see this Imaris HomeSchool recording.
Since Version 9.3
Results:
For more details on Vantage plot comparison, please see this Imaris HomeSchool recording.
Since Version 10.1
Starting with version 10.1 Imaris opens 2D images in a 2D mode and the statistical values are computed specifically for 2D images. Furthermore, statistics and features that do not make sense in 2D have been removed in this mode, and some additional variables have been included such as Circularity and Ellipse Axis Length.
Since Versions 5.7 - 10
2D datasets are handled like 3D datasets, so you get the same statistics but be aware of the interpretation of these values:
Area
The area statistic refers to 3D surface area even for a 2D dataset. Imaris creates a surface around the voxels, including the top, bottom, and side. The reported area will consider all these faces of the surface.
Instead, please use 'Number of Voxels' and multiply it by the XY size of a pixel to get the 2D area value.
Volume
Imaris computes a 3D Volume which takes the Z voxel size into account as given at 'Surpass - Edit - Image Properties - Geometry - Voxel Size - Z'.
If you set Z voxel size = 1, this value will reflect the 2D area. *There may be a rounding error for very small Surface objects.
In this Creation tab you have several choices.
You can re-enter the detection at different steps:
In the Creation tab click on ‘Store the parameters for batch’.
Provide a name and enable the Store Location
All used parameters are listed, and the section marked with ‘[]’ define the corresponding step in the wizard:
The ImarisXT Python interface supports Python 3.7 and Python 2.7.
If you are running a supported Python version:
C:\Program Files\Bitplane\Imaris x64 X.X\XT\python2\ (for Python 2.7 scripts)
C:\Program Files\Bitplane\Imaris x64 X.X\XT\python3\ (for Python 3.7 scripts)
For additional details, please watch this Imaris HomeSchool recording.
Here you can find a detailed description on how to install and run Labkit.
Since Version 8.3
Please see this short tutorial video for how to activate ImageJ and MATLAB plugins.
(1) Go to File > Preferences > CustomTools
(2) Check whether MATLAB Compiler Runtime (MCR) items are orange or white. White means it has been installed and connected properly. If they are orange, there should be a download link for the MCR. Please download and install the proper MCR version based on Imaris version. We recommend choosing the default settings and the default installation path.
Imaris 10.0.1: MCR v9.14
Imaris 9.7: MCR v9.9
Imaris 9.6: MCR v9.8
Imaris 8.3-9.5: MCR v8.4
Imaris 8.2 and below: MCR v7.11
*You can also access MCR installers from the Customer Portal and its Download page.
(3) Once installed, built-in XTensions are ready to use and all MATLAB symbols under the Image Processing menu should turn from grey to brown in color.
Versions 8.3 - 9.9
*.exe and *.xml file requires MATLAB Compiler Runtime (MCR).
*.m requires a full MATLAB installation.
*.py requires Python.
Note: Different XTensions may require different versions of MATLAB/Python or specific versions of Imaris to run properly. Some XTensions may also require specific modules not included in every user’s license. Please check the XTension documentation or contact the developer directly.
Note1: For user-defined XTension folders make sure to copy the following file(s) from the Imaris built-in XTension folder:
MATLAB XT (C:/Program Files/Bitplane/Imaris x64 X.X.X/XT/matlab) - ImarisLib.jar
Python XT (C:/Program Files/Bitplane/Imaris x64 X.X.X/XT/python3) - ImarisLib.py, Imaris folder, ImarisServer folder, private folder (or add these folders to the PATH).
Note 2: Imaris can access files within XTension Folders, but not within their sub-folders.
Since Version 8.0
Please see this short tutorial video for how to activate ImageJ and MATLAB plugins.
(1) Download and install Fiji
(2) Go to File > Preferences > CustomTools
(3) Add the Fiji path to ImageJ/ Fiji Application.
(4) To test, open an image in Imaris, use Fiji > Image to Fiji. The same image will open in Fiji.
Since Version 8.3
If you have a full MATLAB installation where the default path was selected, Imaris should automatically identify the MATLAB path and no additional steps are required. You can check and edit the MATLAB path from File > Preferences > Advanced > CustomTools > MatlabPath.
Please follow this short instruction to learn how to install the Matlab Runtime in Windows 10 or Mac OS and activate Matlab XTensions shipped with Imaris. Please note that activation of the XTensions requires an Imaris XT license.
Please follow this short instruction to learn how to install Python 3.7.9 in Windows 10 and activate Python XTensions shipped with Imaris. Please note that activation of the XTensions requires an Imaris XT license.
Since Version 9.3
Texture cache affects rendering responsiveness. The default value is the physical RAM of your graphics card, and it should work well most of the time. For graphics card with large RAM (>16GB), reducing this value to 12-16GB may sometimes increase responsiveness.
You can adjust the texture cache used by Imaris from File > Preferences > Display.
You can adjust RAM used by Imaris from File > Preferences > Calculation.
The default value is set at half of the system RAM. When modifying this value, please make sure the system has sufficient RAM to run the machine. If you have 128 GB RAM, set this value at 100 GB or lower to ensure system stability.
You can change data cache location from File > Preferences > Calculation.
The default location is usually set to the C drive. If you have multiple hard drives, we recommend setting the data cache location to the faster drive (PCIe SSD) and to avoid using the system drive as a cache drive.
Imaris can write in parallel to different paths if more than one path is added. Please be aware that if multiple drives are used as a cache drive, the one with fewer free space will limit the usable space on the others as well.
Please refer to ImarisXT section.
Before reseting the Preferences please check if there are Creation Parameter stored and export them before continuing. See the How can I export Creation Parameter section.
To reset user settings:
(1) Open Imaris, make sure only one instance is running
(2) File > Preferences > Reset Preferences…
(3) Restart Imaris
Note that some settings are only accessible from Registry. We do not recommend that users edit the registry in most cases. If you need assistance, please contact your regional Support Team.
To learn more about a specific function, right click on the function in Imaris and click ‘Show Help’ to bring you to a content-specific location in the Reference Manual.
You can also go to Help > Reference Manual to browse or search for specific functions.
For statistical value definitions go to Help > Statistics Reference.
If you cannot find the information you are looking for please contact your regional Support team.
(1) Ensure you are not using the integrated Intel graphics card as it is not compatible with Imaris and not supported. In Windows 10, if you have a dedicated graphics card you can set it as the preferred graphics card from ‘Graphics settings”. Under Graphics settings, choose Imaris to set the preference. Select ‘High performance’ or the desired graphics card.
If you are not using Windows 10, the NVIDIA and AMD control panels will allow you to create an application profile for Imaris to use the preferred card.
(2) Make sure your graphics card has at least 1GB of graphics RAM available. We recommend using a graphics card with at least 4GB of graphics RAM for decent performance.
Reducing the Quality of the Volume object can also help to avoid flickering on graphics cards with limited graphics RAM. The Quality slider can be adjusted in the ‘Settings’ tab of the Volume component.
(3) Ensure the texture cache is set correctly in File > Preferences > Display. The value of ‘Texture Cache’ should match the amount of your graphics RAM.
(4) Update your graphics driver by going to either the AMD or NVIDIA website and downloading the latest version of your card.
(1) The message can appear if you are using a Windows machine. Please make sure you are not using the integrated Intel graphics card as it is not compatible with Imaris and therefore not supported.
(2) This message can also appear if you have too many channels enabled simultaneously. While Imaris can handle dozens of channels internally, most graphics cards are usually only able to display 8 channels at the same time.
(3) It may be caused by a driver issue. Update your graphics driver by going directly to either the AMD or NVIDIA website and downloading the latest driver version for your specific card.
(4) If you are logged in on a Windows machine remotely via an RDP session you might have a graphics card and Windows version combination that does not support OpenGL acceleration in RDP sessions. Please see section ‘Can I run Imaris in Windows Remote Desktop (RDP)?’ [h2 link or whatnot please] for more information.
From Version 10.2
None of our installer packages show this error anymore.
Up to Version 10.1
MacOS can complain about the Imaris installer package for not being able to scan it for malicious software. This is one of the protection systems from recent MacOS releases. If you downloaded Imaris installer from our Customer Portal, rest assured that the Imaris installer is clean and does not contain malicious software.
To install Imaris anyway, right click the installer package to bring up the context menu. Select ‘Open’.
MacOS will then bring up a similar dialog with the ‘malicious software’ warning but will now give you the option to open the package. Click ‘Open’ to continue the rest of the installation steps.