Fellow Oak DICOM

Features

• Portable Class Library (PCL)
• Targets .NET 4.5.2 and higher, .NET Core 1.3 and higher, Universal Windows Platform, Xamarin iOS, Xamarin Android, Mono and Unity
• DICOM dictionary version 2016b
• High-performance, fully asynchronous async/await API
• JPEG (including lossless), JPEG-LS, JPEG2000, and RLE image compression (limited on .NET Core, Xamarin, Mono and Unity platforms)
• Supports very large datasets with content loading on demand
• Image rendering
• JSON support

Installation

Easiest is to obtain fo-dicom binaries from NuGet. This package reference the core fo-dicom assemblies for all Microsoft and Xamarin platforms.

NuGet Packages

Package	Description
fo-dicom	Dependencies package including core libraries for Microsoft and Xamarin platforms
fo-dicom.Core	Core library for PCL Profile 111
fo-dicom.Desktop	Core library and native codec libraries for .NET 4.5.2 and higher
fo-dicom.NetStandard	Core library for .NET Core applications, Level 1.3 and higher
fo-dicom.Universal	Core library and native codec libraries for Universal Windows Platform
fo-dicom.Android	Core library for Xamarin Android
fo-dicom.iOS	Core library for Xamarin iOS (Unified)
fo-dicom.log4net	.NET connector to enable fo-dicom logging with log4net
fo-dicom.MetroLog	PCL Profile 111 connector to enable fo-dicom logging with MetroLog
fo-dicom.NLog	.NET connector to enable fo-dicom logging with NLog
fo-dicom.Serilog	.NET connector to enable fo-dicom logging with Serilog
fo-dicom.Json	PCL profile 111 library for JSON I/O support
fo-dicom.Legacy	PCL profile 111 library with obsolete asynchronous methods (to be deprecated)

Usage Notes

Out-of-the-box, fo-dicom for .NET defaults to Windows Forms-style image rendering. To switch to WPF-style image rendering, call:

ImageManager.SetImplementation(WPFImageManager.Instance);

By default, logging defaults to the no-op NullLogerManager. On .NET, several log managers are available and can be enabled like this:

LogManager.SetImplementation(ConsoleLogManager.Instance);  // or ...
LogManager.SetImplementation(NLogManager.Instance);        // or ...

On Universal Windows Platform, Xamarin iOS, Xamarin Android and Mono there is only one operational log manager available, namely MetroLogManager.Instance.

Examples

File Operations

var file = DicomFile.Open(@"test.dcm");             // Alt 1
var file = await DicomFile.OpenAsync(@"test.dcm");  // Alt 2

var patientid = file.Dataset.Get<string>(DicomTag.PatientID);

file.Dataset.Add(DicomTag.PatientsName, "DOE^JOHN");

// creates a new instance of DicomFile
file = file.ChangeTransferSyntax(DicomTransferSyntax.JPEGProcess14SV1);

file.Save(@"output.dcm");             // Alt 1
await file.SaveAsync(@"output.dcm");  // Alt 2

Render Image to JPEG

var image = new DicomImage(@"test.dcm");
image.RenderImage().AsBitmap().Save(@"test.jpg");                     // Windows Forms
image.RenderImage().AsUIImage().AsJPEG().Save(@"test.jpg", true);     // iOS

C-Store SCU

var client = new DicomClient();
client.AddRequest(new DicomCStoreRequest(@"test.dcm"));
client.Send("127.0.0.1", 12345, false, "SCU", "ANY-SCP");             // Alt 1
await client.SendAsync("127.0.0.1", 12345, false, "SCU", "ANY-SCP");  // Alt 2

C-Echo SCU/SCP

var server = new DicomServer<DicomCEchoProvider>(12345);

var client = new DicomClient();
client.NegotiateAsyncOps();
for (int i = 0; i < 10; i++)
    client.AddRequest(new DicomCEchoRequest());
client.Send("127.0.0.1", 12345, false, "SCU", "ANY-SCP");             // Alt 1
await client.SendAsync("127.0.0.1", 12345, false, "SCU", "ANY-SCP");  // Alt 2

C-Find SCU

var cfind = DicomCFindRequest.CreateStudyQuery(patientId: "12345");
cfind.OnResponseReceived = (DicomCFindRequest rq, DicomCFindResponse rp) => {
	Console.WriteLine("Study UID: {0}", rp.Dataset.Get<string>(DicomTag.StudyInstanceUID));
};

var client = new DicomClient();
client.AddRequest(cfind);
client.Send("127.0.0.1", 104, false, "SCU-AE", "SCP-AE");             // Alt 1
await client.SendAsync("127.0.0.1", 104, false, "SCU-AE", "SCP-AE");  // Alt 2

C-Move SCU

var cmove = new DicomCMoveRequest("DEST-AE", studyInstanceUid);

var client = new DicomClient();
client.AddRequest(cmove);
client.Send("127.0.0.1", 104, false, "SCU-AE", "SCP-AE");             // Alt 1
await client.SendAsync("127.0.0.1", 104, false, "SCU-AE", "SCP-AE");  // Alt 2

Sample applications

There are a number of simple sample applications that use fo-dicom available in separate repository here. These also include the samples that were previously included in the Examples sub-folder of the VS solutions.

Contributors

• Anders Gustafsson, Cureos AB
• Colby Dillion
• Ian Yates
• Hesham Desouky, Nebras Technology
• Chris Horn
• Rickard Holmberg
• Mahesh Dubey
• Alexander Saratow
• Håkan MacLean
• Zaid Safadi
• Ryan Melena
• Justin Wake
• Johannes Liegert
• Chris Hafey
• Michael Pavlovsky
• lste
• captainstark
• do0om
• Thunderstriker
• Ed55
• zcr01

License

This library is licensed under the Microsoft Public License (MS-PL). See License.txt for more information.