Skip to main content

Class: NVMesh

Defined in: nvmesh.ts:149

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,
   colorbarVisible: boolean,
   anatomicalStructurePrimary: string): NVMesh;

Defined in: nvmesh.ts:233

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)
colorbarVisiblebooleantruedoes this mesh display a colorbar
anatomicalStructurePrimarystring''region for mesh. Default is an empty string

Returns​

NVMesh

Properties​

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

Methods​

blendColormap()​

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

Defined in: nvmesh.ts:1073

Parameters​

ParameterTypeDefault value
u8Uint8Arrayundefined
additiveRGBAUint8Arrayundefined
layerNVMeshLayerundefined
mnnumberundefined
mxnumberundefined
lutUint8ClampedArrayundefined
invertbooleanfalse

Returns​

void

createFiberDensityMap()​

createFiberDensityMap(): void;

Defined in: nvmesh.ts:527

Returns​

void

decimateFaces()​

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

Defined in: nvmesh.ts:1502

Parameters​

ParameterType
nnumber
ntargetnumber

Returns​

void

decimateHierarchicalMesh()​

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

Defined in: nvmesh.ts:1536

Parameters​

ParameterTypeDefault value
glWebGL2RenderingContextundefined
ordernumber4

Returns​

boolean

generatePosNormClr()​

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

Defined in: nvmesh.ts:1619

Parameters​

ParameterType
ptsFloat32Array
trisUint32Array
rgba255Uint8Array

Returns​

Float32Array

hierarchicalOrder()​

hierarchicalOrder(): number;

Defined in: nvmesh.ts:1469

Returns​

number

indexNearestXYZmm()​

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

Defined in: nvmesh.ts:955

Parameters​

ParameterType
Xmmnumber
Ymmnumber
Zmmnumber

Returns​

number[]

initValuesArray()​

initValuesArray(va: ValuesArray): ValuesArray;

Defined in: nvmesh.ts:347

Parameters​

ParameterType
vaValuesArray

Returns​

ValuesArray

linesToCylinders()​

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

Defined in: nvmesh.ts:360

Parameters​

ParameterType
glWebGL2RenderingContext
posClrF32Float32Array
indicesnumber[]

Returns​

void

loadFromBase64()​

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

Defined in: nvmesh.ts:2058

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

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

scalars2RGBA()​

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

Defined in: nvmesh.ts:1007

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

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

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

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateFibers()​

updateFibers(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:653

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateMesh()​

updateMesh(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1173

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

loadFromFile()​

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

Defined in: nvmesh.ts:2023

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

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

Parameters​

ParameterType
layerNVMeshLayer
nvmeshNVMesh

Returns​

Promise<void>

readFileAsync()​

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

Defined in: nvmesh.ts:2004

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

Parameters​

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

Returns​

Promise<NVMesh>