DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / CoreMatrix Method
The size used for calculations
Controls whether the resulting matrix should take into account the aspect ratio of the image (if the pixels are non-square)
The scaling mode to use. If null, then the images' StretchMode property is used
An override of the Zoom to be used. If null, then the image's Zoom property is used
The size of the screen's pixels. This is only used is the resulting value of Mode is DicomObjects.Enums.StretchModes.TrueSize
Actual offset in output units
Whether to use a BoundingBox, do not use BoundingBox by default






In This Topic
    CoreMatrix Method (DicomImage)
    In This Topic
    Matrix specifying how the image is displayed onto display of the stated
    Syntax
    'Declaration
     
    
    Protected Overridable Function CoreMatrix( _
       ByVal OutputSize As System.Drawing.SizeF, _
       ByVal UseAspect As System.Boolean, _
       ByVal Mode As System.Nullable(Of StretchModes), _
       ByVal LocalZoom As System.Nullable(Of Single), _
       ByVal ScreenPixelSize As System.Nullable(Of SizeF), _
       ByVal Offset As System.Drawing.PointF, _
       Optional ByVal ForceBounding As System.Boolean _
    ) As System.Drawing.Drawing2D.Matrix
    'Usage
     
    
    Dim instance As DicomImage
    Dim OutputSize As System.Drawing.SizeF
    Dim UseAspect As System.Boolean
    Dim Mode As System.Nullable(Of StretchModes)
    Dim LocalZoom As System.Nullable(Of Single)
    Dim ScreenPixelSize As System.Nullable(Of SizeF)
    Dim Offset As System.Drawing.PointF
    Dim ForceBounding As System.Boolean
    Dim value As System.Drawing.Drawing2D.Matrix
     
    value = instance.CoreMatrix(OutputSize, UseAspect, Mode, LocalZoom, ScreenPixelSize, Offset, ForceBounding)
    protected virtual System.Drawing.Drawing2D.Matrix CoreMatrix( 
       System.Drawing.SizeF OutputSize,
       System.bool UseAspect,
       System.Nullable<StretchModes> Mode,
       System.Nullable<float> LocalZoom,
       System.Nullable<SizeF> ScreenPixelSize,
       System.Drawing.PointF Offset,
       System.bool ForceBounding
    )
    protected function CoreMatrix( 
        OutputSize: System.Drawing.SizeF;
        UseAspect: System.Boolean;
        Mode: System.Nullable;
        LocalZoom: System.Nullable;
        ScreenPixelSize: System.Nullable;
        Offset: System.Drawing.PointF;
        ForceBounding: System.Boolean
    ): System.Drawing.Drawing2D.Matrix; virtual; 
    protected function CoreMatrix( 
       OutputSize : System.Drawing.SizeF,
       UseAspect : System.boolean,
       Mode : System.Nullable,
       LocalZoom : System.Nullable,
       ScreenPixelSize : System.Nullable,
       Offset : System.Drawing.PointF,
       ForceBounding : System.boolean
    ) : System.Drawing.Drawing2D.Matrix;
    protected: virtual System.Drawing.Drawing2D.Matrix* CoreMatrix( 
       System.Drawing.SizeF OutputSize,
       System.bool UseAspect,
       System.Nullable<StretchModes> Mode,
       System.Nullable<float> LocalZoom,
       System.Nullable<SizeF> ScreenPixelSize,
       System.Drawing.PointF Offset,
       System.bool ForceBounding
    ) 
    protected:
    virtual System.Drawing.Drawing2D.Matrix^ CoreMatrix( 
       System.Drawing.SizeF OutputSize,
       System.bool UseAspect,
       System.Nullable<StretchModes> Mode,
       System.Nullable<float> LocalZoom,
       System.Nullable<SizeF> ScreenPixelSize,
       System.Drawing.PointF Offset,
       System.bool ForceBounding
    ) 

    Parameters

    OutputSize
    The size used for calculations
    UseAspect
    Controls whether the resulting matrix should take into account the aspect ratio of the image (if the pixels are non-square)
    Mode
    The scaling mode to use. If null, then the images' StretchMode property is used
    LocalZoom
    An override of the Zoom to be used. If null, then the image's Zoom property is used
    ScreenPixelSize
    The size of the screen's pixels. This is only used is the resulting value of Mode is DicomObjects.Enums.StretchModes.TrueSize
    Offset
    Actual offset in output units
    ForceBounding
    Whether to use a BoundingBox, do not use BoundingBox by default

    Return Value

    Matrix
    Remarks
    This is the one and only "main" means of determining the Matrix used for display, and all the Matrix overrides simply call this routine. It is not intended that this routine should be used directly by user code.
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also