fo-dicom.Codecs 5.15.1

dotnet add package fo-dicom.Codecs --version 5.15.1                
NuGet\Install-Package fo-dicom.Codecs -Version 5.15.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="fo-dicom.Codecs" Version="5.15.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add fo-dicom.Codecs --version 5.15.1                
#r "nuget: fo-dicom.Codecs, 5.15.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install fo-dicom.Codecs as a Cake Addin
#addin nuget:?package=fo-dicom.Codecs&version=5.15.1

// Install fo-dicom.Codecs as a Cake Tool
#tool nuget:?package=fo-dicom.Codecs&version=5.15.1                

fo-dicom.Codecs

NuGet downloads github build

<img src="fo-dicom_logo.png" alt="fo-dicom logo" height="80" /> <img src="efferent_logo.png" alt="Efferent logo" height="80" />

This is collaborative project mantained by Fellow Oak Dicom and Efferent Health, LLC. The codecs in this repository are written in pure C/C++ code and wrapped with C# and netstandard2.0. The supported platforms so far are:

OS   x64   Arm64 Tested with
Windows :white_check_mark: Windows 10/11
Linux :white_check_mark: :white_check_mark: Ubuntu 18/20/22
MacOS :white_check_mark: :white_check_mark: Ventura/Sonoma

Supported CODECs

The following CODECS are implemented:

Transfer Syntax UID Description
1.2.840.10008.1.2.5 RLE Lossless
1.2.840.10008.1.2.4.50 JPEG Baseline (Process 1): Default Transfer Syntax for Lossy JPEG 8 Bit Image Compression
1.2.840.10008.1.2.4.51 JPEG Extended (Process 2 & 4): Default Transfer Syntax for Lossy JPEG 12 Bit Image Compression (Process 4 only)
1.2.840.10008.1.2.4.57 JPEG Lossless, Non-Hierarchical (Process 14)
1.2.840.10008.1.2.4.70 JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1]): Default Transfer Syntax for Lossless JPEG Image Compression
1.2.840.10008.1.2.4.80 JPEG-LS Lossless Image Compression
1.2.840.10008.1.2.4.81 JPEG-LS Lossy (Near-Lossless) Image Compression
1.2.840.10008.1.2.4.90 JPEG 2000 Image Compression (Lossless Only)
1.2.840.10008.1.2.4.91 JPEG 2000 Image Compression
1.2.840.10008.1.2.4.201 High-Throughput JPEG 2000 Image Compression (Lossless Only)
1.2.840.10008.1.2.4.202 High-Throughput JPEG 2000 with RPCL Options Image Compression (Lossless Only)
1.2.840.10008.1.2.4.203 High-Throughput JPEG 2000 Image Compression

The HT-JPEG2000 family of codecs is only supported since fo-dicom version 5.1.3

Usage

With fo-dicom 4.x

  • Add the nuget package to your .NET Standard or .NET Core project (minimum version is 2.0)
  • Add the standard fo-dicom nuget packages to your project (version 4.x)
  • At the beginning of your application, replace the transcoder manager, as:
    Dicom.Imaging.Codec.TranscoderManager.SetImplementation(new Dicom.Imaging.NativeCodec.NativeTranscoderManager());
    

With fo-dicom 5.x

  • Add the nuget package to your .NET Standard or .NET project (minimum version is .NET 5.0)
  • Add the standard fo-dicom nuget packages to your project (version 5.x)
  • At the beginning of your application, replace the transcoder manager, as:
    new DicomSetupBuilder()
      .RegisterServices(s => s.AddFellowOakDicom().AddTranscoderManager<FellowOakDicom.Imaging.NativeCodec.NativeTranscoderManager>())
      .SkipValidation()
      .Build();
    

Dependencies

Windows

It is required to have Visual C++ Redistributable v14 installed in the target Windows machine. Otherwise, it will throw a runtime error:

Unable to load DLL 'Dicom.Native': The specified module could not be found. (Exception from HRESULT: 0x8007007E)

The installer can be downloaded directly from https://aka.ms/vs/17/release/vc_redist.x64.exe

Linux

The native library has been built on an Ubuntu 20.04 environment using GNU C Compiler version 9.4.x.

Therefore, it requires a GLIBC library runtime version 2.27 and GLIBCXX version 3.4. Otherwise, it can throw a runtime error like:

Unhandled Exception: System.DllNotFoundException: Unable to load shared library 'Dicom.Native.so' or one of its dependencies.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on fo-dicom.Codecs:

Package Downloads
Kayisoft.Abp.FoDicom.Codecs

Kayisoft FoDicom Codecs Module

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on fo-dicom.Codecs:

Repository Stars
fo-dicom/fo-dicom
Fellow Oak DICOM for .NET, .NET Core, Universal Windows, Android, iOS, Mono and Unity
fo-dicom/fo-dicom-samples
Sample applications associated with the fo-dicom framework