nbiatoolkit.utils.nbia_endpoints

Module Contents

Classes

NBIA_BASE_URLS	This enum class defines the NBIA base URLs used in the NBIA toolkit.
NBIA_ENDPOINTS	This enum class defines the NBIA endpoints used in the NBIA toolkit.
ReturnType	Generic enumeration.

class nbiatoolkit.utils.nbia_endpoints.NBIA_BASE_URLS

Bases: enum.Enum

This enum class defines the NBIA base URLs used in the NBIA toolkit.

NBIA = 'https://services.cancerimagingarchive.net/nbia-api/services/'

NLST = 'https://nlst.cancerimagingarchive.net/nbia-api/services/'

LOGOUT_URL = 'https://services.cancerimagingarchive.net/nbia-api/logout'

__str__()

Return str(self).

_format()

class nbiatoolkit.utils.nbia_endpoints.NBIA_ENDPOINTS

Bases: enum.Enum

This enum class defines the NBIA endpoints used in the NBIA toolkit.

GET_COLLECTIONS = 'v2/getCollectionValues'

GET_COLLECTION_PATIENT_COUNT = 'getCollectionValuesAndCounts'

GET_COLLECTION_DESCRIPTIONS = 'getCollectionDescriptions'

GET_MODALITY_VALUES = 'v2/getModalityValues'

GET_MODALITY_PATIENT_COUNT = 'getModalityValuesAndCounts'

GET_PATIENTS = 'v2/getPatient'

GET_NEW_PATIENTS_IN_COLLECTION = 'v2/NewPatientsInCollection'

GET_PATIENT_BY_COLLECTION_AND_MODALITY = 'v2/getPatientByCollectionAndModality'

GET_BODY_PART_PATIENT_COUNT = 'getBodyPartValuesAndCounts'

GET_STUDIES = 'v2/getPatientStudy'

GET_SERIES = 'v2/getSeries'

GET_UPDATED_SERIES = 'v2/getUpdatedSeries'

GET_SERIES_METADATA = 'v1/getSeriesMetaData'

DOWNLOAD_SERIES = 'v2/getImageWithMD5Hash'

GET_DICOM_TAGS = 'getDicomTags'

__str__()

Return str(self).

_format()

class nbiatoolkit.utils.nbia_endpoints.ReturnType

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

LIST = 'list'

DATAFRAME = 'dataframe'