htpp

htrdr-image post-processing
git clone git://git.meso-star.fr/htpp.git
Log | Files | Refs | README | LICENSE

README.md (3648B)


      1 # htpp
      2 
      3 This tool post-processes images saved in htrdr-image format.
      4 
      5 ## Requirements
      6 
      7 - C compiler
      8 - POSIX make
      9 - pkg-config
     10 - [RSys](https://gitlab.com/vaplv/rsys)
     11 - [Star Color Map](https://gitlab.com/meso-star/star-cmap)
     12 - [mandoc](https://mandoc.bsd.lv)
     13 
     14 ## Installation
     15 
     16 Edit config.mk as needed, then run:
     17 
     18     make clean install
     19 
     20 ## Release notes
     21 
     22 ### Version 0.5
     23 
     24 - Write the man page directly in mdoc's roff macros, instead of using
     25   the intermediate scdoc source.
     26 - Replace CMake by Makefile as build system.
     27 - Update compiler and linker flags to increase the security and
     28   robustness of generated binaries.
     29 - Provide a pkg-config file to link the library as an external
     30   dependency.
     31 
     32 ### Version 0.4.4
     33 
     34 Fix a typo in the man page
     35 
     36 ### Version 0.4.3
     37 
     38 - Add list of available palettes to man page.
     39 - Use scdoc rather than asciidoc as file format for man sources.
     40 - Remove deprecated MSVC support.
     41 
     42 ### Version 0.4.2
     43 
     44 - Fix a wrong assertion on the range of the data to display: in debug
     45   `htpp` was stopping and reporting an error if the data to display all
     46   had the same value.
     47 - Fix the CMake file for MSVC build.
     48 
     49 ### Version 0.4.1
     50 
     51 - Fix MSVC build.
     52 - Change install dir for html man.
     53 - Stop building html man on Unix systems (still optionally available).
     54 
     55 ### Version 0.4
     56 
     57 - Add the `gnuplot` parameter to the `-m` option. Once set, the result
     58   image is written as a gnuplot script rather than a PPM image. This
     59   script generates a PNG image with an embedded color ramp.
     60 - Fix the tone map operator: the exposure term is now also applied to
     61   the white radiance to ensure that it effectively corresponds to the
     62   white color in the output image.
     63 
     64 ### Version 0.3
     65 
     66 - Add the `-i` option that regroups all the options controlling the
     67   post-processing of the pixel color. The options `-e` and `-w` that
     68   defined the exposure and the white scale factor are thus removed.
     69 - Add support of raw data visualisation through color palettes. The `-m`
     70   option enables the mapping of a pixel component to a color ramp. Both,
     71   the pixel component to visualise and the palette to use can be set
     72   through this option.  The data range to visualise can also be fixed.
     73   When this option is defined, the `-v` option can be used to displays
     74   into the terminal the color ramp and its associated values.
     75 - Remove the `-u` and `-T` options that are previously used to roughly
     76   visualise the per pixel uncertainties and the estimate of the per
     77   realisation time: the new `-m` option proposes a far more efficient
     78   alternative.
     79 
     80 ### Version 0.2.1
     81 
     82 - Update how the image exposure is handled: the pixels are multiplied by
     83   the exposure priorly to their tone mapping. Previously, it was the
     84   tone mapped pixels that were multiplied by the exposure.
     85 - Fix the man page that wrongly described the tone mapping operator.
     86 
     87 ### Version 0.2
     88 
     89 - Fix the XYZ to sRGB conversion: the reference white was not correctly
     90   set.
     91 - Fix the gamma correction of the linear sRGB color: there was an issue
     92   in the used formulae.
     93 
     94 ### Version 0.1
     95 
     96 - Handle the update of the htrdr-image file format introduced by
     97   [htrdr](https://gitlab.com/meso-star/htrdr/) 0.1 that adds to each
     98   pixel the estimation of the per realisation path computation time.
     99 
    100 ## Copyright notice
    101 
    102 Copyright © 2018-2020, 2023 |Méso|Star> (contact@meso-star.com)  
    103 Copyright © 2018, 2019 Centre National de la Recherche Scientifique  
    104 Copyright © 2018, 2019 Université Paul Sabatier
    105 
    106 ## License
    107 
    108 htpp is free software released under the GPL v3+ license: GNU GPL
    109 version 3 or later. You are welcome to redistribute it under certain
    110 conditions; refer to the COPYING file for details.