NGL@1.0.0-beta.7 Home Manual Reference Source Gallery
import Volume from 'ngl/src/surface/volume.js'
public class | source

Volume

Volume

Constructor Summary

Public Constructor
public

constructor(name: String, path: String, data: Float32array, nx: Integer, ny: Integer, nz: Integer, atomindex: Int32Array)

Make Volume instance

Member Summary

Public Members
public
public
public
public
public
public
public get

max

public get
public get

min

public
public
public

nx

public

ny

public

nz

public
public get
public get

rms

public get

sum

public get
public
public
Private Members
private
private
private
private
private
private
private

Method Summary

Public Methods
public

clone()

public
public

getBox()

public
public
public
public
public
public
public
public
public
public

set atom indices

public

setData(data: Float32array, nx: Integer, ny: Integer, nz: Integer, atomindex: Int32Array): undefined

set volume data

public

set transformation matrix

public

Set statistics, which can be different from the data in this volume, if this volume is a slice of a bigger volume

Private Methods
private
private

Public Constructors

public constructor(name: String, path: String, data: Float32array, nx: Integer, ny: Integer, nz: Integer, atomindex: Int32Array) source

Make Volume instance

Params:

NameTypeAttributeDescription
name String

volume name

path String

source path

data Float32array

volume 3d grid

nx Integer

x dimension of the 3d volume

ny Integer

y dimension of the 3d volume

nz Integer

z dimension of the 3d volume

atomindex Int32Array

atom indices corresponding to the cells in the 3d grid

Public Members

public atomindex source

public boundingBox source

public center source

public data source

public inverseMatrix source

public matrix source

public get max source

public get mean source

public get min source

public name source

public normalMatrix source

public nx source

public ny source

public nz source

public path source

public get position source

public get rms source

public get sum source

public get type source

public volsurf source

public workerPool source

Private Members

private __box source

private _max source

private _mean source

private _min source

private _position source

private _rms source

private _sum source

Public Methods

public clone() source

public dispose() source

public getBox() source

public getDataAtomindex() source

public getDataColor() source

public getDataPicking() source

public getDataPosition() source

public getDataSize() source

public getSigmaForValue() source

public getSurface() source

public getSurfaceWorker() source

public getValueForSigma() source

public setAtomindex(atomindex: Int32Array): undefined source

set atom indices

Params:

NameTypeAttributeDescription
atomindex Int32Array

atom indices corresponding to the cells in the 3d grid

Return:

undefined

public setData(data: Float32array, nx: Integer, ny: Integer, nz: Integer, atomindex: Int32Array): undefined source

set volume data

Params:

NameTypeAttributeDescription
data Float32array

volume 3d grid

nx Integer

x dimension of the 3d volume

ny Integer

y dimension of the 3d volume

nz Integer

z dimension of the 3d volume

atomindex Int32Array

atom indices corresponding to the cells in the 3d grid

Return:

undefined

public setMatrix(matrix: Matrix4): undefined source

set transformation matrix

Params:

NameTypeAttributeDescription
matrix Matrix4

4x4 transformation matrix

Return:

undefined

public setStats(min: Number | undefined, max: Number | undefined, mean: Number | undefined, rms: Number | undefined) source

Set statistics, which can be different from the data in this volume, if this volume is a slice of a bigger volume

Params:

NameTypeAttributeDescription
min Number | undefined

minimum value of the whole data set

max Number | undefined

maximum value of the whole data set

mean Number | undefined

average value of the whole data set

rms Number | undefined

sigma value of the whole data set

Private Methods

private _getBox() source

private _makeSurface() source