pyxnat.SearchManager

class pyxnat.SearchManager(interface)

Search interface. Handles operations to save and get back searches on the server.

Examples

>>> row = 'xnat:subjectData'
>>> columns = ['xnat:subjectData/PROJECT',
               'xnat:subjectData/SUBJECT_ID'
               ]
>>> criteria = [('xnat:subjectData/SUBJECT_ID', 'LIKE', '*'),
                'AND'
                ]
>>> interface.manage.search.save('mysearch', row, columns,
                                 criteria, sharing='public',
                                 description='my first search'
                                 )

Methods

delete(name)

Removes the search from the server.

delete_template(name)

Deletes a search template.

get(name[, out_format])

Returns the results of the query saved on the XNAT server or the query itself to know what it does.

get_template(name[, as_xml])

Get a saved template, either as an xml document, or as a pyxnat representation, with the keys to be used in the template between the parentheses in %()s.

save(name, row, columns, constraints[, …])

Saves a query on the XNAT server.

save_template(name[, row, columns, …])

Define and save a search template.

saved([with_description])

Returns the names of accessible saved search on the server.

saved_templates([with_description])

Returns the names of accessible saved search templates on the server.

use_template(name, values)

Parameters

eval_rpn_exp