Skip to content

Latest commit

 

History

History
92 lines (54 loc) · 3.41 KB

userguide.md

File metadata and controls

92 lines (54 loc) · 3.41 KB
Raw

MEDIator User Guide

MEDIator, a data sharing and federation middleware platform for heterogeneous medical image archives. MEDIator allows sharing pointers to medical data efficiently, while letting the consumers manipulate the pointers without modifying the raw medical data. MEDIator has been implemented for multiple data sources, including Amazon S3, The Cancer Imaging Archive (TCIA), caMicroscope, and metadata from CSV files for cancer images.

By default, Mediator allows creating pointers to datasets from TCIA. These pointers are called "replicasets."

Using MEDIator to create a replicaset

Why would someone use it? You use MEDIator to create pointers to data. This pointer points to various disjoint sets of data. In case of TCIA, this may span across various collections, patients, studies, and series. These pointers can be shared across various users, spanning multiple organizations, without actually duplicating and sharing the data.

What does it do? MEDIator saves the replicasets created by the users in a secure space, separate from other user spaces.

Create Replica Set.

Creating a replicaset is a POST command that can be issued from a REST client.

For example, a POST request as below:

http://172.20.11.223:8040/replicasets", headers={ "Accept": "application/json" }, params={ "iUserID": 12, "iCollection": "TCGA-GBM", "iPatientID" : "TCGA-06-6701%2CTCGA-08-0831", "iStudyInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.4591.4001.151679082681232740021018262895", "iSeriesInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.4591.4001.179004339156422100336233996679" })

Retrieve Replica Sets of a user.

Retrieving the replicasets of a user is a GET command that can be issued from a REST client.

For example, a GET request as below:

http://172.20.11.223:8040/replicasets/12"

Retrieve a Replica Set.

Retrieving a replicaset is a GET command that can be issued from a REST client.

For example, a GET request as below:

http://172.20.11.223:8040//replicaset/-4727115044472165798

Delete Replica Set.

Deleting a replicaset is a DELETE command that can be issued from a REST client.

For example, a DELETE request as below:

http://172.20.11.223:8040/replicaset/12?replicaSetID=-5896416803618323002

Replace Replica Set.

Replacing a replicaset is a POST command that can be issued from a REST client.

For example, a POST request as below:

http://172.20.11.223:8040/replicaset/-4727115044472165798", headers={ "Accept": "application/json" }, params={"iStudyInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.4591.4001.151679082681232740021018262895", "iSeriesInstanceUID" : "1.3.6.1.4.1.14519.5.2.1.4591.4001.179004339156422100336233996679" })

Append Replica Set.

Appending a replicaset is a POST command that can be issued from a REST client.

For example, a POST request as below:

http://172.20.11.223:8040/replicaset/-4727115044472165798", headers={ "Accept": "application/json" }, params={"iCollection" : "TCGA-GBM"})

Duplicate Replica Set.

Duplicating a replicaset is a POST command that can be issued from a REST client.

For example, a POST request as below:

http://172.20.11.223:8040/replicaset", headers={ "Accept": "application/json" }, params={ "userID" : "1234567", "replicaSetID": "-4727115044472165798"})

Retrieve the users.

Retrieving the users is a GET command that can be issued from a REST client.

For example, a GET request as below:

http://172.20.11.223:8040/