'Declaration
 
Public Overloads Overridable Function SubImage( _
   ByVal Offset As Point, _
   ByVal Size As Size, _
   ByVal Magnification As Single, _
   ByVal Frame As Integer, _
   ByVal Scaling As ScaleMode _
) As DicomImage

'Usage
 
Dim instance As DicomImage
Dim Offset As Point
Dim Size As Size
Dim Magnification As Single
Dim Frame As Integer
Dim Scaling As ScaleMode
Dim value As DicomImage
 
value = instance.SubImage(Offset, Size, Magnification, Frame, Scaling)

public virtual DicomImage SubImage( 
   Point Offset,
   Size Size,
   float Magnification,
   int Frame,
   ScaleMode Scaling
)

public:
virtual DicomImage^ SubImage( 
   Point Offset,
   Size Size,
   float Magnification,
   int Frame,
   ScaleMode Scaling
) 

Parameters

Offset

The left top corner point of the sub Image

Size

The total size of the original image to capture

Magnification

The zooming factor which determines the output size

Frame

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

Scaling

The scaling mode to use

Return Value

Makes a derived image (of same basic DICOM type as the original) scaled and cropped as required. Size refers to the final image size, whether or not it is transformed as below.

The coordinate system used depends on the value of scaling. If ScaleMode.Image then the original image is used without rotation etc, but if ScaleMode.Output then the image is conceptually flipped, rotated etc. before applying the bounds.

This overload is now recommended in place of the earlier version without the scaling mode which is retained for backwards compatibility only.

Target Platforms: .NET CLR 4.0 or higher