.. note::
    :class: sphx-glr-download-link-note

    Click :ref:`here <sphx_glr_download_auto_examples_dicomtree.py>` to download the full example code
.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_dicomtree.py:


=========================================
Show a dicom file using hierarchical tree
=========================================

Show a dicom file using a hierarchical tree in a graphical window.


.. code-block:: default


    # authors : Guillaume Lemaitre <g.lemaitre58@gmail.com>
    # license : MIT

    from __future__ import print_function

    from pydicom import compat

    if compat.in_py2:
        import Tix as tkinter_tix
    else:
        import tkinter.tix as tkinter_tix

    print(__doc__)

    usage = "Usage: python dicomtree.py dicom_filename"


    def RunTree(w, filename):
        top = tkinter_tix.Frame(w, relief=tkinter_tix.RAISED, bd=1)
        tree = tkinter_tix.Tree(top, options="hlist.columns 2")
        tree.pack(expand=1, fill=tkinter_tix.BOTH, padx=10, pady=10,
                  side=tkinter_tix.LEFT)
        # print(tree.hlist.keys())   # use to see the available configure() options
        tree.hlist.configure(bg='white', font='Courier 10', indent=30)
        tree.hlist.configure(selectbackground='light yellow', gap=150)

        box = tkinter_tix.ButtonBox(w, orientation=tkinter_tix.HORIZONTAL)
        # box.add('ok', text='Ok', underline=0, command=w.destroy, width=6)
        box.add('exit', text='Exit', underline=0, command=w.destroy, width=6)
        box.pack(side=tkinter_tix.BOTTOM, fill=tkinter_tix.X)
        top.pack(side=tkinter_tix.TOP, fill=tkinter_tix.BOTH, expand=1)

        show_file(filename, tree)


    def show_file(filename, tree):
        tree.hlist.add("root", text=filename)
        ds = pydicom.dcmread(sys.argv[1])
        ds.decode()  # change strings to unicode
        recurse_tree(tree, ds, "root", False)
        tree.autosetmode()


    def recurse_tree(tree, dataset, parent, hide=False):
        # order the dicom tags
        for data_element in dataset:
            node_id = parent + "." + hex(id(data_element))
            if isinstance(data_element.value, compat.text_type):
                tree.hlist.add(node_id, text=compat.text_type(data_element))
            else:
                tree.hlist.add(node_id, text=str(data_element))
            if hide:
                tree.hlist.hide_entry(node_id)
            if data_element.VR == "SQ":   # a sequence
                for i, dataset in enumerate(data_element.value):
                    item_id = node_id + "." + str(i + 1)
                    sq_item_description = data_element.name.replace(
                        " Sequence", "")  # XXX not i18n
                    item_text = "{0:s} {1:d}".format(sq_item_description, i + 1)
                    tree.hlist.add(item_id, text=item_text)
                    tree.hlist.hide_entry(item_id)
                    recurse_tree(tree, dataset, item_id, hide=True)


    if __name__ == '__main__':
        import sys
        import pydicom
        if len(sys.argv) != 2:
            print("Please supply a dicom file name:\n")
            print(usage)
            sys.exit(-1)
        root = tkinter_tix.Tk()
        root.geometry("{0:d}x{1:d}+{2:d}+{3:d}".format(800, 600, 0, 0))

        RunTree(root, sys.argv[1])
        root.mainloop()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  0.000 seconds)


.. _sphx_glr_download_auto_examples_dicomtree.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download

     :download:`Download Python source code: dicomtree.py <dicomtree.py>`



  .. container:: sphx-glr-download

     :download:`Download Jupyter notebook: dicomtree.ipynb <dicomtree.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_