Commit 83a43720 authored by Valentin Blot's avatar Valentin Blot
Browse files

updated README

parent 2b806b29
Valentin Blot <valentin.blot@ens-lyon.fr>
David Coeurjolly <david.coeurjolly@liris.cnrs.fr>
QuasiAffineTransform
====================
This package implements fast image transformations in dimension 2 and 3 with quasi-affine functions.
The code follows the following papers (https://liris.cnrs.fr/david.coeurjolly/publications.html):
- Quasi-Affine Transformation in 3-D: Theory and Algorithms , D. Coeurjolly, V. Blot, M.A. Jacob-DaCol, 13th International Workshop on Combinatorial Image Analysis, Mexico, Springer Verlag, LNCS, 2009.
- Quasi-Affine Transformation in Higher Dimension , V. Blot and D. Coeurjolly, 15th IAPR International Workshop on Discrete Geometry for Computer Imagery, Montreal, Springer LNCS,2009.
Authors
=======
Valentin Blot <contact@valentinblot.org>
David Coeurjolly <david.coeurjolly@liris.cnrs.fr>
TODO
====
- [ ] Implement usePeriodicity and noMultiply in 3D
- [ ] Translate comments to english
Details
=======
Arithmetic Kernel:
common/mathematic.cpp
common/mathematic.hpp
Main classes (data-structure) :
common/color.cpp
common/color.hpp
Main 2D classes:
2D/image.cpp
2D/image.hpp
2D/paving.cpp
2D/paving.hpp
2D/matrix2x2.cpp
2D/matrix2x2.hpp
2D/vector2d.cpp
2D/vector2d.hpp
Transformation algorithm:
2D/qat.cpp
2D/qat.hpp
Main :
2D/qat-2D.cpp
Main 3D classes:
3D/image3d.cpp
3D/image3d.hpp
3D/paving3d.cpp
3D/paving3d.hpp
3D/matrix3x3.cpp
3D/matrix3x3.hpp
3D/vector3d.cpp
3D/vector3d.hpp
Transformation algorithm:
3D/qat3d.cpp
3D/qat3d.hpp
Main :
3D/qat-3D.cpp
Introduction
============
This package implements fast image transformations in dimension 2 and 3 with quasi-affine functions.
The code follows the following papers (https://liris.cnrs.fr/david.coeurjolly/publications.html):
- Quasi-Affine Transformation in 3-D: Theory and Algorithms , D. Coeurjolly, V. Blot, M.A. Jacob-DaCol, 13th International Workshop on Combinatorial Image Analysis, Mexico, Springer Verlag, LNCS, 2009.
- Quasi-Affine Transformation in Higher Dimension , V. Blot and D. Coeurjolly, 15th IAPR International Workshop on Discrete Geometry for Computer Imagery, Montreal, Springer LNCS,2009.
How to build it
===============
To compile this code, you would need:
- cmake
- Imagemagick to import 2d image files to transform
- libvol/liblongvol to import 3d vol files (https://liris.cnrs.fr/david.coeurjolly/code/simplevol.html)
LICENSE
=======
- GPLv2, see LICENSE file
TODO
====
- [ ] Implement usePeriodicity and noMultiply in 3D
- [ ] Translate comments to english
Details
=======
Arithmetic Kernel:
common/mathematic.cpp
common/mathematic.hpp
Main classes (data-structure) :
common/color.cpp
common/color.hpp
Main 2D classes:
2D/image.cpp
2D/image.hpp
2D/paving.cpp
2D/paving.hpp
2D/matrix2x2.cpp
2D/matrix2x2.hpp
2D/vector2d.cpp
2D/vector2d.hpp
Transformation algorithm:
2D/qat.cpp
2D/qat.hpp
Main :
2D/qat-2D.cpp
How to build it
===============
Main 3D classes:
3D/image3d.cpp
3D/image3d.hpp
3D/paving3d.cpp
3D/paving3d.hpp
3D/matrix3x3.cpp
3D/matrix3x3.hpp
3D/vector3d.cpp
3D/vector3d.hpp
To compile this code, you would need:
Transformation algorithm:
3D/qat3d.cpp
3D/qat3d.hpp
- Imagemagick++ libraries to import 2d image files to transform
- tclap library to parse command-line options
- libvol to import 3d vol files (https://liris.cnrs.fr/david.coeurjolly/code/simplevol.html)
Main :
3D/qat-3D.cpp
The Makefile is included, a simple "make" should build the two binaries. Refer to README files in subdirectories "QuasiAffineTransform" and "libvol" for details.
The built files are qat-2D and qat-3D
David Coeurjolly <david.coeurjolly@liris.cnrs.fr>
Alexis Guillaume <aguillau@liris.univ-lyon2.fr>
Libvol
------
Contact : David Coeurjolly : <david.coeurjolly@liris.cnrs.fr>
Contact : Alexis Guillaume : <aguillau@liris.univ-lyon2.fr>
Presentation
============
Libvol is free software. See file COPYING for details.
LibVol is a library designed to deal with 3D voxel pictures (a voxel is a 3D pixel).
0. Contents
-----------
It provides features such reading a voxel file, writing a voxel file and dealing with it in a C++ program. It implements its own documented-and-easy file formats.
1. Presentation
2. Compilation and installation
3. Supported file formats
4. Where to find documentation
1. Presentation
---------------
Authors
=======
LibVol is a library designed to deal with 3D voxel pictures (a voxel is a 3D pixel).
David Coeurjolly <david.coeurjolly@liris.cnrs.fr>
Alexis Guillaume <aguillau@liris.univ-lyon2.fr>
It provides features such reading a voxel file, writing a voxel file and dealing with it in a C++ program. It implements its own documented-and-easy file formats.
2. Compilation and installation
-------------------------------
Requirements: cmake tool (http://www.cmake.org/)
Just type :
% mkdir build
% cd build
% cmake ..
% make && sudo make install
Librairies and binaries will be installed in /usr/local/.
Or in the main repository:
% cmake . ; make && sudo make install
Of course, you can set up a few things like prefix. To see what, juste type :
% cmake .. -DCMAKE_INSTALL_PREFIX=/my/path/
Creating the doxygen documentation (for developers only)
% make doc
To uninstall:
% sudo make uninstall
3. Supported file formats
-------------------------
Supported file formats
======================
Two formats are available directly with the libvol library :
......@@ -85,11 +52,3 @@ Two formats are available directly with the libvol library :
- Alpha-Color : the color of an "empty" voxel
- Int-Endian : the endianess of an integer (e.g : DCBA, BACD, HGFEDCBA (64 bits int), ...)
- Voxel-Endian : the endianess of a voxel
4. Documentation
----------------
You can read the man page :
% man vol
But you should read the tutorial (see tutorial directory).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment