Class Volume

Volume

Hierarchy

Volume

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Volume(name: string, path: string, data?: Float32Array, nx?: undefined | number, ny?: undefined | number, nz?: undefined | number, atomindex?: Int32Array): Volume

- Defined in src/surface/volume.ts:118
Make Volume instance

Parameters
- name: string
  
  volume name
- path: string
  
  source path
- Optional data: Float32Array
  
  volume 3d grid
- Optional nx: undefined | number
  
  x dimension of the 3d volume
- Optional ny: undefined | number
  
  y dimension of the 3d volume
- Optional nz: undefined | number
  
  z dimension of the 3d volume
- Optional atomindex: Int32Array
  
  atom indices corresponding to the cells in the 3d grid
Returns Volume

Properties

__box

__box: Box3 | undefined

_max

_max: number | undefined

_mean

_mean: number | undefined

_min

_min: number | undefined

_position

_position: Float32Array

_rms

_rms: number | undefined

_sum

_sum: number | undefined

atomindex

atomindex: Int32Array | undefined

boundingBox

boundingBox: Box3

center

center: Vector3

data

data: Float32Array

header

header: any

inverseMatrix

inverseMatrix: Matrix4

matrix

matrix: Matrix4

name

name: string

normalMatrix

normalMatrix: Matrix3

nx

nx: number

ny

ny: number

nz

nz: number

path

path: string

volsurf

volsurf: VolumeSurface | undefined

worker

worker: Worker

workerPool

workerPool: WorkerPool

Accessors

max

get max(): number

- Defined in src/surface/volume.ts:476
Returns number

mean

get mean(): number

- Defined in src/surface/volume.ts:490
Returns number

min

get min(): number

- Defined in src/surface/volume.ts:469
Returns number

position

get position(): Float32Array

- Defined in src/surface/volume.ts:363
Returns Float32Array

rms

get rms(): number

- Defined in src/surface/volume.ts:497
Returns number

sum

get sum(): number

- Defined in src/surface/volume.ts:483
Returns number

type

get type(): string

- Defined in src/surface/volume.ts:142
Returns string

Methods

_getBox

_getBox(center: Vector3 | undefined, size: number): undefined | number[][]

- Defined in src/surface/volume.ts:264
Parameters
- center: Vector3 | undefined
- size: number
Returns undefined | number[][]

_makeSurface

_makeSurface(sd: any, isolevel: number, smooth: number): Surface

- Defined in src/surface/volume.ts:272
Parameters
- sd: any
- isolevel: number
- smooth: number
Returns Surface

clone

clone(): Volume

- Defined in src/surface/volume.ts:504
Returns Volume

dispose

dispose(): void

- Defined in src/surface/volume.ts:524
Returns void

getBox

getBox(center: Vector3, size: number, target: Box3): Box3

- Defined in src/surface/volume.ts:251
Parameters
- center: Vector3
- size: number
- target: Box3
Returns Box3

getDataAtomindex

getDataAtomindex(): undefined | Int32Array

- Defined in src/surface/volume.ts:389
Returns undefined | Int32Array

getDataColor

getDataColor(params: ColormakerParameters & { scheme: string }): Float32Array

- Defined in src/surface/volume.ts:397
Parameters
- params: ColormakerParameters & { scheme: string }
Returns Float32Array

getDataPicking

getDataPicking(): VolumePicker

- Defined in src/surface/volume.ts:420
Returns VolumePicker

getDataPosition

getDataPosition(): Float32Array

- Defined in src/surface/volume.ts:393
Returns Float32Array

getDataSize

getDataSize(size: VolumeSize | number, scale: number): Float32Array

- Defined in src/surface/volume.ts:425
Parameters
- size: VolumeSize | number
- scale: number
Returns Float32Array

getSigmaForValue

getSigmaForValue(value: number): number

- Defined in src/surface/volume.ts:359
Parameters
- value: number
Returns number

getSurface

getSurface(isolevel: number, smooth: number, center: Vector3, size: number, contour: boolean, wrap?: boolean): Surface

- Defined in src/surface/volume.ts:282
Parameters
- isolevel: number
- smooth: number
- center: Vector3
- size: number
- contour: boolean
- Default value wrap: boolean = false
Returns Surface

getSurfaceWorker

getSurfaceWorker(isolevel: number, smooth: number, center: Vector3, size: number, contour: boolean, wrap: boolean, callback: (s: Surface) => void): void

- Defined in src/surface/volume.ts:302
Parameters
- isolevel: number
- smooth: number
- center: Vector3
- size: number
- contour: boolean
- wrap: boolean
- callback: (s: Surface) => void
  - - (s: Surface): void
    - Parameters
      - s: Surface
      Returns void
Returns void

getValueForSigma

getValueForSigma(sigma: number): number

- Defined in src/surface/volume.ts:355
Parameters
- sigma: number
Returns number

setAtomindex

setAtomindex(atomindex?: Int32Array): void

- Defined in src/surface/volume.ts:247
set atom indices

Parameters
- Optional atomindex: Int32Array
  
  atom indices corresponding to the cells in the 3d grid
Returns void

setData

setData(data?: Float32Array, nx?: undefined | number, ny?: undefined | number, nz?: undefined | number, atomindex?: Int32Array): void

- Defined in src/surface/volume.ts:153
set volume data

Parameters
- Optional data: Float32Array
  
  volume 3d grid
- Optional nx: undefined | number
  
  x dimension of the 3d volume
- Optional ny: undefined | number
  
  y dimension of the 3d volume
- Optional nz: undefined | number
  
  z dimension of the 3d volume
- Optional atomindex: Int32Array
  
  atom indices corresponding to the cells in the 3d grid
Returns void

setMatrix

setMatrix(matrix: Matrix4): void

- Defined in src/surface/volume.ts:191
set transformation matrix

Parameters
- matrix: Matrix4
  
  4x4 transformation matrix
Returns void

setStats

setStats(min: number | undefined, max: number | undefined, mean: number | undefined, rms: number | undefined): void

- Defined in src/surface/volume.ts:179
Set statistics, which can be different from the data in this volume, if this volume is a slice of a bigger volume

Parameters
- 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
Returns void

Generated using TypeDoc