pfstools for HDR images Files

pfstools 1.9.0 - Release Notes

This release brings two major changes: The way the Radiance RGBE files
are handled has been changed to be compatible with most of the
software; and this is the first release with CMake build
system. Although automake files are still supported, that support will
be dropped in future releases. Other changes include two new tools:
pfsretime and pfscolortransform, performance improvements and bug
fixes.

Change log:
	* added: CMake build system (to replace automake in future releases)
	* changed: pfsinrgbe & pfsoutrgbe do not correct for Radiance WHITE_EFFICACY by default. Note that this makes absolute values stored in .hdr files using earlier pfstools version smaller then they should be. Check manual pages for pfsinrgbe.
	* added: pfsretime - simple frame duplication
	* added: pfscolortransform - color calibration
	* updated: pfsglview contains many improvement and multithreading (thanks to Oliver Barth)
	* updated: pfsview is multithreaded if openmp present
	* fixed: pfsindcraw uses sRGB rather than the native RGB color space. This should improve colors in HDR images merged from RAW.
	* fixed: bugs in pfsintiff
	* fixed: Building OSX app bundle for pfsview disabled by default (use --enable-osxapp to enable again)


pfstools - README 
-------------------------------------------------------------------     

For Mac OSX installation - see README.OSX

For Windows installation - see README.Cygwin

For specific notes on Matlab installation - see README.matlab


pfstools is a set of command line (and one GUI) programs for reading,
writing, manipulating and viewing high-dynamic range (HDR) images and
video frames. All programs in the package exchange data using unix
pipes and a simple generic HDR image format (pfs). The concept of the
pfstools is similar to netpbm package for low-dynamic range images.

pfstools offers also a good integration with GNU Octave and
matlab. pfstools can serve as a matlab or Octave toolbox for reading
and writing HDR images or simply to effectively store large matrices.

pfs in not just another format for storing HDR images (and there are
already quite a few of them). It is more an attempt to integrate the
existing HDR image formats by providing a simple data format that can
be used to exchange data between applications.

If you use the software for your research work, please consider citing
the paper:

Rafal Mantiuk, Grzegorz Krawczyk, Radoslaw Mantiuk and Hans-Peter Seidel.
High Dynamic Range Imaging Pipeline: Perception-motivated Representation
of Visual Content.
In: Proc. of Human Vision and Electronic Imaging XII. 649212.

@inproceedings{mantiuk:2007:hvei,
 author = {Mantiuk, Rafa{\l} and Krawczyk, Grzegorz and Mantiuk, Rados{\l}aw and Seidel, Hans-Peter},
 editor = {Rogowitz, Bernice E. and Pappas, Thrasyvoulos N. and Daly, Scott J.},
 title = {High Dynamic Range Imaging Pipeline: Perception-motivated Representation of Visual Content},
 booktitle = {Human Vision and Electronic Imaging XII},
 publisher = {SPIE},
 year = {2007},
 volume = {6492},
 number = {649212},
 series = {Proceedings of SPIE},
 address = {San Jose, USA},
 month = {February},
}

The paper is an introduction to both pfstools and HDR imaging in
general. It can be downloaded from:

http://www.mpi-inf.mpg.de/resources/pfstools/papers/mantiuk07hdr_pipeline.pdf

        
1. Compilation
-------------------------------------------------------------------

Startimg from versiomn 1.9.0, pfstools can be compiled using
cmake. This is recommended methods of compilation. Version 1.9.0 still
supports automake, but this support will be dropped in future
releases.

1.1 To build using cmake:

Is is strongly recommended to compile into out-of-source directory:

mkdir build
cd build
cmake ../
make 

If you encounter any problems during compilation, run the make again with the option:

make VERBOSE=1

or, if you use nmake on Windows:

nmake /S

and report the problem with the complete error message to the google discussion group:

https://groups.google.com/forum/#!forum/pfstools


1.2 To build from a 'tar' archive (automake):

> ./configure <options>

for example following command will configure PFS tools to be installed
in user's 'local/' directory:

> ./configure --prefix=$HOME/local --with-octave-dir=$HOME/local/lib

then compile

> make

and install

> make install

NOTE: When you specify a different compiler using for example
CXX=g++-3.2, libtool may incorrectly interpret compiler and use gcc
instead of g++ to link the pfs library. This results in reallocation
error in programs that link dynamically to that library. 

NOTE: Automake 1.6 or later is required!
        
1.3 To build from CVS (automake):

> ./reconf

or

> libtoolize
> aclocal
> autoheader
> automake --add-missing
> autoconf

then proceed as for the 'tar' archive distribution. You may
need to experiment with different versions of automake, aclocal and
autoconf (automake-1.9, aclocal-1.9 and automake2.50 work on Debian).

2. Directory Layout
-------------------------------------------------------------------

doc - documentation
src - all sources go there
  pfs          - pfs library
  fileformat   - readers and writters for various file formats
  octave       - GNU Octave scripts and libraries
  matlab       - matlab mex sources and functions
  pfsview      - qt application for viewing hdr images and other data
                 that can be stored in the pfs stream
  pfsglview    - similar as pfsview, but uses OpenGL & GLUT instead of Qt
  visualc      - (CVS only) preliminary project files for compiling under
                 MS Visual C++ (only a few commands)


3. Dependencies
-------------------------------------------------------------------

Some of the pfs tools require external libraries to be built. As
reusing as much of existing code as possible is quite reasonable, it
also causes quite a lot of problems when linking with several
libraries that come in different versions. To alleviate some of such
linking problems, the configure script of the pfs tools disables
compilation of those applications for which the external libraries can
not be found. Consequently, some of the pfs applications may not be
installed after 'make install', even though the compilation was
successful.

A list of external libraries and applications that depend on them:

libtiff  - pfsintiff, pfsouttiff
libpbm   - pfsinppm, pfsoutppm
        http://netpbm.sourceforge.net/
ImageMagick++ - pfsinimgmagick, pfsoutimgmagick
        http://www.imagemagick.org/script/index.php
jpeghdr - pfsinjpeghdr, pfsoutjpeghdr
        jpeghdr library can be found on the DVD included with the book
        "High Dynamic Range Imaging: Acquisition, Display, and
        Image-Based Lighting" by Erik Reinhard, Greg Ward, Sumanta
        Pattanaik and Paul Debevec. (The Morgan Kaufmann Series in
        Computer Graphics)       
openexr libraries - pfsinexr, pfsoutexr
        http://www.openexr.com/
        
octave, octave-forge - pfsstat, pfsoctavergb, pfsoctavelum
        Note: testing or stable release is required.  Currently pfstools
        do not compile with development Octave releases.

mkoctfile (for building Octave's modules) - pfsread.oct,
           pfswrite.oct, pfstransform_colorspace.oct, and others
libqt4-gui    - pfsview
        http://www.trolltech.com/
dcraw - pfsindcraw
        http://www.cybercom.net/~dcoffin/dcraw/
opengl - pfsglview
matlab, mex - matlab scripts and mex sources


3. Documentation
-------------------------------------------------------------------

First check the list of frequently asked questions in
./doc/faq.txt. Then browse relevant manual pages, which accompany each
program. The documentation for the pfs library API can be generated
with DoxyGen or found in the header files. If you want to include
reading or writing of pfs streams in your applications, refer to
./doc/pfs_format_spec.pdf.