node-bowshock
Version:
An npm Package for Node.js based on https://github.com/emirozer/bowshock
626 lines (564 loc) • 20.5 kB
JavaScript
;
//TODO: Complete helioviewer sdk
var https = require('https');
var fs = require('fs');
var opn = require('opn');
var ProgressBar = require('progress');
/*
http://helioviewer.org/api/docs/v1/
The Helioviewer Project maintains a set of Public APIs with the goal of improving access to solar and heliospheric
datasets to scientists, educators, developers, and the general public. Read below for descriptions of each API
endpoint and examples of usage.
*/
const helpers = require('./helpers');
let helioviewer = {
getjp2image(object){
/*
Helioviewer.org and JHelioviewer operate off of JPEG2000 formatted image data generated from science-quality FITS files. Use the APIs below to interact directly with these intermediary JPEG2000 files.
Download a JP2 image for the specified datasource that is the closest match in time to the `date` requested.
Either `sourceId` must be specified, or the combination of `observatory`, `instrument`, `detector`, and `measurement`.
Request Parameters:
Parameter Required Type Example Description
date Required string 2014-01-01T23:59:59Z Desired date/time of the JP2 image. ISO 8601 combined UTC date and time UTC format.
sourceId Optional number 14 Unique image datasource identifier.
observatory Optional string SDO Observatory name.
instrument Optional string AIA Instrument name.
detector Optional string AIA Detector name.
measurement Optional string 335 Measurement name.
jpip Optional boolean false Optionally return a JPIP URI instead of the binary data of the image itself.
json Optional boolean false Optionally return a JSON object.
EXAMPLE: http://helioviewer.org/api/v1/getJP2Image/?date=2014-01-01T23:59:59Z&sourceId=14&jpip=true
*/
let base_url = 'https://api.helioviewer.org/v2/getJP2Image/?';
let req_url = '';
helpers.validate_iso8601(object.date);
if (object.date.charAt(-1) !== 'Z') {
object.date += 'Z';
}
base_url += 'date=' + object.date + '&';
if (object.sourceId) {
base_url += "sourceId=" + object.sourceId + "&";
}
req_url += base_url + "json=true&jpip=true";
return helpers.getJSON(req_url, 'GET')
},
getjp2header(id){
/*
GET /api/v1/getJP2Header/
Get the XML header embedded in a JPEG2000 image. Includes the FITS header as well as a section of Helioviewer-specific metadata.
Request Parameters:
Parameter Required Type Example Description
id Required number 7654321 Unique JP2 image identifier.
callback Optional string Wrap the response object in a function call of your choosing.
Example (A):
string (XML)
Example Request:
http://helioviewer.org/api/v1/getJP2Header/?id=7654321
*/
return helpers.getXML('https://api.helioviewer.org/v2/getJP2Header/?id=' + id, 'GET')
},
getJPX(object){
let base_url = 'https://api.helioviewer.org/v2/getJPX/?';
let req_url = '';
helpers.validate_iso8601(object.startTime);
if (object.startTime.charAt(-1) !== 'Z') {
object.startTime += 'Z';
}
base_url += 'startTime=' + object.startTime + '&';
helpers.validate_iso8601(object.endTime);
if (object.endTime.charAt(-1) !== 'Z') {
object.endTime += 'Z';
}
base_url += 'endTime=' + object.endTime + '&';
if (object.sourceId) {
base_url += "sourceId=" + object.sourceId + "&";
}
if (object.linked) {
base_url += "linked=" + object.linked + "&";
}
if (object.cadence) {
base_url += "cadence=" + object.cadence + "&";
}
req_url += base_url + "verbose=true&jpip=true";
return helpers.getJSON(req_url, 'GET')
},
getJPXClosestToMidPoint(object){
let base_url = 'https://api.helioviewer.org/v2/getJPXClosestToMidPoint/?';
let req_url = '';
base_url += 'startTimes=';
for(let x in object.startTimes){
base_url += object.startTimes[x] + ',';
}
base_url = base_url.slice(0, -1) + "&";
base_url += 'endTimes=';
for(let x in object.endTimes){
base_url += object.endTimes[x] + ',';
}
base_url = base_url.slice(0, -1) + "&";
base_url += "sourceId=" + object.sourceId + "&";
if (object.linked) {
base_url += "linked=" + object.linked + "&";
}
req_url += base_url + "verbose=true&jpip=true";
return helpers.getJSON(req_url, 'GET')
},
queueMovie(object){
let base_url = 'https://api.helioviewer.org/v2/queueMovie/?';
let req_url = '';
helpers.validate_iso8601(object.startTime);
if (object.startTime.charAt(-1) !== 'Z') {
object.startTime += 'Z';
}
base_url += 'startTime=' + object.startTime + '&';
helpers.validate_iso8601(object.endTime);
if (object.endTime.charAt(-1) !== 'Z') {
object.endTime += 'Z';
}
base_url += 'endTime=' + object.endTime + '&';
base_url += 'layers=' + object.layers + '&';
base_url += 'events=' + object.events + '&';
base_url += 'eventsLabels=' + object.eventsLabels + '&';
base_url += 'imageScale=' + object.imageScale + '&';
if(object.format){
base_url += 'format=' + object.format + '&';
}
if(object.frameRate){
base_url += 'frameRate=' + object.frameRate + '&';
}
if(object.maxFrames){
base_url += 'maxFrames=' + object.maxFrames + '&';
}
if(object.scale){
base_url += 'scale=' + object.scale + '&';
}
if(object.scaleType){
base_url += 'scaleType=' + object.scaleType + '&';
}
if(object.scaleX){
base_url += 'scaleX=' + object.scaleX + '&';
}
if(object.scaleY){
base_url += 'scaleY=' + object.scaleY + '&';
}
if(object.movieLength){
base_url += 'movieLength=' + object.movieLength + '&';
}
if(object.watermark){
base_url += 'watermark=' + object.watermark + '&';
}
if(object.width){
base_url += 'width=' + object.width + '&';
}
if(object.height){
base_url += 'height=' + object.height + '&';
}
if(object.x0){
base_url += 'x0=' + object.x0 + '&';
}
if(object.y0){
base_url += 'y0=' + object.y0 + '&';
}
if(object.x1){
base_url += 'x1=' + object.x1 + '&';
}
if(object.y1){
base_url += 'y1=' + object.y1 + '&';
}
if(object.x2){
base_url += 'x2=' + object.x2 + '&';
}
if(object.y2){
base_url += 'y2=' + object.y2 + '&';
}
if(object.callback){
base_url += 'callback=' + object.callback + '&';
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
reQueueMovie(id){
return helpers.getJSON("https://api.helioviewer.org/v2/reQueueMovie/?id=" + id, 'GET')
},
getMovieStatus(object){
let base_url = 'https://api.helioviewer.org/v2/getMovieStatus/?';
base_url += 'id=' + object.id + '&';
base_url += 'format=' + object.format + '&';
if(object.verbose){
base_url += 'verbose=' + object.verbose + '&';
}
if(object.callback){
base_url += 'callback=' + object.callback + "&";
}
if(object.token){
base_url += 'token=' + object.token + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
downloadMovie(object){
let base_url = 'https://api.helioviewer.org/v2/downloadMovie/?';
base_url += 'id=' + object.id + '&';
base_url += 'format=' + object.format + '&';
if(object.hq){
base_url += 'hq=' + object.hq;
}
var file = fs.createWriteStream(object.id + "." + object.format);
var req = https.get(base_url);
req.on('response', function(res){
var len = parseInt(res.headers['content-length'], 10);
var bar = new ProgressBar(' downloading [:bar] :rate/bps :percent :etas', {
complete: '=',
incomplete: ' ',
width: 20,
total: len
});
res.pipe(file);
res.on('data', function (chunk) {
bar.tick(chunk.length);
});
res.on('end', function () {
console.log('\n');
});
return res;
});
req.end();
},
playMovie(object){
let base_url = 'https://api.helioviewer.org/v2/playMovie/?';
base_url += 'id=' + object.id + '&';
base_url += 'format=' + object.format + '&';
base_url += 'height=' + object.height + '&';
if(object.hq){
base_url += 'hq=' + object.hq + '&';
}
if(object.width){
base_url += 'width=' + object.width + '&';
}
let req_url = base_url.slice(0, -1);
opn(req_url);
return new Promise(function(resolve, reject) {
resolve(req_url);
reject('Error');
});
},
takeScreenshot(object){
/*You must specify values for either `x1`, `y1`, `x2`, and `y2`
or `x0`, `y0`, `width` and `height`.
date, imageScale, layers, and eventsLabels are required
*/
let base_url = 'https://api.helioviewer.org/v2/takeScreenshot/?';
helpers.validate_iso8601(object.date);
if (object.date.charAt(-1) !== 'Z') {
object.date += 'Z';
}
base_url += 'date=' + object.date + '&';
base_url += 'imageScale=' + object.imageScale + '&';
base_url += 'layers=' + object.layers + '&';
base_url += 'height=' + object.height + '&';
if(object.events){
base_url += 'events=' + object.events + '&';
}
if(object.scale){
base_url += 'scale=' + object.scale + '&';
}
if(object.scaleType){
base_url += 'scaleType=' + object.scaleType + '&';
}
if(object.scaleX){
base_url += 'scaleX=' + object.scaleX + '&';
}
if(object.scaleY){
base_url += 'scaleY=' + object.scaleY + '&';
}
if(object.width){
base_url += 'width=' + object.width + '&';
}
if(object.x0){
base_url += 'x0=' + object.x0 + '&';
}
if(object.y0){
base_url += 'y0=' + object.y0 + '&';
}
if(object.x1){
base_url += 'x1=' + object.x1 + '&';
}
if(object.y1){
base_url += 'y1=' + object.y1 + '&';
}
if(object.x2){
base_url += 'x2=' + object.x2 + '&';
}
if(object.y2){
base_url += 'y2=' + object.y2 + '&';
}
if(object.watermark){
base_url += 'watermark=' + object.watermark + '&';
}
if(object.callback){
base_url += 'callback=' + object.callback + '&';
}
if(object.display){
base_url += 'display=' + object.display + '&';
if(object.display === true){
opn(base_url.slice(0, -1));
return base_url.slice(0, -1);
}
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
downloadScreenshot(id){
let base_url = 'https://api.helioviewer.org/v2/downloadScreenshot/?id=' + id;
let file = fs.createWriteStream(id + ".png");
let req = https.get(base_url);
req.on('response', function(res){
var len = parseInt(res.headers['content-length'], 10);
var bar = new ProgressBar(' downloading [:bar] :rate/bps :percent :etas', {
complete: '=',
incomplete: ' ',
width: 20,
total: len
});
res.pipe(file);
res.on('data', function (chunk) {
bar.tick(chunk.length);
});
res.on('end', function () {
console.log('\n');
});
});
req.end();
},
getClosestImage(object){
let base_url = "https://api.helioviewer.org/v2/getClosestImage/?";
helpers.validate_iso8601(object.date);
if (object.date.charAt(-1) !== 'Z') {
object.date += 'Z';
}
base_url += "date=" + object.date + "&";
base_url += "sourceId=" + object.sourceId + "&";
if(object.callback){
base_url += "callback=" + object.callback + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
getDataSources(object){
let base_url = "https://api.helioviewer.org/v2/getDataSources/?";
if (!object) {
return helpers.getJSON(base_url.slice(0, -1));
}
if(object.verbose){
base_url += "verbose=" + object.verbose + "&";
}
if(object.enable){
base_url += "enable=" + object.enable + "&";
}
if(object.callback){
base_url += "callback=" + object.callback + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
getTile(object){
let base_url = "https://api.helioviewer.org/v2/getTile/?";
base_url += "id=" + object.id + "&";
base_url += "x=" + object.x + "&";
base_url += "y=" + object.y + "&";
base_url += "imageScale=" + object.imageScale + "&";
opn(base_url.slice(0, -1));
return base_url.slice(0, -1);
},
shortenURL(query, callback){
let base_url = "https://api.helioviewer.org/v2/shortenURL/?";
base_url += "queryString=" + query + "&";
if(callback){
base_url += "callback=" + callback + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
getNewsFeed(callback){
let base_url = "https://api.helioviewer.org/v2/getNewsFeed/?";
if(callback){
base_url += "callback=" + callback;
}
return helpers.getXML(base_url)
},
checkYouTubeAuth(callback){
let base_url = "https://api.helioviewer.org/v2/checkYouTubeAuth/?";
if (callback) {
base_url += "callback=" + callback;
}
return helpers.getJSON(base_url, 'GET')
},
getYouTubeAuth(object){
let base_url = "https://api.helioviewer.org/v2/getYouTubeAuth/?";
base_url += "id=" + object.id.toString() + "&";
base_url += "title=" + object.title + "&";
base_url += "description=" + object.description + "&";
base_url += "tags=" + object.tags + "&";
if(object.share){
base_url += "share=" + object.share + "&";
}
opn(encodeURI(base_url.slice(0, -1)));
return encodeURI(base_url.slice(0, -1));
},
uploadMovieToYouTube(object){
let base_url = "https://api.helioviewer.org/v2/uploadMovieToYouTube/?";
base_url += "id=" + object.id + "&";
if(object.title){
base_url += "title=" + object.title + "&";
}
if(object.description){
base_url += "description=" + object.description + "&";
}
if(object.tags){
base_url += "tags=" + object.tags + "&";
}
if(object.share){
base_url += "share=" + object.share + "&";
}
if(object.html){
base_url += "html=" + object.html + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
},
getUserVideos(object){
let base_url = "https://api.helioviewer.org/v2/getUserVideos/?";
if(!object){
return helpers.getJSON(base_url.slice(0, -1), 'GET')
}
if(object.num){
base_url += "num=" + object.num + "&";
}
if(object.since){
helpers.validate_iso8601(object.since);
if (object.since.charAt(-1) !== 'Z') {
object.since += 'Z';
}
base_url += "since=" + object.since + "&";
}
if(object.force){
base_url += "force=" + object.force + "&";
}
if(object.callback){
base_url += "callback=" + object.callback + "&";
}
return helpers.getJSON(base_url.slice(0, -1), 'GET')
}
};
module.exports = helioviewer;
//helioviewer.getjp2image({date:"2014-01-01T23:59:59", sourceId:14});
//helioviewer.getjp2header(17654321);
/*helioviewer.getJPX({
startTime: "2014-01-01T00:00:00",
endTime: "2014-01-01T00:45:00" ,
sourceId: 14,
cadence: 12
});
*/
/*helioviewer.getJPXClosestToMidPoint({
startTimes: [1306886400,1306887000,1306887600],
endTimes: [1306886700,1306887300,1306887900] ,
sourceId: 14,
linked: true
});
*/
/*helioviewer.queueMovie({
startTime: "2010-03-01T12:12:12",
endTime: "2010-03-04T12:12:12",
layers: "[3,1,100],[4,1,100]",
events: "[AR,HMI_HARP;,SPoCA,1],[CH,all,1]",
eventsLabels: false,
imageScale: 21.04,
format: "mp4",
frameRate: 15,
maxFrames: 300,
scale: true,
scaleType: "earth",
scaleX: -1000,
scaleY: -500,
movieLength: 4.3333,
watermark: true,
width: 1920,
height: 1200,
x0: 0,
y0: 0,
x1: -5000,
y1: -5000,
x2: 5000,
y2: 5000,
//callback: "Wrap the response object in a function call of your choosing."
});*/
//helioviewer.reQueueMovie("VXvX5");
/*
helioviewer.getMovieStatus({
id: "F3Dh5",
format: "mp4",
verbose: true,
//callback: "callback",
//token: "4673d6db4e2a3365ab361267f2a9a112"
});
*/
/*helioviewer.downloadMovie({
id: "VXvX5",
format: "mp4",
hq: true
});
*/
/*helioviewer.playMovie({
id: "F3Dh5",
format: "mp4",
height: 820,
//hq: true,
//width: 846
});*/
/*helioviewer.takeScreenshot({
date: "2014-01-01T23:59:59",
imageScale: 2.4204409,
layers: "[SDO,AIA,AIA,335,1,100]",
eventLabels: false,
height: 1200,
//events: "[AR,HMI_HARP;SPoCA,1],[CH,all,1]"
//scale: false,
//scaleType: "earth",
//scaleX: -1000,
//scaleY: -500,
//width: 1920,
//x0: 1,
//y0: 1,
x1: -5000,
y1: -5000,
x2: 5000,
y2: 5000,
display: true,
watermark: false
});
*/
//helioviewer.downloadScreenshot(3240748);
//helioviewer.getClosestImage({date: "2014-01-01T23:59:59", sourceId: 14});
/*helioviewer.getDataSources({
verbose: true,
enable: "[Yohkoh,STEREO_A,STEREO_B]",
//callback: "callback
});
*/
/*helioviewer.getTile({
id: 36275490,
x: -1,
y: -1,
imageScale: 2.42044088
});*/
//helioviewer.shortenURL("date%3D2014-02-25T15%3A18%3A07.000Z%26imageScale%3D2.4204409%26centerX%3D-410.06307838566283%26centerY%3D-244.6662219973343%26imageLayers%3D%255BSDO%2CAIA%2CAIA%2C304%2C1%2C100%255D%26eventLayers%3D%26eventLabels%3Dtrue");
//helioviewer.getNewsFeed();
//helioviewer.reQueueMovie("VXvX5");
/*helioviewer.checkYouTubeAuth();
*/
/*helioviewer.getYouTubeAuth({
id: "F3Dh5",
title: "Test",
description: "This movie was produced by Helioviewer.org. See the original at http://helioviewer.org/?movieId=F3Dh5 or download a high-quality version from http://api.helioviewer.org/v2/downloadMovie/?id=F3Dh5&format=mp4&hq=true",
tags: "test",
share: true
});*/
//helioviewer.checkYouTubeAuth();
/*helioviewer.uploadMovieToYouTube({
id: "F3Dh5",
share: true
});*/
//helioviewer.getUserVideos();