GetStructuredDisplayImage(DicomDataSet,GetSopInstanceCallBack,DicomGetImageFlags,StructuredDisplayImageOptions) Method

Summary

Returns a RasterImage containing an image representation of a DICOM Structured Display DicomDataSet.

Syntax

C++

public static RasterImage GetStructuredDisplayImage( 
   this DicomDataSet dsSD, 
   GetSopInstanceCallBack cb, 
   DicomGetImageFlags getImageFlags, 
   StructuredDisplayImageOptions options 
)

<ExtensionAttribute()> 
 Public Shared Function GetStructuredDisplayImage( 
   ByVal dsSD As DicomDataSet, 
   ByVal cb As GetSopInstanceCallBack, 
   ByVal getImageFlags As DicomGetImageFlags, 
   ByVal options As StructuredDisplayImageOptions 
) As RasterImage

public:  
   [ExtensionAttribute] 
   static RasterImage^ GetStructuredDisplayImage( 
      DicomDataSet^ dsSD, 
      GetSopInstanceCallBack^ cb, 
      DicomGetImageFlags^ getImageFlags, 
      StructuredDisplayImageOptions^ options 
   )

Parameters

dsSD

A structured display DicomDataSet.

A callback method takes a SOPInstanceUID as an argument, and returns a DicomDataSet that contains the SOPInstanceUID.

getImageFlags

Flags that affect how the referenced DICOM images are displayed.

options

Options that specify RasterImage resolution, and overlay options.

Return Value

A RasterImage containing an image representation of a DICOM Structured Display DicomDataSet.

Remarks

A DICOM Structured Display contains SOPInstanceUIDs of other DicomDataSet and specifies a layout containing the corresponding DicomDataSet images.

The [GetStructuredDisplayImage] method returns a RasterImage containing an image representation of all refereneced DicomDataSet images, laid out as defined by the dsSD DicomDataSet.

The getImageFlags affect the display of each individual DICOM image. For more information, refer to DicomGetImageFlags.

The options affect the RasterImage width and height, and overlay font and color options. For more infomation, refer to StructuredDisplayImageOptions.

Example

using Leadtools.Dicom; 
using Leadtools.Dicom.Common; 
using Leadtools.Dicom.Common.Extensions; 
using Leadtools; 
using Leadtools.Dicom.Common.Linq.BasicDirectory; 
using Leadtools.Dicom.Common.DataTypes; 
 
 
public DicomDataSet GetSopInstanceCallBack(string sopInstanceUid) 
{ 
   DicomDataSet dsImage = null; 
 
   // Find the DicomDataSet that matches sopInstanceUid 
   // Here we simulate this by loading an existing image 
   dsImage = new DicomDataSet(); 
   dsImage.Load("image2.dcm", DicomDataSetLoadFlags.None); 
   return dsImage; 
} 
 
public RasterImage TestGetStructuredDisplayImage(DicomDataSet dsSD) 
{ 
   DicomExtensions.StructuredDisplayImageOptions options = new DicomExtensions.StructuredDisplayImageOptions 
   { 
      BackColor = Color.Black, 
      EmptyCellColor = Color.Gray, 
      ImageWidth = 800, 
      OverlayBackgroundBrush = Brushes.Yellow, 
      OverlayBrush = Brushes.Red, 
      OverlayFontName = "Courier", 
      OverlayFontSize = 12, 
      ShowOverlay = true 
   }; 
 
   RasterImage image = dsSD.GetStructuredDisplayImage(GetSopInstanceCallBack, DicomGetImageFlags.None, options); 
   return image; 
}