- Source:
Classes
- AsynchPixelBufferDecoder
- DicomBufferToView
- Geometry
- Image
- ImageFactory
- PixelBufferDecoder
- PlaneHelper
- RescaleLut
- RescaleSlopeAndIntercept
- Size
- Spacing
- SynchPixelBufferDecoder
- View
- ViewFactory
- WindowLevel
- WindowLut
Namespaces
Members
(static) MinWindowWidth
- Source:
- See:
Minimum window width value.
(static) viewEventNames :Array
- Source:
List of view event names.
Type:
- Array
Methods
(static) generateImageDataMonochrome(array, iterator, alphaFunc, windowLut, colourMap)
- Source:
Generate image data for 'MONOCHROME*' photometric interpretation.
Parameters:
| Name | Type | Description |
|---|---|---|
array |
Array | The array to store the outut data |
iterator |
object | Position iterator. |
alphaFunc |
function | The alpha function. |
windowLut |
object | The window/level LUT. |
colourMap |
object | The colour map. |
(static) generateImageDataPaletteColor(array, iterator, alphaFunc, colourMap, is16BitsStored)
- Source:
Generate image data for 'PALETTE COLOR' photometric interpretation.
Parameters:
| Name | Type | Description |
|---|---|---|
array |
Array | The array to store the outut data |
iterator |
object | Position iterator. |
alphaFunc |
function | The alpha function. |
colourMap |
object | The colour map. |
is16BitsStored |
boolean | Flag to know if the data is 16bits. |
(static) generateImageDataRgb(array, iterator, alphaFunc)
- Source:
Generate image data for 'RGB' photometric interpretation.
Parameters:
| Name | Type | Description |
|---|---|---|
array |
Array | The array to store the outut data |
iterator |
object | Position iterator. |
alphaFunc |
function | The alpha function. |
(static) generateImageDataYbrFull(array, iterator, alphaFunc)
- Source:
Generate image data for 'YBR_FULL' photometric interpretation.
Parameters:
| Name | Type | Description |
|---|---|---|
array |
Array | The array to store the outut data |
iterator |
object | Position iterator. |
alphaFunc |
function | The alpha function. |
(static) getDefaultImage(width, height, sliceIndex, imageBuffer, numberOfFrames, imageUid) → {object}
- Source:
Get an image from an input context imageData.
Parameters:
| Name | Type | Description |
|---|---|---|
width |
number | The width of the coresponding image. |
height |
number | The height of the coresponding image. |
sliceIndex |
number | The slice index of the imageData. |
imageBuffer |
object | The image buffer. |
numberOfFrames |
number | The final number of frames. |
imageUid |
string | The image UID. |
Returns:
The corresponding view.
- Type
- object
(static) getIteratorValues(iterator) → {Array}
- Source:
Get a list of values for a given iterator.
Parameters:
| Name | Type | Description |
|---|---|---|
iterator |
object | The iterator to use to loop through data. |
Returns:
The list of values.
- Type
- Array
(static) getRegionSliceIterator(image, position, isRescaled, min, max) → {object}
- Source:
Get a slice index iterator for a rectangular region.
Parameters:
| Name | Type | Description |
|---|---|---|
image |
dwv.image.Image | The image to parse. |
position |
dwv.math.Point | The current position. |
isRescaled |
boolean | Flag for rescaled values (default false). |
min |
dwv.math.Point2D | The minimum position (optional). |
max |
dwv.math.Point2D | The maximum position (optional). |
Returns:
The slice iterator.
- Type
- object
(static) getSliceIterator(image, position, isRescaled, viewOrientation) → {object}
- Source:
Get a slice index iterator.
Parameters:
| Name | Type | Description |
|---|---|---|
image |
dwv.image.Image | The image to parse. |
position |
dwv.math.Point | The current position. |
isRescaled |
boolean | Flag for rescaled values (default false). |
viewOrientation |
dwv.math.Matrix33 | The view orientation. |
Returns:
The slice iterator.
- Type
- object
(static) getVariableRegionSliceIterator(image, position, isRescaled, regions) → {object}
- Source:
Get a slice index iterator for a rectangular region.
Parameters:
| Name | Type | Description |
|---|---|---|
image |
dwv.image.Image | The image to parse. |
position |
dwv.math.Point | The current position. |
isRescaled |
boolean | Flag for rescaled values (default false). |
regions |
Array | An array of regions. |
Returns:
The slice iterator.
- Type
- object
(static) getViewFromDOMImage(domImage, origin) → {object}
- Source:
Get data from an input image using a canvas.
Parameters:
| Name | Type | Description |
|---|---|---|
domImage |
object | The DOM Image. |
origin |
object | The data origin. |
Returns:
A load data event.
- Type
- object
(static) getViewFromDOMVideo(video, onloaditem, onload, onprogress, onloadend, dataIndex, origin)
- Source:
Get data from an input image using a canvas.
Parameters:
| Name | Type | Description |
|---|---|---|
video |
object | The DOM Video. |
onloaditem |
function | On load callback. |
onload |
object | The function to call once the data is loaded. |
onprogress |
object | The function to call to report progress. |
onloadend |
object | The function to call to report load end. |
dataIndex |
number | The data index. |
origin |
object | The data origin. |
(static) imageDataToBuffer(imageData) → {Array}
- Source:
Create a simple array buffer from an ImageData buffer.
Parameters:
| Name | Type | Description |
|---|---|---|
imageData |
object | The ImageData taken from a context. |
Returns:
The image buffer.
- Type
- Array
(static) range(dataAccessor, start, maxIter, increment, blockMaxIter, blockIncrement, reverse1, reverse2) → {object}
- Source:
Get an iterator for a given range for a one component data.
Using 'maxIter' and not an 'end' index since it fails in some edge cases (for ex coronal2, ie zxy)
Parameters:
| Name | Type | Description |
|---|---|---|
dataAccessor |
function | Function to access data. |
start |
number | Zero-based index at which to start the iteration. |
maxIter |
number | The maximum number of iterations. |
increment |
number | Increment between indicies. |
blockMaxIter |
number | Number of applied increment after which blockIncrement is applied. |
blockIncrement |
number | Increment after blockMaxIter is reached, the value is from block start to the next block start. |
reverse1 |
boolean | If true, loop from end to start. WARN: don't forget to set the value of start as the last index! |
reverse2 |
boolean | If true, loop from block end to block start. |
Returns:
An iterator folowing the iterator and iterable protocol.
- Type
- object
(static) range3d(dataAccessor, start, end, increment, isPlanar) → {object}
- Source:
- See:
Get an iterator for a given range for a 3 components data.
Parameters:
| Name | Type | Description |
|---|---|---|
dataAccessor |
function | Function to access data. |
start |
number | The start of the range (included). |
end |
number | The end of the range (excluded). (end - start) needs to be a multiple of 3... |
increment |
number | The increment between indicies (default=1). |
isPlanar |
boolean | A flag to know if the data is planar (RRRR...GGGG...BBBB...) or not (RGBRGBRGBRGB...), defaults to false. |
Returns:
A 3 components iterator folowing the iterator and iterable protocol, with extra 'value1' and 'value2' for the second and third component.
- Type
- object
(static) rangeRegion(dataAccessor, start, end, increment, regionSize, regionOffset) → {object}
- Source:
- See:
Get an iterator for a given range with bounds (for a one component data).
Parameters:
| Name | Type | Description |
|---|---|---|
dataAccessor |
function | Function to access data. |
start |
number | The start of the range (included). |
end |
number | The end of the range (excluded). |
increment |
number | The increment between indicies. |
regionSize |
number | The size of the region to iterate through. |
regionOffset |
number | The offset between regions. |
Returns:
An iterator folowing the iterator and iterable protocol.
- Type
- object
(static) rangeRegions(dataAccessor, start, end, increment, regions) → {object}
- Source:
- See:
Get an iterator for a given range with bounds (for a one component data).
Parameters:
| Name | Type | Description |
|---|---|---|
dataAccessor |
function | Function to access data. |
start |
number | The start of the range (included). |
end |
number | The end of the range (excluded). |
increment |
number | The increment between indicies. |
regions |
Array | An array of regions: [off0, size, off1]. |
Returns:
An iterator folowing the iterator and iterable protocol.
- Type
- object
(static) simpleRange(dataAccessor, start, end, increment) → {object}
- Source:
- See:
Get an simple iterator for a given range for a one component data.
Parameters:
| Name | Type | Description |
|---|---|---|
dataAccessor |
function | Function to access data. |
start |
number | The start of the range (included). |
end |
number | The end of the range (excluded). |
increment |
number | The increment between indicies (default=1). |
Returns:
An iterator folowing the iterator and iterable protocol.
- Type
- object
(static) validateWindowWidth(value) → {number}
- Source:
Validate an input window width.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
number | The value to test. |
Returns:
A valid window width.
- Type
- number