Struct FrameMetadata 

pub struct FrameMetadata {

    pub frame_index: u32,
    pub rows: u16,
    pub columns: u16,
    pub number_of_frames: u32,
    pub samples_per_pixel: u16,
    pub bits_allocated: u16,
    pub bits_stored: u16,
    pub high_bit: u16,
    pub pixel_representation: PixelRepresentation,
    pub instance_number: i32,
    pub pixel_spacing: Option<(f64, f64)>,
    pub slice_thickness: Option<f64>,
    pub image_position: Option<DVec3>,
    pub image_orientation: Option<(DVec3, DVec3)>,
    pub window_center: Option<f64>,
    pub window_width: Option<f64>,
    pub rescale_intercept: f64,
    pub rescale_slope: f64,
    pub sop_instance_uid: Option<String>,
    pub transfer_syntax_uid: String,
}

Metadata extracted for one decoded image frame.

Fields

frame_index: u32

Zero-based frame index inside the source DICOM object.

rows: u16

Number of rows in the frame.

columns: u16

Number of columns in the frame.

number_of_frames: u32

Number of frames in the source DICOM object.

samples_per_pixel: u16

Samples per pixel, usually 1 for grayscale volumes.

bits_allocated: u16

Bits allocated per sample.

bits_stored: u16

Bits stored per sample.

high_bit: u16

Highest stored bit index.

pixel_representation: PixelRepresentation

Pixel sign convention.

instance_number: i32

Instance Number (0020,0013) if present.

pixel_spacing: Option<(f64, f64)>

Pixel spacing as (row_spacing, column_spacing).

slice_thickness: Option<f64>

Slice thickness if present.

image_position: Option<DVec3>

Image Position (Patient) if present.

image_orientation: Option<(DVec3, DVec3)>

Image Orientation (Patient) as (row_direction, column_direction).

window_center: Option<f64>

Optional display window center.

window_width: Option<f64>

Optional display window width.

rescale_intercept: f64

Modality LUT intercept.

rescale_slope: f64

Modality LUT slope.

sop_instance_uid: Option<String>

SOP Instance UID if present.

transfer_syntax_uid: String

Transfer Syntax UID from the file meta information.

Implementations

impl FrameMetadata

pub fn direction(&self) -> DMat3

Returns a best-effort 3x3 direction matrix for the frame.

pub fn slice_normal(&self) -> Option<DVec3>

Returns the frame normal when orientation is available.

pub fn spacing_xy(&self) -> DVec3

Returns in-plane spacing in (x, y) volume order.

pub fn voxel_count(&self) -> usize

Returns the expected pixel count for one decoded frame.

Trait Implementations

impl Clone for FrameMetadata

fn clone(&self) -> FrameMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FrameMetadata

fn eq(&self, other: &FrameMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FrameMetadata