Skip to content

Commit 63ff79e

Browse files
Update README.md
1 parent f8ae1fa commit 63ff79e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@
66

77
[![install4j](https://www.ej-technologies.com/images/product_banners/install4j_small.png)](https://www.ej-technologies.com/products/install4j/overview.html)
88

9-
This package allows you to run compute-intense parts of BigStitcher distributed on your workstation, a cluster or the cloud using Apache Spark. The following modules are currently available in BigStitcher-Spark listed as `JavaClassName`/`cmd-line-tool-name` (you can find documentation below, but a good start is also to just check out the cmd-line arguments, they mostly follow the BigStitcher GUI; each module takes an existing XML):
9+
This package allows you to run compute-intense parts of BigStitcher distributed on your workstation, a cluster or the cloud using Apache Spark. The following modules are currently available in BigStitcher-Spark listed as `JavaClassName`/**`cmd-line-tool-name`** (you can find documentation below, but a good start is also to just check out the cmd-line arguments, they mostly follow the BigStitcher GUI; each module takes an existing XML):
1010

11-
* `SparkResaveN5`/`resave` (resave an XML dataset you defined in BigStitcher - use virtual loading only - into N5 for processing)
12-
* `SparkInterestPointDetection`/`detect-interestpoints` (detect interest points for alignment)
13-
* `SparkGeometricDescriptorMatching`/`match-interestpoints` (perform pair-wise interest point matching)
14-
* `SparkPairwiseStitching`/`stitching` (run pairwise stitching between overlapping tiles)
15-
* `Solver`/`solver` (perform the global solve, works with interest points and stitching)
16-
* `CreateFusionContainer`/`create-fusion-container` (set up the container into which the affine fusion will write it's data, now supports OME-ZARR)
17-
* `SparkAffineFusion`/`affine-fusion` (fuse the aligned dataset using interpolated affine/rigid/translation models)
18-
* `SparkNonRigidFusion`/`nonrigid-fusion` (fuse the aligned dataset using non-rigid models)
11+
* `SparkResaveN5`/**`resave`** (resave an XML dataset you defined in BigStitcher - use virtual loading only - into N5 for processing)
12+
* `SparkInterestPointDetection`/**`detect-interestpoints`** (detect interest points for alignment)
13+
* `SparkGeometricDescriptorMatching`/**`match-interestpoints`** (perform pair-wise interest point matching)
14+
* `SparkPairwiseStitching`/**`stitching`** (run pairwise stitching between overlapping tiles)
15+
* `Solver`/**`solver`** (perform the global solve, works with interest points and stitching)
16+
* `CreateFusionContainer`/**`create-fusion-container`** (set up the container into which the affine fusion will write it's data, now supports OME-ZARR)
17+
* `SparkAffineFusion`/**`affine-fusion`** (fuse the aligned dataset using interpolated affine/rigid/translation models)
18+
* `SparkNonRigidFusion`/**`nonrigid-fusion`** (fuse the aligned dataset using non-rigid models)
1919

2020
Additonally there are some utility methods:
21-
* `SparkDownsample`/`downsample` (perform downsampling of existing volumes)
22-
* `ClearInterestPoints`/`clear-interestpoints` (clears interest points)
23-
* `ClearRegistrations`/`clear-registrations` (clears registrations)
21+
* `SparkDownsample`/**`downsample`** (perform downsampling of existing volumes)
22+
* `ClearInterestPoints`/**`clear-interestpoints`** (clears interest points)
23+
* `ClearRegistrations`/**`clear-registrations`** (clears registrations)
2424

2525
***Note: BigStitcher-Spark is designed to work hand-in-hand with BigStitcher.** You can always verify the results of each step BigStitcher-Spark step interactively using BigStitcher by simply opening the XML. You can of course also run certain steps in BigStitcher, and others in BigStitcher-Spark. Not all functionality is 100% identical between BigStitcher and BigStitcher-Spark; important differences in terms of capabilities is described in the respective module documentation below (typically BigStitcher-Spark supports a specific feature that was hard to implement in BigStitcher and vice-versa).*
2626

0 commit comments

Comments
 (0)