Extensions/bboxdump/bboxdump.py

# Copyright (C) 2003-2004 by Intevation GmbH
# Authors:
# Frank Koormann <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

"""
Extend thuban with a bounding box dump.

Dumps the bounding boxes of all shapes of the selected layer.
An optional column can be specified to group the objects, 
in this case the bounding box is a union of the separate boxes.
"""

__version__ = '$Revision$'
# $Source$
# $Id$

import os, sys
import string

from wxPython.wx import *
from wxPython.lib.dialogs import wxScrolledMessageDialog

from Thuban.UI.common import ThubanBeginBusyCursor, ThubanEndBusyCursor
from Thuban.UI.command import registry, Command
from Thuban.UI.mainwindow import main_menu, _has_selected_shape_layer
from Thuban.UI.extensionregistry import ExtensionDesc, ext_registry
from Thuban import _

import shapelib
import dbflib

ext_registry.add(ExtensionDesc(
    name = 'bboxdump',
    version = '1.0.0',
    authors= [ 'Frank Koormann' ],
    copyright = '2003-2004 Intevation GmbH',
    desc = _("Dumps the bounding boxes of all\n" \
             "shapes of the selected layer.")))

# Widget IDs
ID_FILENAME = 4001
ID_ATTRIBUTES = 4002
ID_SELFN = 4003

class BBoxDumpDialog(wxDialog):
    """Bounding Box Dump Dialog

    Specify a filename for the dump and optionally a layer's column 
    field to group objects.
    """

    def __init__(self, parent, title, layer = None):
        wxDialog.__init__(self, parent, -1, title,
                          style = wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)

        if layer is None:
            return wxID_CANCEL

        # Store the layer
        self.layer = layer

        # Filename selection elements
        self.filename = wxTextCtrl(self, ID_FILENAME, "")
        self.button_selectfile = wxButton(self, ID_SELFN, _('Select...'))
        EVT_BUTTON(self, ID_SELFN, self.OnSelectFilename)

        # Column choice elements
        self.choice_column = wxChoice(self, ID_ATTRIBUTES)
        self.choice_column.Append(_('Select...'), None)
        for col in self.layer.ShapeStore().Table().Columns():
                self.choice_column.Append(col.name, col)
        self.choice_column.SetSelection(0)

        # Dialog button elements
        self.button_dump = wxButton(self, wxID_OK, _("OK"))
        EVT_BUTTON(self, wxID_OK, self.OnDump)
        self.button_dump.SetDefault()
        # TODO: Disable the OK button until a filename is entered ...
        # self.button_dump.Enable(False)
        self.button_cancel = wxButton(self, wxID_CANCEL, _("Cancel"))


        # Dialog Layout: three horizontal box sizers.
        topbox = wxBoxSizer(wxVERTICAL)

        hbox = wxBoxSizer(wxHORIZONTAL)
        topbox.Add(hbox, 0, wxALL|wxEXPAND)
        hbox.Add(wxStaticText(self, -1, _("File:")),
                 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
        hbox.Add(self.filename, 1, wxALL|wxEXPAND, 4)
        hbox.Add(self.button_selectfile, 0, wxALL, 4)

        hbox = wxBoxSizer(wxHORIZONTAL)
        topbox.Add(hbox, 0, wxALL|wxEXPAND)
        hbox.Add(wxStaticText(self, -1, _("Group by:")),
                 0, wxALL|wxALIGN_CENTER_VERTICAL, 4)
        hbox.Add(self.choice_column, 1, wxALL|wxEXPAND, 4)

        hbox = wxBoxSizer(wxHORIZONTAL)
        topbox.Add(hbox, 0, wxALL|wxEXPAND)
        hbox.Add(self.button_dump, 0, wxALL|wxALIGN_CENTER,
                  10)
        hbox.Add(self.button_cancel, 0, wxALL|wxALIGN_CENTER,
                  10)

        # Finalize ...
        self.SetAutoLayout(True)
        self.SetSizer(topbox)
        topbox.Fit(self)
        topbox.SetSizeHints(self)

        # Store for later use
        self.parent = parent

    def OnDump(self, event):
        """Bounding Box Dump Dialog event handler OK button.

        Prepare the inputs from the dialog and call processing.
        """
        i = self.choice_column.GetSelection()
        column = self.choice_column.GetClientData(i)
        self.Close()

        ThubanBeginBusyCursor()
        try:
            bboxmessage = bboxdump(self.layer, column, self.filename.GetValue())
        finally:
            ThubanEndBusyCursor()

        if bboxmessage:
            dlg = wxScrolledMessageDialog(
                                self.parent, bboxmessage,
                                _("Bounding Box Dump %s") % self.layer.Title())
            dlg.ShowModal()

    def OnSelectFilename(self, event):
        """Bounding Box Dump Dialog event handler File Selection.

        Opens a file dialog to specify a file to dump into.
        """
        dlg = wxFileDialog(self, _("Dump Bounding Boxes To"), 
                       os.path.dirname(self.filename.GetValue()), 
                       os.path.basename(self.filename.GetValue()),
                       _("CSV Files (*.csv)|*.csv|") +
                       _("All Files (*.*)|*.*"),
                       wxSAVE|wxOVERWRITE_PROMPT)
        if dlg.ShowModal() == wxID_OK:
            self.filename.SetValue(dlg.GetPath())
            dlg.Destroy()
        else:
            dlg.Destroy()


def bboxdump(layer, column, filename):
    """Bounding Box Dump Processing

    layer    - Layer of shapes to be dumped
    column   - optional column to group shapes (else None)
    filename - optional filename to dump into (else empty string, i.e. dump
           to message dialog)
    """
    # Preparation
    shapelist = {}
    bboxmessage = []
 
    dlg= wxProgressDialog(_("Bounding Box Dump"),
                          _("Collecting shapes ..."),
                          layer.ShapeStore().NumShapes(),
                          None)

    cnt = 0
    step =  int(layer.ShapeStore().NumShapes() / 100.0)
    if step == 0:
        step = 1

    # Collect shape ids to be dumped
    if column is None:
        # A simple dump of shapes bbox is required
        for s in layer.ShapeStore().AllShapes():
            i = s.ShapeID()
            shapelist[i] = (i,)
            if cnt % step == 0:
                dlg.Update(cnt)
            cnt = cnt + 1
    else:
        # group them by column ... 
        for s in layer.ShapeStore().AllShapes():
            i = s.ShapeID()
            row = layer.ShapeStore().Table().ReadRowAsDict(i)
            att = row[column.name]
            if not shapelist.has_key(att):
                shapelist[att] = []
            shapelist[att].append(i)
            if cnt % step == 0:
                dlg.Update(cnt)
            cnt = cnt + 1

    dlg.Destroy()
    dlg= wxProgressDialog(_("Bounding Box Dump"),
                          _("Dump bounding boxes of selected shapes ..."),
                          len(shapelist),
                          None)
    cnt = 0
    step = int(len(shapelist) / 100.0)
    if step == 0:
        step = 1

    # Dump them, sorted
    keys = shapelist.keys()
    keys.sort()
    for key in keys:
        bbox = layer.ShapesBoundingBox(shapelist[key])
        bboxmessage.append("%.3f,%.3f,%.3f,%.3f,%s\n" % (
                            bbox[0], bbox[1], bbox[2], bbox[3], key))
        if cnt % step == 0:
            dlg.Update(cnt)
        cnt = cnt + 1
    dlg.Destroy()

    # finally
    if filename != '':
        bboxfile = file(filename, 'w+')
        bboxfile.write(string.join(bboxmessage))
        bboxfile.close()
        return None
    else:
        return string.join(bboxmessage)

def LayerBBoxDump(context):
    """Menu Handler BBoxDump
    """
    layer = context.mainwindow.canvas.SelectedLayer()
    if layer is not None:
        dlg = BBoxDumpDialog(context.mainwindow, _("Bounding Box Dump"),
                             layer = layer)
        dlg.ShowModal()


# bboxdump executed as an extension to Thuban

# register the new command
registry.Add(Command('bboxdump', _('BBox Dump'), LayerBBoxDump,
                     helptext = _('Dump Bounding Boxes of Layer Objects'),
                     sensitive = _has_selected_shape_layer))

# find the extensions menu (create it anew if not found)
extensions_menu = main_menu.FindOrInsertMenu('extensions', _('E&xtensions'))

# finally add the new entry to the extensions menu
extensions_menu.InsertItem('bboxdump')
1	jan	2356	# Copyright (C) 2003-2004 by Intevation GmbH
2	frank	2196	# Authors:
3			# Frank Koormann <[email protected]>
4			#
5			# This program is free software under the GPL (>=v2)
6			# Read the file COPYING coming with Thuban for details.
7
8			"""
9			Extend thuban with a bounding box dump.
10
11			Dumps the bounding boxes of all shapes of the selected layer.
12			An optional column can be specified to group the objects,
13			in this case the bounding box is a union of the separate boxes.
14			"""
15
16			__version__ = '$Revision$'
17	jan	2203	# $Source$
18			# $Id$
19	frank	2196
20			import os, sys
21	frank	2197	import string
22	frank	2196
23			from wxPython.wx import *
24			from wxPython.lib.dialogs import wxScrolledMessageDialog
25
26			from Thuban.UI.common import ThubanBeginBusyCursor, ThubanEndBusyCursor
27			from Thuban.UI.command import registry, Command
28			from Thuban.UI.mainwindow import main_menu, _has_selected_shape_layer
29	jan	2356	from Thuban.UI.extensionregistry import ExtensionDesc, ext_registry
30	frank	2196	from Thuban import _
31
32			import shapelib
33			import dbflib
34
35	jan	2356	ext_registry.add(ExtensionDesc(
36			name = 'bboxdump',
37			version = '1.0.0',
38			authors= [ 'Frank Koormann' ],
39			copyright = '2003-2004 Intevation GmbH',
40			desc = _("Dumps the bounding boxes of all\n" \
41			"shapes of the selected layer.")))
42
43	frank	2197	# Widget IDs
44	frank	2196	ID_FILENAME = 4001
45			ID_ATTRIBUTES = 4002
46			ID_SELFN = 4003
47
48			class BBoxDumpDialog(wxDialog):
49			"""Bounding Box Dump Dialog
50
51			Specify a filename for the dump and optionally a layer's column
52			field to group objects.
53			"""
54
55			def __init__(self, parent, title, layer = None):
56			wxDialog.__init__(self, parent, -1, title,
57			style = wxDEFAULT_DIALOG_STYLE\|wxRESIZE_BORDER)
58
59			if layer is None:
60			return wxID_CANCEL
61
62			# Store the layer
63			self.layer = layer
64
65			# Filename selection elements
66			self.filename = wxTextCtrl(self, ID_FILENAME, "")
67			self.button_selectfile = wxButton(self, ID_SELFN, _('Select...'))
68			EVT_BUTTON(self, ID_SELFN, self.OnSelectFilename)
69
70			# Column choice elements
71			self.choice_column = wxChoice(self, ID_ATTRIBUTES)
72			self.choice_column.Append(_('Select...'), None)
73			for col in self.layer.ShapeStore().Table().Columns():
74			self.choice_column.Append(col.name, col)
75			self.choice_column.SetSelection(0)
76
77			# Dialog button elements
78			self.button_dump = wxButton(self, wxID_OK, _("OK"))
79			EVT_BUTTON(self, wxID_OK, self.OnDump)
80			self.button_dump.SetDefault()
81			# TODO: Disable the OK button until a filename is entered ...
82			# self.button_dump.Enable(False)
83			self.button_cancel = wxButton(self, wxID_CANCEL, _("Cancel"))
84
85
86			# Dialog Layout: three horizontal box sizers.
87			topbox = wxBoxSizer(wxVERTICAL)
88
89			hbox = wxBoxSizer(wxHORIZONTAL)
90			topbox.Add(hbox, 0, wxALL\|wxEXPAND)
91			hbox.Add(wxStaticText(self, -1, _("File:")),
92			0, wxALL\|wxALIGN_CENTER_VERTICAL, 4)
93			hbox.Add(self.filename, 1, wxALL\|wxEXPAND, 4)
94			hbox.Add(self.button_selectfile, 0, wxALL, 4)
95
96			hbox = wxBoxSizer(wxHORIZONTAL)
97			topbox.Add(hbox, 0, wxALL\|wxEXPAND)
98			hbox.Add(wxStaticText(self, -1, _("Group by:")),
99			0, wxALL\|wxALIGN_CENTER_VERTICAL, 4)
100			hbox.Add(self.choice_column, 1, wxALL\|wxEXPAND, 4)
101
102			hbox = wxBoxSizer(wxHORIZONTAL)
103			topbox.Add(hbox, 0, wxALL\|wxEXPAND)
104			hbox.Add(self.button_dump, 0, wxALL\|wxALIGN_CENTER,
105			10)
106			hbox.Add(self.button_cancel, 0, wxALL\|wxALIGN_CENTER,
107			10)
108
109			# Finalize ...
110			self.SetAutoLayout(True)
111			self.SetSizer(topbox)
112			topbox.Fit(self)
113			topbox.SetSizeHints(self)
114
115			# Store for later use
116			self.parent = parent
117
118			def OnDump(self, event):
119			"""Bounding Box Dump Dialog event handler OK button.
120
121			Prepare the inputs from the dialog and call processing.
122			"""
123			i = self.choice_column.GetSelection()
124			column = self.choice_column.GetClientData(i)
125			self.Close()
126
127			ThubanBeginBusyCursor()
128			try:
129			bboxmessage = bboxdump(self.layer, column, self.filename.GetValue())
130			finally:
131			ThubanEndBusyCursor()
132
133			if bboxmessage:
134			dlg = wxScrolledMessageDialog(
135			self.parent, bboxmessage,
136	frank	2197	_("Bounding Box Dump %s") % self.layer.Title())
137	frank	2196	dlg.ShowModal()
138
139			def OnSelectFilename(self, event):
140			"""Bounding Box Dump Dialog event handler File Selection.
141
142			Opens a file dialog to specify a file to dump into.
143			"""
144			dlg = wxFileDialog(self, _("Dump Bounding Boxes To"),
145			os.path.dirname(self.filename.GetValue()),
146			os.path.basename(self.filename.GetValue()),
147			_("CSV Files (.csv)\|.csv\|") +
148			_("All Files (.)\|."),
149			wxSAVE\|wxOVERWRITE_PROMPT)
150			if dlg.ShowModal() == wxID_OK:
151			self.filename.SetValue(dlg.GetPath())
152			dlg.Destroy()
153			else:
154			dlg.Destroy()
155
156
157			def bboxdump(layer, column, filename):
158			"""Bounding Box Dump Processing
159
160			layer - Layer of shapes to be dumped
161			column - optional column to group shapes (else None)
162			filename - optional filename to dump into (else empty string, i.e. dump
163	frank	2197	to message dialog)
164	frank	2196	"""
165			# Preparation
166			shapelist = {}
167	frank	2197	bboxmessage = []
168	frank	2196
169	frank	2197	dlg= wxProgressDialog(_("Bounding Box Dump"),
170			_("Collecting shapes ..."),
171			layer.ShapeStore().NumShapes(),
172			None)
173
174			cnt = 0
175			step = int(layer.ShapeStore().NumShapes() / 100.0)
176			if step == 0:
177			step = 1
178
179	frank	2196	# Collect shape ids to be dumped
180			if column is None:
181			# A simple dump of shapes bbox is required
182	frank	2197	for s in layer.ShapeStore().AllShapes():
183			i = s.ShapeID()
184	frank	2196	shapelist[i] = (i,)
185	frank	2197	if cnt % step == 0:
186			dlg.Update(cnt)
187			cnt = cnt + 1
188	frank	2196	else:
189			# group them by column ...
190	frank	2197	for s in layer.ShapeStore().AllShapes():
191			i = s.ShapeID()
192	frank	2196	row = layer.ShapeStore().Table().ReadRowAsDict(i)
193			att = row[column.name]
194			if not shapelist.has_key(att):
195			shapelist[att] = []
196			shapelist[att].append(i)
197	frank	2197	if cnt % step == 0:
198			dlg.Update(cnt)
199			cnt = cnt + 1
200	frank	2196
201	frank	2197	dlg.Destroy()
202			dlg= wxProgressDialog(_("Bounding Box Dump"),
203			_("Dump bounding boxes of selected shapes ..."),
204			len(shapelist),
205			None)
206			cnt = 0
207			step = int(len(shapelist) / 100.0)
208			if step == 0:
209			step = 1
210
211	frank	2196	# Dump them, sorted
212			keys = shapelist.keys()
213			keys.sort()
214			for key in keys:
215			bbox = layer.ShapesBoundingBox(shapelist[key])
216	frank	2197	bboxmessage.append("%.3f,%.3f,%.3f,%.3f,%s\n" % (
217			bbox[0], bbox[1], bbox[2], bbox[3], key))
218			if cnt % step == 0:
219			dlg.Update(cnt)
220			cnt = cnt + 1
221			dlg.Destroy()
222	frank	2196
223			# finally
224			if filename != '':
225	frank	2197	bboxfile = file(filename, 'w+')
226			bboxfile.write(string.join(bboxmessage))
227	frank	2196	bboxfile.close()
228			return None
229			else:
230	frank	2197	return string.join(bboxmessage)
231	frank	2196
232			def LayerBBoxDump(context):
233			"""Menu Handler BBoxDump
234			"""
235			layer = context.mainwindow.canvas.SelectedLayer()
236			if layer is not None:
237			dlg = BBoxDumpDialog(context.mainwindow, _("Bounding Box Dump"),
238			layer = layer)
239			dlg.ShowModal()
240
241
242	frank	2197	# bboxdump executed as an extension to Thuban
243	frank	2196
244			# register the new command
245			registry.Add(Command('bboxdump', _('BBox Dump'), LayerBBoxDump,
246			helptext = _('Dump Bounding Boxes of Layer Objects'),
247			sensitive = _has_selected_shape_layer))
248
249			# find the extensions menu (create it anew if not found)
250	jan	2203	extensions_menu = main_menu.FindOrInsertMenu('extensions', _('E&xtensions'))
251	frank	2196
252			# finally add the new entry to the extensions menu
253			extensions_menu.InsertItem('bboxdump')
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision