Series Methods

The getSeries() method can provide insight to the available series in the NBIA database.

NBIAClient.getSeries(Collection: str = '', PatientID: str = '', StudyInstanceUID: str = '', Modality: str = '', SeriesInstanceUID: str = '', BodyPartExamined: str = '', ManufacturerModelName: str = '', Manufacturer: str = '', return_type: ReturnType | str | None = None) → List[dict[Any, Any]] | DataFrame[source]

By default, the method will return all the series in the database. However, it can be filtered by the following parameters:

  • Collection

  • PatientID

  • StudyInstanceUID

  • Modality

  • SeriesInstanceUID

  • BodyPartExamined

  • ManufacturerModelName

  • Manufacturer

The following examples demonstrate using the getSeries().

with NBIAClient(return_type="dataframe") as client:
    series = client.getSeries(
        Collection = "TCGA-BLCA"
    )

print(series.iloc[0])

SeriesInstanceUID        1.3.6.1.4.1.14519.5.2.1.8421.4016.110651529487...
StudyInstanceUID         1.3.6.1.4.1.14519.5.2.1.8421.4016.447463489999...
Modality                                                                CT
ProtocolName                                                 01_Abd_Pelvis
SeriesDate                                           2004-01-20 00:00:00.0
SeriesDescription                                      Topogram  0.6  T20s
BodyPartExamined                                                   BLADDER
SeriesNumber                                                             1
Collection                                                       TCGA-BLCA
PatientID                                                     TCGA-CU-A3QU
Manufacturer                                                       SIEMENS
ManufacturerModelName                                         Sensation 64
SoftwareVersions                                            syngo CT 2007S
ImageCount                                                               2
TimeStamp                                            2014-03-18 08:50:42.0
LicenseName              Creative Commons Attribution 3.0 Unported License
LicenseURI                     http://creativecommons.org/licenses/by/3.0/
CollectionURI                https://doi.org/10.7937/K9/TCIA.2016.8LNG8XDR
FileSize                                                           1054338
Name: 0, dtype: object