Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: CLI11 to replace Boost program option #373

Merged
merged 129 commits into from Sep 21, 2020
Merged

Conversation

kerautret
Copy link
Member

@kerautret kerautret commented Apr 20, 2020

PR Description/instructions (Work In Progress)

Main steps to transform each tool:

1. Removes the boost program options related headers and replace them with CLI1.hpp:

Capture d’écran 2020-04-23 à 10 47 08

2. Comment in order to remove the option descriptions and parser parts, like for instance here:

Capture d’écran 2020-04-23 à 10 49 08

3. Apply the CLI11 format with shorter style:

Start with the CLI object:
Capture d’écran 2020-04-23 à 10 58 37
And then add the options:
Capture d’écran 2020-04-23 à 10 50 34

4. Check the executable with at least basic examples.

5. Update the documentation

  Just copy past the help result you obtain in your terminal.

Capture d’écran 2020-04-23 à 10 56 43

6. Push your commit on the current branch or apply a Pull Request on it:

https://github.com/kerautret/DGtalTools/tree/CLI11

Progression:

  • Transform all tools of convertors:

    • HDF52vol
    • convertVol
    • dicom2vol
    • freeman2img
    • freeman2sdp
    • heightfield2shading
    • heightfield2vol
    • img2freeman
    • imgAddNoise
    • itk2vol
    • longvol2vol
    • mesh2heightfield
    • mesh2vol
    • ofs2off
    • raw2HDF5
    • raw2vol
    • sdp2vol
    • slice2vol
    • vol2heightfield
    • vol2obj
    • vol2raw
    • vol2sdp
    • vol2slice
    • vol2vox
    • volBoundary2obj
    • vox2vol
  • Transform all tools of estimators:

    • 2dLocalEstimators
    • 3dCurveTangentEstimator
    • 3dLocalEstimators
    • curvatureBC
    • curvatureMCMS
    • curvatureScaleSpaceBCC
    • eulerCharacteristic
    • generic3dNormalEstimators
    • lengthEstimators
    • statisticsEstimators
    • tangentBC
    • vol2normalField
    • volSurfaceRegularization
  • Transform all tools of generators:

    • 3dParametricCurveDigitizer
    • contourGenerator
    • shapeGenerator
  • Transform all tools of geometricTransform:

    • rigidTransform2D
    • rigidTransform3D
  • Transform all tools of imageProcessing:

    • at-u0-v1
    • at-u2-v0
    • atv-u2-v0
  • Transform all tools of visualisation

    • 2dCompImage
    • 3dCompSurfelData
    • 3dCurvatureViewer
    • 3dCurvatureViewerNoise
    • 3dCurveViewer
    • 3dDisplaySurfelData
    • 3dHeightMapViewer
    • 3dImageViewer
    • 3dImplicitSurfaceExtractorBy4DExtension
    • 3dImplicitSurfaceExtractorByThickening
    • 3dSDPViewer
    • 3dVolBoundaryViewer
    • 3dVolViewer
    • displayContours
    • meshViewer
    • patternTriangulation
    • sliceViewer
  • Transform all tools of volumetric:

    • 3dVolMarchingCubes
    • criticalKernelsThinning3D
    • homotopicThinning3D
    • volAddBorder
    • volAddNoise
    • volCComponentCounter
    • volCrop
    • volFillInterior
    • volFlip
    • volImageMetrics
    • volIntensityScale
    • volMask
    • volReSample
    • volSegment
    • volShapeMetrics
    • volSubSample
    • volTrValues

Checklist

  • Doxygen documentation of the code completed (classes, methods, types, members...).
  • Main tool doxygen documentation (following existing documentation of DGtalTools documentation.
  • Check if it follows the tools structure described in CONTRIBUTING.md
  • New entry in the ChangeLog.md added.
  • Update the readme with potentially a screenshot of the tools if it applies.
  • No warning raised in Debug cmake mode (otherwise, Travis C.I. will fail).

kerautret added a commit that referenced this pull request May 5, 2020
auto merge (not very important with PR #373 )
@kerautret kerautret added this to the 1.1 milestone May 7, 2020
@kerautret kerautret marked this pull request as draft May 23, 2020 20:32
@dcoeurjo
Copy link
Member

Youhou !! 🎉🎉🎉

@dcoeurjo dcoeurjo marked this pull request as ready for review September 21, 2020 07:40
@dcoeurjo
Copy link
Member

dcoeurjo commented Sep 21, 2020

thanks @kerautret and @ngophuc for this impressive work

ChangeLog.md Outdated Show resolved Hide resolved
@dcoeurjo
Copy link
Member

Huge thank :) merging

@dcoeurjo dcoeurjo self-requested a review September 21, 2020 09:31
@dcoeurjo dcoeurjo merged commit fb1e2b6 into DGtal-team:master Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants