fiftyone.utils.dicom.DICOMSampleParser

class documentation

class DICOMSampleParser(foud.LabeledImageSampleParser): (source)

Constructor: DICOMSampleParser(keywords, parsers)

View In Hierarchy

Parser for labeled image samples stored in DICOM format.

Parameters
keywordsan optional keyword or list of keywords from pydicom:pydicom.dataset.Dataset.dir to load from the DICOM files. By default, all available fields are loaded
parsersan optional dict mapping keywords to functions that parse the values generated by pydicom:pydicom.dataset.Dataset.get for certain fields. By default, all fields are converted to primitive values, if possible
Method __init__ Undocumented
Method clear_sample Clears the current sample.
Method get_image Returns the image from the current sample.
Method get_label Returns the label for the current sample.
Instance Variable keywords Undocumented
Instance Variable parsers Undocumented
Property has_image_metadata Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
Property has_image_path Whether this parser produces paths to images on disk for samples that it parses.
Property label_cls The fiftyone.core.labels.Label class(es) returned by this parser.
Method _ensure_ds Undocumented
Instance Variable _ds Undocumented

Inherited from LabeledImageSampleParser:

Method get_image_metadata Returns the image metadata for the current sample.
Method get_image_path Returns the image path for the current sample.

Inherited from SampleParser (via LabeledImageSampleParser):

Method with_sample Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.
Property current_sample The current sample.
Instance Variable _current_sample Undocumented
def __init__(self, keywords=None, parsers=None): (source)
overrides fiftyone.utils.data.parsers.SampleParser.__init__

Undocumented

def clear_sample(self): (source)
overrides fiftyone.utils.data.parsers.SampleParser.clear_sample

Clears the current sample.

Also clears any cached sample information stored by the parser.

def get_image(self): (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image

Returns the image from the current sample.

Returns
a numpy image
def get_label(self): (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.get_label

Returns the label for the current sample.

Returns
a fiftyone.core.labels.Label instance, or a dictionary mapping field names to fiftyone.core.labels.Label instances, or None if the sample is unlabeled
keywords: None = (source)

Undocumented

parsers: None = (source)

Undocumented

@property
has_image_metadata = (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_metadata

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.

@property
has_image_path = (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_path

Whether this parser produces paths to images on disk for samples that it parses.

@property
label_cls = (source)
overrides fiftyone.utils.data.parsers.LabeledImageSampleParser.label_cls

The fiftyone.core.labels.Label class(es) returned by this parser.

This can be any of the following:

  • a fiftyone.core.labels.Label class. In this case, the parser is guaranteed to return labels of this type
  • a list or tuple of fiftyone.core.labels.Label classes. In this case, the parser can produce a single label field of any of these types
  • a dict mapping keys to fiftyone.core.labels.Label classes. In this case, the parser will return label dictionaries with keys and value-types specified by this dictionary. Not all keys need be present in the imported labels
  • None. In this case, the parser makes no guarantees about the labels that it may return
def _ensure_ds(self): (source)

Undocumented

_ds = (source)

Undocumented