├── test ├── baboon_rgb_256.jpg └── index.js ├── README.md ├── package.json ├── LICENSE ├── .gitignore └── src └── index.js /test/baboon_rgb_256.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Abdelaziz18003/gnuplot-imshow/master/test/baboon_rgb_256.jpg -------------------------------------------------------------------------------- /test/index.js: -------------------------------------------------------------------------------- 1 | const getPixels = require('get-pixels') 2 | const imshow = require('../src/index') 3 | 4 | getPixels('test/baboon_rgb_256.jpg', (err, pixels) => { 5 | imshow(pixels, {title: 'baboon image'}) 6 | }) 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gnuplot-imshow 2 | Display an ndarray as an image using gnuplot 3 | 4 | 5 | ## Installation 6 | 7 | ```bash 8 | npm install gnuplot-imshow 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | const getPixels = require('get-pixels') 15 | const imshow = require('gnuplot-imshow'); 16 | 17 | getPixels('baboon.jpg', (err, pixels) => { 18 | imshow(pixels, {title: 'baboon image'}) 19 | }) 20 | ``` 21 | ![gnuplot-imshow-demo](https://i.imgur.com/hNHi08o.png) -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gnuplot-imshow", 3 | "version": "0.3.1", 4 | "description": "Display an ndarray as an image using gnuplot", 5 | "main": "src/index.js", 6 | "scripts": { 7 | "test": "node test/index.js" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/Abdelaziz18003/gnuplot-imshow.git" 12 | }, 13 | "author": "", 14 | "license": "MIT", 15 | "bugs": { 16 | "url": "https://github.com/Abdelaziz18003/gnuplot-imshow/issues" 17 | }, 18 | "homepage": "https://github.com/Abdelaziz18003/gnuplot-imshow#readme", 19 | "devDependencies": { 20 | "get-pixels": "^3.3.2" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Abdelaziz Mokhnache 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | "use strict" 2 | 3 | const { spawn } = require('child_process'); 4 | const os = require('os'); 5 | 6 | module.exports = function imshow (ndarray, options = {}) { 7 | if (!isNdarray(ndarray) && !isValidImage(ndarray)) { 8 | throw new Error('Image must be a 2D ndarray or a 3D ndarray having 3 or 4 channels') 9 | } 10 | let data = '' 11 | for (let i = 0; i < ndarray.shape[0]; i++) { 12 | // get-pixels package always returns a rotated image 13 | // so we fix this below by counting in reverse 14 | for (let j = ndarray.shape[1] - 1; j >= 0; j--) { 15 | data += `${ndarray.get(i, j, 0)} ${ndarray.get(i, j, 1)} ${ndarray.get(i, j, 2)}\n` 16 | } 17 | data += '\n\n' 18 | } 19 | 20 | let gnuplot = spawn('gnuplot', ['-p']); 21 | if (options.title) { 22 | gnuplot.stdin.write(`set term ${getTerminal()} title '${options.title}'\n`); 23 | } 24 | gnuplot.stdin.write(`set size square\n`); 25 | gnuplot.stdin.write(`set size square\n`); 26 | gnuplot.stdin.write(`set autoscale xfix\n`); 27 | gnuplot.stdin.write(`set autoscale yfix\n`); 28 | gnuplot.stdin.write(`plot '-' using -2:0:1:2:3 with rgbimage\n`); 29 | gnuplot.stdin.write(`${data}`); 30 | gnuplot.stdin.write(`EOF`); 31 | gnuplot.stdin.end(); 32 | } 33 | 34 | function isNdarray (array) { 35 | return ( 36 | array.hasOwnProperty('data') && 37 | array.hasOwnProperty('shape') && 38 | array.hasOwnProperty('stride') && 39 | array.hasOwnProperty('offset') 40 | ) 41 | } 42 | 43 | function isValidImage (image) { 44 | return image.dimension === 2 || 45 | image.dimension === 3 && image.shape[2] === 3 || 46 | image.dimension === 3 && image.shape[2] === 4 47 | } 48 | 49 | function getTerminal () { 50 | const currentOS = os.platform; 51 | const terminals = { 52 | win32: 'wxt', 53 | linux: 'qt' 54 | } 55 | return terminals[currentOS] || 'qt' 56 | } --------------------------------------------------------------------------------