Plugin DICOM
Afficher les images médicales avec DicomPlugin
Le plugin DICOM ajoute la visualisation d'images médicales à Doconut : les fichiers DICOM multi‑trames sont rendus sous forme d'aperçu animé, de trames individuelles, ou les deux. DICOM est un format uniquement plugin — sans ce plugin (et sa capacité de licence), les fichiers .dcm ne peuvent pas être ouverts du tout.
| Surface | Quand l'utiliser |
|---|---|
Viewer avec DicomConfig (C#) | Vous ouvrez des fichiers DICOM sur le serveur et choisissez comment leurs trames sont présentées |
Le visualiseur (docViewer) | Vous affichez l'étude sur votre page : animation, trames et un panneau de propriétés DICOM |
Point de terminaison HTTP (?token=<token>&meta=1) | Vous lisez les métadonnées techniques depuis votre propre interface |
Le plugin n'a aucun widget propre : les fichiers DICOM s'ouvrent dans le visualiseur standard. Avec le plugin de conversion également enregistré, les fichiers .dcm et .ima peuvent être convertis en Pdf, Png, Jpeg, Bmp, Tiff ou Gif ; cette conversion nécessite également la capacité Dicom.
Installer le paquet
dotnet add package Doconut.NET8.DicomLa commande non versionnée installe la dernière version stable. Pour fixer le plugin à la version décrite dans cette documentation, transmettez la version séparément :
dotnet add package Doconut.NET8.Dicom --version 26.10.0Conservez le paquet DICOM à la même version que Doconut.NET8. L'ID du paquet est Doconut.NET8.Dicom ; .<version> n'apparaît que dans le nom de fichier .nupkg téléchargé.
Le fichier de licence du plugin, Doconut.Viewer.Dicom.lic, se place dans le même dossier que Doconut.Viewer.lic ; il est lu conjointement avec la licence du visualiseur.
Plateformes. Le plugin fonctionne partout où Doconut.NET8 fonctionne : Windows et Linux basé sur glibc en x64 (pas Alpine ou autres distributions basées sur musl). Sous Linux, installez la bibliothèque de configuration des polices avant l'ouverture du premier document :
apt-get update && apt-get install -y libfontconfig1Sur RHEL, Fedora et distributions similaires, le paquet est fontconfig. Sans cela, l'ouverture d'un document échoue avec The system library libfontconfig1 is missing. Install it (Debian/Ubuntu: apt-get install -y libfontconfig1) and see the Linux section of the Doconut documentation.
Enregistrer le plugin
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});Le plugin (Name : "Doconut DICOM Viewer") enregistre des visualiseurs pour les extensions .dcm et .ima, contrôlées par la capacité Dicom. Sans une licence qui la délivre, AddDoconut() génère une InvalidOperationException au démarrage, avant que l'application ne traite une requête :
The Dicom plugin is registered via AddPlugin but no active license grants Dicom. Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Dicom.Il se déclenche en l'absence de licence, avec un fichier hérité TRIAL, une licence sans Dicom, et une licence payante utilisée en dehors de sa fenêtre de version. Les licences temporaires Démo/NFR sont acceptées. Voir Configuration de la licence pour savoir comment les licences sont chargées.
Comme aucun visualiseur intégré ne gère ces formats, la porte d'exécution échoue également de manière critique si la capacité devient indisponible plus tard :
LicenseException: This document type requires the 'Dicom' plugin license.Licence & filigrane
| État de la licence | Démarrage | Sortie DICOM |
|---|---|---|
Licence payante accordant Dicom, dans sa fenêtre de version | Démarre | Rendu selon les règles normales de filigrane de la page |
| Licence temporaire active (Démo/NFR) | Démarre | Rendu avec le filigrane d'évaluation |
Aucune licence, un fichier hérité TRIAL, une licence sans Dicom, ou une licence payante hors de sa fenêtre de version | AddDoconut() génère une exception | — |
La décision de filigrane de la page normale s'applique également à la sortie DICOM. Pour la sortie animée, chaque trame GIF est marquée afin que le filigrane reste visible pendant toute la lecture. Un DocOptions.Watermark personnalisé n'est utilisé que lorsque le chemin de licence autorise les filigranes personnalisés ; il ne peut pas remplacer un filigrane d'évaluation.
Utilisation depuis C#
var token = await viewer.OpenDocumentAsync(path, new DicomConfig
{
DisplayMode = DicomDisplayMode.AnimationAndFrames
});Pour les sessions ouvertes via ce plugin, Viewer expose les métadonnées des balises :
var metadata = await viewer.GetDicomMetadataAsync(token);
// null lorsque la session n’est pas un document DICOMModes d'affichage, résolution et métadonnées
Modes d'affichage
Les fichiers DICOM multi‑images peuvent être présentés de trois manières (DicomDisplayMode) :
| Mode | Pages générées | Utilisation |
|---|---|---|
AnimationOnly | Page 1 = GIF animé en boucle de toutes les images | Revue cinématographique rapide |
FramesOnly | Pages 1..N = un PNG statique par image | Navigation diagnostique image par image |
AnimationAndFrames (default) | Page 1 = GIF animé, pages 2..N+1 = un PNG statique par image (N = nombre d'images) | Vue d'ensemble + détail dans un même document |
Le timing de l'animation est contrôlé par AnimationFrameDelayMs (par défaut 100 ms = 10 IPS ; la granularité du GIF est de 10 ms) et LoopCount (0 = boucle infinie).
Résolution
DicomConfig rend à 100 DPI par axe par défaut. Les propriétés de résolution ont une chaîne de secours utile à connaître : si vous ne définissez pas explicitement HorizontalResolution/VerticalResolution, elles suivent BaseConfig.ImageResolution lorsque celui‑ci est configuré, et ne retombent à 100 qu'ensuite.
// Augmentation uniforme via la propriété de base…
new DicomConfig { ImageResolution = 150 };
// …ou contrôle par axe
new DicomConfig { HorizontalResolution = 200, VerticalResolution = 150 };Métadonnées
DicomMetadata ne transporte que les balises techniques et d'imagerie — nombre d'images, dimensions, profondeur de bits, interprétation photométrique, syntaxe de transfert, modalité et niveau de fenêtre par défaut. Il ne contient aucune donnée permettant d'identifier le patient. La liste complète se trouve dans la référence API.
Dans le visualiseur
Le visualiseur ne nécessite aucune configuration spécifique à DICOM. Lorsque le document ouvert est un fichier DICOM, il demande les métadonnées (?token=<token>&meta=1) et ajoute un bouton DICOM qui ouvre un panneau de propriétés techniques. Si cette requête échoue, le panneau reste caché et le document s'affiche tout de même.
Construisez votre propre interface
Les métadonnées sont disponibles via HTTP sous le chemin où UseDoconut() est monté (généralement /doconut), pour tout jeton de document ouvert :
| Route | Objectif | Réponse réussie |
|---|---|---|
GET ?token=<token>&meta=1 | Lire les métadonnées techniques d'un document DICOM ouvert | 200 — DicomMetadata au format JSON, avec les noms de propriétés de la référence API (Width, Height, NumberOfFrames, …) |
| Statut | Quand | Corps |
|---|---|---|
404 | Le document n'est pas un fichier DICOM | statut uniquement |
500 | La lecture des métadonnées a échoué | { "error": "metadata failed" } |
Les images de page, y compris la première page animée, utilisent la route d'image standard du visualiseur.
En production
Les études multiframe peuvent générer à la fois une animation et une page statique par image. AnimationAndFrames offre la navigation la plus riche mais comporte également le coût de rendu et de cache le plus élevé. Pour les grandes études :
- utilisez
FramesOnlylorsque l'inspection des images est plus importante que la lecture cinématographique ; - évitez d'augmenter les deux axes de résolution sans mesurer la mémoire ;
- fermez explicitement la session lorsque l'étude n'est plus ouverte ;
- conservez
CachePagesactivé uniquement lorsque les avantages d'un accès répété l'emportent sur les images conservées.
Placez Doconut.Viewer.Dicom.lic à côté de Doconut.Viewer.lic sur chaque serveur.
Référence API
DicomConfig, DicomDisplayMode et DicomMetadata se trouvent dans l'espace de noms Doconut. DicomPlugin est dans Doconut.Plugins.Dicom. Le tableau complet des propriétés DicomConfig se trouve dans Format Configs.
DicomConfig
public sealed class DicomConfig : BaseConfig
{
public int HorizontalResolution { get; set; } // par défaut : ImageResolution lorsqu’il est défini, sinon 100
public int VerticalResolution { get; set; } // par défaut : ImageResolution lorsqu’il est défini, sinon 100
public int AnimationFrameDelayMs { get; set; } = 100;
public ushort LoopCount { get; set; } = 0; // 0 = boucle infinie
public DicomDisplayMode DisplayMode { get; set; } = DicomDisplayMode.AnimationAndFrames;
}DicomDisplayMode
public enum DicomDisplayMode { AnimationOnly, FramesOnly, AnimationAndFrames }Viewer.GetDicomMetadataAsync
public Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default);Renvoie null lorsque le document n'est pas un fichier DICOM. Lève InvalidOperationException lorsque le jeton est inconnu ou expiré.
DicomMetadata
public sealed class DicomMetadata
{
public int Width { get; init; }
public int Height { get; init; }
public int NumberOfFrames { get; init; }
public int BitsAllocated { get; init; }
public int BitsStored { get; init; }
public int SamplesPerPixel { get; init; }
public string? PhotometricInterpretation { get; init; }
public string? PixelRepresentation { get; init; } // "Unsigned" ou "Signed"
public string? PlanarConfiguration { get; init; }
public string? TransferSyntax { get; init; }
public string? Modality { get; init; } // null lorsqu'il n'est pas exposé
public double? WindowCenter { get; init; }
public double? WindowWidth { get; init; }
public bool IsColor { get; init; }
}Dépannage
| Symptôme | Cause | Solution |
|---|---|---|
AddDoconut() lance The Dicom plugin is registered via AddPlugin but no active license grants Dicom. | Pas de licence, un fichier TRIAL, une licence sans Dicom, ou une licence payante en dehors de sa fenêtre de version | Installez une licence qui accorde Dicom, ou supprimez AddPlugin<DicomPlugin>() |
L'ouverture d'un fichier .dcm lance Document format '.dcm' is not supported. | DicomPlugin n'est pas enregistré, ou son package n'est pas déployé | Ajoutez AddPlugin<DicomPlugin>() dans AddDoconut() et déployez le package |
L'ouverture d'un fichier .dcm lance LicenseException: This document type requires the 'Dicom' plugin license. | La licence chargée n'accorde plus Dicom | Installez une licence qui accorde Dicom |
| Une seule page apparaît | La source est à image unique, ou DisplayMode est AnimationOnly | Utilisez FramesOnly ou AnimationAndFrames pour une source multi‑images |
| L'animation est trop rapide ou trop lente | AnimationFrameDelayMs est désactivé ; le timing GIF effectif utilise des unités de 10 ms | Ajustez AnimationFrameDelayMs |
| La mémoire augmente sur les gros fichiers multiframe | Le mode d'affichage, la résolution et le cache de pages ajoutent tous des images retenues | Voir En production ; fermez les sessions explicitement |
Les métadonnées sont null | Le document n'est pas un fichier DICOM | Vérifiez le type de fichier avant de demander les métadonnées |
GetDicomMetadataAsync lance Document session not found. Please re-open document. | Le jeton a expiré ou n'a jamais été ouvert | Ouvrez à nouveau le document |
Cette page était-elle utile ?