DicomObjects.NET8 Documentation
DicomObjects Namespace / DicomImage Class / Frame Property



In This Topic
    Frame Property (DicomImage)
    In This Topic
    Controls which frame of a multi-frame image is displayed
    Syntax
    'Declaration
     
    
    Public Property Frame As Integer
    'Usage
     
    
    Dim instance As DicomImage
    Dim value As Integer
     
    instance.Frame = value
     
    value = instance.Frame
    public int Frame {get; set;}
    public:
    property int Frame {
       int get();
       void set (    int value);
    }

    Property Value

    The number of the frame to display
    Remarks

    Unlike other indices in DicomObjects, this is 1-based, as that is the DICOM convention - i.e. the range is from 1 to FrameCount.

    If set to a value higher than FrameCount, this property is reduced modulo FrameCount, to bring it within range. Cine sequences may therefore be run repeatedly simply by incrementing Frame continuously. Alternatively, to allow multi-frame images to "play" autonomously, the CineMode property may be used.

    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