Skip to content

Commit

Permalink
Previous commit also added capability to generate BIFs from colour im…
Browse files Browse the repository at this point in the history
…ages. These are converted to greyscale internally before generating BIFs. This commit amends documentation to reflect this.
  • Loading branch information
martintoreilly committed Aug 21, 2016
1 parent 9af7abf commit 6beeb60
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions @mtBifs/mtBifs.m
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@
%% Public instance methods
methods (Access = public)
function obj = mtBifs(inputImage, blurWidth, flatnessThreshold)
% Creates a BIF object from a 2D greyscale image.
% Creates a BIF object from a 2D image.
%
% INPUTS:
% inputImage: 2D greyscale image for which to generate BIFs. Values can
% be in any range, but input must be 2D image.
% inputImage: 2D image for which to generate BIFs. Image can be greyscale
% (colour images are converted to greyscale to generate BIFs).
% blurWidth: Standard deviation of Gaussian used to generate BIF filters.
% flatnessThreshold: Threshold for 'flat' bif class. Zeroth order BIF response
% is multiplied by this threshold factor. The higher the flatness threshold
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Type `mtDemoBifLab` at the Matlab command line to display demonstration images
and their associated BIFs

### Generate BIFs
Generate BIFs from a **greyscale** image using `bifs = mtBifs(inputImage, blurWidth, flatnessThreshold)`
Generate BIFs from an image using `bifs = mtBifs(inputImage, blurWidth, flatnessThreshold)`

`blurWidth` (σ in the reference papers) sets the scale of the features that the BIFs detect. It is the
standard deviation of the gaussian derivative filters used to
Expand Down

0 comments on commit 6beeb60

Please sign in to comment.