Meshroom/meshroom/nodes/aliceVision/FeatureMatching.py

import sys
from meshroom.core import desc


class FeatureMatching(desc.CommandLineNode):
    internalFolder = '{cache}/{nodeType}/{uid0}/'
    commandLine = 'aliceVision_featureMatching {allParams}'
    parallelization = desc.Parallelization(inputListParamName='viewpoints', blockSize=20)
    commandLineRange = '--rangeStart {rangeStart} --rangeSize {rangeBlockSize}'

    inputs = [
        desc.File(
            name='input',
            label='Input',
            description='''SfMData file.''',
            value='',
            uid=[0],
        ),
        desc.ChoiceParam(
            name='geometricModel',
            label='Geometric Model',
            description='''Pairwise correspondences filtering thanks to robust model estimation: * f: fundamental matrix * e: essential matrix * h: homography matrix''',
            value='f',
            values=['f', 'e', 'h'],
            exclusive=True,
            uid=[0],
        ),
        desc.ChoiceParam(
            name='describerTypes',
            label='Describer Types',
            description='''Describer types used to describe an image.''',
            value=['SIFT'],
            values=['SIFT', 'SIFT_FLOAT', 'AKAZE', 'AKAZE_LIOP', 'AKAZE_MLDB', 'CCTAG3', 'CCTAG4', 'SIFT_OCV',
                    'AKAZE_OCV'],
            exclusive=False,
            uid=[0],
            joinChar=',',
        ),
        desc.File(
            name='featuresDirectory',
            label='Features Directory',
            description='''Path to a directory containing the extracted features.''',
            value='',
            uid=[0],
        ),
        desc.File(
            name='imagePairsList',
            label='Image Pairs List',
            description='''Path to a file which contains the list of image pairs to match.''',
            value='',
            uid=[0],
        ),
        desc.ChoiceParam(
            name='photometricMatchingMethod',
            label='Photometric Matching Method',
            description='''For Scalar based regions descriptor: * BRUTE_FORCE_L2: L2 BruteForce matching * ANN_L2: L2 Approximate Nearest Neighbor matching * CASCADE_HASHING_L2: L2 Cascade Hashing matching * FAST_CASCADE_HASHING_L2: L2 Cascade Hashing with precomputed hashed regions (faster than CASCADE_HASHING_L2 but use more memory) For Binary based descriptor: * BRUTE_FORCE_HAMMING: BruteForce Hamming matching''',
            value='ANN_L2',
            values=('BRUTE_FORCE_L2', 'ANN_L2', 'CASCADE_HASHING_L2', 'FAST_CASCADE_HASHING_L2', 'BRUTE_FORCE_HAMMING'),
            exclusive=True,
            uid=[0],
        ),
        desc.ChoiceParam(
            name='geometricEstimator',
            label='Geometric Estimator',
            description='''Geometric estimator: * acransac: A-Contrario Ransac * loransac: LO-Ransac (only available for fundamental matrix)''',
            value='acransac',
            values=['acransac', 'loransac'],
            exclusive=True,
            uid=[0],
        ),
        desc.StringParam(
            name='savePutativeMatches',
            label='Save Putative Matches',
            description='''putative matches.''',
            value='',
            uid=[0],
        ),
        desc.BoolParam(
            name='guidedMatching',
            label='Guided Matching',
            description='''the found model to improve the pairwise correspondences.''',
            value=False,
            uid=[0],
        ),
        desc.File(
            name='matchFilePerImage',
            label='Match File Per Image',
            description='''matches in a separate file per image.''',
            value='',
            uid=[0],
        ),
        desc.FloatParam(
            name='distanceRatio',
            label='Distance Ratio',
            description='''Distance ratio to discard non meaningful matches.''',
            value=0.8,
            range=(-float('inf'), float('inf'), 0.01),
            uid=[0],
        ),
        desc.ChoiceParam(
            name='videoModeMatching',
            label='Video Mode Matching',
            description='''sequence matching with an overlap of X images: * 0: will match 0 with (1->X), ... * 2: will match 0 with (1,2), 1 with (2,3), ... * 3: will match 0 with (1,2,3), 1 with (2,3,4), ...''',
            value=0,
            values=('0', '2', '3'),
            exclusive=True,
            uid=[0],
        ),
        desc.IntParam(
            name='maxIteration',
            label='Max Iteration',
            description='''Maximum number of iterations allowed in ransac step.''',
            value=2048,
            range=(0, sys.maxsize, 1),
            uid=[0],
        ),
        desc.BoolParam(
            name='useGridSort',
            label='Use Grid Sort',
            description='''matching grid sort.''',
            value=False,
            uid=[0],
        ),
        desc.File(
            name='exportDebugFiles',
            label='Export Debug Files',
            description='''debug files (svg, dot).''',
            value='',
            uid=[0],
        ),
        desc.StringParam(
            name='fileExtension',
            label='File Extension',
            description='''File extension to store matches (bin or txt).''',
            value='bin',
            uid=[0],
        ),
        desc.IntParam(
            name='maxMatches',
            label='Max Matches',
            description='''Maximum number pf matches to keep.''',
            value=0,
            range=(-sys.maxsize, sys.maxsize, 1),
            uid=[0],
        ),
        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'],
            exclusive=True,
            uid=[],
        )
    ]

    outputs = [
        desc.File(
            name='output',
            label='Output',
            description='''Path to a directory in which computed matches will be stored. Optional parameters:''',
            value='{cache}/{nodeType}/{uid0}/',
            uid=[],
        ),
    ]