> For the complete documentation index, see [llms.txt](https://docs.biodock.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biodock.ai/files/supported-image-types.md).

# Supported image types

*What you'll get: which file formats Biodock accepts, how to upload multi-file formats, and what Biodock reads from them.*

## Supported file formats

Biodock accepts common image formats, the main whole-slide formats, and most formats that Bio-Formats can read. See the [Bio-Formats list of formats](https://bio-formats.readthedocs.io/en/stable/supported-formats.html).

Formats fall into two groups:

* **Read directly:** `.png`, `.jpg`/`.jpeg`, `.tif`/`.tiff` (including OME-TIFF), and the whole-slide formats `.svs`, `.ndpi`, `.mrxs`, `.vms`, `.vmu`, `.svslide` and `.bif`.
* **Converted on upload:** everything else, for example `.czi`, `.lif`, `.nd2`, `.lsm`, `.scn`, `.vsi`, `.ims`, `.oir` and `.qptiff`. Biodock converts these with Bio-Formats. What you see in the viewer is made from the converted image, so colours can look slightly different from your microscope software.

A converted file that holds a z-stack becomes one 2D image per z-plane.

### Formats we recommend

These formats have been used and tested the most on Biodock. If you can export in more than one format, pick one of these:

* `.tif`/`.tiff` and OME-TIFF
* `.svs`
* `.czi`
* `.lif`
* `.png`
* `.jpg`/`.jpeg`
* `.mrxs` (see below)
* `.vsi` (see below)

## Uploading MRXS and VSI

MRXS and VSI images are not a single file. Each needs its data files, and uploading only the main file gives an image that can't be opened.

* **MRXS:** upload the `.mrxs` file together with its folder of `.dat` files. The folder must have the same name as the `.mrxs` file and contain `Index.dat` and `Slidedat.ini`.
* **VSI:** upload the `.vsi` file together with the folder of `.ets` files your scanner saved next to it.

Lay the files out like this before you upload:

<figure><img src="https://3806122466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk3DfNQKoMy1JXdaDLvpG%2Fuploads%2FxoMOHrVJii6BWRsh4d39%2Fimage.png?alt=media&amp;token=4342d06c-0515-4add-8415-3b9cb28ff391" alt="A Finder window with an .mrxs file next to a folder of the same name that holds the .dat files, Index.dat and Slidedat.ini"><figcaption><p>MRXS: the <code>.mrxs</code> file next to its folder of the same name.</p></figcaption></figure>

<figure><img src="https://3806122466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fk3DfNQKoMy1JXdaDLvpG%2Fuploads%2FBoIb4DcikdFVGgxY4VrS%2Fimage.png?alt=media&amp;token=94f78852-7bb9-43a2-abb2-5033f1d99521" alt="A Finder window with a .vsi file next to the folder of .ets files the scanner saved"><figcaption><p>VSI: the <code>.vsi</code> file next to its folder of <code>.ets</code> files.</p></figcaption></figure>

Then upload them together:

1. In **Files**, go to the folder you want and click **Upload files**.
2. Click **browse folders**, and pick the folder that holds the image and its data folder.
3. Check what the dialog found, for example **Detected 1 vsi file with matched ets files.** If the data files don't match, it shows **Invalid MRXS files** or **Invalid VSI files** instead, with what to fix.
4. Click the upload button, for example **Upload 3 files**.

Large slides take a few minutes to process. Keep the window open while the files transfer; after that you can close it. Follow the progress with **Recent uploads** in the top bar.

To import a VSI image from Amazon S3 or Google Cloud Storage, put the `.vsi` file and its folder of `.ets` files in a `.zip` archive, and import the `.zip`.

## Pixel size

Biodock reads an image's pixel size from the file's own metadata when you upload it. You can't enter or edit a pixel size in Biodock. The file details panel shows it in the **Pixel size**, **Physical size** and **Magnification** rows, or **—** when the file has none.

* **Converted formats** (for example `.czi`, `.nd2`, `.lif`, `.lsm`, `.scn`, `.vsi`): the pixel size is read during conversion, if the file records one.
* **Whole-slide formats** (`.svs`, `.ndpi`, `.mrxs`, `.vms`, `.vmu`, `.svslide`, `.bif`): the pixel size and the scan magnification are read from the scanner's metadata. Slides uploaded before Biodock started reading these may show **—**; uploading the slide again reads them.
* **`.png`, `.jpg`/`.jpeg` and `.tif`/`.tiff`, including OME-TIFF:** no pixel size is recorded, even if the file contains one.

If you need a pixel size, upload your microscope's own format (such as CZI, ND2 or LIF) rather than a TIFF export.

Copies made with **Make a copy**, and images made by [merging channels](https://docs.biodock.ai/files/view-and-manage-data/merging-channels.md), have no pixel size.

## Limits

The largest file you can upload is 64 GB for whole-slide formats and 40 GB for every other format. See [Uploading images](https://docs.biodock.ai/files/uploading-images.md#upload-limits).

**Time series**

Biodock doesn't support time series in a single file, time series traces on the dashboard, or tracking objects between time points. To compare time points, put each one in its own folder: each folder becomes a group you can compare on the dashboard.

**3D images**

Biodock trains and analyses 2D images (with any number of channels), so it has no volume measurements. With 3D images, you can:

* use maximum projection images,
* pick the z-planes you want to analyse, or
* train and analyse every z-plane as its own image.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.biodock.ai/files/supported-image-types.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
