SetImage Method

public void SetImage( 
   DicomElement element,
   RasterImage image,
   DicomImageCompressionType compression,
   DicomImagePhotometricInterpretationType photometric,
   int bitsPerPixel,
   int qualityFactor,
   DicomSetImageFlags flags
)

'Declaration
 
Public Sub SetImage( _
   ByVal element As DicomElement, _
   ByVal image As RasterImage, _
   ByVal compression As DicomImageCompressionType, _
   ByVal photometric As DicomImagePhotometricInterpretationType, _
   ByVal bitsPerPixel As Integer, _
   ByVal qualityFactor As Integer, _
   ByVal flags As DicomSetImageFlags _
) 

'Usage
 
Dim instance As DicomDataSet
Dim element As DicomElement
Dim image As RasterImage
Dim compression As DicomImageCompressionType
Dim photometric As DicomImagePhotometricInterpretationType
Dim bitsPerPixel As Integer
Dim qualityFactor As Integer
Dim flags As DicomSetImageFlags
 
instance.SetImage(element, image, compression, photometric, bitsPerPixel, qualityFactor, flags)

public void SetImage( 
   DicomElement element,
   RasterImage image,
   DicomImageCompressionType compression,
   DicomImagePhotometricInterpretationType photometric,
   int bitsPerPixel,
   int qualityFactor,
   DicomSetImageFlags flags
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomDataSet.SetImage( 
   element ,
   image ,
   compression ,
   photometric ,
   bitsPerPixel ,
   qualityFactor ,
   flags 
)

public:
void SetImage( 
   DicomElement^ element,
   RasterImage^ image,
   DicomImageCompressionType compression,
   DicomImagePhotometricInterpretationType photometric,
   int bitsPerPixel,
   int qualityFactor,
   DicomSetImageFlags flags
) 

Parameters

element

An item in the Data Set.

image

Image to set.

compression

Indicates the type of compression to use.

photometric

Photometric constant.

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	Use the specified bits per pixel in the resulting image.
12	Use 12 bits per pixel in the resulting image.
16	Use 16 bits per pixel in the resulting image.
24	Use 24 bits per pixel in the resulting image.
32	Use 32 bits per pixel in the resulting image.

qualityFactor

The quality factor (Q factor) is a number that determines the degree of loss in the compression process. You can set a value from 2 to 255, where 2 is the highest quality and 255 is the most compression.

flags

Flags that control the behavior of this method.

Most DICOM files will only have one Data Element of type DicomTag.PixelData. Therefore, in most instances you can set element to null, since the method will automatically replace the images of the only Pixel Data Element in the file. If element is not null, it must point to the Pixel Data Element itself.

To replace only one image within the Pixel Data Element, call the DeleteImage(DicomElement,Int32,Int32) and InsertImage methods.

If the DICOM file is DicomClassType.BasicDirectory, the file may contain more than one Pixel Data Element. In this case you must specify in element the Pixel Data Element in which the images will be replaced.

For a table of possible Compression, Photometric, BitsPerPixel, and Quality Factor combinations, refer to Compression Table.

For more options when using the JPEG 2000 compression, refer to Jpeg2000Options.

This method will either insert, delete or update one or more of the following elements:

This method is indifferent to the pixel data restrictions imposed by the various DICOM IOD classes; for example, this method will allow the user to insert a colored image into a "Digital X-Ray Image Storage" Data Set.

This method will always insert a "Number of Frames" (0028, 0008) element and set its value.

• DicomSetImageFlags.MfgOverwriteShared
• DicomSetImageFlags.MfgVoiLutPerFrame
• DicomSetImageFlags.MfgVoiLutShared
• DicomSetImageFlags.MfgModalityLutPerFrame
• DicomSetImageFlags.MfgModalityLutShared

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomDataSet Class
DicomDataSet Members
SetImages Method
GetImage(DicomElement,Int32,Int32,RasterByteOrder,DicomGetImageFlags) Method
GetImages(DicomElement,Int32,Int32,Int32,RasterByteOrder,DicomGetImageFlags) Method
InsertImage Method
InsertImages Method