Archives API Reference¶
Module imagedata.archives.abstractarchive¶
Abstract class for image archives.
Defines generic functions.
-
class
imagedata.archives.abstractarchive.
AbstractArchive
(name, description, authors, version, url, _mimetypes)[source]¶ Abstract base class definition for imagedata archive plugins. Plugins must be a subclass of AbstractPlugin and must define the atttributes set in __init__() and the following methods:
__init__() method use_query() method getnames() method basename() method open() method getmembers() method to_localfile() method read() method write() method
-
abstract
add_localfile
(local_file, filename)[source]¶ Add a local file to the archive.
- Parameters
local_file – named local file
filename – filename in the archive
- Returns
filehandle to file in the archive
Plugin authors
Multi-line string naming the author(s) of the plugin.
-
abstract
basename
(filehandle)[source]¶ Basename of file.
Examples
if archive.basename(filehandle) == “DICOMDIR”:
- Parameters
filehandle – reference to member object
-
property
description
¶ Plugin description
Single line string describing the image format.
-
abstract
getmembers
(files=None)[source]¶ Get the members of the archive.
- Returns
- The members of the archive as an OrderedDict of member objects.
The keys are the member names as given by getnames().
-
abstract
getnames
(files=None)[source]¶ Get name list of the members.
- Returns
- The members as a list of their names.
It has the same order as the members of the archive.
-
property
mimetypes
¶ MIME types supporte by self plugin.
List of strings.
-
property
name
¶ Plugin name
Single word string describing the image format. Typical names: dicom, nifti, itk.
-
abstract
open
(filehandle, mode='rb')[source]¶ Open file.
- Returns
a member object for member given its filehandle.
-
property
transport
¶ Underlying transport plugin
-
property
url
¶ Plugin URL
URL string to the site of the plugin or the author(s).
-
property
version
¶ Plugin version
String giving the plugin version. Version scheme: 1.0.0
-
abstract
Module imagedata.archives.filesystemarchive¶
Read/Write local image files
-
class
imagedata.archives.filesystemarchive.
FilesystemArchive
(transport=None, url=None, mode='r', read_directory_only=True, opts=None)[source]¶ Read/write local files.
-
add_localfile
(local_file, filename)[source]¶ Add a local file to the archive.
- Parameters
local_file – named local file
filename – filename in the archive
- Returns
filehandle to file in the archive
-
basename
(filehandle)[source]¶ Basename of file.
Examples
if archive.basename(filehandle) == “DICOMDIR”:
- Parameters
filehandle – reference to member object
-
getmembers
(files=None)[source]¶ Get the members of the archive.
- Returns
- The members of the archive as a list of member objects.
The list has the same order as the members in the archive.
-
getnames
(files=None)[source]¶ Get name list of the members.
- Returns
- The members as a list of their names.
It has the same order as the members of the archive.
-
property
transport
¶ Underlying transport plugin
-
Module imagedata.archives.zipfilearchive¶
Read/Write image files from a zipfile
-
class
imagedata.archives.zipfilearchive.
WriteFileIO
(archive, filename, localfile)[source]¶ Local object making sure the new file is written to zip archive before closing.
-
class
imagedata.archives.zipfilearchive.
ZipfileArchive
(transport=None, url=None, mode='r', read_directory_only=False, opts=None)[source]¶ Read/write image files from a zipfile.
-
add_localfile
(local_file, filename)[source]¶ Add a local file to the archive.
- Parameters
local_file – named local file
filename – filename in the archive
- Returns
filehandle to file in the archive
-
basename
(filehandle)[source]¶ Basename of file.
Examples
if archive.basename(filehandle) == “DICOMDIR”:
- Parameters
filehandle – reference to member object
-
getmembers
(files=None)[source]¶ Get the members of the archive.
- Returns
- The members of the archive as a list of member objects.
The list has the same order as the members in the archive.
-
getnames
(files=None)[source]¶ Get name list of the members.
- Returns
- The members as a list of their names.
It has the same order as the members of the archive.
-
open
(filehandle, mode='rb')[source]¶ Open file.
- Returns
A member object for member with filehandle.
Extract the member object to local file space. This is necessary to allow the seek() operation on open files.
-
property
transport
¶ Underlying transport plugin
-