NGL@0.10.4 Home Manual Reference Source GalleryRepository
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

Method Summary

Public Methods
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 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 Methods

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