ImageDistances.jl icon indicating copy to clipboard operation
ImageDistances.jl copied to clipboard

clarification of NCC and ZNCC

Open johnnychen94 opened this issue 4 years ago • 1 comments

Originally posted by @mateuszbaran in #44

By the way, your definition of NCC seems more related to ZNCC? See here: https://www.ncbi.nlm.nih.gov/pmc/articles/PMC3596837/ . Implementation and the docstring are inconsistent about subtracting the mean.

Our NCC implementation is actually zero-mean NCC.

A safe patch to correct the definition is:

  • [x] deprecate NCC/ncc in favor of ZNCC/zncc (#65)
  • [ ] remove the NCC symbol in ImageDistances v0.3.0
  • [ ] add back NCC in ImageDistances v0.4.0 (or maybe even later than that)

johnnychen94 avatar Apr 16 '21 12:04 johnnychen94

This sounds like a good plan :slightly_smiling_face: .

mateuszbaran avatar Apr 18 '21 10:04 mateuszbaran