Skip to content

nexus_treeview

A treeview tkinter frame for displaying the hierachical structure of HDF and Nexus files

HdfNameSpace

Bases: CanvasTreeview

HDF Namespace object

Source code in mmg_toolbox/tkguis/widgets/nexus_treeview.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
class HdfNameSpace(CanvasTreeview):
    """
    HDF Namespace object
    """

    def __init__(self, root: tk.Misc, width: int | None = None, height: int | None = None):
        columns = [
            ('#0', 'Name', 100, False, None),
            ('path', 'Path', 300, False, None),
            ('value', 'Value', 200, False, None),
        ]
        super().__init__(root, *columns, width=width, height=height)

    def populate(self, hdf_obj: h5py.File, hdf_map: hdfmap.NexusMap,
                 all: bool = True, group: bool = False, combined: bool = False, values: bool = False,
                 arrays: bool = False, scannables: bool = False, metadata: bool = False, image_data: bool = False):
        """Load HDF file, populate ttk.treeview object"""

        data = {
            name: hdf_map.get_string(hdf_obj, name)
            for name, path in hdf_map.combined.items()
        }

        if all or group:
            datasets = self.tree.insert("", tk.END, text='Groups', values=('', ''))
            for name, path_list in hdf_map.classes.items():
                # path_list = list(set(path_list))  # remove duplicates
                if len(path_list) == 1:
                    self.tree.insert(datasets, tk.END, text=name, values=(path_list[0], ''))
                else:
                    grp = self.tree.insert(datasets, tk.END, text=name, values=('', ''))
                    for path in path_list:
                        self.tree.insert(grp, tk.END, text=name, values=(path, ''))

        if all or combined:
            datasets = self.tree.insert("", tk.END, text='Combined', values=('', ''))
            for name, path in hdf_map.combined.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

        if all or values:
            datasets = self.tree.insert("", tk.END, text='Values', values=('', ''))
            for name, path in hdf_map.values.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

        if all or arrays:
            datasets = self.tree.insert("", tk.END, text='Arrays', values=('', ''))
            for name, path in hdf_map.arrays.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

        if all or scannables:
            datasets = self.tree.insert("", tk.END, text='Scannables', values=('', ''))
            for name, path in hdf_map.scannables.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

        if all or metadata:
            datasets = self.tree.insert("", tk.END, text='Metadata', values=('', ''))
            for name, path in hdf_map.metadata.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

        if all or image_data:
            datasets = self.tree.insert("", tk.END, text='Image Data', values=('', ''))
            for name, path in hdf_map.image_data.items():
                value = data.get(name, 'NOT IN MAP')
                self.tree.insert(datasets, tk.END, text=name, values=(path, value))

populate(hdf_obj, hdf_map, all=True, group=False, combined=False, values=False, arrays=False, scannables=False, metadata=False, image_data=False)

Load HDF file, populate ttk.treeview object

Source code in mmg_toolbox/tkguis/widgets/nexus_treeview.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
def populate(self, hdf_obj: h5py.File, hdf_map: hdfmap.NexusMap,
             all: bool = True, group: bool = False, combined: bool = False, values: bool = False,
             arrays: bool = False, scannables: bool = False, metadata: bool = False, image_data: bool = False):
    """Load HDF file, populate ttk.treeview object"""

    data = {
        name: hdf_map.get_string(hdf_obj, name)
        for name, path in hdf_map.combined.items()
    }

    if all or group:
        datasets = self.tree.insert("", tk.END, text='Groups', values=('', ''))
        for name, path_list in hdf_map.classes.items():
            # path_list = list(set(path_list))  # remove duplicates
            if len(path_list) == 1:
                self.tree.insert(datasets, tk.END, text=name, values=(path_list[0], ''))
            else:
                grp = self.tree.insert(datasets, tk.END, text=name, values=('', ''))
                for path in path_list:
                    self.tree.insert(grp, tk.END, text=name, values=(path, ''))

    if all or combined:
        datasets = self.tree.insert("", tk.END, text='Combined', values=('', ''))
        for name, path in hdf_map.combined.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

    if all or values:
        datasets = self.tree.insert("", tk.END, text='Values', values=('', ''))
        for name, path in hdf_map.values.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

    if all or arrays:
        datasets = self.tree.insert("", tk.END, text='Arrays', values=('', ''))
        for name, path in hdf_map.arrays.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

    if all or scannables:
        datasets = self.tree.insert("", tk.END, text='Scannables', values=('', ''))
        for name, path in hdf_map.scannables.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

    if all or metadata:
        datasets = self.tree.insert("", tk.END, text='Metadata', values=('', ''))
        for name, path in hdf_map.metadata.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

    if all or image_data:
        datasets = self.tree.insert("", tk.END, text='Image Data', values=('', ''))
        for name, path in hdf_map.image_data.items():
            value = data.get(name, 'NOT IN MAP')
            self.tree.insert(datasets, tk.END, text=name, values=(path, value))

HdfTreeview

Bases: CanvasTreeview

HDF Treeview object

Source code in mmg_toolbox/tkguis/widgets/nexus_treeview.py 
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class HdfTreeview(CanvasTreeview):
    """
    HDF Treeview object
    """
    def __init__(self, root: tk.Misc, width: int | None = None, height: int | None = None):
        columns = [
            ('#0', 'HDF Address', 400, False, None),
            ('type', 'Type', 100, False, None),
            ('name', 'Name', 100, False, None),
            ('value', 'Value', 200, False, None),
        ]
        super().__init__(root, *columns, width=width, height=height)


    def populate(self, hdf_obj: h5py.File, openstate=True):
        """Load HDF file, populate ttk.treeview object"""

        def recur_func(hdf_group, tree_group="", top_address='/'):
            for key in hdf_group:
                obj = hdf_group.get(key)
                link = hdf_group.get(key, getlink=True)
                address = top_address + key
                name = generate_identifier(address)
                if isinstance(obj, h5py.Group):
                    try:
                        nx_class = obj.attrs['NX_class'].decode() if 'NX_class' in obj.attrs else 'Group'
                    except AttributeError:
                        nx_class = obj.attrs['NX_class']
                    except OSError:
                        nx_class = 'Group'  # if object doesn't have attrs
                    values = (nx_class, name, "")
                    new_tree_group = self.tree.insert(tree_group, tk.END, text=address, values=values)
                    # add attributes
                    for attr, val in obj.attrs.items():
                        self.tree.insert(new_tree_group, tk.END, text=f"@{attr}", values=('Attribute', attr, val))
                    recur_func(obj, new_tree_group, address + '/')
                    self.tree.item(new_tree_group, open=openstate)
                elif isinstance(obj, h5py.Dataset):
                    if isinstance(link, h5py.ExternalLink):
                        link_type = 'External Link'
                    elif isinstance(link, h5py.SoftLink):
                        link_type = 'Soft Link'
                    else:
                        link_type = 'Dataset'
                    if obj.shape:
                        val = f"{obj.dtype} {obj.shape}"
                    else:
                        val = str(obj[()])
                    values = (link_type, name, val)
                    # datasets.append(address)
                    new_tree_group = self.tree.insert(tree_group, tk.END, text=address, values=values)
                    for attr, val in obj.attrs.items():
                        self.tree.insert(new_tree_group, tk.END, text=f"@{attr}", values=('Attribute', attr, val))
                    self.tree.item(new_tree_group, open=False)

        # add top level file group
        hdf_filename = hdf_obj.filename
        self.tree.insert("", tk.END, text='/', values=('File', os.path.basename(hdf_filename), ''))
        recur_func(hdf_obj, "")

populate(hdf_obj, openstate=True)

Load HDF file, populate ttk.treeview object

Source code in mmg_toolbox/tkguis/widgets/nexus_treeview.py 
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def populate(self, hdf_obj: h5py.File, openstate=True):
    """Load HDF file, populate ttk.treeview object"""

    def recur_func(hdf_group, tree_group="", top_address='/'):
        for key in hdf_group:
            obj = hdf_group.get(key)
            link = hdf_group.get(key, getlink=True)
            address = top_address + key
            name = generate_identifier(address)
            if isinstance(obj, h5py.Group):
                try:
                    nx_class = obj.attrs['NX_class'].decode() if 'NX_class' in obj.attrs else 'Group'
                except AttributeError:
                    nx_class = obj.attrs['NX_class']
                except OSError:
                    nx_class = 'Group'  # if object doesn't have attrs
                values = (nx_class, name, "")
                new_tree_group = self.tree.insert(tree_group, tk.END, text=address, values=values)
                # add attributes
                for attr, val in obj.attrs.items():
                    self.tree.insert(new_tree_group, tk.END, text=f"@{attr}", values=('Attribute', attr, val))
                recur_func(obj, new_tree_group, address + '/')
                self.tree.item(new_tree_group, open=openstate)
            elif isinstance(obj, h5py.Dataset):
                if isinstance(link, h5py.ExternalLink):
                    link_type = 'External Link'
                elif isinstance(link, h5py.SoftLink):
                    link_type = 'Soft Link'
                else:
                    link_type = 'Dataset'
                if obj.shape:
                    val = f"{obj.dtype} {obj.shape}"
                else:
                    val = str(obj[()])
                values = (link_type, name, val)
                # datasets.append(address)
                new_tree_group = self.tree.insert(tree_group, tk.END, text=address, values=values)
                for attr, val in obj.attrs.items():
                    self.tree.insert(new_tree_group, tk.END, text=f"@{attr}", values=('Attribute', attr, val))
                self.tree.item(new_tree_group, open=False)

    # add top level file group
    hdf_filename = hdf_obj.filename
    self.tree.insert("", tk.END, text='/', values=('File', os.path.basename(hdf_filename), ''))
    recur_func(hdf_obj, "")