Skip to content

DiffImagesResult

diffImages returns this rather than a DiffImageResult: a list has no before and after, and the mask says which of them disagree rather than what happened to a pixel.

FieldWhat it is
widthHow wide the frame all of them were compared in is.
heightHow tall it is.
areasWhere each picture sits in it, in the order they were given.
offsetsHow far each was moved to line it up with the baseline.
baselineWhich of them the rest were counted against.
maskA bit a picture: bit i is set where the picture at i differs from the baseline.
regionsWhere the changes are, in reading order.
statsA DiffImagesStats.
completeWhether the list of regions holds all of them.

DiffImagesStats is pixels, covered, unchanged, changed and ratio as a pair's is, with apart saying how many pixels each picture disagrees with the baseline about.

DiffImagesSimilarity, which imagesSimilarity returns, is the same counts as shares.

Released under the MIT License