DicomObjects.NetStandard Documentation
DicomObjects Namespace / DicomImage Class / PixelValuesByFrame Method
The 1-based frame number to retrieve
Controls whether to apply the scale/offset or Modality LUT if present



In This Topic
    PixelValuesByFrame Method
    In This Topic
    Returns a float array of pixel values for a frame, optionally transformed via the modality transformation
    Syntax
    'Declaration
     
    
    Public Function PixelValuesByFrame( _
       ByVal frame As Integer, _
       ByVal modalityTransform As Boolean _
    ) As Single()
    'Usage
     
    
    Dim instance As DicomImage
    Dim frame As Integer
    Dim modalityTransform As Boolean
    Dim value() As Single
     
    value = instance.PixelValuesByFrame(frame, modalityTransform)
    public float[] PixelValuesByFrame( 
       int frame,
       bool modalityTransform
    )
    public:
    array<float>^ PixelValuesByFrame( 
       int frame,
       bool modalityTransform
    ) 

    Parameters

    frame
    The 1-based frame number to retrieve
    modalityTransform
    Controls whether to apply the scale/offset or Modality LUT if present

    Return Value

    Array of float values representing the (possibly transformed) pixel values
    Remarks
    Even if modalityTransform is false, the values are still masked to the relevant bit length and interpreted as sign/unsigned. This differs from RawPixelValuesByFrame.
    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