Skip to content

Commit 4864a17

Browse files
committed
[bin] batch: improve help
Clarify the wording for --input, --inputRecursive, --pipeline and --output.
1 parent ccb7851 commit 4864a17

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

bin/meshroom_batch

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,22 @@ Additional Resources:
6161

6262
general_group = parser.add_argument_group('General Options')
6363
general_group.add_argument(
64-
'-i', '--input', metavar='NODEINSTANCE="SFM/FOLDERS/IMAGES,..."', type=str, nargs='*',
64+
'-i', '--input',
65+
metavar='FILE FOLDER NODEINSTANCE=FILE,FOLDER,...',
66+
type=str,
67+
nargs='*',
6568
default=[],
66-
help='Input folder containing images or folders of images or file (.sfm or .json) '
67-
'with images paths and optionally predefined camera intrinsics.')
69+
help='Input files and folders to process. '
70+
'When multiple Init Nodes exist in the pipeline, inputs are applied to all by default. '
71+
'To target a specific Init Node, use the format Node1=input1,input2 Node2=input3')
6872

6973
general_group.add_argument(
70-
'-I', '--inputRecursive', metavar='NODEINSTANCE="FOLDERS/IMAGES,..."', type=str, nargs='*',
74+
'-I', '--inputRecursive',
75+
metavar='FOLDER FOLDER_2 NODEINSTANCE=FOLDER,FOLDER_2,...',
76+
type=str,
77+
nargs='*',
7178
default=[],
72-
help='Input folders containing all images recursively.')
79+
help='Recursively scan these directories for input files.')
7380

7481
general_group.add_argument(
7582
'-p', '--pipeline',
@@ -78,18 +85,16 @@ general_group.add_argument(
7885
default=os.environ.get('MESHROOM_DEFAULT_PIPELINE', 'photogrammetry'),
7986
help='Template pipeline among those listed or a Meshroom file containing a custom pipeline '
8087
'to run on input images:\n' +
81-
'\n'.join([' - ' + p for p in meshroom.core.pipelineTemplates]) +
82-
'\nRequirements: the graph must contain one CameraInit node, and at least '
83-
'one CopyFiles node if --output is set.',
84-
)
88+
'\n'.join([' - ' + p for p in meshroom.core.pipelineTemplates]))
8589

8690
general_group.add_argument(
87-
'-o', '--output', metavar='FOLDER COPYFILES_INSTANCE=FOLDER',
88-
type=str, required=False, nargs='*',
89-
help='Output folder where results should be copied to. '
90-
'If the output folder is provided without specifiying the instance of a CopyFiles node, '
91-
'all the CopyFiles nodes in the scene will be set with the same ouput folder value. '
92-
'If not set, results will have to be retrieved directly from the cache folder.')
91+
'-o', '--output',
92+
metavar='FOLDER COPYFILES_INSTANCE=FOLDER',
93+
type=str,
94+
required=False,
95+
nargs='*',
96+
help='Output folder for copying results. '
97+
'Sets output folder for all CopyFiles nodes, or target specific nodes using COPYFILES_INSTANCE=FOLDER.')
9398

9499
general_group.add_argument(
95100
'-s', '--save', metavar='FILE', type=str, required=False,

0 commit comments

Comments
 (0)