xnat_search.py 5.81 KB
Newer Older
1
HOST = None
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

def main(host):
    import distutils.core

    root_element = 'xnat:mrScanData'
    constraints = [
        ('xnat:mrScanData/TYPE', 'LIKE', '%t1%'),
        ('xnat:mrScanData/PARAMETERS_FLIP', '>=', '10'),
        'AND',
        [('xnat:mrScanData/PARAMETERS_TE', '>', '2.0'),
         ('xnat:mrScanData/PARAMETERS_TE', '<', '2.0'),
         'OR'
         ]
        ]



    results = search_for(host, root_element, constraints)

    print "Search results (%s):" % len(results)
    print results

    while True:
        try:
            is_downl = distutils.util.strtobool(raw_input("download? "))
            break
        except ValueError:
            print "invalid character. Please use y or n."

    if is_downl:
        print "downloading files..."
        download_all(results, host)
        print "finished"
    else:
        print "download canceled"

def get_search_fields():
    return [{'label':'type', 'field':'xnat:mrScanData/TYPE'},
            {'label':'fov_x', 'field':'xnat:mrScanData/PARAMETERS_FOV_X'},
            {'label':'fov_y', 'field':'xnat:mrScanData/PARAMETERS_FOV_Y'},
            {'label':'tr', 'field': 'xnat:mrScanData/PARAMETERS_TR'},
            {'label':'te', 'field': 'xnat:mrScanData/PARAMETERS_TE'},
            {'label':'ti', 'field': 'xnat:mrScanData/PARAMETERS_TI'},
            {'label':'flip', 'field': 'xnat:mrScanData/PARAMETERS_FLIP'},
            {'label':'voxel_res_x', 'field':'xnat:mrScanData/PARAMETERS_VOXELRES_X'},
            {'label':'voxel_res_y', 'field':'xnat:mrScanData/PARAMETERS_VOXELRES_Y'},
            {'label':'voxel_res_z', 'field':'xnat:mrScanData/PARAMETERS_VOXELRES_Z'}
            ]

def get_query_methods():
    return ["AND", "OR"]

def get_operators():
    return ["LIKE", ">", "<", "<=", ">=", "="]

57
def download_all(results, host=None):
58
    for r in results:
59
60
        download(r, host)

Franziska Koehn's avatar
Franziska Koehn committed
61
62
63
64
65
def download_f(*args, **kwargs):
    download(*args, **kwargs)
    # if this does not return False, the function will be repeatedly called by timeout_add
    return False

66
67
68
69
70
71
72
73
74
75
def download(result, host=None):
    if not host:
        host = HOST
    print(result)
    subject = result['xnat_mrsessiondata_subject_id']
    experiment = result['xnat_mrsessiondata_session_id']
    project = result['xnat_mrsessiondata_project']
    scan = result['id']
    file_name = "%s_%s_%s" % (subject, result['type'], scan)
    download_file(host, project, subject, experiment, scan, file_name)
76
77

def search_for_mrScanData(host, constraints, user, passw):
Franziska Koehn's avatar
Franziska Koehn committed
78
    get_credentials(username=user, password=passw, force=True)
79
80
81
82
    return search_for(host, 'xnat:mrScanData', constraints)

def search_for(host, root_element, constraints):
    from pyxnat import Interface
83
    from pyxnat.core import errors
84
    from tempfile import mkdtemp
85
    from httplib2 import ServerNotFoundError
86
87
88

    user, passw = get_credentials()
    tmp_dir=mkdtemp()
89
90
91
92
93
94
95
96

    try:
        central = Interface(server="%s" % host,
                  user=user,
                  password=passw,
                  cachedir=tmp_dir)
    except IndexError:
        return "ServerNotFoundError"    #TODO Eigene Fehlerklasse
97
98
99
100
101
102
103
104
105

    search_fields = [
        'xnat:mrSessionData/PROJECT',       #project id
        'xnat:mrSessionData/SUBJECT_ID',    #subject id
        'xnat:mrSessionData/SESSION_ID',    #experiment id
        'xnat:mrScanData/ID',               #scan id
        'xnat:mrScanData/TYPE',             #scan type
        ]

106
107
108
109
110
111
112
113
    result = []

    try:
        result =  central.select(root_element,search_fields).where(constraints)
    except errors.DatabaseError:
        return "DatabaseError"   #TODO Eigene Fehlerklasse
    except ServerNotFoundError:
        return "ServerNotFoundError"    #TODO Eigene Fehlerklasse
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

    try:
        central.disonnect()
    except AttributeError:
        print "can\'t close connection (wrong pyxnat version?)"

    try:
        from shutil import rmtree
        rmtree(tmp_dir)
    except:
        pass
    return result


def get_credentials(force=False,username="", password="" ):
    if get_credentials.cache and not force:
        return get_credentials.cache
    from getpass import getpass
    while not len(username):
        username = raw_input("Username: ").strip()
    while not len(password):
        password = getpass().strip()
    get_credentials.cache = username, password
    return get_credentials()
get_credentials.cache = None

def download_file(host, project, subject, experiment, scan, file_name):
    import requests
    from base64 import b64encode
    from requests.auth import HTTPBasicAuth

    if not file_name.endswith(".zip"):
        file_name += ".zip"

    url= "%s/data/archive/projects/%s/subjects/%s/experiments/%s/scans/%s/resources/DICOM/files?format=zip" % (host, project, subject, experiment, scan)

    user, passw = get_credentials()

    try:
        with open(file_name, 'wb') as handle:
            response = requests.get(url, stream=True, auth=HTTPBasicAuth(user, passw))
            if not response.ok:
                raise ValueError(response.status_code)
            for block in response.iter_content(1024):
                if not block:
                    break
                handle.write(block)
    except IOError as e:
        print "Error writing file %s, %s" % (file_name, e)
    except ValueError as e:
        print "Error downloading file %s, Status Code %s" % (url, e)

if __name__ == "__main__":
    import argparse

    parser = argparse.ArgumentParser(description='search and download')
    parser.add_argument('--host', type=str, help='hostname or ip-address (including port).', default="localhost:8080")
    parser.add_argument('--user', type=str, help='user:passw', default=":")

    #TODO force download (boolean)
    #TODO read constraints und root_element from file
    #TODO GUI

    args = parser.parse_args()

    u,p = args.user.split(':')
    get_credentials(username=u, password=p)
    main(args.host)