DicomObjects.NET8 Documentation
DicomObjects Namespace / DicomImage Class / SubImage Method / SubImage(SKPointI,SKSizeI,Single,Int32,ScaleMode) Method

The left top corner point of the sub Image

The total size of the original image to capture

The zooming factor which determines the output size

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

The scaling mode to use




In This Topic
    SubImage(SKPointI,SKSizeI,Single,Int32,ScaleMode) Method
    In This Topic
    Creates a copy of part or all of the image with controlled size
    Syntax
    'Declaration
     
    
    Public Overloads Overridable Function SubImage( _
       ByVal offset As SkiaSharp.SKPointI, _
       ByVal size As SkiaSharp.SKSizeI, _
       ByVal magnification As Single, _
       ByVal frame As Integer, _
       ByVal scaleMode As ScaleMode _
    ) As DicomImage
    'Usage
     
    
    Dim instance As DicomImage
    Dim offset As SkiaSharp.SKPointI
    Dim size As SkiaSharp.SKSizeI
    Dim magnification As Single
    Dim frame As Integer
    Dim scaleMode As ScaleMode
    Dim value As DicomImage
     
    value = instance.SubImage(offset, size, magnification, frame, scaleMode)
    public virtual DicomImage SubImage( 
       SkiaSharp.SKPointI offset,
       SkiaSharp.SKSizeI size,
       float magnification,
       int frame,
       ScaleMode scaleMode
    )
    public:
    virtual DicomImage^ SubImage( 
       SkiaSharp.SKPointI offset,
       SkiaSharp.SKSizeI size,
       float magnification,
       int frame,
       ScaleMode scaleMode
    ) 

    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

    scaleMode

    The scaling mode to use

    Return Value

    Remarks

    Makes a derived image (of same basic DICOM type as the original) scaled and cropped as required. SKSizeI 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.

    Requirements

    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

    See Also