[nodes] D-G: Harmonize and improve labels and descriptions

Use CamelCase for all labels, always end descriptions with periods, and
replace the mixed use of single and double quotes with double quotes
only.
This commit is contained in:
Candice Bentéjac 2023-06-16 10:31:03 +02:00
parent 241bead35c
commit 5c2865968d
11 changed files with 971 additions and 935 deletions

View file

@ -32,126 +32,126 @@ It is robust to motion-blur, depth-of-field, occlusion. Be careful to have enoug
inputs = [
desc.File(
name='input',
label='SfMData',
description='SfMData file.',
value='',
name="input",
label="SfMData",
description="Input SfMData file.",
value="",
uid=[0],
),
desc.File(
name='masksFolder',
label='Masks Folder',
description='Use masks to filter features. Filename should be the same or the image uid.',
value='',
name="masksFolder",
label="Masks Folder",
description="Use masks to filter features. Filename should be the same or the image UID.",
value="",
uid=[0],
),
desc.ChoiceParam(
name='describerTypes',
label='Describer Types',
description='Describer types used to describe an image.',
value=['dspsift'],
values=['sift', 'sift_float', 'sift_upright', 'dspsift', 'akaze', 'akaze_liop', 'akaze_mldb', 'cctag3', 'cctag4', 'sift_ocv', 'akaze_ocv', 'tag16h5'],
name="describerTypes",
label="Describer Types",
description="Describer types used to describe an image.",
value=["dspsift"],
values=["sift", "sift_float", "sift_upright", "dspsift", "akaze", "akaze_liop", "akaze_mldb", "cctag3", "cctag4", "sift_ocv", "akaze_ocv", "tag16h5"],
exclusive=False,
uid=[0],
joinChar=',',
joinChar=",",
),
desc.ChoiceParam(
name='describerPreset',
label='Describer Density',
description='Control the ImageDescriber density (low, medium, normal, high, ultra).\n'
'Warning: Use ULTRA only on small datasets.',
value='normal',
values=['low', 'medium', 'normal', 'high', 'ultra', 'custom'],
name="describerPreset",
label="Describer Density",
description="Control the ImageDescriber density (low, medium, normal, high, ultra).\n"
"Warning: Use ULTRA only on small datasets.",
value="normal",
values=["low", "medium", "normal", "high", "ultra", "custom"],
exclusive=True,
uid=[0],
group=lambda node: 'allParams' if node.describerPreset.value != 'custom' else None,
),
desc.IntParam(
name='maxNbFeatures',
label='Max Nb Features',
description='Max number of features extracted (0 means default value based on Describer Density).',
name="maxNbFeatures",
label="Max Nb Features",
description="Maximum number of features extracted (0 means default value based on Describer Density).",
value=0,
range=(0, 100000, 1000),
uid=[0],
advanced=True,
enabled=lambda node: (node.describerPreset.value == 'custom'),
enabled=lambda node: (node.describerPreset.value == "custom"),
),
desc.ChoiceParam(
name='describerQuality',
label='Describer Quality',
description='Control the ImageDescriber quality (low, medium, normal, high, ultra).',
value='normal',
values=['low', 'medium', 'normal', 'high', 'ultra'],
name="describerQuality",
label="Describer Quality",
description="Control the ImageDescriber quality (low, medium, normal, high, ultra).",
value="normal",
values=["low", "medium", "normal", "high", "ultra"],
exclusive=True,
uid=[0],
),
desc.ChoiceParam(
name='contrastFiltering',
label='Contrast Filtering',
name="contrastFiltering",
label="Contrast Filtering",
description="Contrast filtering method to ignore features with too low contrast that can be considered as noise:\n"
"* Static: Fixed threshold.\n"
"* AdaptiveToMedianVariance: Based on image content analysis.\n"
"* NoFiltering: Disable contrast filtering.\n"
"* GridSortOctaves: Grid Sort but per octaves (and only per scale at the end).\n"
"* GridSort: Grid sort per octaves and at the end (scale * peakValue).\n"
"* GridSortScaleSteps: Grid sort per octaves and at the end (scale and then peakValue).\n"
"* NonExtremaFiltering: Filter non-extrema peakValues.\n",
value='GridSort',
values=['Static', 'AdaptiveToMedianVariance', 'NoFiltering', 'GridSortOctaves', 'GridSort', 'GridSortScaleSteps', 'GridSortOctaveSteps', 'NonExtremaFiltering'],
" - Static: Fixed threshold.\n"
" - AdaptiveToMedianVariance: Based on image content analysis.\n"
" - NoFiltering: Disable contrast filtering.\n"
" - GridSortOctaves: Grid Sort but per octaves (and only per scale at the end).\n"
" - GridSort: Grid sort per octaves and at the end (scale * peakValue).\n"
" - GridSortScaleSteps: Grid sort per octaves and at the end (scale and then peakValue).\n"
" - NonExtremaFiltering: Filter non-extrema peakValues.\n",
value="GridSort",
values=["Static", "AdaptiveToMedianVariance", "NoFiltering", "GridSortOctaves", "GridSort", "GridSortScaleSteps", "GridSortOctaveSteps", "NonExtremaFiltering"],
exclusive=True,
advanced=True,
uid=[0],
),
desc.FloatParam(
name='relativePeakThreshold',
label='Relative Peak Threshold',
description='Peak Threshold relative to median of gradients.',
name="relativePeakThreshold",
label="Relative Peak Threshold",
description="Peak threshold relative to median of gradients.",
value=0.01,
range=(0.01, 1.0, 0.001),
advanced=True,
uid=[0],
enabled=lambda node: (node.contrastFiltering.value == 'AdaptiveToMedianVariance'),
enabled=lambda node: (node.contrastFiltering.value == "AdaptiveToMedianVariance"),
),
desc.BoolParam(
name='gridFiltering',
label='Grid Filtering',
description='Enable grid filtering. Highly recommended to ensure usable number of features.',
name="gridFiltering",
label="Grid Filtering",
description="Enable grid filtering. Highly recommended to ensure usable number of features.",
value=True,
advanced=True,
uid=[0],
),
desc.ChoiceParam(
name='workingColorSpace',
label='Working Color Space',
description='Allows you to choose the color space in which the data are processed.',
value='sRGB',
values=['sRGB', 'Linear', 'ACES2065-1', 'ACEScg', 'no_conversion'],
name="workingColorSpace",
label="Working Color Space",
description="Allows you to choose the color space in which the data are processed.",
value="sRGB",
values=["sRGB", "Linear", "ACES2065-1", "ACEScg", "no_conversion"],
exclusive=True,
uid=[0],
),
desc.BoolParam(
name='forceCpuExtraction',
label='Force CPU Extraction',
description='Use only CPU feature extraction.',
name="forceCpuExtraction",
label="Force CPU Extraction",
description="Use only CPU feature extraction.",
value=True,
uid=[],
advanced=True,
),
desc.IntParam(
name='maxThreads',
label='Max Nb Threads',
description='Specifies the maximum number of threads to run simultaneously (0 for automatic mode).',
name="maxThreads",
label="Max Nb Threads",
description="Maximum number of threads to run simultaneously (0 for automatic mode).",
value=0,
range=(0, 24, 1),
uid=[],
advanced=True,
),
desc.ChoiceParam(
name='verboseLevel',
label='Verbose Level',
description='verbosity level (fatal, error, warning, info, debug, trace).',
value='info',
values=['fatal', 'error', 'warning', 'info', 'debug', 'trace'],
name="verboseLevel",
label="Verbose Level",
description="Verbosity level (fatal, error, warning, info, debug, trace).",
value="info",
values=["fatal", "error", "warning", "info", "debug", "trace"],
exclusive=True,
uid=[],
)
@ -159,9 +159,9 @@ It is robust to motion-blur, depth-of-field, occlusion. Be careful to have enoug
outputs = [
desc.File(
name='output',
label='Features Folder',
description='Output path for the features and descriptors files (*.feat, *.desc).',
name="output",
label="Features Folder",
description="Output path for the features and descriptors files (*.feat, *.desc).",
value=desc.Node.internalFolder,
uid=[],
),