Merge pull request #30 from MrClock8163/feature/converter-commands

Add format converter commands

Author: MrClock8163

CHANGELOG.md

@@ -9,14 +9,18 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- Added aliases to multiple commands and command groups
 - Added resection calculation logic
 - Added station calculation (`calc station`) using resection from set
   measurements
 - Added station uploading (`upload station`) to set station coordinates and
   orientation
+- Added CSV to targets JSON conversion (`convert csv-targets`)
+- Added targets JSON to CSV conversion (`convert targets-csv`)
+- Added GSI to targets JSON conversion (`convert gsi-targets`)
+- Added targets JSON to GSI conversion (`convert targets-gsi`)
 - Added logging options to `iman` root command
 - Added logging to instrument connected commands
-- Added aliases to multiple commands and command groups
 - Added `dateformat` option to set measurement
 - Added `timeformat` option to set measurement
 
@@ -46,6 +50,7 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Removed
 
+- Removed importer command group and subcommands (`import`)
 - Removed logging options from set measurement
 - Removed `format` option from set measurement
 

docs/commands/sets/index.rst

@@ -13,3 +13,4 @@ measurements to predefined target points.
     validate
     merge
     calc
+    to_gsi

docs/commands/sets/to_gsi.rst

@@ -0,0 +1,31 @@
+Convert to GSI
+==============
+
+To help in further processing of the set measurements, the data can be
+converted into the Leica GSI8 or GSI16 exchange formats.
+
+Requirements
+------------
+
+- Session result files from previous set measurements
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Converting with default units
+
+    iman convert set-gsi set_measurement.json measurements.gsi
+
+.. code-block:: shell
+    :caption: Converting to specific units
+
+    iman convert set-gsi --length-unit cmm --angle-unit gon set_measurement.json measurements.gsi
+
+Usage
+-----
+
+.. click:: instrumentman.setmeasurement:cli_convert_set_to_gsi
+    :prog: iman convert set-gsi
+
+

docs/commands/targets/from_csv.rst

@@ -0,0 +1,35 @@
+Convert from CSV
+================
+
+A target point definition can be created by importing the point coordinates
+from a variable column CSV file. Coordinate and point name columns are
+mandatory.
+
+Requirements
+------------
+
+- Target point coordinates in CSV format
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Importing coordinates
+
+    iman convert csv-targets -c pt -c e -c n -c h targets.csv targets.json
+
+.. code-block:: shell
+    :caption: Importing targets with matching prisms and target heights
+
+    iman convert csv-targets -c pt -c e -c n -c h --reflector MINI --height 0.12 targets.csv targets.json
+
+.. code-block:: shell
+    :caption: Importing coordinates but ignoring second (possibly code) column in CSV
+
+    iman convert csv-targets -c pt -c ignore -c e -c n -c h targets.csv targets.json
+
+Usage
+-----
+
+.. click:: instrumentman.setup:cli_convert_csv_to_targets
+    :prog: iman convert csv-targets

docs/commands/targets/from_gsi.rst

@@ -0,0 +1,34 @@
+Convert from GSI
+================
+
+A common output of Leica total stations is the Leica GSI format. Cartesian
+coordinate and polar measurements can be converted to a target definition.
+
+Requirements
+------------
+
+- Target point measurements in GSI8 or GSI16 format
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Importing coordinates
+
+    iman convert gsi-targets measurements.gsi targets.json
+
+.. code-block:: shell
+    :caption: Importing targets from polar measurements
+
+    iman convert gsi-targets --station 1.212 -5.439 0.934 --iheight 0.000 measurements.gsi targets.json
+
+.. code-block:: shell
+    :caption: Importing targets with identical reflectors and target heights
+
+    iman convert gsi-targets --reflector MINI --height 0.0 measurements.gsi targets.json
+
+Usage
+-----
+
+.. click:: instrumentman.setup:cli_convert_gsi_to_targets
+    :prog: iman convert gsi-targets

docs/commands/targets/import.rst

@@ -18,4 +18,7 @@ to create such a definition.
     :maxdepth: 1
 
     measure
-    import
+    from_csv
+    to_csv
+    from_gsi
+    to_gsi

docs/commands/targets/index.rst

@@ -0,0 +1,24 @@
+Convert to CSV
+==============
+
+If necessary, the target definition can be converted into an ordinary CSV
+coordinate list file for easier use in other applications.
+
+Requirements
+------------
+
+- Target definition JSON file
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Exporting coordinates
+
+    iman convert targets-csv -c pt -c e -c n -c h targets.json targets.csv
+
+Usage
+-----
+
+.. click:: instrumentman.setup:cli_convert_targets_to_csv
+    :prog: iman convert targets-csv

docs/commands/targets/to_csv.rst

@@ -0,0 +1,32 @@
+Convert to GSI
+==============
+
+Sometimes it is necessary to use the target coordinates for further
+measurements. To simplify the process, the targets definition file can be
+converted into a Leica GSI8 or GSI16 file, which is a common exchange format
+for Leica instruments.
+
+Requirements
+------------
+
+- Target definition JSON file
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Exporting coordinates
+
+    iman convert targets-gsi targets.json targets.gsi
+
+.. code-block:: shell
+    :caption: Exporting coordinates to GSI16 with 0.00001m precision
+
+    iman convert targets-gsi --gsi16 --precision cmm targets.json targets.gsi
+
+Usage
+-----
+
+.. click:: instrumentman.setup:cli_convert_targets_to_gsi
+    :prog: iman convert targets-gsi
+

docs/commands/targets/to_gsi.rst

@@ -13,7 +13,7 @@ readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
     "pyserial ~= 3.5.0",
-    "geocompy >= 0.11.0",
+    "geocompy >= 0.12.0",
     "rich >= 13.9",
     "textual >= 3.2.0",
     "rapidfuzz ~= 3.13.0",