copyxnat.xnat_backend.pyxnat_server module

Wrappers for communicating between copyxnat items and pyXNAT backend items

class copyxnat.xnat_backend.pyxnat_server.PyXnatAssessor(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithInOutResources

Wrapper around a pyxnat assessor interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatExperiment(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithResources

Wrapper around a pyxnat experiment interface

assessors()

Return array of PyXnatAssessor wrappers for this experiment

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

reconstructions()

Return array of PyXnatReconstruction wrappers for this experiment

scans()

Return array of PyXnatScan wrappers for this experiment

class copyxnat.xnat_backend.pyxnat_server.PyXnatFile(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItem

Wrapper around a pyxnat file interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

create_on_server(local_file, create_params, overwrite, reporter)

Create this item on the XNAT server if it does not already exist

download_file(save_dir, label)

Get file from server and save to disk

file_attributes()

Return dict of file attributes

class copyxnat.xnat_backend.pyxnat_server.PyXnatInResource(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatResourceBase

Wrapper around a pyxnat in resource interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatItem(interface, label=None)

Bases: object

Abstraction of wrappers around pyXnat interfaces

classmethod create(parent, label)

Create a new child item of this class type from given parent

abstract classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

create_on_server(local_file, create_params, overwrite, reporter)

Create this item on the XNAT server if it does not already exist

datatype()

Return the XNAT datatype of this item

exists()

Return True if the item already exists on the server

fetch_interface()

Return the pyxnat interface to this item

get_attribute(name)

Return the specified attribute from this item

get_id()

Return the XNAT ID of this item

get_label()

Return the XNAT label of this item, or ID if the label is empty

get_xml_string()

Return XML representation of this XNAT item

set_attribute(name, value)

Return the specified attribute from this item

class copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithInOutResources(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItem

Wrapper around a pyxnat interface that can contain resources

abstract classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

in_resources()

Return item’s in resources as an array of PyXnatResource wrappers

out_resources()

Return item’s out resources as an array of PyXnatResource wrappers

class copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithResources(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItem

Wrapper around a pyxnat interface that can contain resources

abstract classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

resources()

Return item’s resources as an array of PyXnatResource wrappers

class copyxnat.xnat_backend.pyxnat_server.PyXnatOutResource(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatResourceBase

Wrapper around a pyxnat out resource interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatProject(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithResources

Wrapper around a pyxnat project interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

subjects()

Return array of PyXnatSubject wrappers for this project

class copyxnat.xnat_backend.pyxnat_server.PyXnatReconstruction(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithInOutResources

Wrapper around a pyxnat reconstruction interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatResource(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatResourceBase

Wrapper around a pyxnat resource interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatResourceBase(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItem

Wrapper around a pyxnat resource interface

abstract classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

create_on_server(local_file, create_params, overwrite, reporter)

Create this item on the XNAT server if it does not already exist

download_zip_file(save_dir)

Get zip file from server and save to disk

files()

Return item’s files as an array of PyXnatFile wrappers

resource_attributes()

Return dict of resource attributes

class copyxnat.xnat_backend.pyxnat_server.PyXnatScan(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithResources

Wrapper around a pyxnat scan interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

class copyxnat.xnat_backend.pyxnat_server.PyXnatServer(params)

Bases: object

Wrapper around pyXNAT server interface

datatypes()

Return datatypes on this server

experiment_list(project)

Return list of experiments in this project

fetch_interface()

Return the pyxnat interface to this server

logout()

Disconnect from server

num_experiments(project)

Return number of experiments in this project

project(label)

Return PyXnatProject project

project_list()

Return array of project ids

project_name_metadata()

Return list of dictionaries containing project name metadata

projects()

Return array of PyXnatProject projects

request(uri, method)

Execute a REST call on the server

request_json_property(uri)

Execute a REST call on the server and return string

request_string(uri)

Execute a REST call on the server and return string

class copyxnat.xnat_backend.pyxnat_server.PyXnatSubject(interface, label=None)

Bases: copyxnat.xnat_backend.pyxnat_server.PyXnatItemWithResources

Wrapper around a pyxnat subject interface

classmethod create_interface(parent, label)

Create a pyXnat child interface from the given pyXnat parent

experiments()

Return array of PyXnatExperiment wrappers for this subject