EARTH

TOTEM EARTH* provides a 2D-3D earth service to programmicatlly embed 3D animated objects with the following CRUD endpoints:

TBD

Manage

npm install @totemorg/earth		# install service

npm run start [ ? | $ | ...]	# Unit test
npm run verminor				# Roll minor version
npm run vermajor				# Roll major version
npm run redoc					# Regen documentation

Usage

Acquire, optionally configure and start a EARTH server:

const EARTH = require("@totemorg/earth").config({
	key: value, 						// set key
	"key.key": value, 					// indexed set
	"key.key.": value					// indexed append
}, sql => {
	console.log( sql ? "look mom - Im running!" : "something evil is lurking" );
});

where configuration keys follow ENUMS deep copy conventions.

Program Reference

EARTH

Provide earth-based chipping and Cesium interface.

Requires: module:fs, module:child_process, module:stream, module:enums

• EARTH
  • static
    • .aoi
    • .limit
    • .make
    • .cache
    • .models
    • .spoof
    • .nodeRouters
    • .ringRadius()
    • .getVoxels()
      • ~getMeta()
    • .ingestCache(sql, fileID, cb)
    • .ingestPipe(sql, filter, fileID, src, cb)
    • .ingestList(sql, evs, fileID, cb)
    • .ingestFile(sql, path, fileID, cb)
    • .ingestService()
    • .config()
    • .detectAOI()
    • .voxelizeAOI()
    • .chipAOI()
  • inner
    • ~POS()
    • ~AOI()

EARTH.aoi

Kind: static property of EARTH

EARTH.limit

Kind: static property of EARTH

EARTH.make

Kind: static property of EARTH

EARTH.cache

Kind: static property of EARTH

EARTH.models

Kind: static property of EARTH

EARTH.spoof

Kind: static property of EARTH

EARTH.nodeRouters

Kind: static property of EARTH

EARTH.ringRadius()

Kind: static method of EARTH

EARTH.getVoxels()

Kind: static method of EARTH

getVoxels~getMeta()

Chip voxels defined by the pipe:

    "PIPE NAME" ||  
    {
        file: "PLUGIN.CASE" || "/DATASET?QUERY" || [ ev, ev, ... ] || ev
        group: "KEY,..." || ""  
        where: { KEY: VALUE, ...} || {}  
        order: "KEY,..." || "t"  
        limit: VALUE || 1000  
        task: "NAME" || ""  
        aoi: "NAME" || [ [lat,lon], ... ] || [] 
    }

with calbacks to cb({File, Voxel, Events, Flux, Stats, Sensor, Chip}) for each voxel accessed.

Kind: inner method of getVoxels

EARTH.ingestCache(sql, fileID, cb)

Ingest the evcache db for the given fileID into the events db then callback cb(aoi)

Kind: static method of EARTH

| Param | Type | Description | | --- | --- | --- | | sql | Object | connector | | fileID | Number | of internal event store (0 to bypass voxelization) | | cb | function | Response callback( ingested aoi info ) |

EARTH.ingestPipe(sql, filter, fileID, src, cb)

Pipe src event stream created for this fileID thru the supplied filter(ev,cache) to the evcache db with callback cb(aoi) when finished.

Kind: static method of EARTH

| Param | Type | Description | | --- | --- | --- | | sql | Object | connector | | filter | function | the cache(ev) method supplied to filter(ev,cache) adds an event ev {x,y,z,t,s,class,index,state,fileID} to the evcache db. | | fileID | Number | of internal event store (0 to bypass voxelization) | | src | Stream | source stream created for this fileID | | cb | function | Response callback( ingested aoi info ) |

EARTH.ingestList(sql, evs, fileID, cb)

Ingest events list to internal fileID with callback cb(aoi) when finished.

Kind: static method of EARTH

| Param | Type | Description | | --- | --- | --- | | sql | Object | connector | | evs | Array | events [ ev, ... ] to ingest | | fileID | Number | of internal event store (0 to bypass voxelization) | | cb | function | Response callback( ingested aoi info ) |

EARTH.ingestFile(sql, path, fileID, cb)

Ingest events in evsPath to internal fileID with callback cb(aoi). Ingest events in a file to the internal events file.

Kind: static method of EARTH

| Param | Type | Description | | --- | --- | --- | | sql | Object | connector | | path | String | to events file containing JSON or csv info | | fileID | Number | of internal event store (0 to bypass voxelization) | | cb | function | Response callbatck( ingested aoi info ) |

EARTH.ingestService()

Kind: static method of EARTH

EARTH.config()

Kind: static method of EARTH

EARTH.detectAOI()

Kind: static method of EARTH

EARTH.voxelizeAOI()

Kind: static method of EARTH

EARTH.chipAOI()

Kind: static method of EARTH

EARTH~POS()

Curved earth functions conventions:

    t,cols,x,y,lat,gtp[0]
    s,rows,y,lon,gtp[1]
    old poly = TL,TR,BL,BR,TL
    new poly = TL,TR,BR,BL
    top = ortho north

Kind: inner method of EARTH

EARTH~AOI()

ring = [ [lat,lon], .... ] degs defines aoi chipFeatures = number of feature across chip edge chipPixels = number of pixels across chip edge chipDim = length of chip edge [m] overlap = number of features to overlap chips r = surface radius [km] 6147=earth 0=flat

Kind: inner method of EARTH

Contacting, Contributing, Following

Feel free to

• submit and status EARTH issues
• contribute to EARTH notebooks
• revise EARTH requirements
• browse EARTH holdings
• or follow EARTH milestones

License

MIT

© 2012 ACMESDS