Skip to main content

Class: NVMesh

Defined in: nvmesh.ts:133

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:219

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:136
colorbarVisiblebooleanundefinednvmesh.ts:137
colormap?| string | ColorMap | LegacyConnectomeundefinednvmesh.ts:173
colormapInvertbooleanfalsenvmesh.ts:146
connectome?| string | LegacyConnectomeundefinednvmesh.ts:179
data_type?stringundefinednvmesh.ts:159
dpg?ValuesArrayundefinednvmesh.ts:174
dps?ValuesArrayundefinednvmesh.ts:175
dpsThresholdnumberNaNnvmesh.ts:171
dpv?ValuesArrayundefinednvmesh.ts:176
edgeColormapstring'warm'nvmesh.ts:189
edgeColormapNegative?stringundefinednvmesh.ts:191
edgeMax?numberundefinednvmesh.ts:195
edgeMin?numberundefinednvmesh.ts:194
edges?number[] | NVConnectomeEdge[]undefinednvmesh.ts:199
edgeScalenumber1nvmesh.ts:185
extentsMaxnumber | number[]undefinednvmesh.ts:140
extentsMinnumber | number[]undefinednvmesh.ts:139
f32PerVertexnumber5nvmesh.ts:170
fiberColorstring'Global'nvmesh.ts:165
fiberDecimationStridenumber1nvmesh.ts:166
fiberDensity?Float32Arrayundefinednvmesh.ts:163
fiberDithernumber0.1nvmesh.ts:164
fiberGroupColormapColorMapnullnvmesh.ts:147
fiberLength?numberundefinednvmesh.ts:161
fiberLengths?Uint32Arrayundefinednvmesh.ts:162
fiberMask?unknown[]undefinednvmesh.ts:172
fiberOcclusionnumber0nvmesh.ts:169
fiberRadiusnumber0nvmesh.ts:168
fiberSidesnumber5nvmesh.ts:167
furthestVertexFromOriginnumberundefinednvmesh.ts:138
groups?ValuesArrayundefinednvmesh.ts:177
hasConnectomebooleanfalsenvmesh.ts:178
idstringundefinednvmesh.ts:134
indexBufferWebGLBufferundefinednvmesh.ts:149
indexCount?numberundefinednvmesh.ts:182
layersNVMeshLayer[]undefinednvmesh.ts:156
legendLineThicknessnumber0nvmesh.ts:186
meshShaderIndexnumber0nvmesh.ts:143
namestringundefinednvmesh.ts:135
nodeColormapstring'warm'nvmesh.ts:188
nodeColormapNegative?stringundefinednvmesh.ts:190
nodeMaxColor?numberundefinednvmesh.ts:193
nodeMinColor?numberundefinednvmesh.ts:192
nodes?| LegacyNodes | NVConnectomeNode[]undefinednvmesh.ts:197
nodeScalenumber4nvmesh.ts:184
offsetPt0Uint32Arraynullnvmesh.ts:144
opacitynumberundefinednvmesh.ts:141
points?Point[]undefinednvmesh.ts:201
ptsFloat32Arrayundefinednvmesh.ts:154
rgba255Uint8Arrayundefinednvmesh.ts:160
showLegendbooleantruenvmesh.ts:187
tris?Uint32Arrayundefinednvmesh.ts:155
typeMeshTypeMeshType.MESHnvmesh.ts:157
vaoWebGLVertexArrayObjectundefinednvmesh.ts:151
vaoFiberWebGLVertexArrayObjectundefinednvmesh.ts:152
vertexBufferWebGLBufferundefinednvmesh.ts:150
vertexCountnumber1nvmesh.ts:183
visiblebooleanundefinednvmesh.ts:142

Methods​

blendColormap()​

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

Defined in: nvmesh.ts:1085

Parameters​

ParameterTypeDefault value
u8Uint8Arrayundefined
additiveRGBAUint8Arrayundefined
layerNVMeshLayerundefined
mnnumberundefined
mxnumberundefined
lutUint8ClampedArrayundefined
invertbooleanfalse

Returns​

void

createFiberDensityMap()​

createFiberDensityMap(): void;

Defined in: nvmesh.ts:518

Returns​

void

decimateFaces()​

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

Defined in: nvmesh.ts:1521

Parameters​

ParameterType
nnumber
ntargetnumber

Returns​

void

decimateHierarchicalMesh()​

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

Defined in: nvmesh.ts:1555

Parameters​

ParameterTypeDefault value
glWebGL2RenderingContextundefined
ordernumber4

Returns​

boolean

generatePosNormClr()​

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

Defined in: nvmesh.ts:1629

Parameters​

ParameterType
ptsFloat32Array
trisUint32Array
rgba255Uint8Array

Returns​

Float32Array

hierarchicalOrder()​

hierarchicalOrder(): number;

Defined in: nvmesh.ts:1488

Returns​

number

indexNearestXYZmm()​

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

Defined in: nvmesh.ts:972

Parameters​

ParameterType
Xmmnumber
Ymmnumber
Zmmnumber

Returns​

number[]

initValuesArray()​

initValuesArray(va: ValuesArray): ValuesArray;

Defined in: nvmesh.ts:338

Parameters​

ParameterType
vaValuesArray

Returns​

ValuesArray

linesToCylinders()​

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

Defined in: nvmesh.ts:351

Parameters​

ParameterType
glWebGL2RenderingContext
posClrF32Float32Array
indicesnumber[]

Returns​

void

loadFromBase64()​

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

Defined in: nvmesh.ts:2051

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:1472

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

scalars2RGBA()​

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

Defined in: nvmesh.ts:1024

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:1586

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:1614

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:993

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateFibers()​

updateFibers(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:644

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateMesh()​

updateMesh(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1177

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

loadFromFile()​

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

Defined in: nvmesh.ts:2024

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:1939

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:1852

Parameters​

ParameterType
layerNVMeshLayer
nvmeshNVMesh

Returns​

Promise<void>

readFileAsync()​

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

Defined in: nvmesh.ts:2005

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:1675

Parameters​

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

Returns​

Promise<NVMesh>