Skip to content

Commit cee57bb

Browse files
committed
Reformat document for new emphasis syntax
Refers to imcf#34
1 parent 6148f75 commit cee57bb

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

CHANGELOG.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ API documentation][apidocs].
3030
* `imcflibs.imagej.misc.subtract_images` to subtract an image from another.
3131
* `imcflibs.imagej.misc.close_images` for closing all ImagePluses from a list.
3232
* `imcflibs.imagej.misc.get_threshold_value_from_method` to get the value that a
33-
selected _AutoThreshold_ method would be using.
33+
selected *AutoThreshold* method would be using.
3434
* `imcflibs.imagej.misc.write_ordereddict_to_csv` to write data from an ordered
3535
dictionary (or list of ordered dictionaries) to a CSV file.
3636
* `imcflibs.imagej.misc.save_image_in_format` to save an ImagePlus in a
3737
specified format, such as `ImageJ-TIF` or `OME-TIFF` etc.
3838
* `imcflibs.imagej.misc.run_imarisconvert` to convert a given file to Imaris
39-
format using the utility _ImarisConvert_. The function uses
39+
format using the utility *ImarisConvert*. The function uses
4040
`imcflibs.imagej.misc.locate_latest_imaris` to find the path to the most
4141
recent Imaris installation.
4242

@@ -48,16 +48,16 @@ API documentation][apidocs].
4848
* `imcflibs.imagej.labelimage.binary_to_label` for segmenting a binary image to
4949
get a label image (2D/3D).
5050
* `imcflibs.imagej.labelimage.relate_label_images` to relate two label images
51-
(2D/3D) using the _3D Association_ plugin from the 3DImageJSuite.
51+
(2D/3D) using the *3D Association* plugin from the 3DImageJSuite.
5252
* `imcflibs.imagej.labelimage.dilate_labels_2d` to dilate a label image slice by
5353
slice. Works for 2D or 3D images.
5454

5555
#### New submodule `imcflibs.imagej.objects3d`
5656

5757
* `imcflibs.imagej.objects3d.population3d_to_imgplus` to turn an
58-
_Objects3DPopulation_ into an ImagePlus (2D/3D).
58+
*Objects3DPopulation* into an ImagePlus (2D/3D).
5959
* `imcflibs.imagej.objects3d.imgplus_to_population3d` to get the
60-
_Objects3DPopulation_ from an ImagePlus (2D/3D).
60+
*Objects3DPopulation* from an ImagePlus (2D/3D).
6161
* `imcflibs.imagej.objects3d.segment_3d_image` to threshold an image into a
6262
labeled stack.
6363
* `imcflibs.imagej.objects3d.get_objects_within_intensity` to filter a
@@ -69,7 +69,7 @@ API documentation][apidocs].
6969

7070
#### New submodule `imcflibs.imagej.bdv`
7171

72-
Providing _BigDataViewer_ related functionality.
72+
Providing *BigDataViewer* related functionality.
7373

7474
* Option configuration classes:
7575
* `imcflibs.imagej.bdv.ProcessingOptions` to configure the options on how the
@@ -81,31 +81,31 @@ Providing _BigDataViewer_ related functionality.
8181
* `imcflibs.imagej.bdv.get_processing_settings` to generate the strings needed
8282
for the processing.
8383
* `imcflibs.imagej.bdv.backup_xml_files` to create a backup of BDV-XML files.
84-
* `imcflibs.imagej.bdv.define_dataset_auto` to run "_Define Multi-View Dataset_"
85-
using the "_Auto-Loader_" option.
86-
* `imcflibs.imagej.bdv.define_dataset_manual` to run "_Define Multi-View
87-
Dataset_" using the "_Manual Loader_" option.
84+
* `imcflibs.imagej.bdv.define_dataset_auto` to run "*Define Multi-View Dataset*"
85+
using the "*Auto-Loader*" option.
86+
* `imcflibs.imagej.bdv.define_dataset_manual` to run "*Define Multi-View
87+
Dataset*" using the "*Manual Loader*" option.
8888
* `imcflibs.imagej.bdv.resave_as_h5` to resave the dataset in H5 to make it
8989
compatible with BigDataViewer/BigStitcher.
90-
* `imcflibs.imagej.bdv.flip_axes` to call BigStitcher's "_Flip Axes_" command.
90+
* `imcflibs.imagej.bdv.flip_axes` to call BigStitcher's "*Flip Axes*" command.
9191
* `imcflibs.imagej.bdv.phase_correlation_pairwise_shifts_calculation` to
9292
calculate pairwise shifts using Phase Correlation.
9393
* `imcflibs.imagej.bdv.filter_pairwise_shifts` for filtering pairwise shifts
9494
based on different thresholds.
9595
* `imcflibs.imagej.bdv.optimize_and_apply_shifts` to optimize shifts and apply
9696
them to a dataset.
97-
* `imcflibs.imagej.bdv.detect_interest_points` for running the "_Detect Interest
98-
Points_" command for registration.
99-
* `imcflibs.imagej.bdv.interest_points_registration` to run the "_Register
100-
Dataset based on Interest Points_" command.
97+
* `imcflibs.imagej.bdv.detect_interest_points` for running the "*Detect Interest
98+
Points*" command for registration.
99+
* `imcflibs.imagej.bdv.interest_points_registration` to run the "*Register
100+
Dataset based on Interest Points*" command.
101101
* `imcflibs.imagej.bdv.duplicate_transformations` for duplicating / propagating
102102
transformation parameters to other channels.
103-
* `imcflibs.imagej.bdv.fuse_dataset` to call BigStitcher's "_Fuse Multi-View
104-
Dataset_" command.
103+
* `imcflibs.imagej.bdv.fuse_dataset` to call BigStitcher's "*Fuse Multi-View
104+
Dataset*" command.
105105

106106
#### New submodule `imcflibs.imagej.trackmate`
107107

108-
Providing helper functions to interface with _Trackmate_.
108+
Providing helper functions to interface with *Trackmate*.
109109

110110
* Multiple functions to set up Trackmate settings with different detectors:
111111
* `imcflibs.imagej.trackmate.cellpose_detector`
@@ -125,7 +125,7 @@ Providing helper functions to interface with _Trackmate_.
125125

126126
#### New submodule `imcflibs.imagej.omerotools`
127127

128-
Providing helper functions to connect to _OMERO_ using user credentials, fetch
128+
Providing helper functions to connect to *OMERO* using user credentials, fetch
129129
and upload images, retrieve datasets or save ROIs to OMERO.
130130

131131
* `imcflibs.imagej.omerotools.parse_url` to parse the OMERO URL and get a list
@@ -260,7 +260,7 @@ Utilities for filtering and thresholding.
260260

261261
* The functions below now also accept parameters of type `java.io.File` (instead
262262
of `str`), making them safe for being used directly with variables retrieved
263-
via ImageJ2's _Script Parameter_ `@# File`:
263+
via ImageJ2's *Script Parameter* `@# File`:
264264
* `imcflibs.pathtools.parse_path`
265265
* `imcflibs.strtools.filename`
266266
* Several changes in `imcflibs.pathtools.parse_path`:

0 commit comments

Comments
 (0)