Add the cadSrSeriesDataContext into list of CAD SR Markings
cad sr series context to add
Add circle annotation to presentation series context
A circle graphic annotation
referenced sop instance uid
frame number
boolean true if annotation is added or false
Add ellipse annotation to presentation series context
An ellipse graphic annotation
referenced sop instance uid
frame number
boolean true if annotation is added or false
Add line annotation to presentation series context
A line graphic annotation
referenced sop instance uid
frame number
boolean true if annotation is added or false
Add point annotation to presentation series context
A point graphic annotation
referenced sop instance uid
frame number
boolean true if annotation is added or false
Set PresentationDataContext object to the list.
PresentationDataContext for this series
Add text annotation to presentation series context
A text graphic annotation
referenced sop instance uid
frame number
boolean true if annotation is added or false
render params2D object holding instance details
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Check if given points are within image dislay area by adding given delta x and y
An array of points to be validated
point x to be added to each point. Default to 0
point y to be added to each point. Default to 0
boolean true if all the given points are within image bouding area otherwise false
Return true if graphic annotations can be shown for this engine, otherwise false
true/false
Return true if CAD SR Marking can be shown for this engine, otherwise false
true/false
Convert list of CAD markings data into Presentation data context and return them
An array of PresentationDataContext
Create a new PresentationDataContext object to be associated to this renderengine. The newly added graphic annotations will be managed by this object
Delete given annotation type and sop instance Uid
type of annotation
currently loaded image
Synchronous call that maps the DICOM image point to the viewport (pixel) coordindates), taking into account the current the zoom/pan/rotation values. This is analogous to the 3D "project ray" functionality
DICOM image point (mm's)
viewport point (pixel space)
Disable all the presentation data list associated to this series
Set value for showAnnotation flag
boolean value to be set. Defaults to true
Set value for showCadSR flag
boolean value to be set. Defaults to true
flag true to render false to hide
call back method to call on both success and failure case
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Synchronous call that computes the distance from a DICOM image point (inputPoint) in patient space (mm's) to a given image.
3D vector in Fovia volume space
image number in the current series loaded by this render engine
distance from inputPoint and the image
Get active presentation sopInstanceUid for active presentation
presentation sopInstanceUid if success otherwise return null
Get annotations from presentation data list for given type and SOP instance UID
graphic annotation type
image identifier
list of graphic annotations associated for the given type and instance
Get annotations from CAD SR markings list for given type and SOP instance UID
graphic annotation type
image identifier
list of graphic annotations associated for the given type and instance
Returns the renderParameter
Get image bound area
Fovia.Util.Rect2D class if valid image width and height found, otherwise null
Get CIELab color value for given graphic layer. Value from dicom tag (0070,0401) converted to RGB
graphic layer name for which the color value is required
Fovia.Util.Color object if value found for given object, otherwise undefined
Get marker summary details for given image tag
DICOMImageTags value
Fovia.ConceptSummary value if found, otherwise null
Return true if the loaded series in this renderengine is multiframe, otherwise false
true/false
Get organization root value
org. root value
Retrun list of presentation to save.
Array
returns the renderEngine ID associated with this object (only used internally)
call back method that 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 )
Rotates the converted screen point based on image rotation angle to get the translated point.
rotated dicom point (mm's)
Rotates the dicom image point based on image rotation angle to get the translated point.
rotated dicom point (mm's)
Get rotation angle from cached render params
(0/90/180/270)
number between 0 and 255 as index in the 256 elements map of colors
optional, use callback instead of promises
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Get annotation by given point and sop instance Uid
selected point on the screen coordinates
currently loaded image
currently loaded frame
Graphic Annotation matching the given point instance
Get annotation by given point and sop instance Uid from CAD SR markings
selected point on the screen coordinates
currently loaded image
currently loaded frame
Graphic Annotation matching the given point instance
series data context assocaited with this render engine
Get visual attributes for given graphic annotation type
graphic annotation type
Visual attribute if given type is found, otherwise undefined
invoked when an image for this renderEngine is received from the server. This will set internal state based on the received image, and then invoke the imageReadyCallback. (only used internally)
Initialize viewing attributes from default image tags
Initialize viewing attributes from presentation state values
render params to be updated
instance to which the value should be updated
Return true if organization root value is not empty, else false
Check if existing presentation data list is available for this series
boolean true if atlease one presentation data is available, otherwise false
Check if valid panning is done by using the given offset, viewport width and height and current zoom value
offset x
offset y
viewport width
viewport height
current zoom factor value
boolean true if current pan is valid otherwise false
Load annotations from CAD SR markings for given graphic type and image information
one of the graphic object type
dicom image tags
list of graphic annotations associated for the given type and instance
Synchronous call that maps a point from the 3D location in 3D Patient Space (mm's) using the DICOM Frame of Reference origin to the image plane (in mm's) of the DICOM image
3D location in 3D Patient Space (mm's)
the imagePixel which is the location in the image plane of the DICOM image, and the perpindicularDistToImage from the input vector , which is in mm's
invoked when an pdf for this renderEngine is received from the server. This will set internal state based on the received pdf, and then invoke the imageReadyCallback. (only used internally)
Return presentation state flag
boolean stating whether presentation state data should be applied
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 )
Triggers a render on this engine. The only difference between render and renderFinal is that render uses the interactive JPEG quality whil renderFinal uses final JPEG quality, as specified in setJPEGQuality. The imageReadyCallback associated with thsi render engine will be invokved once the image is ready
Triggers a render final on this engine. The only difference between render and renderFinal is that render uses the interactive JPEG quality whil renderFinal uses final JPEG quality, as specified in setJPEGQuality. The imageReadyCallback associated with thsi render engine will be invokved once the image is ready
Triggers a render final pdf on this engine.
Clear list of CAD SR Markings
Clear list of presentations
Set annotation color (in rgb) for given graphic layer
graphic layer name
r value
g value
b value
Set flag stating whether a graphic annotation is modified or not This expects one presentation is already selected (selectedPresentationIndex)
true/false
Set background color for font for the given graphic type
annotation type
color to be set as background
true if given graphic type is found, otherwise false
Set value for content creator name (0070,0084)
value for content creator name
optional, use callback instead of promises
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
Set font size for the given graphic type
annotation type
font size
true if given graphic type is found, otherwise false
Set font type for the given graphic type
annotation type
type of font
true if given graphic type is found, otherwise false
Set foreground color for font for the given graphic type
annotation type
color to be set as foreground
true if given graphic type is found, otherwise false
Set list of reference image associated to this series
An array of referenced image sequence
Set color for lines for given graphic type
annotation type
color to be set to line
true if given graphic type is found, otherwise false
Set line width for given graphic type
annotation type
width to be set to line
true if given graphic type is found, otherwise false
Set organization root value for generating UUIDs
value to be set to org. root
Set PresentationDataContext which holds newly added graphic annotations and viewing attributes and enable the presentation is valid object
PresentationDataContext for this series
Set list of presentations associated to this series
An array of PresentationDataContext data context object
Set presentationID which holds the presentation sopinstanceuid
presentationID for this series
presentationID that will be sent to the server
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 )
Set flag to state whether to use presentation state values or default
render parameters that will be sent to the server
enum to instruct the render engine to re-render with the updated parameters
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 )
number between 0 and 255 as index in the 256 elements map of colors
Fovia.Util.Color to set set the specific index
optional, use callback instead of promises
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
SeriesSegmentationContext to be updated
call back method that 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 )
Set viewing attribute values to presentation data context
ViewingAttribute to be applied to this series
Toggle showAnnotation flag
Update viewing attributes(rotate/flip/inverse) to presentation when modified
Fovia.RenderParams2D object having updated viewing attributes
Update W/L level value from render params
Fovia.RenderParams2D object having updated W/L values and image details
renderEngineContext2D is backed by a native 2D renering engine and is typically associated with a Fovia.UI.HTMLViewport2D , although it can be created directly if the application is managing its own UI events.