Skip to main content

Class: NVMesh

Defined in: nvmesh.ts:152

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

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

Methods​

blendColormap()​

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

Defined in: nvmesh.ts:1076

Parameters​

ParameterTypeDefault value
u8Uint8Arrayundefined
additiveRGBAUint8Arrayundefined
layerNVMeshLayerundefined
mnnumberundefined
mxnumberundefined
lutUint8ClampedArrayundefined
invertbooleanfalse

Returns​

void

createFiberDensityMap()​

createFiberDensityMap(): void;

Defined in: nvmesh.ts:530

Returns​

void

decimateFaces()​

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

Defined in: nvmesh.ts:1527

Parameters​

ParameterType
nnumber
ntargetnumber

Returns​

void

decimateHierarchicalMesh()​

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

Defined in: nvmesh.ts:1561

Parameters​

ParameterTypeDefault value
glWebGL2RenderingContextundefined
ordernumber4

Returns​

boolean

generatePosNormClr()​

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

Defined in: nvmesh.ts:1644

Parameters​

ParameterType
ptsFloat32Array
trisUint32Array
rgba255Uint8Array

Returns​

Float32Array

hierarchicalOrder()​

hierarchicalOrder(): number;

Defined in: nvmesh.ts:1494

Returns​

number

indexNearestXYZmm()​

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

Defined in: nvmesh.ts:958

Parameters​

ParameterType
Xmmnumber
Ymmnumber
Zmmnumber

Returns​

number[]

initValuesArray()​

initValuesArray(va: ValuesArray): ValuesArray;

Defined in: nvmesh.ts:350

Parameters​

ParameterType
vaValuesArray

Returns​

ValuesArray

linesToCylinders()​

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

Defined in: nvmesh.ts:363

Parameters​

ParameterType
glWebGL2RenderingContext
posClrF32Float32Array
indicesnumber[]

Returns​

void

loadFromBase64()​

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

Defined in: nvmesh.ts:2083

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

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

scalars2RGBA()​

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

Defined in: nvmesh.ts:1010

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

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

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

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateFibers()​

updateFibers(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:656

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

updateMesh()​

updateMesh(gl: WebGL2RenderingContext): void;

Defined in: nvmesh.ts:1176

Parameters​

ParameterType
glWebGL2RenderingContext

Returns​

void

loadFromFile()​

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

Defined in: nvmesh.ts:2048

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

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

Parameters​

ParameterType
layerNVMeshLayer
nvmeshNVMesh

Returns​

Promise<void>

readFileAsync()​

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

Defined in: nvmesh.ts:2029

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

Parameters​

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

Returns​

Promise<NVMesh>