Skip to main content

Class: NVMesh

Defined in: nvmesh.ts:157

a NVMesh encapsulates some mesh data and provides methods to query and operate on meshes

Extended by​

Constructors​

Constructor​

new NVMesh(
   pts: Float32Array,
   tris: Uint32Array,
   name: string,
   rgba255: Uint8Array,
   opacity: number,
   visible: boolean,
   gl: WebGL2RenderingContext,
   connectome:
  | string
  | LegacyConnectome,
   dpg: ValuesArray,
   dps: ValuesArray,
   dpv: ValuesArray,
   groups: ValuesArray,
   colorbarVisible: boolean,
   anatomicalStructurePrimary: string): NVMesh;

Defined in: nvmesh.ts:243

Parameters​

ParameterTypeDefault valueDescription
ptsFloat32Arrayundefineda 3xN array of vertex positions (X,Y,Z coordinates).
trisUint32Arrayundefineda 3xN array of triangle indices (I,J,K; indexed from zero). Each triangle generated from three vertices.
namestring''a name for this image. Default is an empty string
rgba255Uint8Array...the base color of the mesh. RGBA values from 0 to 255. Default is white
opacitynumber1.0the opacity for this mesh. default is 1
visiblebooleantruewhether or not this image is to be visible
glWebGL2RenderingContextundefinedWebGL rendering context
connectome| string | LegacyConnectomenullspecify connectome edges and nodes. Default is null (not a connectome).
dpgValuesArraynullData per group for tractography, see TRK format. Default is null (not tractograpgy)
dpsValuesArraynullData per streamline for tractography, see TRK format. Default is null (not tractograpgy)
dpvValuesArraynullData per vertex for tractography, see TRK format. Default is null (not tractograpgy)
groupsValuesArraynullGroups for tractography, see TRK format. Default is null (not tractograpgy)
colorbarVisiblebooleantruedoes this mesh display a colorbar
anatomicalStructurePrimarystring''region for mesh. Default is an empty string

Returns​

NVMesh

Properties​

PropertyTypeDefault valueDefined in
anatomicalStructurePrimarystringundefinednvmesh.ts:160
colorbarVisiblebooleanundefinednvmesh.ts:161
colormap?| string | ColorMap | LegacyConnectomeundefinednvmesh.ts:197
colormapInvertbooleanfalsenvmesh.ts:170
connectome?| string | LegacyConnectomeundefinednvmesh.ts:203
data_type?stringundefinednvmesh.ts:183
dpg?ValuesArrayundefinednvmesh.ts:198
dps?ValuesArrayundefinednvmesh.ts:199
dpsThresholdnumberNaNnvmesh.ts:195
dpv?ValuesArrayundefinednvmesh.ts:200
edgeColormapstring'warm'nvmesh.ts:213
edgeColormapNegative?stringundefinednvmesh.ts:215
edgeMax?numberundefinednvmesh.ts:219
edgeMin?numberundefinednvmesh.ts:218
edges?number[] | NVConnectomeEdge[]undefinednvmesh.ts:223
edgeScalenumber1nvmesh.ts:209
extentsMaxnumber | number[]undefinednvmesh.ts:164
extentsMinnumber | number[]undefinednvmesh.ts:163
f32PerVertexnumber5nvmesh.ts:194
fiberColorstring'Global'nvmesh.ts:189
fiberDecimationStridenumber1nvmesh.ts:190
fiberDensity?Float32Arrayundefinednvmesh.ts:187
fiberDithernumber0.1nvmesh.ts:188
fiberGroupColormapColorMapnullnvmesh.ts:171
fiberLength?numberundefinednvmesh.ts:185
fiberLengths?Uint32Arrayundefinednvmesh.ts:186
fiberMask?unknown[]undefinednvmesh.ts:196
fiberOcclusionnumber0nvmesh.ts:193
fiberRadiusnumber0nvmesh.ts:192
fiberSidesnumber5nvmesh.ts:191
furthestVertexFromOriginnumberundefinednvmesh.ts:162
groups?ValuesArrayundefinednvmesh.ts:201
hasConnectomebooleanfalsenvmesh.ts:202
idstringundefinednvmesh.ts:158
indexBufferWebGLBufferundefinednvmesh.ts:173
indexCount?numberundefinednvmesh.ts:206
layersNVMeshLayer[]undefinednvmesh.ts:180
legendLineThicknessnumber0nvmesh.ts:210
meshShaderIndexnumber0nvmesh.ts:167
namestringundefinednvmesh.ts:159
nodeColormapstring'warm'nvmesh.ts:212
nodeColormapNegative?stringundefinednvmesh.ts:214
nodeMaxColor?numberundefinednvmesh.ts:217
nodeMinColor?numberundefinednvmesh.ts:216
nodes?| LegacyNodes | NVConnectomeNode[]undefinednvmesh.ts:221
nodeScalenumber4nvmesh.ts:208
offsetPt0Uint32Arraynullnvmesh.ts:168
opacitynumberundefinednvmesh.ts:165
points?Point[]undefinednvmesh.ts:225
ptsFloat32Arrayundefinednvmesh.ts:178
rgba255Uint8Arrayundefinednvmesh.ts:184
showLegendbooleantruenvmesh.ts:211
tris?Uint32Arrayundefinednvmesh.ts:179
typeMeshTypeMeshType.MESHnvmesh.ts:181
vaoWebGLVertexArrayObjectundefinednvmesh.ts:175
vaoFiberWebGLVertexArrayObjectundefinednvmesh.ts:176
vertexBufferWebGLBufferundefinednvmesh.ts:174
vertexCountnumber1nvmesh.ts:207
visiblebooleanundefinednvmesh.ts:166

Methods​

blendColormap()​

blendColormap(
   u8: Uint8Array,
   additiveRGBA: Uint8Array,
   layer: NVMeshLayer,
   mn: number,
   mx: number,
   lut: Uint8ClampedArray,
   invert: boolean): void;

Defined in: nvmesh.ts:1129

Parameters​

ParameterTypeDefault value
u8Uint8Arrayundefined
additiveRGBAUint8Arrayundefined
layerNVMeshLayerundefined
mnnumberundefined
mxnumberundefined
lutUint8ClampedArrayundefined
invertbooleanfalse

Returns​

void

createFiberDensityMap()​

createFiberDensityMap(): void;

Defined in: nvmesh.ts:542

Returns​

void

decimateFaces()​

decimateFaces(n: number, ntarget: number): void;

Defined in: nvmesh.ts:1573

Parameters​

ParameterType
nnumber
ntargetnumber

Returns​

void

decimateHierarchicalMesh()​

decimateHierarchicalMesh(gl: WebGL2RenderingContext, order: number): boolean;

Defined in: nvmesh.ts:1607

Parameters​

ParameterTypeDefault value
glWebGL2RenderingContextundefined
ordernumber4

Returns​

boolean

generatePosNormClr()​

generatePosNormClr(
   pts: Float32Array,
   tris: Uint32Array,
   rgba255: Uint8Array): Float32Array;

Defined in: nvmesh.ts:1690

Parameters​

ParameterType
ptsFloat32Array
trisUint32Array
rgba255Uint8Array

Returns​

Float32Array

hierarchicalOrder()​

hierarchicalOrder(): number;

Defined in: nvmesh.ts:1540

Returns​

number

indexNearestXYZmm()​

indexNearestXYZmm(
   Xmm: number,
   Ymm: number,
   Zmm: number): number[];

Defined in: nvmesh.ts:1011

Parameters​

ParameterType
Xmmnumber
Ymmnumber
Zmmnumber

Returns​

number[]

initValuesArray()​

initValuesArray(va: ValuesArray): ValuesArray;

Defined in: nvmesh.ts:362

Parameters​

ParameterType
vaValuesArray

Returns​

ValuesArray

linesToCylinders()​

linesToCylinders(
   gl: WebGL2RenderingContext,
   posClrF32: Float32Array,
   indices: number[]): void;

Defined in: nvmesh.ts:375

Parameters​

ParameterType
glWebGL2RenderingContext
posClrF32Float32Array
indicesnumber[]

Returns​

void

loadFromBase64()​

loadFromBase64(__namedParameters: Partial<LoadFromBase64Params>): Promise<NVMesh>;

Defined in: nvmesh.ts:2137

load and return a new NVMesh instance from a base64 encoded string

Parameters​

ParameterType
__namedParametersPartial<LoadFromBase64Params>

Returns​

Promise<NVMesh>

reverseFaces()​

reverseFaces(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1524

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

scalars2RGBA()​

scalars2RGBA(
   rgba: Uint8ClampedArray,
   layer: NVMeshLayer,
   scalars: AnyNumberArray,
   isNegativeCmap: boolean): Uint8ClampedArray;

Defined in: nvmesh.ts:1063

Parameters​

ParameterTypeDefault value
rgbaUint8ClampedArrayundefined
layerNVMeshLayerundefined
scalarsAnyNumberArrayundefined
isNegativeCmapbooleanfalse

Returns​

Uint8ClampedArray

setLayerProperty()​

setLayerProperty(
   id: number,
   key: keyof NVMeshLayer,
   val: string | number | boolean,
gl: WebGL2RenderingContext): Promise<void>;

Defined in: nvmesh.ts:1638

Parameters​

ParameterType
idnumber
keykeyof NVMeshLayer
valstring | number | boolean
glWebGL2RenderingContext

Returns​

Promise<void>

setProperty()​

setProperty(
   key: keyof NVMesh,
   val:
  | string
  | number
  | boolean
  | number[]
  | ColorMap
  | Float32Array
  | Uint8Array
  | LegacyConnectome,
   gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1671

Parameters​

ParameterType
keykeyof NVMesh
val| string | number | boolean | number[] | ColorMap | Float32Array | Uint8Array | LegacyConnectome
glWebGL2RenderingContext

Returns​

void

unloadMesh()​

unloadMesh(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1032

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateFibers()​

updateFibers(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:668

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateMesh()​

updateMesh(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1229

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

loadFromFile()​

static loadFromFile(__namedParameters: Partial<LoadFromFileParams>): Promise<NVMesh>;

Defined in: nvmesh.ts:2102

factory function to load and return a new NVMesh instance from a file in the browser

Parameters​

ParameterType
__namedParametersPartial<LoadFromFileParams>

Returns​

Promise<NVMesh>

NVMesh instance

loadFromUrl()​

static loadFromUrl(__namedParameters: Partial<LoadFromUrlParams>): Promise<NVMesh>;

Defined in: nvmesh.ts:2017

factory function to load and return a new NVMesh instance from a given URL

Parameters​

ParameterType
__namedParametersPartial<LoadFromUrlParams>

Returns​

Promise<NVMesh>

loadLayer()​

static loadLayer(layer: NVMeshLayer, nvmesh: NVMesh): Promise<void>;

Defined in: nvmesh.ts:1920

Parameters​

ParameterType
layerNVMeshLayer
nvmeshNVMesh

Returns​

Promise<void>

readFileAsync()​

static readFileAsync(file: Blob): Promise<ArrayBuffer>;

Defined in: nvmesh.ts:2083

Parameters​

ParameterType
fileBlob

Returns​

Promise<ArrayBuffer>

readMesh()​

static readMesh(
   buffer: ArrayBuffer,
   name: string,
   gl: WebGL2RenderingContext,
   opacity: number,
   rgba255: Uint8Array,
visible: boolean): Promise<NVMesh>;

Defined in: nvmesh.ts:1736

Parameters​

ParameterTypeDefault value
bufferArrayBufferundefined
namestringundefined
glWebGL2RenderingContextundefined
opacitynumber1.0
rgba255Uint8Array...
visiblebooleantrue

Returns​

Promise<NVMesh>