Transports API Reference

Module imagedata.transports.abstracttransport

Abstract class for image transports.

Defines generic functions.

class imagedata.transports.abstracttransport.AbstractTransport(name: str, description: str, authors: str, version: str, url: str, schemes: List[str] | None = None)[source]

Abstract base class definition for imagedata transport plugins. Plugins must be a subclass of AbstractPlugin and must define the attributes set in __init__() and the following methods:

open() method isfile() method walk() method

property authors: str

Plugin authors

Multi-line string naming the author(s) of the plugin.

abstract close()[source]: Close the transport

property description: str

Plugin description

Single line string describing the transport method.

abstract exists(path: str) → bool[source]: Determine whether the named path exists.

abstract info(path) → str[source]

Return info describing the object

Parameters:: path (str) – object path
Returns:: Preferably a one-line string describing the object
Return type:: description (str)

abstract isfile(path: str) → bool[source]: Return True if path is an existing regular file.

property name: str

Plugin name

Single word string describing the image format. Typical names: file, dicom, xnat

abstract open(path: str, mode: str = 'r') → IOBase[source]: Extract a member from the archive as a file-like object.

property schemes: List[str]

List of transport schemes supported by this plugin.

List of strings.

property url: str

Plugin URL

URL string to the site of the plugin or the author(s).

property version: str

Plugin version

String giving the plugin version. Version scheme: 1.0.0

abstract walk(top: str)[source]: Generate the file names in a directory tree by walking the tree. Input: - top: starting point for walk (str) Return: - tuples of (root, dirs, files)

exception imagedata.transports.abstracttransport.NoOtherInstance[source]

Module imagedata.transports.dicomtransport

Transfer DICOM images to and from DICOM Storage SCP

exception imagedata.transports.dicomtransport.AssociationFailed[source]

exception imagedata.transports.dicomtransport.AssociationNotEstablished[source]

Send DICOM images to DICOM Storage SCP

close()[source]: Close the DICOM association transport

exists(path)[source]: Determine whether the named path exists.

info(path) → str[source]

Return info describing the object

Parameters:: path (str) – object path
Returns:: Preferably a one-line string describing the object
Return type:: description (str)

isfile(path)[source]: Return True if path is an existing regular file.

open(path, mode='r')[source]: Extract a member from the archive as a file-like object.

store(ds)[source]: Store DICOM dataset using DICOM Storage SCU protocol.

walk(top)[source]: Generate the file names in a directory tree by walking the tree. Input: - top: starting point for walk (str) Return: - tuples of (root, dirs, files)

Module imagedata.transports.filetransport

Read/Write local files

Read/write local files.

Parameters:

netloc (str) – Not used.
root (str) – Root path.
mode (str) – Filesystem access mode.
read_directory_only (bool) – Whether root should refer to a directory.
opts (dict) – Options

Returns:

FileTransport instance

Raises:

RootIsNotDirectory – when the root is not a directory when read_directory_only is True.
FileNotFoundError – Specified root does not exist.
AssertionError – When root is None.

close()[source]: Close the transport

exists(path)[source]: Determine whether the named path exists.

info(path) → str[source]

Return info describing the object

Parameters:: path (str) – object path
Returns:: Preferably a one-line string describing the object
Return type:: description (str)

isfile(path)[source]

Check whether path refers to an existing regular file.

Parameters:: path – Path to file.
Returns:: Existense of regular file (bool)

open(path: str, mode: str = 'r') → IOBase[source]

Extract a member from the archive as a file-like object.

Parameters:

path (str) – Path to file.
mode (str) – Open mode, can be ‘r’, ‘w’, ‘x’ or ‘a’

walk(top)[source]

Generate the file names in a directory tree by walking the tree.

Parameters:: top – starting point for walk (str)
Returns:: tuples of (root, dirs, files)

Module imagedata.transports.xnattransport

Read/write files in xnat database

Read/write files in xnat database.

close()[source]: Close the transport

exists(path)[source]: Return True if the named path exists.

info(path) → str[source]

Return info describing the object

Parameters:: path (str) – object path
Returns:: Preferably a one-line string describing the object
Return type:: description (str)

isfile(path)[source]: Return True if path is an existing regular file.

open(path, mode='r')[source]: Extract a member from the archive as a file-like object.

walk(top)[source]: Generate the file names in a directory tree by walking the tree. Input: - top: starting point for walk (str) Return: - tuples of (root, dirs, files)