%% zoom_3D_README.m
%
% E. Koenig, P. Chainais 08/04/2010
%
% Set of functions used to realize a virtual augmentation of information of
% scale invariant 3D field. For informations on this method, see [1].
%
%
%% References
%
% |[1] Koenig, E., Chainais, P.: Virtual resolution enhancement of scale 
% invariant textured images using stochastic processes, Proceedings of ICIP 
% 2009 (2009)|
%
% |[2] Chainais, P.: Infinitely divisible cascades to model the statistics 
% of natural images, IEEE Trans. on P.A.M.I. 29(12), 2105-2119 (2007)|
%
% |[3] Unser, M., Aldroubi, A. Eden, M.: Enlargement or reduction of digital 
% images with minimum loss of information. IEEE Transactions on Image 
% Processing 4(3), 247-258 (1995)|
%
%

%%
% The package zoom_3D contains 5 folders and 4 documents
%

%% Documentation/
%
% This folder.
%

%% Test/
%
% <../../Test/html/test_zoom_3D.html test_zoom_3D> is a test program of our
% augmentation method :
%
% * creation of a scale invariant 3D field
% * augmentation by any factor N, power of 2
% * visualization using Matlab
% * script to create a .dat file used to visualize the resulting fields 
% using our visualization method. This method uses Marching Cubes and can
% display different levels of value on screen.
%
%

%% Examples/
%
% Images created by a realization of _test_zoom_3D.m_, corresponding to the 
% data in _test_zoom_3D.mat_. This folder contains 3 types of data:
%
% * I_N_Matlab.png: images of the visualization of the field using Matlab
% * I_N.dat: file containing the 3D field to be visualized using our method 
% * I_N_MarchingCubes.png: images of the visualization using our method
%
% where N is the level of augmentation (0 is the initial image and N is the
% image augmanted by a factor 2^N).
%

%% Visualization/
%
% Visualization of a 3D field using Marching Cubes. A program for each
% operating system is available (champ_Linux, champ_Mac and
% champ_Windows.exe).
%
% Use (example using champ_Mac, the use for the others is the same):  
%
% _./champ_Mac file_name layer_number_
%      
% where file_name is the name of the .dat file containing the 3D field and
% layer_nb is the number of layers (level of voxel value) to be displayed.
%

%% Functions/
%
% Set of functions needed by our augmentation method:
%
% * to compile/: functions to be compiled before use:
%
% -> <../../Functions/to_compile/CPC_3D/html/cpc_3D.html CPC_3D>: creation
% of a scale invariant 3D field using compound Poisson cascades [2]
%
% -> <../../Functions/to_compile/interpol_2D/html/mexinterp.html
% interpol_2D>: interpolation using splines in 2D and 1D based on the work
% of Unser et al. [3] 
% 
% * <../../Functions/html/derivfrac3D.html derivfrac3D>: pseudo-fractional
% derivation 
% * <../../Functions/html/givexpIDC2D.html givexpIDC2D>: method to evaluate
% theoretical scale invariant exponents
%
% $$ \tau(q) $$
%
% * <../../Functions/html/integfrac3D.html integfrac3D>: pseudo-fractional
% integration 
% * <../../Functions/html/interp_x2_3D.html interp_x2_3D>: interpolation of
% a 3D field by a factor 2 
% * <../../Functions/html/zoom_out_x2_3D.html zoom_out_x2_3D>: zoom out of
% a 3D field by a factor 2 
% * <../../Functions/html/zoom_x2_3D.html zoom_x2_3D>: our method of
% augmentation by a factor 2
%

%% README
%
% Brief description of the contents of this package.
%

%% Contents.m
%
% Brief description of the contents of this package.
%

%% INSTALL
%
% Installations required to correctly use this package.
%

%% zoom_3D_Path.m
%
% Set of diverse Matlab paths to correctly use this package. This file
% needs to be modified:
%
% UserPath = 'AbsolutePathNameforzoom_3DMainDirectory';
%

%% make.m
%
% Needs to be executed to create the two mex functions
% <../../Functions/to_compile/CPC_3D/html/cpc_3D.html CPC_3D> (creation of scale
% invariant 3D field) and
% <../../Functions/to_compile/interpol_2D/html/mexinterp.html mexinterp>
% (interpolation using splines in 1D and 2D). 
%

%% 
