documentation added

This commit is contained in:
Simon 2021-07-02 20:28:52 +02:00 committed by GitHub
parent c4bd28d956
commit 6ff9140aa8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,23 +1,25 @@
__version__ = "2.0"
__version__ = "1.0"
from meshroom.core import desc
class Split360Images(desc.CommandLineNode):
commandLine = 'aliceVision_utils_split360Images {allParams}'
category = 'Utils'
documentation = '''This program is used to extract multiple images from equirectangular or dualfisheye images or image folder'''
inputs = [
desc.File(
name='input',
label='Images Folder',
description='Images Folder',
description="Images Folder",
value='',
uid=[0],
),
),
desc.ChoiceParam(
name='splitMode',
label='Split Mode',
description='''Split mode (equirectangular, dualfisheye)''',
description="Split mode (equirectangular, dualfisheye)",
value='equirectangular',
values=['equirectangular', 'dualfisheye'],
exclusive=True,
@ -26,7 +28,7 @@ class Split360Images(desc.CommandLineNode):
desc.ChoiceParam(
name='dualFisheyeSplitPreset',
label='Dual Fisheye Split Preset',
description='''Dual-Fisheye split type preset (center, top, bottom)''',
description="Dual-Fisheye split type preset (center, top, bottom)",
value='center',
values=['center', 'top', 'bottom'],
exclusive=True,
@ -35,7 +37,7 @@ class Split360Images(desc.CommandLineNode):
desc.IntParam(
name='equirectangularNbSplits',
label='Equirectangular Nb Splits',
description='''Equirectangular number of splits''',
description="Equirectangular number of splits",
value=2,
range=(1, 100, 1),
uid=[0],
@ -43,7 +45,7 @@ class Split360Images(desc.CommandLineNode):
desc.IntParam(
name='equirectangularSplitResolution',
label='Equirectangular Split Resolution',
description='''Equirectangular split resolution''',
description="Equirectangular split resolution",
value=1200,
range=(100, 10000, 1),
uid=[0],
@ -51,7 +53,7 @@ class Split360Images(desc.CommandLineNode):
desc.ChoiceParam(
name='equirectangularDemoMode',
label='Equirectangular Demo Mode',
description='''Export a SVG file that simulate the split''',
description="Export a SVG file that simulate the split",
value='0',
values=['0', '1'],
exclusive=True,
@ -63,7 +65,7 @@ class Split360Images(desc.CommandLineNode):
desc.File(
name='output',
label='Output Folder',
description='''Output folder for extracted frames.''',
description="Output folder for extracted frames.",
value=desc.Node.internalFolder,
uid=[],
),