Tcia Tools

Configuration File: tcia_tools.json Tool Type: Local Tools Count: 10

This page contains all tools defined in the tcia_tools.json configuration file.

Available Tools

TCIA_get_body_part_values (Type: BaseRESTTool)

Get the body parts examined in TCIA imaging collections. Returns body part names for filtering se…

TCIA_get_body_part_values tool specification

Tool Information:

• Name: TCIA_get_body_part_values

• Type: BaseRESTTool

• Description: Get the body parts examined in TCIA imaging collections. Returns body part names for filtering series queries. Optionally filter by collection or modality.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name to filter by (e.g., ‘TCGA-GBM’)

• Modality ([‘string’, ‘null’]) (optional) Imaging modality to filter by (e.g., ‘CT’, ‘MR’)

Example Usage:

query = {
    "name": "TCIA_get_body_part_values",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_manufacturer_values (Type: BaseRESTTool)

Get the distinct scanner Manufacturer values present in a TCIA collection (optionally filtered by…

TCIA_get_manufacturer_values tool specification

Tool Information:

• Name: TCIA_get_manufacturer_values

• Type: BaseRESTTool

• Description: Get the distinct scanner Manufacturer values present in a TCIA collection (optionally filtered by modality or body part). This is a faceting tool analogous to TCIA_get_modality_values and TCIA_get_body_part_values, but for equipment manufacturer (e.g., ‘GE MEDICAL SYSTEMS’, ‘SIEMENS’, ‘Philips’, ‘TOSHIBA’). Use to discover which scanner vendors appear in a collection.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name to filter by (e.g., ‘LIDC-IDRI’). Omit to get manufacturers across all collections.

• Modality ([‘string’, ‘null’]) (optional) Imaging modality to filter by (e.g., ‘CT’, ‘MR’)

• BodyPartExamined ([‘string’, ‘null’]) (optional) Body part to filter by (e.g., ‘CHEST’)

Example Usage:

query = {
    "name": "TCIA_get_manufacturer_values",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_modality_values (Type: BaseRESTTool)

Get the imaging modalities available in a specific TCIA collection or across all collections. Ret…

TCIA_get_modality_values tool specification

Tool Information:

• Name: TCIA_get_modality_values

• Type: BaseRESTTool

• Description: Get the imaging modalities available in a specific TCIA collection or across all collections. Returns modality codes such as CT, MR, PT (PET), CR, DX, US (ultrasound), NM.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name to filter by (e.g., ‘LIDC-IDRI’). Omit to get all modalities.

• BodyPartExamined ([‘string’, ‘null’]) (optional) Body part to filter by (e.g., ‘CHEST’)

Example Usage:

query = {
    "name": "TCIA_get_modality_values",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_patient_studies (Type: BaseRESTTool)

Get study information for patients in The Cancer Imaging Archive (TCIA). Returns study metadata i…

TCIA_get_patient_studies tool specification

Tool Information:

• Name: TCIA_get_patient_studies

• Type: BaseRESTTool

• Description: Get study information for patients in The Cancer Imaging Archive (TCIA). Returns study metadata including study date, description, and patient details. Filter by collection name or patient ID.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name (e.g., ‘TCGA-GBM’, ‘LIDC-IDRI’)

• PatientID ([‘string’, ‘null’]) (optional) Patient identifier

• StudyInstanceUID ([‘string’, ‘null’]) (optional) DICOM Study Instance UID

Example Usage:

query = {
    "name": "TCIA_get_patient_studies",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_patients (Type: BaseRESTTool)

List the patients (subjects) in a TCIA imaging collection. Returns patient-level fields not avail…

TCIA_get_patients tool specification

Tool Information:

• Name: TCIA_get_patients

• Type: BaseRESTTool

• Description: List the patients (subjects) in a TCIA imaging collection. Returns patient-level fields not available from study-level tools: PatientId, PatientName, Phantom (whether the subject is a phantom test object vs a real patient), and SpeciesCode/SpeciesDescription (e.g. ‘337915000’ / ‘Homo sapiens’). Use this to enumerate subjects and filter human vs phantom/animal subjects. Filter by collection name. Example collections: ‘LIDC-IDRI’, ‘TCGA-GBM’, ‘TCGA-LUAD’.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name to list patients for (e.g., ‘LIDC-IDRI’, ‘TCGA-GBM’). Omit to list patients across all collections.

Example Usage:

query = {
    "name": "TCIA_get_patients",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_series (Type: BaseRESTTool)

Get imaging series from The Cancer Imaging Archive (TCIA). A series is a set of related images fr…

TCIA_get_series tool specification

Tool Information:

• Name: TCIA_get_series

• Type: BaseRESTTool

• Description: Get imaging series from The Cancer Imaging Archive (TCIA). A series is a set of related images from a single imaging session. Returns metadata including modality, body part, patient ID, image count, and file size. Filter by collection name, patient ID, study UID, modality, or body part. Example collections: ‘TCGA-GBM’, ‘LIDC-IDRI’, ‘TCGA-LUAD’, ‘TCGA-BRCA’.

Parameters:

• Collection ([‘string’, ‘null’]) (optional) Collection name (e.g., ‘TCGA-GBM’, ‘LIDC-IDRI’, ‘TCGA-LUAD’)

• PatientID ([‘string’, ‘null’]) (optional) Patient identifier

• StudyInstanceUID ([‘string’, ‘null’]) (optional) DICOM Study Instance UID

• Modality ([‘string’, ‘null’]) (optional) Imaging modality (e.g., ‘CT’, ‘MR’, ‘PT’, ‘CR’, ‘DX’)

• BodyPartExamined ([‘string’, ‘null’]) (optional) Body part examined (e.g., ‘CHEST’, ‘BRAIN’, ‘ABDOMEN’)

Example Usage:

query = {
    "name": "TCIA_get_series",
    "arguments": {
    }
}
result = tu.run(query)

TCIA_get_series_metadata (Type: BaseRESTTool)

Get detailed DICOM metadata for a specific imaging series in TCIA by its Series Instance UID. Ret…

TCIA_get_series_metadata tool specification

Tool Information:

• Name: TCIA_get_series_metadata

• Type: BaseRESTTool

• Description: Get detailed DICOM metadata for a specific imaging series in TCIA by its Series Instance UID. Returns equipment information, acquisition parameters, and series attributes.

Parameters:

• SeriesInstanceUID (string) (required) DICOM Series Instance UID (e.g., ‘1.3.6.1.4.1.14519.5.2.1.6279.6001.141365756818074698800993818518’)

Example Usage:

query = {
    "name": "TCIA_get_series_metadata",
    "arguments": {
        "SeriesInstanceUID": "example_value"
    }
}
result = tu.run(query)

TCIA_get_series_size (Type: BaseRESTTool)

Get the total file size and image count for a specific imaging series in The Cancer Imaging Archi…

TCIA_get_series_size tool specification

Tool Information:

• Name: TCIA_get_series_size

• Type: BaseRESTTool

• Description: Get the total file size and image count for a specific imaging series in The Cancer Imaging Archive (TCIA). Returns total size in bytes and number of DICOM objects. Use this to estimate download sizes before retrieving imaging data. Obtain SeriesInstanceUID from TCIA_get_series results.

Parameters:

• SeriesInstanceUID (string) (required) DICOM Series Instance UID. Example: ‘1.3.6.1.4.1.14519.5.2.1.6279.6001.100225287222365663678666836860’. Obtain from TCIA_get_series results.

Example Usage:

query = {
    "name": "TCIA_get_series_size",
    "arguments": {
        "SeriesInstanceUID": "example_value"
    }
}
result = tu.run(query)

TCIA_get_sop_instance_uids (Type: BaseRESTTool)

List the SOP Instance UIDs of every individual DICOM image (slice) within a TCIA imaging series. …

TCIA_get_sop_instance_uids tool specification

Tool Information:

• Name: TCIA_get_sop_instance_uids

• Type: BaseRESTTool

• Description: List the SOP Instance UIDs of every individual DICOM image (slice) within a TCIA imaging series. This is the deepest granularity below a series: each returned object is a single image instance. Use this to enumerate or reference individual slices. Requires a SeriesInstanceUID, obtained from TCIA_get_series results.

Parameters:

• SeriesInstanceUID (string) (required) DICOM Series Instance UID. Example: ‘1.3.6.1.4.1.14519.5.2.1.6279.6001.179049373636438705059720603192’. Obtain from TCIA_get_series results.

Example Usage:

query = {
    "name": "TCIA_get_sop_instance_uids",
    "arguments": {
        "SeriesInstanceUID": "example_value"
    }
}
result = tu.run(query)

TCIA_list_collections (Type: BaseRESTTool)

List all publicly available imaging collections in The Cancer Imaging Archive (TCIA). TCIA is a l…

TCIA_list_collections tool specification

Tool Information:

• Name: TCIA_list_collections

• Type: BaseRESTTool

• Description: List all publicly available imaging collections in The Cancer Imaging Archive (TCIA). TCIA is a large archive of medical images of cancer available for public download. Returns collection names for use with other TCIA tools.

Parameters:

No parameters required.

Example Usage:

query = {
    "name": "TCIA_list_collections",
    "arguments": {
    }
}
result = tu.run(query)

Navigation

• Available Tools - Back to Tools Overview

• Tool Loading Tutorial - Loading Local Tools