PrinterImage(Int32,Int32,Boolean,Single,Rectangle,Boolean,Int32) Method

In This Topic

Creates a copy of the image for printing or other purposes

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function PrinterImage( _
   ByVal Bits As System.Integer, _
   ByVal Planes As System.Integer, _
   ByVal ShowAnnotations As System.Boolean, _
   ByVal Zoom As System.Single, _
   ByVal Area As System.Drawing.Rectangle, _
   ByVal SquarePixels As System.Boolean, _
   ByVal Frame As System.Integer _
) As DicomImage

public DicomImage PrinterImage( 
   System.int Bits,
   System.int Planes,
   System.bool ShowAnnotations,
   System.float Zoom,
   System.Drawing.Rectangle Area,
   System.bool SquarePixels,
   System.int Frame
)

Parameters

Bits

Bit depth of final image (must be 8-16, but always 8 when Planes=3)

Planes

1 for monochrome and 3 for colour

ShowAnnotations

Controls whether annotations are "burnt-in" to the new image

Zoom

Zoom to apply to new image

Area

The area of the original image to use

SquarePixels

Controls whether Image Aspect Ratio is used - if true, then output pixels are square, but if false, then they retain their original aspect ratio

If ShowAnnotations is true, then this parameter is ignored and treated as true.

Frame

The frame number to use. This is 1-index, i.e. first frame is 1 not 0

Return Value

DicomImage

Remarks

The copy is fully rendered and scaled to the chosen bit depth, so no further windowing is required. Only 8 bits are allowed when Planes=3 (RGB). Area refers to the original image � the size of the final image is the product of the cropped size and the chosen zoom. If the edges are given as 0, the full image is used.

Example

DicomImage image = new DicomImage("your_dicom_image.dcm");
            
int bits = 8;
int planes = 1; // RGB = 3
bool showAnnotations = true;
float zoom = 1; // 1 = original zoom
Rectangle area = Rectangle.Empty;
bool squarePixels = false;
int frame = 1;
                    
var printerImage = image.PrinterImage(bits, planes, showAnnotations, zoom, area, squarePixels, frame);

Requirements

Target Platforms: .NET CLR 4.8 or higher

Reference

DicomImage Class
DicomImage Members
Overload List

Send Feedback