Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Video spot tracker #2032

Closed
wants to merge 4 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 17 additions & 12 deletions docs/sphinx/developers/jace/overview.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,34 @@ JACE C++ bindings for the Java API
==================================

To make Bio-Formats accessible to software written in C++, we have
created a Bio-Formats C++ interface (BF-CPP for short). It uses LOCI's
`jar2lib <http://loci.wisc.edu/software/jar2lib>`_ program to generate
a C++ proxy class for each equivalent Bio-Formats Java class. The
created a Bio-Formats C++ interface. It uses LOCI's jar2lib_ program to
generate a C++ proxy class for each equivalent Bio-Formats Java class. The
resulting proxies are then compiled into a library, which represents
the actual interface from C++ to Bio-Formats. Using this library in
your projects gives you access to the image support of Bio-Formats.

BF-CPP comes with some standalone examples which you can use as a
starting point in your own project:
The JACE C++ bindings comes with some standalone examples which you can use as
a starting point in your own project:

- :source:`showinf <components/formats-bsd/cppwrap/showinf.cpp>`
- :source:`minimum_writer <components/formats-bsd/cppwrap/minimum_writer.cpp>`

Other projects using BF-CPP include:
Other projects using the JACE C++ bindings include:

- `WiscScan <http://loci.wisc.edu/software/wiscscan>`_ which uses BF-CPP
to write :model_doc:`OME-TIFF <ome-tiff>` files.
- :doc:`/users/xuvtools/index` which uses an adapted version of BF-CPP
called
- WiscScan_ which uses the JACE C++ bindings to write
:model_doc:`OME-TIFF <ome-tiff>` files.
- :doc:`/users/xuvtools/index` which uses an adapted version of the JACE C++
bindings called
`BlitzBioFormats <http://www.xuvtools.org/devel:libblitzbioformats>`_.
- `Video Spot Tracker`_ which uses the Jace C++ bindings to add Bio-Formats
support since version 8.10.

See the :doc:`build instructions <build>` (:doc:`Windows
<build-windows>`, :doc:`Mac OS X <build-macosx>`, :doc:`Linux
<build-linux>`) for details on compiling BF-CPP from source. Once this
is done, simply include it in your project as you would any other
<build-linux>`) for details on compiling the Java C++ bindings from source.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just wanted to ensure that you didn't intend "JACE" here too

Once this is done, simply include it in your project as you would any other
external library.

.. _jar2lib: http://loci.wisc.edu/software/jar2lib
.. _WiscScan: http://loci.wisc.edu/software/wiscscan
.. _Video Spot Tracker: http://cismm.cs.unc.edu/resources/software-manuals/video-spot-tracker-manual