dicom

README

DICOM parser in Go

Usage

package main

import (
	"fmt"
	"github.com/gillesdemey/go-dicom"
	"io/ioutil"
)

func main() {

	bytes, err := ioutil.ReadFile("myfile.dcm")
	
	parser, err := dicom.NewParser()
	data, err := parser.Parse(bytes)

	for _, elem := range data.Elements {
		fmt.Printf("%+v\n", &elem)
	}

}

Commandline Interface

dicom -file=myfile.dcm

Will print something like:

Group	Element	Name				VR	VL	Value
0002	0000	FileMetaInformationGroupLength	UL	4	204
0002	0001	FileMetaInformationVersion	OB	2	[0 1]
0002	0002	MediaStorageSOPClassUID		UI	26	[1.2.840.10008.5.1.4.1.1.2]
0002	0003	MediaStorageSOPInstanceUID	UI	56	[1.3.12.2.1107.5.1.4.54023.30000005032916373504600004748]
0002	0010	TransferSyntaxUID		UI	22	[1.2.840.10008.1.2.4.91]
0002	0012	ImplementationClassUID		UI	22	[1.3.6.1.4.1.19291.2.1]
0002	0013	ImplementationVersionName	SH	10	[OSIRIX001]
0002	0016	SourceApplicationEntityTitle	AE	6	[OsiriX]
0008	0008	ImageType			CS	34	[ORIGINAL PRIMARY AXIAL CT_SOM5 SPI]
0008	0016	SOPClassUID			UI	26	[1.2.840.10008.5.1.4.1.1.2]
0008	0018	SOPInstanceUID			UI	56	[1.3.12.2.1107.5.1.4.54023.30000005032916373504600004748]
0008	0020	StudyDate			DA	8	[20050329]
0008	0021	SeriesDate			DA	8	[20050329]
0008	0022	AcquisitionDate			DA	8	[20050329]
0008	0023	ContentDate			DA	8	[20050329]
0008	0030	StudyTime			TM	14	[142530.125000 ]
0008	0031	SeriesTime			TM	14	[144801.203000 ]
0008	0032	AcquisitionTime			TM	14	[143840.611848 ]
0008	0033	ContentTime			TM	14	[143840.611848 ]
0008	0050	AccessionNumber			SH	8	[2386679]
0008	0060	Modality			CS	2	[CT]
0008	0070	Manufacturer			LO	8	[SIEMENS]
0008	0080	InstitutionName			LO	20	[UCLA  Medical Center]
0008	0081	InstitutionAddress		ST	52	[UCLA Medical PlazaLos Angeles/2782F4/Los AngelesUSA]
0008	0090	ReferringPhysicianName		PN	16	[MIYAMOTO^MICHAEL]
0008	1010	StationName			SH	8	[CT54023]
0008	1030	StudyDescription		LO	48	[Cardiac^1CTA_CORONARY_ARTERIES_TESTBOLUS (Adult)]

Acknowledgements

I'd like to thank my friend Seppe Stas for helping me get through the horrific DICOM image specification and some of the harder parts of the parser.

Some more inspiration and helpful resource that brought this library to life (in no particular order):

DWV by ivmartel https://github.com/ivmartel/dwv/
dicomParser by Chris Hafey https://github.com/chafey/dicomParser
http://www.dicomlibrary.com
http://dicom.nema.org/medical/dicom/current/output/pdf/part05.pdf

Documentation

Index

• Constants
• Variables
• func Dictionary(r io.Reader) func(*Parser) error
• type DicomElement
  • func (e *DicomElement) GetValue() string
  • func (e *DicomElement) String() string
• type DicomFile
  • func (di *DicomFile) Discard(in <-chan DicomMessage, done *sync.WaitGroup)
  • func (di *DicomFile) Log(in <-chan DicomMessage, done *sync.WaitGroup) <-chan DicomMessage
  • func (file *DicomFile) LookupElement(name string) (*DicomElement, error)
  • func (di *DicomFile) Parse(buff []byte) error
  • func (di *DicomFile) WriteImagesToFolder(in <-chan DicomMessage, done *sync.WaitGroup, folder string) <-chan DicomMessage
  • func (di *DicomFile) WriteToFile(in <-chan DicomMessage, done *sync.WaitGroup, file *os.File) <-chan DicomMessage
• type DicomMessage
• type Parser
  • func NewParser(options ...func(*Parser) error) (*Parser, error)
  • func (p *Parser) Parse(buff []byte) (*DicomFile, error)

Constants

const (
	JPEG_2000       = "1.2.840.10008.1.2.4.91"
	JPEG_BASELINE_1 = "1.2.840.10008.1.2.4.50"
)

Variables

var (
	ErrIllegalTag            = errors.New("Illegal tag found in PixelData")
	ErrTagNotFound           = errors.New("Could not find tag in dicom dictionary")
	ErrBrokenFile            = errors.New("Invalid DICOM file")
	ErrOddLength             = errors.New("Encountered odd length Value Length")
	ErrUndefLengthNotAllowed = errors.New("UC, UR and UT may not have an Undefined Length, i.e.,a Value Length of FFFFFFFFH.")
)

Errors

Functions

func Dictionary

func Dictionary(r io.Reader) func(*Parser) error

Sets the dictionary for the Parser

Types

type DicomElement

type DicomElement struct {
	Group       uint16
	Element     uint16
	Name        string
	Vr          string
	Vl          uint32
	Value       []interface{} // Value Multiplicity PS 3.5 6.4
	IndentLevel uint8

	P uint32
	// contains filtered or unexported fields
}

A DICOM element

func (*DicomElement) GetValue

func (e *DicomElement) GetValue() string

func (*DicomElement) String

func (e *DicomElement) String() string

Stringer

type DicomFile

type DicomFile struct {
	Elements []DicomElement
}

func (*DicomFile) Discard

func (di *DicomFile) Discard(in <-chan DicomMessage, done *sync.WaitGroup)

Discard messages

func (*DicomFile) Log

func (di *DicomFile) Log(in <-chan DicomMessage, done *sync.WaitGroup) <-chan DicomMessage

Logs dicom elements

func (*DicomFile) LookupElement

func (file *DicomFile) LookupElement(name string) (*DicomElement, error)

Lookup a tag by name

func (*DicomFile) Parse

func (di *DicomFile) Parse(buff []byte) error

generator

func (*DicomFile) WriteImagesToFolder

func (di *DicomFile) WriteImagesToFolder(in <-chan DicomMessage, done *sync.WaitGroup, folder string) <-chan DicomMessage

Writes pixel data to folder

func (*DicomFile) WriteToFile

func (di *DicomFile) WriteToFile(in <-chan DicomMessage, done *sync.WaitGroup, file *os.File) <-chan DicomMessage

Writes dicom elements to file

type DicomMessage

type DicomMessage struct {
	// contains filtered or unexported fields
}

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func NewParser

func NewParser(options ...func(*Parser) error) (*Parser, error)

Create a new parser, with functional options for configuration http://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis

func (*Parser) Parse

func (p *Parser) Parse(buff []byte) (*DicomFile, error)

Parse a byte array, returns a DICOM file struct