Enum dicom_pixeldata::PhotometricInterpretation

pub enum PhotometricInterpretation {
    Monochrome1,
    Monochrome2,
    PaletteColor,
    Rgb,
    YbrFull,
    YbrFull422,
    YbrPartial420,
    YbrIct,
    YbrRct,
    Other(String),
}

A decoded representation of the DICOM Photometric Interpretation attribute.

See section C.7.6.3 of the standard for more details about each photometric interpretation.

In the event that the photometric interpretation is not any of the specified variants, the Other variant is used. Note that this enumeration covers the ones which are known, not necessarily supported in the decoding process.

Variants

Monochrome1

MONOCHROME1: Pixel data represent a single monochrome image plane. The minimum sample value is intended to be displayed as white.

Monochrome2

MONOCHROME2: Pixel data represent a single monochrome image plane. The minimum sample value is intended to be displayed as black.

PaletteColor

PALETTE COLOR: Pixel data describe a color image with a single sample per pixel (single image plane).

Rgb

RGB: Pixel data represent a color image described by red, green, and blue image planes.

YbrFull

YBR_FULL: Pixel data represent a color image described by one luminance (Y) and two chrominance planes (CB and CR) and as a result there are half as many CB and CR values as Y values.

YbrFull422

YBR_FULL_422: The same as YBR_FULL except that the CB and CR values are sampled horizontally at half the Y rate.

YbrPartial420

YBR_PARTIAL_420: Pixel data represent a color image described by one luminance (Y) and two chrominance planes (CB and CR). The CB and CR values are sampled horizontally and vertically at half the Y rate and as a result there are four times less CB and CR values than Y values.

YbrIct

YBR_ICT: Irreversible Color Transformation. Pixel data represent a color image described by one luminance (Y) and two chrominance planes (CB and CR).

YbrRct

YBR_RCT: Rreversible Color Transformation. Pixel data represent a color image described by one luminance (Y) and two chrominance planes (CB and CR).

Other(String)

The photometric interpretation is not one of the known variants.

Note: this value is assumed to be different from any other variant listed above, and no checks are made to ensure this assumption. The construction of PhotometricInterpretation::Other when one of the existing variants is applicable is considered a bug.

Note 2: subsequent crate versions may introduce new variants, and as a consequence break any user depending on the Other variant. If you need to depend on an unspecified variant, you should also double check the photometric interpretations here every time the crate is updated.

Implementations

impl PhotometricInterpretation

pub fn as_str(&self) -> &str

Obtain a string representation of the photometric interpretation.

pub fn is_monochrome(&self) -> bool

Get whether this photometric interpretation is one of the monochrome variants (MONOCHROME1 or MONOCHROME2).

Trait Implementations

impl AsRef<str> for PhotometricInterpretation

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PhotometricInterpretation

fn clone(&self) -> PhotometricInterpretation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhotometricInterpretation

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

Formats the value using the given formatter.

impl Display for PhotometricInterpretation

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

Formats the value using the given formatter.

impl From<&'_ str> for PhotometricInterpretation

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for PhotometricInterpretation

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq<PhotometricInterpretation> for PhotometricInterpretation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for PhotometricInterpretation