pydicom.pixel_data_handlers.gdcm_handler

Use the GDCM Python package to decode pixel transfer syntaxes.

Functions

create_data_element(ds)

Return a gdcm.DataElement for the Pixel Data.

create_image(ds, data_element)

Return a gdcm.Image.

get_pixeldata(ds)

Use the GDCM package to decode Pixel Data.

is_available()

Return True if the handler has its dependencies met.

needs_to_convert_to_RGB(ds)

Return True if the Pixel Data should to be converted from YCbCr to RGB.

should_change_PhotometricInterpretation_to_RGB(ds)

Return True if the Photometric Interpretation should be changed to RGB.

supports_transfer_syntax(transfer_syntax)

Return True if the handler supports the transfer_syntax.

pydicom.pixel_data_handlers.gdcm_handler.create_data_element(ds: Dataset) DataElement[source]

Return a gdcm.DataElement for the Pixel Data.

Parameters

ds (dataset.Dataset) – The Dataset containing the Pixel Data.

Returns

The converted Pixel Data element.

Return type

gdcm.DataElement

pydicom.pixel_data_handlers.gdcm_handler.create_image(ds: Dataset, data_element: DataElement) gdcm.Image[source]

Return a gdcm.Image.

Parameters
  • ds (dataset.Dataset) – The Dataset containing the Image Pixel module.

  • data_element (gdcm.DataElement) – The gdcm.DataElement Pixel Data element.

Return type

gdcm.Image

pydicom.pixel_data_handlers.gdcm_handler.get_pixeldata(ds: Dataset) numpy.ndarray[source]

Use the GDCM package to decode Pixel Data.

Returns

A correctly sized (but not shaped) array of the entire data volume

Return type

numpy.ndarray

Raises
  • ImportError – If the required packages are not available.

  • TypeError – If the image could not be read by GDCM or if the Pixel Data type is unsupported.

  • AttributeError – If the decoded amount of data does not match the expected amount.

pydicom.pixel_data_handlers.gdcm_handler.is_available() bool[source]

Return True if the handler has its dependencies met.

pydicom.pixel_data_handlers.gdcm_handler.needs_to_convert_to_RGB(ds: Dataset) bool[source]

Return True if the Pixel Data should to be converted from YCbCr to RGB.

This affects JPEG transfer syntaxes.

pydicom.pixel_data_handlers.gdcm_handler.should_change_PhotometricInterpretation_to_RGB(ds: Dataset) bool[source]

Return True if the Photometric Interpretation should be changed to RGB.

This affects JPEG transfer syntaxes.

pydicom.pixel_data_handlers.gdcm_handler.supports_transfer_syntax(transfer_syntax: UID) bool[source]

Return True if the handler supports the transfer_syntax.

Parameters

transfer_syntax (uid.UID) – The Transfer Syntax UID of the Pixel Data that is to be used with the handler.