File size: 6,303 Bytes
34a4bcb |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# Copyright (c) MONAI Consortium
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import os
from typing import Iterable
import monai
from monai.config.type_definitions import PathLike
from monai.utils import optional_import
requests_get, has_requests = optional_import("requests", name="get")
pd, has_pandas = optional_import("pandas")
DCM_FILENAME_REGEX = r"^(?!.*LICENSE).*" # excluding the file with "LICENSE" in its name
BASE_URL = "https://services.cancerimagingarchive.net/nbia-api/services/v1/"
__all__ = [
"get_tcia_metadata",
"download_tcia_series_instance",
"get_tcia_ref_uid",
"match_tcia_ref_uid_in_study",
"DCM_FILENAME_REGEX",
"BASE_URL",
]
def get_tcia_metadata(query: str, attribute: str | None = None) -> list:
"""
Achieve metadata of a public The Cancer Imaging Archive (TCIA) dataset.
This function makes use of The National Biomedical Imaging Archive (NBIA) REST APIs to access the metadata
of objects in the TCIA database.
Please refer to the following link for more details:
https://wiki.cancerimagingarchive.net/display/Public/NBIA+Search+REST+API+Guide
This function relies on `requests` package.
Args:
query: queries used to achieve the corresponding metadata. A query is consisted with query name and
query parameters. The format is like: <query name>?<parameter 1>&<parameter 2>.
For example: "getSeries?Collection=C4KC-KiTS&Modality=SEG"
Please refer to the section of Image Metadata APIs in the link mentioned
above for more details.
attribute: Achieved metadata may contain multiple attributes, if specifying an attribute name, other attributes
will be ignored.
"""
if not has_requests:
raise ValueError("requests package is necessary, please install it.")
full_url = f"{BASE_URL}{query}"
resp = requests_get(full_url)
resp.raise_for_status()
metadata_list: list = []
if len(resp.text) == 0:
return metadata_list
for d in resp.json():
if attribute is not None and attribute in d:
metadata_list.append(d[attribute])
else:
metadata_list.append(d)
return metadata_list
def download_tcia_series_instance(
series_uid: str,
download_dir: PathLike,
output_dir: PathLike,
check_md5: bool = False,
hashes_filename: str = "md5hashes.csv",
progress: bool = True,
) -> None:
"""
Download a dicom series from a public The Cancer Imaging Archive (TCIA) dataset.
The downloaded compressed file will be stored in `download_dir`, and the uncompressed folder will be saved
in `output_dir`.
Args:
series_uid: SeriesInstanceUID of a dicom series.
download_dir: the path to store the downloaded compressed file. The full path of the file is:
`os.path.join(download_dir, f"{series_uid}.zip")`.
output_dir: target directory to save extracted dicom series.
check_md5: whether to download the MD5 hash values as well. If True, will check hash values for all images in
the downloaded dicom series.
hashes_filename: file that contains hashes.
progress: whether to display progress bar.
"""
query_name = "getImageWithMD5Hash" if check_md5 else "getImage"
download_url = f"{BASE_URL}{query_name}?SeriesInstanceUID={series_uid}"
monai.apps.utils.download_and_extract(
url=download_url,
filepath=os.path.join(download_dir, f"{series_uid}.zip"),
output_dir=output_dir,
progress=progress,
)
if check_md5:
if not has_pandas:
raise ValueError("pandas package is necessary, please install it.")
hashes_df = pd.read_csv(os.path.join(output_dir, hashes_filename))
for dcm, md5hash in hashes_df.values:
monai.apps.utils.check_hash(filepath=os.path.join(output_dir, dcm), val=md5hash, hash_type="md5")
def get_tcia_ref_uid(
ds: Iterable,
find_sop: bool = False,
ref_series_uid_tag: tuple = (0x0020, 0x000E),
ref_sop_uid_tag: tuple = (0x0008, 0x1155),
) -> str:
"""
Achieve the referenced UID from the referenced Series Sequence for the input pydicom dataset object.
The referenced UID could be Series Instance UID or SOP Instance UID. The UID will be detected from
the data element of the input object. If the data element is a sequence, each dataset within the sequence
will be detected iteratively. The first detected UID will be returned.
Args:
ds: a pydicom dataset object.
find_sop: whether to achieve the referenced SOP Instance UID.
ref_series_uid_tag: tag of the referenced Series Instance UID.
ref_sop_uid_tag: tag of the referenced SOP Instance UID.
"""
ref_uid_tag = ref_sop_uid_tag if find_sop else ref_series_uid_tag
output = ""
for elem in ds:
if elem.VR == "SQ":
for item in elem:
output = get_tcia_ref_uid(item, find_sop)
if elem.tag == ref_uid_tag:
return elem.value # type: ignore[no-any-return]
return output
def match_tcia_ref_uid_in_study(study_uid, ref_sop_uid):
"""
Match the SeriesInstanceUID from all series in a study according to the input SOPInstanceUID.
Args:
study_uid: StudyInstanceUID.
ref_sop_uid: SOPInstanceUID.
"""
series_list = get_tcia_metadata(query=f"getSeries?StudyInstanceUID={study_uid}", attribute="SeriesInstanceUID")
for series_id in series_list:
sop_id_list = get_tcia_metadata(
query=f"getSOPInstanceUIDs?SeriesInstanceUID={series_id}", attribute="SOPInstanceUID"
)
if ref_sop_uid in sop_id_list:
return series_id
return ""
|