You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,29 +107,29 @@ This approach consists of two steps: converting the tracking data into our speci
107
107
For the first step, we assume your cell tracking data is saved as `tracks.csv` (or `tracks.parquet`, or [GEFF](https://live-image-tracking-tools.github.io/geff/main/#installation) file) in the format as described above (5-6 columns, with column names: `track_id, t, (z), y, x, (parent_track_id)]`), where `z` and `parent_track_id` are optional (no `z` column assumes 2D data, and no `parent_track_id` column assumes no cell divisions). This `tracks.csv` file can be converted to our Zarr format using the following command-line function (found in [/python/src/intracktive/convert.py](/python/src/intracktive/convert.py)):
This function converts `tracks.csv` to `tracks_bundle.zarr` (if interested, see the [Zarr format](public/docs/file_format.md)). Change `/path/to/tracks.csv` into the actual path to your `tracks.csv`. By default, `tracks_bundle.zarr` is saved in the same directory as `tracks.csv`, unless `--out_dir` is specified as the extra parameter to the function call (see the [function itself](python/src/intracktive/convert.py#L717) for more details). The conversion script works for 2D and 3D datasets (when the column `z` is not present, a 2D dataset is assumed, i.e., all `z`-values will be set to 0)
114
114
115
115
By default, all the cells are represented by equally-sized dots in `inTRACKtive`. The conversion script has the option of giving each cell a different size. For this: 1) make sure `tracks.csv` has an extra column named `radius`, and 2) use the flag `--add_radius` when calling the conversion script:
Or use `intracktive convert --help` for the documentation on the inputs and outputs
122
122
123
123
Additionally, inTRACKtive has the option of giving each cell a different color based on provided data attributes (see the example [Jupyter Notebook (`/napari/src/intracktive/examples`)](/python/src/intracktive/examples/notebook1_inTRACKtive_from_notebook.ipynb), and [videos](public/docs/videos.md)). One can add any attributes to the Zarr file, as long as they are present as columns in the `tracks.csv` tracking data. Using the following command-line interface, you can add one/multiple/all columns as attributes to the data:
When using `add_all_attributes`, the code will add all given columns as an attribute, apart from the default columns (`track_id`, `t`, `z`, `y`, `x`, and `parent_track_id`). If desired, one can manually add these columns as attributes using `add_attribute x`, for example. The conversion script will detect whether each provided column represents a categorical or continuous attribute. This information is saved in the Zarr attributes information and loaded by inTRACKtive to use the appropriate colormap.
135
135
@@ -139,23 +139,23 @@ In order for the viewer to access the data, the data must be hosted at a locatio
139
139
intracktive serve path/to/data
140
140
```
141
141
142
-
where `path/to/data` is the full path to the folder containing your data (e.g., `tracks_bundle.zarr`). Note that the path should **not** include the Zarr filename, so if the `tracks_bundle.zarr` is located in your Downloads folder, use `intracktive server ~/Downloads`. The tool will create a `localhost` with a name similar to `http://127.0.0.1:8000/`.
142
+
where `path/to/data` is the full path to the folder containing your data (e.g., `tracks_bundle.zarr`). Note that the path should **not** include the Zarr filename, so if the `tracks_bundle.zarr` is located in your Downloads folder, use `intracktive serve ~/Downloads`. The tool will create a `localhost` with a name similar to `http://127.0.0.1:8000/`.
143
143
144
144
Open this link in the browser, navigate to the exact dataset, right-click on the dataset (`tracks-bundle.zarr`) and `copy link` (depending on the browser). Then, open [the `inTRACKtive` viewer](https://intracktive.sf.czbiohub.org/), paste the copied link into the viewer (use the :globe_with_meridians: icon in the lower-left corner), and visualize your own data!
145
145
146
-
Alternatively, you can use use a single command to serve and view the Zarr bundle with inTRACKtive:
146
+
Alternatively, you can use use a single command to serve and view the Zarr bundle with inTRACKtive:
147
147
148
148
```
149
-
intracktive open path/to/.zarr
149
+
intracktive open path/to/tracks_bundle.zarr
150
150
151
-
intracktive open path/to/.csv
151
+
intracktive open path/to/tracks.csv
152
152
153
-
intracktive open path/to/.parquet
153
+
intracktive open path/to/tracks.parquet
154
154
155
-
intracktive open path/to/.geff
155
+
intracktive open path/to/tracks.geff
156
156
```
157
157
158
-
where `path/to/zarr` is the full path to the Zarr bundle, including the Zarr filename (example: `~/Downloads/tracks_bundle.zarr`). This command will spin up a local host at the location of the Zarr bundle, and open a browser tab with `inTRACKtive` running with this dataset. If you `intracktive open`an csv/parquet/GEFF file, the command will first convert the input to our Zarr format and open that file.
158
+
where the path is the full path to the file, including the filename (example: `~/Downloads/tracks_bundle.zarr`). This command will spin up a local host at the location of the Zarr bundle, and open a browser tab with `inTRACKtive` running with this dataset. If you `intracktive open`a CSV/Parquet/GEFF file, the command will first convert the input to our Zarr format and open that file.
0 commit comments