dicoogle.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

__title__ = 'dicoogle'
__version__ = '3.0.0' # semver
__author__ = 'Luís Bastião Silva'
__original_authors__ = 'Luís A. Bastião Silva, Tiago Marques Godinho'
__license__ = 'GPL v3'
__copyright__ = 'Copyright 2020, BMD software'

__url__ = 'https://www.dicoogle.com'

__maintainer__ = 'Luís Bastião Silva'
__email__ = 'bastiao@bmd-software.com'

__all__ = ()

import requests

class Dicoogle:
    """The client"""
    def __init__(self, url='demo.dicoogle.com'):
        self.ENDPOINT = "http://" + url

    def search_dim(self, query, provider=None, keyword=True):
        """Search with DIM levels
        Parameters
        ----------
        query : str
            The query using Dicoogle query supported syntax
            Forward to the query plugin/provider
        provider : str, optional
            The provider that the query will be forward
        keyword : bool, optional
            if a keyword query, this option should be true
        """
        url = self.ENDPOINT + "/searchDIM"
        data = {"query": query, "keyword": keyword}
        if provider:
            data["provider"] = provider

        r = requests.get(url, params=data)
        return r

    def export_csv(self, query, fields=[], providers=[], file=None):
        """Export the results for a CSV file
        Parameters
        ----------
        query : str
            The query using Dicoogle query supported syntax
            Forward to the query plugin/provider
        fields: list of strings
            a list of the fields that should be exported 
        providers : list of strings (providers)
            A list of providers 
        file : string, optional
            exported file name
        """
        url = self.ENDPOINT + "/export"
        data = {"query": query, "fields": fields, "providers": providers}
        r = requests.get(url, params=data, stream=True)
        if file:
            for chunk in r.iter_content(chunk_size=1024):
                if chunk:
                    file.write(chunk)
                    file.flush()

        return r
    
    def index(self, uri, provider=None):
        """Index DICOM objects
        Parameters
        ----------
        uri : str
            The uri that will be indexed (e.g file:///C:/files/abc or mongodb://collect1/dicom/a)
        provider : str 
            Provider 
        """    
        url = self.ENDPOINT + "/management/tasks/index"
        data = {"uri":uri}
        if provider:
            data["provider"] = provider
        r = requests.post(url,data=data)
        return r

    def search(self, query, provider, keyword=False):
        """Search with any levels
        Parameters
        ----------
        query : str
            The query using Dicoogle query supported syntax
            Forward to the query plugin/provider
        provider : str
            The provider that the query will be forward
        keyword : bool, optional
            if a keyword query, this option should be true
        """
        url = self.ENDPOINT + "/search"
        data = {"query": query, "provider": provider, "keyword": keyword}
        r = requests.get(url, params=data);
        return r

    def dump(self, uid):
        """Dump the metadata for a SOPInstanceUID
        Parameters
        ----------
        uid : str
            SOPInstanceUID that it is expected to get a metadata dump 
        """
        url = self.ENDPOINT + "/dump"
        data = {"uid": uid}
        r = requests.get(url, params=data)
        return r