@abasb75/dicom-pixel-decoder/README.md

A lightweight DICOM image decoder.

# @abasb75/dicom-parser

A lightweight DICOM parsing and pixel decoding library for JavaScript/TypeScript. This library allows you to read DICOM files, extract pixel data, and render images with proper scaling and color interpretation.

Features

## Installation

```bash
npm install @abasb75/dicom-parser @abasb75/dicom-pixel-decoder
```


## Usage
```js
import { parse } from '@abasb75/dicom-parser';
import Dataset from '@abasb75/dicom-parser/Dataset';
import { decode } from '@abasb75/dicom-pixel-decoder';
import { DecodeOptions } from '@abasb75/dicom-pixel-decoder/types';

// Assume arrayBuffer is an ArrayBuffer of your DICOM file
const dataset = await parse(arrayBuffer);

const frameIndex = 0;
const pixelData = await dataset.getPixelData(frameIndex);

const image = await decode(pixelData, {
  ...dataset.getPixelModule(),
  ...dataset.getScalingModule(),
  ...dataset.getVOILutModule(),
  littleEndian: dataset.littleEndian,
  transferSyntaxUID: dataset.transferSyntaxUID,
  isFloat: dataset.getPixelTypes() === Dataset.Float,
} as DecodeOptions);

if (!image || !image.pixelData) {
  throw new Error('Failed to decode image');
}

// Apply palette color if necessary
if (image.pixelModule.photometricInterpretation === 'PALETTE COLOR') {
  image.applyPaletteColor(dataset.getPaletteColorData());
}

// Apply scaling
image.applyScaling();

// Render pixel data to your canvas or custom renderer
render(image.pixelData);
```

## Demo

<a href="https://abasb75.github.io/dicom-pixel-decoder/">demo link</a>


## Supported transfer syntax

#Transfer Syntax UID | #Transfer Syntax name | #support	 
--- | --- | ---
1.2.840.10008.1.2	 |  Implicit VR Endian: Default Transfer Syntax for DICOM | Yes 
1.2.840.10008.1.2.1	 |  Explicit VR Little Endian | Yes
1.2.840.10008.1.2.1.99 | Deflated Explicit VR Little Endian | Yes
1.2.840.10008.1.2.2 | Explicit VR Big Endian | Yes
1.2.840.10008.1.2.4.50 | JPEG Baseline (Process 1) | Yes 
1.2.840.10008.1.2.4.51 | JPEG Baseline (Processes 2 & 4) | Yes	 
1.2.840.10008.1.2.4.57 | JPEG Lossless, Nonhierarchical (Processes 14) | Yes
1.2.840.10008.1.2.4.70 | JPEG Lossless, Nonhierarchical, First- Order Prediction | Yes
1.2.840.10008.1.2.4.80 | JPEG-LS Lossless Image Compression	 | Yes
1.2.840.10008.1.2.4.81 | JPEG-LS Lossy (Near- Lossless) Image Compression | Yes
1.2.840.10008.1.2.4.90 | JPEG 2000 Image Compression (Lossless Only) | Yes 
1.2.840.10008.1.2.4.91 | JPEG 2000 Image Compression	 | Yes
1.2.840.10008.1.2.4.201 | High-Throughput JPEG 2000 Image Compression (Lossless Only)	 | Yes
1.2.840.10008.1.2.4.203 | High-Throughput JPEG 2000 Image Compression | Yes
1.2.840.10008.1.2.5	| RLE Lossless	 	| Yes	
1.2.840.10008.1.2.4.52 | JPEG Extended (Processes 3 & 5) | Yes(Retired)
1.2.840.10008.1.2.4.202 | High-Throughput JPEG 2000 with RPCL Options Image Compression (Lossless Only) | Untested
1.2.840.10008.1.2.4.53 | JPEG Spectral Selection, Nonhierarchical (Processes 6 & 8)	| Untested(Retired)
1.2.840.10008.1.2.4.54 | JPEG Spectral Selection, Nonhierarchical (Processes 7 & 9)	| Untested(Retired)	
1.2.840.10008.1.2.4.55 | JPEG Full Progression, Nonhierarchical (Processes 10 & 12)	| Untested(Retired)	
1.2.840.10008.1.2.4.56 | JPEG Full Progression, Nonhierarchical (Processes 11 & 13)	| Untested(Retired)	
1.2.840.10008.1.2.4.58 | JPEG Lossless, Nonhierarchical (Processes 15)	Retired	| Untested(Retired)		
1.2.840.10008.1.2.4.59 | JPEG Extended, Hierarchical (Processes 16 & 18)	| Untested(Retired)		
1.2.840.10008.1.2.4.60 | JPEG Extended, Hierarchical (Processes 17 & 19) | Untested
1.2.840.10008.1.2.4.61 | JPEG Spectral Selection, Hierarchical (Processes 20 & 22)	| Untested(Retired)		
1.2.840.10008.1.2.4.62 | JPEG Spectral Selection, Hierarchical (Processes 21 & 23)	| Untested(Retired)		
1.2.840.10008.1.2.4.63 | JPEG Full Progression, Hierarchical (Processes 24 & 26)	| Untested(Retired)		
1.2.840.10008.1.2.4.64 | JPEG Full Progression, Hierarchical (Processes 25 & 27)	| Untested(Retired)		
1.2.840.10008.1.2.4.65 | JPEG Lossless, Nonhierarchical (Process 28) | Untested(Retired)		
1.2.840.10008.1.2.4.66 | JPEG Lossless, Nonhierarchical (Process 29) | Untested(Retired)
1.2.840.10008.1.2.4.92 | JPEG 2000 Part 2 Multicomponent Image Compression (Lossless Only) | Untested
1.2.840.10008.1.2.4.93 | JPEG 2000 Part 2 Multicomponent Image Compression | Untested
1.2.840.10008.1.2.4.94 | JPIP Referenced	 	| No	
1.2.840.10008.1.2.4.95 | JPIP Referenced Deflate	 	| No	
1.2.840.10008.1.2.6.1 | RFC 2557 MIME Encapsulation	 	| No	
1.2.840.10008.1.2.4.100 | MPEG2 Main Profile Main Level	| No
1.2.840.10008.1.2.4.102 | MPEG-4 AVC/H.264 High Profile / Level 4.1 | No
1.2.840.10008.1.2.4.103 | MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1	 | No


## Tested Datasets:
1. Many Private datasets.

2. <a href="https://github.com/cornerstonejs/cornerstoneWADOImageLoader/tree/master/testImages">
https://github.com/cornerstonejs/cornerstoneWADOImageLoader/tree/master/testImages
</a>

3. <a href="https://github.com/pydicom/pydicom-data">
https://github.com/pydicom/pydicom-data
</a>

4. <a href="https://www.dicomlibrary.com/">
https://www.dicomlibrary.com/
</a>