@totemorg/chip v1.10.0
CHIP
CHIP surface of a planet. Returned chips contain animage chip and various meta (solar etc) information.
Manage
npm install @totemstan/chip # install
npm run start [ ? | $ | ...] # Unit test
npm run verminor # Roll minor version
npm run vermajor # Roll major version
npm run redoc # Regen documentation
Usage
Acquire and optionally configure:
require("@totemstan/chip").config({
key: value, // set key
"key.key": value, // indexed set
"key.key.": value // indexed append
}, err => {
console.log( err ? "something evil is lurking" : "look mom - Im running!");
});
where configuration keys follow ENUMS deep copy conventions.
Program Reference
CHIP
Chip surface of spherical objects like the earth.
Requires: module:fs, module:child_process, module:stream, module:enums
CHIP.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 CHIP
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 ) |
CHIP.ingestList(sql, evs, fileID, cb)
Ingest events list to internal fileID with callback cb(aoi) when finished.
Kind: static method of CHIP
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 ) |
CHIP.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 CHIP
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 ) |
CHIP~POS
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 class of CHIP
CHIP~AOI
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 class of CHIP
Contacting, Contributing, Following
Feel free to
- submit and status TOTEM issues
- contribute to TOTEM notebooks
- revise TOTEM requirements
- browse TOTEM holdings
- or follow TOTEM milestones
License
© 2012 ACMESDS