API

daikon : * | Object

daikon

Kind: global variable

• daikon : * | Object
  • .Dictionary : Object | *
    • .getVR(group, element) ⇒ string
    • .getDescription(group, element) ⇒ string
  • .Image : function
    • .getCols() ⇒ number
    • .getRows() ⇒ number
    • .getSeriesDescription() ⇒ string
    • .getSeriesInstanceUID() ⇒ string
    • .getSeriesNumber() ⇒ number
    • .getEchoNumber() ⇒ number
    • .getImagePosition() ⇒ Array.<number>
    • .getImageDirections() ⇒ Array.<number>
    • .getImagePositionSliceDir(sliceDir) ⇒ number
    • .getModality() ⇒ string
    • .getSliceLocation() ⇒ number
    • .getSliceLocationVector() ⇒ Array.<number>
    • .getImageNumber() ⇒ number
    • .getTemporalPosition() ⇒ number
    • .getTemporalNumber() ⇒ number
    • .getSliceGap() ⇒ number
    • .getSliceThickness() ⇒ number
    • .getImageMax() ⇒ number
    • .getImageMin() ⇒ number
    • .getDataScaleSlope() ⇒ number
    • .getDataScaleIntercept() ⇒ number
    • .getWindowWidth() ⇒ number
    • .getWindowCenter() ⇒ number
    • .getPixelSpacing() ⇒ Array.<number>
    • .getImageType() ⇒ Array.<string>
    • .getBitsStored() ⇒ number
    • .getBitsAllocated() ⇒ number
    • .getFrameTime() ⇒ number
    • .getAcquisitionMatrix() ⇒ Array.<number>
    • .getTR() ⇒ number
    • .getTag(group, element) ⇒ Tag
    • .getPixelData() ⇒ Tag
    • .getRawData() ⇒ ArrayBuffer
    • .getInterpretedData(asArray, asObject, frameIndex) ⇒ Float32Array | Array | object
    • .hasPixelData() ⇒ boolean
    • .getOrientation() ⇒ string
    • .isMosaic() ⇒ boolean
    • .isPalette() ⇒ boolean
    • .isCompressed() ⇒ boolean
    • .isCompressedJPEG() ⇒ boolean
    • .isCompressedJPEGLossless() ⇒ boolean
    • .isCompressedJPEGBaseline() ⇒ boolean
    • .isCompressedJPEG2000() ⇒ boolean
    • .isCompressedJPEGLS() ⇒ boolean
    • .isCompressedRLE() ⇒ boolean
    • .getNumberOfFrames() ⇒ number
    • .getNumberOfSamplesPerPixel() ⇒ number
    • .getPixelRepresentation() ⇒ number
    • .getPhotometricInterpretation() ⇒ string
    • .getPatientName() ⇒ string
    • .getPatientID() ⇒ string
    • .getStudyTime() ⇒ string
    • .getTransferSyntax() ⇒ string
    • .getStudyDate() ⇒ string
    • .getPlanarConfig() ⇒ number
    • .getImageDescription() ⇒ string
    • .getDataType() ⇒ number
    • .getEncapsulatedData() ⇒ Array.<Tag>
    • .getAllInterpretedPrivateData() ⇒ string
    • .toString() ⇒ string
  • .Parser : function
    • instance
      • .parse(data) ⇒ Image | null
    • static
      • .verbose : boolean
      • .isMagicCookieFound(data) ⇒ boolean
  • .RLE : function
    • .decode(data, littleEndian, numElements) ⇒ DataView
  • .Series : function
    • instance
      • .toString() ⇒ string
      • .getName() ⇒ string | null
      • .addImage(image)
      • .matchesSeries(image) ⇒ boolean
      • .buildSeries()
      • .concatenateImageData(progressMeter, onFinishedImageRead)
    • static
      • .useExplicitOrdering : boolean
      • .useExplicitSpacing : number
      • .parseImage(data) ⇒ Image | null
  • .Siemens : function
    • .readHeader() ⇒ string
    • .canRead(group, element) ⇒ boolean
  • .Tag : function
    • instance
      • .toString([level], [html]) ⇒ string
      • .toHTMLString(level) ⇒ string
      • .isTransformSyntax() ⇒ boolean
      • .isPixelData() ⇒ boolean
      • .isPrivateData() ⇒ boolean
      • .hasInterpretedPrivateData() ⇒ boolean
      • .isSublistItem() ⇒ boolean
      • .isSublistItemDelim() ⇒ boolean
      • .isSequenceDelim() ⇒ boolean
      • .isMetaLength() ⇒ boolean
    • static
      • .createId(group, element) ⇒ string

daikon.Dictionary : Object | *

daikon.Dictionary

Kind: static property of daikon

• .Dictionary : Object | *
  • .getVR(group, element) ⇒ string
  • .getDescription(group, element) ⇒ string

Dictionary.getVR(group, element) ⇒ string

Returns the VR for the specified group and element.

Kind: static method of Dictionary

Param	Type
group	number
element	number

Dictionary.getDescription(group, element) ⇒ string

Returns the description for the specified group and element.

Kind: static method of Dictionary

Param	Type
group	number
element	number

daikon.Image : function

The Image constructor.

Kind: static property of daikon
Properties

Name	Type	Description
tags	object	a map of tag id to tag (see daikon.Tag.createId)
tagsFlat	object	a flattened map of tags

• .Image : function
  • .getCols() ⇒ number
  • .getRows() ⇒ number
  • .getSeriesDescription() ⇒ string
  • .getSeriesInstanceUID() ⇒ string
  • .getSeriesNumber() ⇒ number
  • .getEchoNumber() ⇒ number
  • .getImagePosition() ⇒ Array.<number>
  • .getImageDirections() ⇒ Array.<number>
  • .getImagePositionSliceDir(sliceDir) ⇒ number
  • .getModality() ⇒ string
  • .getSliceLocation() ⇒ number
  • .getSliceLocationVector() ⇒ Array.<number>
  • .getImageNumber() ⇒ number
  • .getTemporalPosition() ⇒ number
  • .getTemporalNumber() ⇒ number
  • .getSliceGap() ⇒ number
  • .getSliceThickness() ⇒ number
  • .getImageMax() ⇒ number
  • .getImageMin() ⇒ number
  • .getDataScaleSlope() ⇒ number
  • .getDataScaleIntercept() ⇒ number
  • .getWindowWidth() ⇒ number
  • .getWindowCenter() ⇒ number
  • .getPixelSpacing() ⇒ Array.<number>
  • .getImageType() ⇒ Array.<string>
  • .getBitsStored() ⇒ number
  • .getBitsAllocated() ⇒ number
  • .getFrameTime() ⇒ number
  • .getAcquisitionMatrix() ⇒ Array.<number>
  • .getTR() ⇒ number
  • .getTag(group, element) ⇒ Tag
  • .getPixelData() ⇒ Tag
  • .getRawData() ⇒ ArrayBuffer
  • .getInterpretedData(asArray, asObject, frameIndex) ⇒ Float32Array | Array | object
  • .hasPixelData() ⇒ boolean
  • .getOrientation() ⇒ string
  • .isMosaic() ⇒ boolean
  • .isPalette() ⇒ boolean
  • .isCompressed() ⇒ boolean
  • .isCompressedJPEG() ⇒ boolean
  • .isCompressedJPEGLossless() ⇒ boolean
  • .isCompressedJPEGBaseline() ⇒ boolean
  • .isCompressedJPEG2000() ⇒ boolean
  • .isCompressedJPEGLS() ⇒ boolean
  • .isCompressedRLE() ⇒ boolean
  • .getNumberOfFrames() ⇒ number
  • .getNumberOfSamplesPerPixel() ⇒ number
  • .getPixelRepresentation() ⇒ number
  • .getPhotometricInterpretation() ⇒ string
  • .getPatientName() ⇒ string
  • .getPatientID() ⇒ string
  • .getStudyTime() ⇒ string
  • .getTransferSyntax() ⇒ string
  • .getStudyDate() ⇒ string
  • .getPlanarConfig() ⇒ number
  • .getImageDescription() ⇒ string
  • .getDataType() ⇒ number
  • .getEncapsulatedData() ⇒ Array.<Tag>
  • .getAllInterpretedPrivateData() ⇒ string
  • .toString() ⇒ string

image.getCols() ⇒ number

Returns the number of columns.

Kind: instance method of Image

image.getRows() ⇒ number

Returns the number of rows.

Kind: instance method of Image

image.getSeriesDescription() ⇒ string

Returns the series description.

Kind: instance method of Image

image.getSeriesInstanceUID() ⇒ string

Returns the series instance UID.

Kind: instance method of Image

image.getSeriesNumber() ⇒ number

Returns the series number.

Kind: instance method of Image

image.getEchoNumber() ⇒ number

Returns the echo number.

Kind: instance method of Image

image.getImagePosition() ⇒ Array.<number>

Returns the image position.

Kind: instance method of Image

image.getImageDirections() ⇒ Array.<number>

Returns the image axis directions

Kind: instance method of Image

image.getImagePositionSliceDir(sliceDir) ⇒ number

Returns the image position value by index.

Kind: instance method of Image

Param	Type	Description
sliceDir	number	the index

image.getModality() ⇒ string

Returns the modality

Kind: instance method of Image

image.getSliceLocation() ⇒ number

Returns the slice location.

Kind: instance method of Image

image.getSliceLocationVector() ⇒ Array.<number>

Returns the slice location vector.

Kind: instance method of Image

image.getImageNumber() ⇒ number

Returns the image number.

Kind: instance method of Image

image.getTemporalPosition() ⇒ number

Returns the temporal position.

Kind: instance method of Image

image.getTemporalNumber() ⇒ number

Returns the temporal number.

Kind: instance method of Image

image.getSliceGap() ⇒ number

Returns the slice gap.

Kind: instance method of Image

image.getSliceThickness() ⇒ number

Returns the slice thickness.

Kind: instance method of Image

image.getImageMax() ⇒ number

Returns the image maximum.

Kind: instance method of Image

image.getImageMin() ⇒ number

Returns the image minimum.

Kind: instance method of Image

image.getDataScaleSlope() ⇒ number

Returns the rescale slope.

Kind: instance method of Image

image.getDataScaleIntercept() ⇒ number

Returns the rescale intercept.

Kind: instance method of Image

image.getWindowWidth() ⇒ number

Returns the window width.

Kind: instance method of Image

image.getWindowCenter() ⇒ number

Returns the window center.

Kind: instance method of Image

image.getPixelSpacing() ⇒ Array.<number>

Returns the pixel spacing.

Kind: instance method of Image

image.getImageType() ⇒ Array.<string>

Returns the image type.

Kind: instance method of Image

image.getBitsStored() ⇒ number

Returns the number of bits stored.

Kind: instance method of Image

image.getBitsAllocated() ⇒ number

Returns the number of bits allocated.

Kind: instance method of Image

image.getFrameTime() ⇒ number

Returns the frame time.

Kind: instance method of Image

image.getAcquisitionMatrix() ⇒ Array.<number>

Returns the acquisition matrix (e.g., "mosaic" data).

Kind: instance method of Image

image.getTR() ⇒ number

Returns the TR.

Kind: instance method of Image

image.getTag(group, element) ⇒ Tag

Returns a tag matching the specified group and element.

Kind: instance method of Image

Param	Type
group	number
element	number

image.getPixelData() ⇒ Tag

Returns the pixel data tag.

Kind: instance method of Image

image.getRawData() ⇒ ArrayBuffer

Returns the raw pixel data.

Kind: instance method of Image

image.getInterpretedData(asArray, asObject, frameIndex) ⇒ Float32Array | Array | object

Returns interpreted pixel data (considers datatype, byte order, data scales).

Kind: instance method of Image

Param	Type	Description
asArray	boolean	if true, the returned data is a JavaScript Array
asObject	boolean	if true, an object is returned with properties: data, min, max, minIndex, maxIndex, numCols, numRows
frameIndex	number	if provided, only the desired frame in a multi-frame dataset is returned

image.hasPixelData() ⇒ boolean

Returns true if pixel data is found.

Kind: instance method of Image

image.getOrientation() ⇒ string

Returns an orientation string (e.g., XYZ+--).

Kind: instance method of Image

image.isMosaic() ⇒ boolean

Returns true if this image is "mosaic".

Kind: instance method of Image

image.isPalette() ⇒ boolean

Returns true if this image uses palette colors.

Kind: instance method of Image

image.isCompressed() ⇒ boolean

Returns true if this image stores compressed data.

Kind: instance method of Image

image.isCompressedJPEG() ⇒ boolean

Returns true if this image stores JPEG data.

Kind: instance method of Image

image.isCompressedJPEGLossless() ⇒ boolean

Returns true of this image stores lossless JPEG data.

Kind: instance method of Image

image.isCompressedJPEGBaseline() ⇒ boolean

Returns true if this image stores baseline JPEG data.

Kind: instance method of Image

image.isCompressedJPEG2000() ⇒ boolean

Returns true if this image stores JPEG2000 data.

Kind: instance method of Image

image.isCompressedJPEGLS() ⇒ boolean

Returns true if this image stores JPEG-LS data.

Kind: instance method of Image

image.isCompressedRLE() ⇒ boolean

Returns true if this image stores RLE data.

Kind: instance method of Image

image.getNumberOfFrames() ⇒ number

Returns the number of frames.

Kind: instance method of Image

image.getNumberOfSamplesPerPixel() ⇒ number

Returns the number of samples per pixel.

Kind: instance method of Image

image.getPixelRepresentation() ⇒ number

Returns the pixel representation.

Kind: instance method of Image

image.getPhotometricInterpretation() ⇒ string

Returns the photometric interpretation.

Kind: instance method of Image

image.getPatientName() ⇒ string

Returns the patient name.

Kind: instance method of Image

image.getPatientID() ⇒ string

Returns the patient ID.

Kind: instance method of Image

image.getStudyTime() ⇒ string

Returns the study time.

Kind: instance method of Image

image.getTransferSyntax() ⇒ string

Returns the transfer syntax.

Kind: instance method of Image

image.getStudyDate() ⇒ string

Returns the study date.

Kind: instance method of Image

image.getPlanarConfig() ⇒ number

Returns the planar configuration.

Kind: instance method of Image

image.getImageDescription() ⇒ string

Returns all descriptive info for this image.

Kind: instance method of Image

image.getDataType() ⇒ number

Returns the datatype (e.g., daikon.Image.BYTE_TYPE_INTEGER_UNSIGNED).

Kind: instance method of Image

image.getEncapsulatedData() ⇒ Array.<Tag>

Returns encapsulated data tags.

Kind: instance method of Image

image.getAllInterpretedPrivateData() ⇒ string

Returns a string of interpreted private data.

Kind: instance method of Image

image.toString() ⇒ string

Returns a string representation of this image.

Kind: instance method of Image

daikon.Parser : function

The Parser constructor.

Kind: static property of daikon
Properties

Name	Type
explicit	boolean
littleEndian	boolean

• .Parser : function
  • instance
    • .parse(data) ⇒ Image | null
  • static
    • .verbose : boolean
    • .isMagicCookieFound(data) ⇒ boolean

parser.parse(data) ⇒ Image | null

Parses this data and returns an image object.

Kind: instance method of Parser

Param	Type
data	DataView

Parser.verbose : boolean

Global property to output string representation of tags as they are parsed.

Kind: static property of Parser

Parser.isMagicCookieFound(data) ⇒ boolean

Returns true if the DICOM magic cookie is found.

Kind: static method of Parser

Param	Type
data	DataView

daikon.RLE : function

The RLE constructor.

Kind: static property of daikon

rlE.decode(data, littleEndian, numElements) ⇒ DataView

Decodes the RLE data.

Kind: instance method of RLE

Param	Type
data	ArrayBuffer
littleEndian	boolean
numElements	number

daikon.Series : function

The Series constructor.

Kind: static property of daikon
Properties

Name	Type
images	Array.<Image>

• .Series : function
  • instance
    • .toString() ⇒ string
    • .getName() ⇒ string | null
    • .addImage(image)
    • .matchesSeries(image) ⇒ boolean
    • .buildSeries()
    • .concatenateImageData(progressMeter, onFinishedImageRead)
  • static
    • .useExplicitOrdering : boolean
    • .useExplicitSpacing : number
    • .parseImage(data) ⇒ Image | null

series.toString() ⇒ string

Returns the series ID.

Kind: instance method of Series

series.getName() ⇒ string | null

Returns a nice name for the series.

Kind: instance method of Series

series.addImage(image)

Adds an image to the series.

Kind: instance method of Series

Param	Type
image	Image

series.matchesSeries(image) ⇒ boolean

Returns true if the specified image is part of the series (or if no images are yet part of the series).

Kind: instance method of Series

Param	Type
image	Image

series.buildSeries()

Orders and organizes the images in this series.

Kind: instance method of Series

series.concatenateImageData(progressMeter, onFinishedImageRead)

Concatenates image data (asynchronously).

Kind: instance method of Series

Param	Type	Description
progressMeter	object	- the object must have a drawProgress(percent, label) function [e.g., drawProgress(.5, "Loading...")]
onFinishedImageRead	function	- callback

Series.useExplicitOrdering : boolean

True to keep original order of images, ignoring metadata-based ordering.

Kind: static property of Series

Series.useExplicitSpacing : number

A hint to software to use this explicit distance (mm) between slices (see daikon.Series.useExplicitOrdering)

Kind: static property of Series

Series.parseImage(data) ⇒ Image | null

Parses the DICOM header and return an image object.

Kind: static method of Series

Param	Type
data	DataView

daikon.Siemens : function

The Siemens constructor.

Kind: static property of daikon
Params: ArrayBuffer buffer

• .Siemens : function
  • .readHeader() ⇒ string
  • .canRead(group, element) ⇒ boolean

siemens.readHeader() ⇒ string

Reads the Siemens header. (See http://nipy.org/nibabel/dicom/siemens_csa.html)

Kind: instance method of Siemens

siemens.canRead(group, element) ⇒ boolean

Returns true if the specified group and element indicate this tag can be read.

Kind: instance method of Siemens

Param	Type
group	number
element	number

daikon.Tag : function

The Tag constuctor.

Kind: static property of daikon
Properties

Name	Type	Description
group	number
element	number
vr	string
offsetStart	number
offsetValue	number
offsetEnd	number
sublist	boolean	true if this tag is a sublist
value	number | Array.<number> | string | Array.<string> | object

• .Tag : function
  • instance
    • .toString([level], [html]) ⇒ string
    • .toHTMLString(level) ⇒ string
    • .isTransformSyntax() ⇒ boolean
    • .isPixelData() ⇒ boolean
    • .isPrivateData() ⇒ boolean
    • .hasInterpretedPrivateData() ⇒ boolean
    • .isSublistItem() ⇒ boolean
    • .isSublistItemDelim() ⇒ boolean
    • .isSequenceDelim() ⇒ boolean
    • .isMetaLength() ⇒ boolean
  • static
    • .createId(group, element) ⇒ string

tag.toString([level], [html]) ⇒ string

Returns a string representation of this tag.

Kind: instance method of Tag

Param	Type	Description
[level]	number	the indentation level
[html]	boolean

tag.toHTMLString(level) ⇒ string

Returns an HTML string representation of this tag.

Kind: instance method of Tag

Param	Type	Description
level	number	the indentation level

tag.isTransformSyntax() ⇒ boolean

Returns true if this is the transform syntax tag.

Kind: instance method of Tag

tag.isPixelData() ⇒ boolean

Returns true if this is the pixel data tag.

Kind: instance method of Tag

tag.isPrivateData() ⇒ boolean

Returns true if this tag contains private data.

Kind: instance method of Tag

tag.hasInterpretedPrivateData() ⇒ boolean

Returns true if this tag contains private data that can be read.

Kind: instance method of Tag

tag.isSublistItem() ⇒ boolean

Returns true if this tag is a sublist item.

Kind: instance method of Tag

tag.isSublistItemDelim() ⇒ boolean

Returns true if this tag is a sublist item delimiter.

Kind: instance method of Tag

tag.isSequenceDelim() ⇒ boolean

Returns true if this tag is a sequence delimiter.

Kind: instance method of Tag

tag.isMetaLength() ⇒ boolean

Returns true if this is a meta length tag.

Kind: instance method of Tag

Tag.createId(group, element) ⇒ string

Create an ID string based on the specified group and element

Kind: static method of Tag

Param	Type
group	number
element	number