TCIApathfinder (version 1.0.6)

save_image_series: Save a series of DICOM image files as a zip file

Description

Save a series of DICOM image files as a zip file

Usage

save_image_series(series_instance_uid, out_dir = NULL,
  out_file_name = NULL)

Arguments

series_instance_uid

Series instance UID. To get a list of available series instance UIDs, call get_series_info. Note: if series_instance_uid is invalid, the API may still successfully return an empty zip file.

out_dir

Directory to write zip file to

out_file_name

Name of zip file to write. If out_file_name is NULL, the original file name will be used.

Value

List containing elements:

• out_file: The output zip file that was written

• response: API response

See Also

get_series_info, TCIA REST API Usage Guide, TCIA API object definitions

Examples

# NOT RUN {
save_image_series(
     series_instance_uid = "1.3.6.1.4.1.14519.5.2.1.5382.4002.806935685832642465081499816867",
     out_dir = "~/Desktop")
save_image_series(
     series_instance_uid = "1.3.6.1.4.1.14519.5.2.1.5382.4002.806935685832642465081499816867",
     out_dir = "~/Desktop", out_file_name = "file.zip")
# }
# NOT RUN {
# }