###################################################################

###################################################################

1.Introduction.

CrackForest is a fast road crack detector that achieves excellent accuracy.

Part of the Matlab code is supported on Piotr Dollar’s Structured Edge Detection Toolbox (https://github.com/pdollar/edges).

If you use the Structured Edge Detection Toolbox, we appreciate it if you cite an appropriate subset of the following papers:

@article{shi2016automatic,
  title={Automatic road crack detection using random structured forests},
  author={Shi, Yong and Cui, Limeng and Qi, Zhiquan and Meng, Fan and Chen, Zhensong},
  journal={IEEE Transactions on Intelligent Transportation Systems},
  volume={17},
  number={12},
  pages={3434--3445},
  year={2016},
  publisher={IEEE}
}

@inproceedings{cui2015pavement,
  title={Pavement Distress Detection Using Random Decision Forests},
  author={Cui, Limeng and Qi, Zhiquan and Chen, Zhensong and Meng, Fan and Shi, Yong},
  booktitle={International Conference on Data Science},
  pages={95--102},
  year={2015},
  organization={Springer}
}

###################################################################

2.License.

The software is made available for non-commercial research purposes only.

###################################################################

3.Installation.

a) This code is written for the Matlab interpreter (tested with versions R2014b) and requires the Matlab Image Processing Toolbox.

b) Additionally, Piotr’s Computer Vision Toolbox (version 3.26 or later) is also required. It can be downloaded at:

 https://pdollar.github.io/toolbox/.

c) Next, please compile mex code from within Matlab (note: win64/linux64 binaries included):

  mex private/edgesDetectMex.cpp -outdir private [OMPPARAMS]

  mex private/edgesNmsMex.cpp -outdir private [OMPPARAMS]

  mex private/spDetectMex.cpp -outdir private [OMPPARAMS]

  mex private/edgeBoxesMex.cpp -outdir private

Here [OMPPARAMS] are parameters for OpenMP and are OS and compiler dependent.

  Windows: [OMPPARAMS] = '-DUSEOMP' 'OPTIMFLAGS="$OPTIMFLAGS' '/openmp"'

  Linux V1: [OMPPARAMS] = '-DUSEOMP' CFLAGS="$CFLAGS -fopenmp" LDFLAGS="$LDFLAGS -fopenmp"

  Linux V2: [OMPPARAMS] = '-DUSEOMP' CXXFLAGS="$CXXFLAGS -fopenmp" LDFLAGS="$LDFLAGS -fopenmp"

To compile without OpenMP simply omit [OMPPARAMS]; note that code will be single threaded in this case.

d) Add crack detection code to Matlab path (change to current directory first):

>> addpath(pwd); savepath;

e) Finally, optionally download the crack image dataset (necessary for training/evaluation):

 https://github.com/cuilimeng/CrackForest-dataset

f) A fully trained crack model for RGB images is available as part of this release.

###################################################################

4.Getting Started.

• Make sure to carefully follow the installation instructions above.
• Please see "edgesDemo.m" to run demos and get basic usage information.

###################################################################

5.History.

Version 1.0 (2015/09/28)

• initial version

###################################################################