Add new SOP class UID to create sub series per image
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Call custom functions server operations
The array of volumes to call custom function operations.
The array of octres to call custom function operations.
The array of render engines to call custom function operations.
The array of segmentations to call custom function operations.
The JSON parameters to be sent to server for custom functions operations.
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Call custom functions 2D server operations
The array of segmentations to call custom function operations.
The JSON parameters to be sent to server for custom functions operations.
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
volume data context ids
octtree ids
call back method to be called on both success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
list of 3D render engines used to create the blended render engine.
list of volmume data contexts used to create the blended render engine.
callback invokved when images are generated.
This is an asynchronous method that returns a Promise as follows:
Promise .then(renderEngineContext : RenderEngineContext3D ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderEngineContext : RenderEngineContext3D )
identifier for volume data to create octree
optionally specify the smoothing value of the type Fovia.SmoothParameter. The supported smoothing for octree values are Fovia.SmoothParameter.none, Fovia.SmoothParameter.trilinear and Fovia.SmoothParameter.tricubic
Reserved for future use
This is an asynchronous method that returns a Promise as follows:
Promise .then(octreeContext : OctreeContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , octreeContext : OctreeContext )
Creates a PolygonContext object with the supplied vertices, normals, and colors.
array of vectors for each polygon point
array of vectors for each normal assoicated with each polygon point
array of colors assoicated with each polygon point
This is an asynchronous method that returns a Promise as follows:
Promise .then(polygonContext : PolygonContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , polygonContext : PolygonContext )
Creates a PolygonContext object from a file stored on disk.
The name of the file.
An optional smoothing parameter to be applied.
If true the mesh object's vertices are recalculated so that the center of the object is positioned on the origin. If false the object is loaded unmodified.
A PolygonFileType value specifying the type of polygon object to be loaded.
This is an asynchronous method that returns a Promise as follows:
Promise .then(polygonContext : PolygonContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderParams : PolygonContext )
Creates a PolygonContext object from an OBJ file stored on disk performs a vertex colorization from a 'texture' JPG image. This is different from true UV texture mapping and works best on models with a high ratio of vertices to texture resolution. For true UV texture mapping use the PolygonContext.setTextureMapFromFile() method.
The name of the file.
The name of the JPG image to use as the vertex colorization source.
If true the mesh object's vertices are recalculated so that the center of the object is positioned on the origin. If false the object is loaded unmodified.
This is an asynchronous method that returns a Promise as follows:
Promise .then(polygonContext : PolygonContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderParams : PolygonContext )
Creates a PolygonContext object by converting volume data to polygon data.
The volume data from which the polygon data will be generated.
The octree associated with the volume data from which the polygon data will be generated.
If true then volume data gradients at the isosurface will be used to compute vertex normals. If false then normals are not calculated.
If true then increasing volume gradients are considered to be inside the mesh. If false then the opposite is true. Normally this value should be true.
The dataset value corosponding to the isosurface from which to generate the polygon data.
A bitmask determining which segmentation label volumes will be included in the polgyon conversion process.
This is an asynchronous method that returns a Promise as follows:
Promise .then(polygonContext : PolygonContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderParams : PolygonContext )
series data context used to create the render engine.
This is an asynchronous method that returns a Promise as follows:
Promise .then(renderEngineContext : RenderEngineContext2D ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderEngineContext : RenderEngineContext2D )
volmume data context used to create the render engine.
octree context used to create the render engine (may be null).
initial renderType for this engine.
This is an asynchronous method that returns a Promise as follows:
Promise .then(renderEngineContext : RenderEngineContext3D ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderEngineContext : RenderEngineContext3D )
initial renderType for this engine.
This is an asynchronous method that returns a Promise as follows:
Promise .then(renderEngineContext : RenderEngineContext3D ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderEngineContext : RenderEngineContext3D )
series data context to be updated in new render engine instance
sub series id
call back method to be called when dicom image received
call back method to be called on both success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
series data context that to be updated on new instance
call back method that to be called in both success and failure cas
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
volume data context
call back method to be called on both success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
The octree associated with the volume data to segment.
This is an asynchronous method that returns a Promise as follows:
Promise .then(segmentationContext : VolumeSegmentationContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , segmentationContext : VolumeSegmentationContext )
Get Non-Image data (GSPS, CADSR, Key Images) for given render engine
The render engine ID
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Retrieves a list of presets from the remote server.
This is an asynchronous method that returns a Promise as follows:
Promise .then(listOfPresets : Array .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , listOfPresetFileNames: Array )
This is an asynchronous method that returns a Promise as follows:
Promise .then(volumeDataInfo : VolumeDataContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , volumeDataInfo : VolumeDataContext )
If true, and octree is created for the loaded volume data.
This is an asynchronous method that returns a Promise as follows:
Promise .then(volumeDataInfo : VolumeDataContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , volumeDataInfo : VolumeDataContext )
Loads the specific DICOM dataset based on the supplied path. This directory should include a single 3D-able dataset. The returns a VolumeDataContext. The vdc includes an optional a SeriesDataContext, which includes contains a list of DICOM tags.
directory path containin a single DICOM dataset.
automatically build the octree when set to true (default is true)
Set to true to read standard DICOM tags (which is default), or false to skip this. This will slow down the call since all DICOM tags are read.
This is an asynchronous method that returns a Promise as follows:
Promise .then(volumeDataInfo : VolumeDataContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , volumeDataInfo : VolumeDataContext )
Loads the specific DICOM dataset based on the supplied path. This directory should include a single dataset. Unlike loadDICOMDir, this method will not return a SeriesDataContext
directory path containin a single DICOM dataset.
If true then octree is created for the loaded volume data.
This is an asynchronous method that returns a Promise as follows:
Promise .then(volumeDataInfo : VolumeDataContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , volumeDataInfo : VolumeDataContext )
Loads the specific DICOM dataset based on the series data context. It is expected that the series is "3D-able", or else it will thrown an exception. The returned VolumeDataContext includes a SeriesDataContext which contains a list of DICOM tags.
series data context witha "3D-able" series
If true then octree is created for the loaded volume data.
This is an asynchronous method that returns a Promise as follows:
Promise .then(volumeDataInfo : VolumeDataContext ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , volumeDataInfo : VolumeDataContext )
Loads an XML preset file contating the data for a RenderParams3D structure.
The file name to load.
This is an asynchronous method that returns a Promise as follows:
Promise .then(renderParams : RenderParams3D ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , renderParams : RenderParams3D )
xml file name to be loaded
call back method to be called on both success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Pauses all server operations for one volume, all operations will be rejected on server Does not affect calls to other datasets, either segmentation, rendering etc.
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
This call will release all native memory includinging the ( SeriesDataContext) associated with the 2D object. It is CRITICAL that all rendering has completed and that that any associated RenderEngine3D or HTMLViewport objects are released prior to invoking this call. Specifically, ensure that either RenderEngineContext2D.releaseSessionResources OR HTMLViewport.releaseSessionResources has been called and successfully completed, or the internal rendering state will become undefined.
call back method to be called on success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Resume server operations for one volume data
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Resume server operations for one volume data
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
Loads an XML preset file contating the data for a RenderParams3D structure.
The file name to load.
The RenderParams3D structure to save.
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
xml file name to be written
call back method to be called on success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Scans the directory and build up a complete patient/study/series and NonImageSeries model of its contents. A ScanDirResults based on the supplied path. This directory should include a single dataset. Unlike loadDICOMDir, this method will not return a SeriesDataContext
directory path to be scanned.
set to true (default) to preload all data into memory, false otherwise.
Set to false (default), to split each image into sub-series for specific sop class uids
This is an asynchronous method that returns a Promise as follows:
Promise .then(scanDirResults : ScanDirResults ) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , scanDirResults : ScanDirResults )
Specifies the JPEG quality setting used by the server for creation of all images. This is a global setting for the HDVR rendering server.
JPEG interative quality, 20 - lowest quality, 100 - best quality.
JPEG final quality, 20 - lowest quality, 100 - best quality.
This is a synchronous method and returns ReturnCode.ok on success.
Specifies the default rendering quality setting used by the server. This is a combination of the Quality setting the desired FPS. This is a global setting for the HDVR rendering server.
Specifies the rendering quality.
specifies a hint to the engine for desired frames per second. Specify zero (0) to disable this feature.
This is a synchronous method and returns ReturnCode.ok on success.
Specifies the default session timeout used by the server for this application (or user session).
default timeout in seconds, must be 0 (no timeout) or greater
This is a synchronous method and returns ReturnCode.ok on success.
rendering engine instance
interpolation mode
fuse volume
call back method to be called on success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Update the custom presentation data to native
The render engine ID
The presentation data
This is an asynchronous method that returns a Promise as follows:
Promise .then() .catch (err: ReturnCode )
callbackFunc(err: ReturnCode )
ServerContext is a static class will initialize the HDVR rendering server, load data, and access server resources.