...
Excerpt |
---|
Image Download APIsUse the APIs in the following table to download images from TCIA. Query Name | Return Values | Output Format | Query Parameters | Usage |
---|
getImage | An object that represents a set of images in a ZIP file based on SeriesInstanceUID. The naming scheme for the NewFileNames parameter changes from sequential numbers to acquisition number - instance number (in correct order). API example and return values for getImage | ZIP | SeriesInstanceUID (R) NewFileNames (O) - Accepted values are Yes and No. | Used for bulk transfer of all images in a series. | getImageWithMD5Hash | All images in the series and MD5 hash values API example and return values for getImageWithMD5Hash | ZIP | SeriesInstanceUID (R) | Used for bulk transfer of images with the ability to check MD5Hash. | getSingleImage | A single DICOM Object that is identified by its SeriesInstanceUID and SOPInstanceUID. This API will always be used following the getSOPInstanceUIDs. API example and return values for getSingleImage | Raw DICOM Object | SeriesInstanceUID (R) SOPInstanceUID (R) | Used to retrieve a single image. |
Use the APIs in the following table to explore the metadata of objects in the TCIA database. Queries return a file in one of these data formats: CSV, HTML, XML, and JSON. JSON is the default return format if no format parameter is specified. SeriesInstanceUID StudyInstanceUID Modality ProtocolName SeriesDate (O) SeriesDescription (O) (O) SeriesNumber (O) AnnotationsFlag (O) Collection (O) PatientID (O) Manufacturer (O) ManufacturerModelName (O) | SoftwareVersions StudyDate ImageCount (O) TimeStamp (O) LicenseName (O) LicenseURI (O) CollectionURI (O) FileSize (O) StudyDesc (O) SeriesInstanceUID (O) | getSeriesMetaData | All of the metadata for a given SeriesInstanceUID API example and return values for getSeriesMetaData | SeriesInstanceUID (R) Collection (O) 3rd Party Analysis Data (O) Data Description URI (O) Subject ID (O) Study UID (O) Study Description (O) Study Date (O) Series Description (O) Manufacturer (O) Modality (O) SOP Class UID (O) Number of Images (O) File Size (O) File Location (O) Series Number (O) License Name (O) License URL (O) Annotation Size (O) Series Date (O) Protocol Name (O) Body Part Examined (O) Annotations Flag (O) Manufacturer Model Name (O) Software Versions (O) TimeStamp (O) | getSeriesSize | Set of total byte size and object count filtered by query key API example and return values for getSeriesSize | SeriesInstanceUID (R) | getSOPInstanceUIDs | A list of SOPInstanceUIDs for a given series using the SeriesInstanceUID API example and return values for getSOPInstanceUIDs | SeriesInstanceUID (R) | getUpdatedSeries | Set of series updated since a specified date API example and return values for getUpdatedSeries | fromDate (R) |
|
Return Values
This section lists and explains the return values of the APIs included in both tables above.
...