node package manager
Stop writing boring code. Discover, share, and reuse within your team. Create a free org »

best-image-browser

BestImage Browser

alt text

A user interface for testing out the bestImage module, and to experiment with various alterations to the image scoring configuration and algorithm.

BestImage has a simple interface for simply retrieving the "best image" given a URL, and a "query", which is a string which represents the kind of information one might be seeking on this particular page.
The quality of the result returned will be dependent on the construction of the destination web site. If the webmaster, for example, tries to highlight directly the relevant image using meta tags (og, twitter, etc.) Then this will be preferred, otherwise a scoring algorithm is used based on characteristics learned on what makes for a good image, including matching to the provided query, and title of the document.

BestImage also provides a way for you to do your own scoring by either modifying the scores provided by BestImage, or by overriding them fully with your own scoring algorithm.

About the Scoring Function (scoreFn) which can be passed to getBestAltImage

provide a callback to post-adjust the default scoring algorithm for an array of image objects. If specified, this callback by default will be called after bestImage has completed it's scoring. The scores for all objects will be between 0 and 1, with the highest scoring item always being at 1.

The array of objects will be as follows:

 { src: image src tag from document
   alt: optional title (alt text) for image
   class: class name of image tag
   isMeta: image was specified in meta tags (curated)
   docTitle: title of source document and/or query used to generate it
   score: <the calculated score>
 }

If you pass in replace=true, then the default scoring algorithm is bypassed, and all scores will be set to 0.

Your callback should be of the form:

function(imgArray) {
 
    // do your processing
    imgArray.forEach(function(item)) {
    item.score = myScore(item);   // array is altered in place
    }
 }

Usage:

Installation

npm install best-image-browser

License

The MIT License (MIT)

Copyright (c) 2017, IAC Publishing Labs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.