DicomObjects.NET.8.48 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 System.Integer, _
   ByVal modalityTransform As System.Boolean _
) As System.Single()
    'Usage
 

    Dim instance As DicomImage
Dim frame As System.Integer
Dim modalityTransform As System.Boolean
Dim value() As System.Single
 
value = instance.PixelValuesByFrame(frame, modalityTransform)
    public System.float[] PixelValuesByFrame( 
   System.int frame,
   System.bool modalityTransform
)
    public function PixelValuesByFrame( 
    frame: System.Integer;
    modalityTransform: System.Boolean
): System.array of Single; 
    public function PixelValuesByFrame( 
   frame : System.int,
   modalityTransform : System.boolean
) : System.float[];
    public: System.float[]* PixelValuesByFrame( 
   System.int frame,
   System.bool modalityTransform
) 
    public:
System.array<float>^ PixelValuesByFrame( 
   System.int frame,
   System.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: .NET CLR 4.8 or higher

    See Also

    Reference

    DicomImage Class
    DicomImage Members

    Send Feedback