Skip to content

README.md

Latest commit

 

History

History
129 lines (103 loc) · 7.65 KB

README.md

File metadata and controls

129 lines (103 loc) · 7.65 KB
Raw

Data Wizard — Documentation

Data Wizard (plugin name in QGIS: IB-Tool-Data-Wizard) is a companion QGIS plugin to IB-Tool 3. It automates the manual ATKIS-to-input-data workflow described in IB-Tool 3's own tutorial: given a folder of raw ATKIS Basis-DLM data and a separately supplied building-footprint file, it produces the HU, RN, and Aux GeoPackages IB-Tool 3 needs — reprojecting, optionally clipping, and mapping/merging the raw layers automatically.

This document covers Data Wizard itself — installation is out of scope (see Plugin Installation Paths below for the short version). For everything about the target data format, the underlying manual workflow, and IB-Tool 3's own usage, see Relationship to IB-Tool 3's Documentation.

What It Does

Data Wizard automates steps 2–7 of IB-Tool 3's data preparation tutorial — determining the project CRS, optional clipping to a study area, mapping raw ATKIS layers into HU/RN/Aux, and export as GeoPackage. Only step 1 (downloading the raw data yourself) and step 8 (final validation via IB-Tool 3's own Check button) stay outside the plugin.

  1. Project CRS is fixed from the CRS of ver01_l.shp in the source folder. Any other raw layer — including the building-footprint file and the optional study-area polygon — that uses a different CRS is reprojected automatically before further processing.
  2. Clipping happens only if a study-area polygon is supplied. Multiple polygons in that file are dissolved into a single clip mask first. If no study area is given, raw layers are processed at their full extent.
  3. Mapping & merging follows a fixed rule (see Output Layers below) — the same rule documented in IB-Tool 3's data-preparation.md, now applied automatically instead of by hand in QGIS.
  4. HU function-code field: if the building file doesn't already carry fkt, gfkzshh, or funktion, the plugin scans its columns for one matching the ATKIS building object-art code pattern (31001_xxxx). Exactly one match → copied automatically into a new funktion column. No match, or more than one → a picker dialog lets you choose the correct column (or skip). The original column is never renamed or removed, and the source file itself is never modified — only the generated HU.gpkg gets the extra column.

Requirements

Input Required What it is
Quellordner (source folder) yes A folder containing exactly these seven ATKIS Basis-DLM shapefiles, flat (no subfolders searched): ver01_l.shp, ver02_l.shp, ver03_l.shp, veg02_f.shp, veg03_f.shp, gew01_f.shp, gew01_l.shp
Gebäudedatei (building file) yes A separate building-footprint file (.shp/.gpkg), chosen individually — not expected to sit in the source folder, since it typically comes from a different data source (e.g. ALKIS)
Untersuchungsgebiet (study area) no A polygon file (.shp/.gpkg) to clip everything to; leave empty to process the full extent of the raw data
Zielordner (target folder) yes Output folder for the three GeoPackages; must already exist

Usage

  1. Open the plugin from the toolbar/menu (IB-Tool-Data-Wizard).
  2. Fill in the four fields above (browse buttons for each). Picking the building file immediately runs the function-code field check — a picker dialog may appear if it can't be resolved automatically.
  3. Click OK. Processing runs in the background (QGIS Task Manager); progress and any warnings appear as log messages ("Data Wizard" in View → Panels → Log Messages) and in the message bar.
  4. On completion, HU.gpkg, RN.gpkg, and AUX_L.gpkg are in the target folder. Load them into IB-Tool 3 along with a Part layer and (optionally) a filter file, and run IB-Tool 3's own Check — see IB-Tool 3's quickstart.md for that step. Data Wizard does not run IB-Tool 3's validation checklist itself.

Output Layers

Output file Source layers Rule
HU.gpkg Building file (chosen separately) Copied as-is, all fields kept, no forced singlepart. funktion column added if needed (see above).
RN.gpkg ver01_l, ver02_l Merged, forced singlepart
AUX_L.gpkg ver03_l (as-is); veg02_f (dissolve → lines); veg03_f filtered to OBJART 43005/43006 (dissolve → lines); gew01_f (lines); gew01_l (as-is) Merged, forced singlepart

Out of Scope

  • Part (partitioning layer) — produced by the sibling plugin IB-Tool (Partitioning); Data Wizard doesn't touch it.
  • Filter file — a separately maintained, largely static file; Data Wizard doesn't touch it.
  • Validation — Data Wizard does not re-implement IB-Tool 3's input-data.md validation checklist. The one exception is a non-blocking log warning if HU ends up with no function-code field at all. The authoritative check is IB-Tool 3's own Check button.

Architecture

File Responsibility
data_wizard.py Plugin entry point (Data_Wizard class); dialog invocation, input validation, background-task dispatch (_AtkisTask, a QgsTask subclass)
data_wizard_dialog.py / data_wizard_dialog_base.ui Dialog UI — the four input fields, browse handlers, HU function-field detection/picker
processor.py All processing logic — CRS handling, clipping, the HU/RN/Aux mapping rules, GeoPackage writing. Pure functions, no UI code, so it runs safely inside the background QgsTask

Relationship to IB-Tool 3's Documentation

Data Wizard is a data-preparation front-end for IB-Tool 3 — it doesn't replace IB-Tool 3's own documentation, which remains the authority on the target data format and on IB-Tool 3 itself. Both plugins now live in their own GitHub repositories (both private, under the IB-Tool organization), so the links below point at IB-Tool 3's repository on GitHub rather than a local sibling folder — following them requires being logged into GitHub with access to that org.

For... See
The exact target specification Data Wizard's output must satisfy (field requirements, geometry types, minimum feature counts, the full validation checklist) input-data.md
The manual workflow this plugin automates (background/rationale for each step) data-preparation.md
Where to download raw ATKIS data per German state data-sources.md
Running IB-Tool 3 itself once Data Wizard's outputs are ready quickstart.md
How IB-Tool 3's algorithm actually works how-it-works.md
IB-Tool 3's own code structure plugin-architecture.md

Plugin Installation Paths

Same as any QGIS plugin — see IB-Tool 3's plugin-architecture.md → Plugin Installation Paths for the per-OS paths; Data Wizard's own folder name (data_wizard) is already a valid Python identifier, so no renaming is needed for QGIS to load it (unlike IB-Tool 3's IB-Tool-3 → ibtool rename requirement).