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



In This Topic
    PixelValuesByFrameGeneric Method (DicomDataSet)
    In This Topic
    Returns an array of pixel values for a frame, optionally transformed via the modality transformation. Also accssible from
    Syntax
    'Declaration
     
    
    Public Function PixelValuesByFrameGeneric( _
       ByVal frame As Integer, _
       ByVal modalityTransform As Boolean _
    ) As Array
    'Usage
     
    
    Dim instance As DicomDataSet
    Dim frame As Integer
    Dim modalityTransform As Boolean
    Dim value As Array
     
    value = instance.PixelValuesByFrameGeneric(frame, modalityTransform)
    public Array PixelValuesByFrameGeneric( 
       int frame,
       bool modalityTransform
    )
    public:
    Array^ PixelValuesByFrameGeneric( 
       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 values representing the (possibly transformed) pixel values. Return type is a generic array as opposed to DicomImage.PixelValuesByFrame which returns a float[]
    Remarks
    Even if modalityTransform is false, the values are still masked to the relevant bit length and interpreted as sign/unsigned. This differs from DicomImage.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