In This Topic ▼

GetImage Method

Summary

Returns the RasterImage contained in the DicomDataSet, but with the RasterViewPerspective changed accordingly from applying a PlaneOrientation to a given RasterViewPerspective.

Syntax

C++

public static RasterImage GetImage( 
   this DicomDataSet ds, 
   DicomElement element, 
   int index, 
   int bitsPerPixel, 
   RasterByteOrder order, 
   DicomGetImageFlags flags, 
   OrientationConfiguration orientation 
)

<ExtensionAttribute()> 
Public Shared Function GetImage( _ 
   ByVal ds As DicomDataSet, _ 
   ByVal element As DicomElement, _ 
   ByVal index As Integer, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal order As RasterByteOrder, _ 
   ByVal flags As DicomGetImageFlags, _ 
   ByVal orientation As OrientationConfiguration _ 
) As RasterImage

[ExtensionAttribute()] 
public: 
static RasterImage^ GetImage(  
   DicomDataSet^ ds, 
   DicomElement^ element, 
   int index, 
   int bitsPerPixel, 
   RasterByteOrder order, 
   DicomGetImageFlags flags, 
   OrientationConfiguration^ orientation 
)

Parameters

ds
The DicomDataSet that contains the image orientation vectors

element
An item in the Data Set.

index
The zero-based index of the frame to load.

bitsPerPixel
Value that represents the resulting image pixel depth. Possible values are:

Value	Meaning
0	Keep the original file's pixel depth (do not convert).
1 to 8	The specified bits per pixel in the resulting image.
12	12 bits per pixel in the resulting image.
16	16 bits per pixel in the resulting image.
24	24 bits per pixel in the resulting image.
32	32 bits per pixel in the resulting image.

order
This value is ignored.

flags
Flags that control the behavior of this method.

orientation
An OrientationConfiguration that will be applied to the current view perspective.

Return Value

The image of a Pixel Data element.

Remarks

This method will load any image from ds, using element as the parent element to begin the search, where the element searched for is the PixelData element. The resulting image has its RasterViewPerspective changed accordingly from applying a PlaneOrientation to a given RasterViewPerspective.

The input view perspective is define by two values: the original RasterViewPerspective contained in ds, and a row and column orientation vector (which are read from the ds by searching for the DicomElement that has a tag of ImageOrientationPatient which contains the orientation vectors.).

Note that the orientation contains three lists of conditions (one for each 3D axis) that can be applied to the image contained in the ds if the condition is met.

Example

This example does the following:

Loads a DICOM dataset that contains orientation vectors that orient it as a coronal slice
Creates an OrientationConfiguration that contains a coronal PlaneOrientation that corresponds to a horizontal flip
Gets the image from the DICOM dataset and modifies the view perspective to reflect OrientationConfiguration

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 void GetImageExample() 
{ 
   DicomEngine.Startup(); 
   string dicomFileCoronal = Path.Combine(LEAD_VARS.ImagesDir, "Image3.dcm"); 
   DicomDataSet ds = new DicomDataSet(); 
   ds.Load(dicomFileCoronal, DicomDataSetLoadFlags.None); 
 
   // Create a new coronal PlaneOrientation that corresponds to a horizontal flip 
   PlaneOrientation poCoronal = new PlaneOrientation(); 
   poCoronal.Name = "Coronal or Frontal"; 
   poCoronal.Top = OrientationAxis.Inferior; 
   poCoronal.Right = OrientationAxis.Right; 
   poCoronal.Condition = new TagValueOrientationCondition(DicomTag.ImageOrientationPatient, null); 
   if (!poCoronal.IsValid(Plane.Coronal)) 
   { 
      MessageBox.Show("Invalid PlaneOrientation for Coronal"); 
      return; 
   } 
 
   // Create a new sagittal PlaneOrientation that corresponds to a Rotate90 
   PlaneOrientation poSagittal = new PlaneOrientation(); 
   poSagittal.Name = "Sagittal"; 
   poSagittal.Top = OrientationAxis.Anterior; 
   poSagittal.Right = OrientationAxis.Inferior; 
   poSagittal.Condition = new TagValueOrientationCondition(0, null); 
   if (!poSagittal.IsValid(Plane.Sagittal)) 
   { 
      MessageBox.Show("Invalid PlaneOrientation for Sagittal"); 
      return; 
   } 
 
   // Create a new Axial that corresponds to a Rotate180 
   PlaneOrientation poAxial = new PlaneOrientation(); 
   poAxial.Name = "Axial"; 
   poAxial.Top = OrientationAxis.Posterior; 
   poAxial.Right = OrientationAxis.Left; 
   poAxial.Condition = new TagValueOrientationCondition(0, null); 
   if (!poAxial.IsValid(Plane.Axial)) 
   { 
      MessageBox.Show("Invalid PlaneOrientation for Axial"); 
      return; 
   } 
 
   // Setup the OrientationConfiguration 
   OrientationConfiguration oc = new OrientationConfiguration(); 
   oc.Coronal.Add(poCoronal); 
   oc.Sagittal.Add(poSagittal); 
   oc.Axial.Add(poAxial); 
   if (!oc.IsValid()) 
   { 
      MessageBox.Show("Invalid OrientationConfiguration"); 
      return; 
   } 
 
   // Find the image from the dataset with the new view perspective 
   // RasterViewPerspective newViewPerspective = ds.GetNewViewPerspective(RasterViewPerspective.TopLeft, oc); 
   RasterImage image = ds.GetImage(null, 0, 0, RasterByteOrder.Gray, DicomGetImageFlags.None, oc); 
 
   // New view perspective should be BottomLeft 
   RasterViewPerspective newViewPerspective = image.ViewPerspective; 
   MessageBox.Show("newViewPerspective should be BottomLeft\nActual newViewPerspective is " + newViewPerspective.ToString()); 
 
   DicomEngine.Shutdown(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools.Dicom 
Imports Leadtools.Dicom.Common 
Imports Leadtools.Dicom.Common.Extensions 
Imports Leadtools.Dicom.Common.Linq 
Imports Leadtools.Dicom.Common.Linq.BasicDirectory 
Imports Leadtools 
Imports Leadtools.Dicom.Common.DataTypes 
 
Public Sub GetImageExample() 
   Dim dicomFileCoronal As String = Path.Combine(LEAD_VARS.ImagesDir, "image3.dcm") 
   Dim ds As New DicomDataSet() 
   ds.Load(dicomFileCoronal, DicomDataSetLoadFlags.None) 
 
   ' Create a new coronal PlaneOrientation that corresponds to a horizontal flip 
   Dim poCoronal As New PlaneOrientation() 
   poCoronal.Name = "Coronal or Frontal" 
   poCoronal.Top = OrientationAxis.Inferior 
   poCoronal.Right = OrientationAxis.Right 
   poCoronal.Condition = New TagValueOrientationCondition(DicomTag.ImageOrientationPatient, Nothing) 
   If (Not poCoronal.IsValid(Plane.Coronal)) Then 
      MessageBox.Show("Invalid PlaneOrientation for Coronal") 
      Return 
   End If 
 
   ' Create a new sagittal PlaneOrientation that corresponds to a Rotate90 
   Dim poSagittal As New PlaneOrientation() 
   poSagittal.Name = "Sagittal" 
   poSagittal.Top = OrientationAxis.Anterior 
   poSagittal.Right = OrientationAxis.Inferior 
   poSagittal.Condition = New TagValueOrientationCondition(0, Nothing) 
   If (Not poSagittal.IsValid(Plane.Sagittal)) Then 
      MessageBox.Show("Invalid PlaneOrientation for Sagittal") 
      Return 
   End If 
 
   ' Create a new Axial that corresponds to a Rotate180 
   Dim poAxial As New PlaneOrientation() 
   poAxial.Name = "Axial" 
   poAxial.Top = OrientationAxis.Posterior 
   poAxial.Right = OrientationAxis.Left 
   poAxial.Condition = New TagValueOrientationCondition(0, Nothing) 
   If (Not poAxial.IsValid(Plane.Axial)) Then 
      MessageBox.Show("Invalid PlaneOrientation for Axial") 
      Return 
   End If 
 
   ' Set up the OrientationConfiguration 
   Dim oc As New OrientationConfiguration() 
   oc.Coronal.Add(poCoronal) 
   oc.Sagittal.Add(poSagittal) 
   oc.Axial.Add(poAxial) 
   If (Not oc.IsValid()) Then 
      MessageBox.Show("Invalid OrientationConfiguration") 
      Return 
   End If 
 
   ' Find the image from the dataset with the new view perspective 
   ' RasterViewPerspective newViewPerspective = ds.GetNewViewPerspective(RasterViewPerspective.TopLeft, oc); 
   Dim image As RasterImage = ds.GetImage(Nothing, 0, 0, RasterByteOrder.Gray, DicomGetImageFlags.None, oc) 
 
   ' New view perspective should be BottomLeft 
   Dim newViewPerspective As RasterViewPerspective = image.ViewPerspective 
   MessageBox.Show("newViewPerspective should be BottomLeft" & Constants.vbLf & "Actual newViewPerspective is " & newViewPerspective.ToString()) 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

DicomExtensions Class

DicomExtensions Members

Download our FREE evaluation

Help Version 20.0.2020.4.3