MakeMultiFrame Method

In This Topic

Creates a single multi-frame object from a collection of individual images.

Syntax

Visual Basic
C#

'Declaration
 
Public Function MakeMultiFrame( _
   ByVal remove As System.Boolean _
) As DicomImage

public DicomImage MakeMultiFrame( 
   System.bool remove
)

Parameters

remove: True if the images should be removed from the collection after this function call.

Return Value

The new DicomImage

Remarks

Constructs a single multi-frame image from a series of identically-sized single frame images, which have been collected into a DicomImageCollection. If the argument is true, the images are removed from the collection as they are added to the new object. Apart from the pixel data, all information is copied from the first image only.

Note that the newly created multi-frame image may need some modifications, as DicomObjects has no knowledge of the relationship between frames. By default, attributes 0028,0009 & 0018,1063 are set to give a constant 10 frames per second. These may need to be removed/changed.

Example

DicomImageCollection imageCollection = new DicomImageCollection();
 DicomImage finalMFImage = new DicomImage();
  
 DicomImage image1 = new DicomImage("your_dicom_image1.dcm");
 DicomImage image2 = new DicomImage("your_dicom_image2.dcm");
 DicomImage image3 = new DicomImage("your_dicom_image3.dcm");
  
 imageCollection.Add(image1);
 imageCollection.Add(image2);
 imageCollection.Add(image3);
  
 bool removeFromCollection = false;
 finalMFImage = imageCollection.MakeMultiFrame(removeFromCollection);
  
// Optionally write resulting multiframe image to disk
finalMFImage.Write("output_image.dcm");

Requirements

Target Platforms: .NET CLR 4.8 or higher

Reference

DicomImageCollection Class
DicomImageCollection Members

Send Feedback