Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Volume

Volume

Hierarchy

  • Volume

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new Volume(name: string, path: string, data: any, nx: any, ny: any, nz: any, atomindex: Int32Array): Volume

  • Make Volume instance

    Parameters

    • name: string

      volume name

    • path: string

      source path

    • data: any

      volume 3d grid

    • nx: any

      x dimension of the 3d volume

    • ny: any

      y dimension of the 3d volume

    • nz: any

      z dimension of the 3d volume

    • atomindex: Int32Array

      atom indices corresponding to the cells in the 3d grid

    Returns Volume

Accessors

max

  • get max(): number

mean

  • get mean(): number

min

  • get min(): number

position

  • get position(): Float32Array

rms

  • get rms(): number

sum

  • get sum(): number

type

  • get type(): string

Methods

_getBox

  • _getBox(center: any, size: any): undefined | any[]

_makeSurface

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

clone

dispose

  • dispose(): void

getBox

  • getBox(center: any, size: any, target: any): any

getDataAtomindex

  • getDataAtomindex(): undefined | Int32Array

getDataColor

  • getDataColor(params: any): Float32Array

getDataPicking

getDataPosition

  • getDataPosition(): Float32Array

getDataSize

  • getDataSize(size: any, scale: any): number[] | Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array

  • Parameters

    • size: any
    • scale: any

    Returns number[] | Uint8Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Float32Array | Uint8ClampedArray | Float64Array

getSigmaForValue

  • getSigmaForValue(value: any): number

getSurface

  • getSurface(isolevel: any, smooth: any, center: any, size: any, contour: any, wrap: any): Surface

getSurfaceWorker

  • getSurfaceWorker(isolevel: any, smooth: any, center: any, size: any, contour: any, wrap: any, callback: any): void

  • Parameters

    • isolevel: any
    • smooth: any
    • center: any
    • size: any
    • contour: any
    • wrap: any
    • callback: any

    Returns void

getValueForSigma

  • getValueForSigma(sigma: any): number

setAtomindex

  • setAtomindex(atomindex: Int32Array): undefined

  • set atom indices

    Parameters

    • atomindex: Int32Array

      atom indices corresponding to the cells in the 3d grid

    Returns undefined

setData

  • setData(data: any, nx: any, ny: any, nz: any, atomindex: Int32Array): undefined

  • set volume data

    Parameters

    • data: any

      volume 3d grid

    • nx: any

      x dimension of the 3d volume

    • ny: any

      y dimension of the 3d volume

    • nz: any

      z dimension of the 3d volume

    • atomindex: Int32Array

      atom indices corresponding to the cells in the 3d grid

    Returns undefined

setMatrix

  • setMatrix(matrix: Matrix4): undefined

  • set transformation matrix

    Parameters

    • matrix: Matrix4

      4x4 transformation matrix

    Returns undefined

setStats

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

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

    Parameters

    • min: undefined | number

      minimum value of the whole data set

    • max: undefined | number

      maximum value of the whole data set

    • mean: undefined | number

      average value of the whole data set

    • rms: undefined | number

      sigma value of the whole data set

    Returns void

Generated using TypeDoc