close panorama

kmakemultires - make multiresolution panoramas

  • a tool to generate automatically krpano multiresolution panoramas
  • it supports CUBICAL and SPHERICAL panorama images
    (currently only 8bit RGB and RGBA JPEG and TIFF images)
    • the type of the image is detected by their aspect radio (width:height)
      cubical = 1:1, spherical = 2:1
    • the filenames of the 6 cube images should have suffixes like:
      _l, _f, _r, _b, _u, _d   or   left, front, right, back, up, down
      to allow a automatic detection of the cube side
  • it automatically calculates the best tilesize and the number of multiresolution levels and generates the tiles for it
  • a smooth preview image (spherical or cubestrip) is automatically generated too
  • based on templates it also generates a XML and HTML file
  • optionally it copies additional files for the XML and HTML
    (plugins, interfaces-buttons, SWFObject, ...)
  • fully configurable - have a look at the kmakemultires.config file
  • use it direct from command line / terminal or use it via drag and drop
  • available for Windows, Mac and Linux

Download

Download it together with the other krpano Tools here - Download


Tutorials

kmakemultires - Windows Tutorials
kmakemultires - Mac OS X Tutorials


Syntax

kmakemultires [options] [inputfiles ...]

Parameters:

[options] - optional
  • change any setting from the config file by setting it direct as parameter,
    syntax: -[setting]=[value]
  • these options overwrite the settings from the kmakemultires.config file
  • special option "-q" to suppress output messages
 
[inputfiles ...]
  • jpeg or tiff images (only 8bit RGB and RGBA supported)
  • spherical panorama images (aspect ratio 2:1)
  • or six cube side images (aspect ratio 1:1), the filenames of the cube images should have: _l,_f,_r,_b,_u,_d or left,front,right,back,up,down suffixes to allow automatic detection of the cube side
  • wildcards allowed (e.g. "*.tif" or "*.*")
  • optionally - a .config file can be passed for user config parameters

Examples:

set tilesize for all input images to 500:
kmakemultires -tilesize=500 *.tif

generate 2 levels, tilesize is 512, max resolution 2048, and no html files:
kmakemultires -levels=2 -tilesize=512 -maxsize=2048 -html=false *

suppress output messages:
kmakemultires -quiet=true pano/cube_*.jpg

for "-quiet=true" exist a special short form - just "-q":
kmakemultires -q pano/cube_*.jpg


Configuration with the kmakemultires.config File


USAGE:
To change the settings edit this file with any texteditor or make a copy of it, modify it, remove default/unwanted tags, and pass/drop the modded file together with the panorama images. At first the default kmakemultires.config will be parsed and the the passed .config file, the parameters from the passed one overwrite the default ones.


NOTES for filepaths:
    placeholder %INPUTPATH%:
    • this is path of the inputfile(s)
    • it can be used to generate the output at the same path

    placeholder %BASENAME%:
    • this is the basic name of a panorama with out filepath
    • it will be generated for the input filename, without extenstion and without the cube side suffixes
    • if it is not possible to generate the basename from the input file, the name 'pano0000' is used, where '0000' is a sequential number

SETTINGS:

  • tilepath
    • path for the multiresolution tiles
    • use the placeholder %INPUTPATH% for path of the input images
    • use the placeholder %BASENAME% for the basename of the panorama
    default:
    tilepath=%INPUTPATH%/%BASENAME%.tiles

  • preview
    • generate a preview image
    • true or false
    default:
    preview=true

  • cspreview
    • generate a cubestrip preview image
    • better quality for zenith/nadir views
    • possible settings:
      • true - always cubestrip preview image
      • false - always spherical preview image
    default:
    cspreview=true

  • previewsmooth
    • smooths the preview image
    • 0-100 (higher values are smoother)
    default:
    previewsmooth=77

  • previewpath
    • path for the preview image
    • use the placeholder %INPUTPATH% for path of the input images
    • use the placeholder %BASENAME% for the basename of the panorama
    default:
    previewpath=%INPUTPATH%/%BASENAME%.tiles/preview.jpg

  • tilesize
    • size of the image tiles
    • should be around 512 and 1024 (state: krpano version 1.0.6)
    • use 'auto' to find automatically the best
    default:
    tilesize=auto

  • levels
    • number of multiresolution levels to generate
    • use 'auto' to find automatically the best
    • the number of the automaic levels depends on the image size of the panorama and the on the 'minsize' and 'maxsize' settings
    default:
    levels=auto

  • levelstep
    • each multiresolution level will be reduced by 'levelstep'
    • examples:
      levelstep=2
      level1=10000x5000
      level2=5000x2500 (=10000/2, =5000/2)
      level3=2500x1250 (=5000/2, =2500/2)

      levelstep=2.5
      level1=10000x5000
      level2=4000x2000 (=10000/2.5 =5000/2.5)
      level3=1600x800 (=4000/2.5, =2000/2.5)
    default:
    levelstep=2

  • minsize
    • minimum size for multiresolution levels
      (for spherical panorama images this is the height)
    • when levels=auto it will automatically generate levels down to this size
    • use 'auto' to find automatically the best for typical fullscreen panoramas
    default:
    minsize=auto

  • maxsize
    • maximum size for multiresolution levels
      (for spherical panorama images this is the height)
    • if the size of the source panorama image is higher then this, then it will be downsampled to this size
    • use 'auto' to find automatically the best for typical fullscreen panoramas
    default:
    maxsize=auto

  • xml
    • generate a xml file (true or false)
    • it uses the 'xmltemplate' file to generate the a xml for the panorama
    default:
    xml=true

  • xmlpath
    • path of the xml to generate
    • use the placeholder %INPUTPATH% for path of the input images
    • use the placeholder %BASENAME% for the basename of the panorama
    default:
    xmlpath=%INPUTPATH%/%BASENAME%.xml

  • xmltemplate
    • template file for the xml
    • there are 2 placeholders in the xml file:
      • [PREVIEW] - for the preview tag
      • [IMAGE] - for the image tag
      they will be replaced with the generated xml code for the panorama
    default:
    xmltemplate=kmakemultires.xmltemplates/default.xml

  • xmltemplate_additional_file
    • additional files of the xmltemplate (plugins, lensflares, include files ...)
    • can be used more than once
    • this files will be copied to the panorama directory
    • the paths are made realtive to the .xml file
    default:
    none
    addtional files for the with_plugins.xml template:
    xmltemplate_additional_file=kmakemultires.xmltemplates/krpano_default_flares.jpg
    xmltemplate_additional_file=kmakemultires.xmltemplates/plugins/options.swf
    xmltemplate_additional_file=kmakemultires.xmltemplates/plugins/editor.swf

  • copyswf
    • copy the krpano.swf to the panorama folder (true or false)
    default:
    copyswf=true

  • krpanoswf
    • path to the krpano.swf file
    • only needed when using copyswf=true or renamedswf=true
    default:
    krpanoswf=kmakemultires.krpano/krpano.swf

  • renamedswf
    • copy and rename the krpano.swf to the same name as the xml file
    • this allowes starting the viewer by just clicking the swf file
    • copyswf must be set to true
    • NOTE - using this is not recommended!
      • this makes updating for future krpano.swf versions laborious!
        (each swf file must be updated separately)
      • the htmltemplate will be not adjusted for the renamed swf file
      • and the license file must copied/renamed for every panorama!
      • it should be only used for testing
    default:
    renamedswf=false

  • html
    • generate a html file (true or false)
    • it uses the 'htmltemplate' file to generate the a html for the panorama
    • this is only possible when 'xml' is also set to true
    default:
    html=true

  • htmlpath
    • path of the generated html
    • use the placeholder %INPUTPATH% for path of the input images
    • use the placeholder %BASENAME% for the basename of the panorama
    default:
    htmlpath=%INPUTPATH%/%BASENAME%.html

  • htmltemplate
    • template file for the html
    • there is 1 placeholders in the html file:
      [XML] - for the path to the xml file
    default:
    htmltemplate=kmakemultires.htmltemplates/fullscreen.html

  • htmltemplate_additional_file
    • additional files of the htmltemplate
    • can be used more than once
    • this files will be copied to the panorama directory
    • the paths are made realtive to the htmltemplate .html file
    default:
    htmltemplate_additional_file=kmakemultires.htmltemplates/swfobject/swfobject.js
    htmltemplate_additional_file=kmakemultires.htmltemplates/swfobject/swfkrpanomousewheel.js
    htmltemplate_additional_file=kmakemultires.htmltemplates/swfobject/expressinstall.swf

  • indexbase
    • numbering start of the tiles
    default:
    indexbase=1

  • filter
    • downsample filter for lower multiresolution levels
    • possible filters:
      • POINT = simple point filtering (bad quality)
      • LINEAR = linear filtering (better, but still bad quality)
      • CUBIC = cubic filtering (soft, loss of details)
      • HAMMING = hamming filter (good, only a little loss of details)
      • GAUSS = gaussion filtering (good, only a little loss of details)
      • MITCHELL = mitchell filtering (good quality for upsampling)
      • LANCZOS = windowed sinc filter (best quality, keeps the most details)
    default:
    filter=LANCZOS

  • jpegquality
    • jpeg compression quality for the image tiles
    • 1-100 ... 1=worst, 100=best qualitiy
    default:
    jpegquality=85

  • jpegsubsamp
    • jpeg color subsampling to reduce file size
    • more informations: Wikipedia - Chroma subsampling
    • possible values:
      • 444 = no color subsampling (best quality)
      • 422 = horizontal (1/2) color subsampling
      • 420 = horizontal (1/2) and vertical (1/2) color subsampling (the jpeg default)
      • 411 = horizontal (1/4) and vertical (1/2) color subsampling (best compression)
    default:
    jpegsubsamp=420

  • jpegoptimize
    • optimize jpeg huffman compression
    • should be always on
    • but this needs more processing memory
    • if memory usage is critical it should be disabled
    default:
    jpegoptimize=true

  • manualjpegcompression
    • manual jpeg compression
    • instead of saving jpegs, lossless tiffs are saved
    • these tiffs must be manually converted to jpegs
    default:
    manualjpegcompression=false

  • quiet
    • no console output, process silently
    • only errors are shown
    default:
    quiet=false

  • waitkey
    • wait for keypress after processing
    default:
    waitkey=true