[nodes] add some nodes documentation

This commit is contained in:
Fabien Castan 2020-03-26 11:20:44 +01:00
parent 0e606eef4e
commit 64a4c9426a
30 changed files with 352 additions and 18 deletions

View file

@ -10,6 +10,13 @@ class PanoramaCompositing(desc.CommandLineNode):
commandLine = 'aliceVision_panoramaCompositing {allParams}'
size = desc.DynamicNodeSize('input')
documentation = '''
Once the images have been transformed geometrically (in PanoramaWarping),
they have to be fused together in a single panorama image which looks like a single photography.
The Multi-band Blending method provides the best quality. It averages the pixel values using multiple bands in the frequency domain.
Multiple cameras are contributing to the low frequencies and only the best one contributes to the high frequencies.
'''
inputs = [
desc.File(
name='input',
@ -31,7 +38,10 @@ class PanoramaCompositing(desc.CommandLineNode):
desc.ChoiceParam(
name='compositerType',
label='Compositer Type',
description='Which compositer should be used to blend images',
description='Which compositer should be used to blend images:\n'
' * multiband: high quality transition by fusing images by frequency bands\n'
' * replace: debug option with straight transitions\n'
' * alpha: debug option with linear transitions\n',
value='multiband',
values=['replace', 'alpha', 'multiband'],
exclusive=True,
@ -40,7 +50,10 @@ class PanoramaCompositing(desc.CommandLineNode):
desc.ChoiceParam(
name='overlayType',
label='Overlay Type',
description='Which overlay to display on top of panorama for debug',
description='Overlay on top of panorama to analyze transitions:\n'
' * none: no overlay\n'
' * borders: display image borders\n'
' * seams: display transitions between images\n',
value='none',
values=['none', 'borders', 'seams'],
exclusive=True,