Merge pull request #86 from j9ac9k/vcd-websocket-fixes

websocket fixes and hyphens for command line args, not underscores

src/codem/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.25.4.dev0"
+__version__ = "0.25.4"
 
 import codem.lib.log as log
 import codem.lib.resources as resources

src/codem/__main__.py

@@ -0,0 +1,3 @@
+from .main import main
+
+main()

src/codem/lib/log.py

@@ -92,7 +92,11 @@ def __init__(self, config: Dict[str, Any]):
         elif config["LOG_TYPE"] == "websocket":
             formatter = CustomJsonFormatter()
             self.relay = websocket.WebSocket()
-            self.relay.connect(f'ws://{config["WEBSOCKET_URL"]}/websocket')
+            url = f'ws://{config["WEBSOCKET_URL"]}/websocket'
+            try:
+                self.relay.connect(url)
+            except ConnectionRefusedError as err:
+                raise ConnectionRefusedError(f"Connection Refused to {url}")
             log_handler = WebSocketHandler("DEBUG", websocket=self.relay)
             log_handler.setFormatter(formatter)
         else:

src/codem/lib/progress.py

@@ -19,7 +19,11 @@ def __init__(self, url: str) -> None:
             self.url = url
 
         def __enter__(self) -> Any:
-            self.ws.connect(f"ws://{self.url}/websocket")
+            url = f'ws://{self.url}/websocket'
+            try:
+                self.ws.connect(url)
+            except ConnectionRefusedError as err:
+                raise ConnectionRefusedError(f"Connection Refused to {url}")
             return self
 
         def __exit__(self, *args: Any, **kwargs: Any) -> None:

src/codem/main.py

@@ -170,98 +170,98 @@ def get_args() -> argparse.Namespace:
         help="path to the area of interest file",
     )
     ap.add_argument(
-        "--min_resolution",
+        "--min-resolution",
         "-min",
         type=float,
         default=CodemRunConfig.MIN_RESOLUTION,
         help="minimum pipeline data resolution",
     )
     ap.add_argument(
-        "--dsm_akaze_threshold",
+        "--dsm-akaze-threshold",
         "-dat",
         type=float,
         default=0.0001,
         help="AKAZE feature detection response threshold",
     )
     ap.add_argument(
-        "--dsm_lowes_ratio",
+        "--dsm-lowes-ratio",
         "-dlr",
         type=float,
         default=0.9,
         help="feature matching relative strength control",
     )
     ap.add_argument(
-        "--dsm_ransac_max_iter",
+        "--dsm-ransac-max-iter",
         "-drmi",
         type=int,
         default=10000,
         help="max iterations for the RANSAC algorithm",
     )
     ap.add_argument(
-        "--dsm_ransac_threshold",
+        "--dsm-ransac-threshold",
         "-drt",
         type=float,
         default=10,
         help="maximum residual error for a feature matched pair to be included in RANSAC solution",
     )
     ap.add_argument(
-        "--dsm_solve_scale",
+        "--dsm-solve-scale",
         "-dss",
         type=str2bool,
         default=True,
         help="boolean to include or exclude scale from the solved registration transformation",
     )
     ap.add_argument(
-        "--dsm_strong_filter",
+        "--dsm-strong-filter",
         "-dsf",
         type=float,
         default=10,
         help="stddev of the large Gaussian filter used to normalize DSM prior to feature extraction",
     )
     ap.add_argument(
-        "--dsm_weak_filter",
+        "--dsm-weak-filter",
         "-dwf",
         type=float,
         default=1,
         help="stddev of the small Gaussian filter used to normalize the DSM prior to feature extraction",
     )
     ap.add_argument(
-        "--icp_angle_threshold",
+        "--icp-angle-threshold",
         "-iat",
         type=float,
         default=0.001,
         help="minimum change in Euler angle between ICP iterations",
     )
     ap.add_argument(
-        "--icp_distance_threshold",
+        "--icp-distance-threshold",
         "-idt",
         type=float,
         default=0.001,
         help="minimum change in translation between ICP iterations",
     )
     ap.add_argument(
-        "--icp_max_iter",
+        "--icp-max-iter",
         "-imi",
         type=int,
         default=100,
         help="max iterations of the ICP algorithm",
     )
     ap.add_argument(
-        "--icp_rmse_threshold",
+        "--icp-rmse-threshold",
         "-irt",
         type=float,
         default=0.0001,
         help="minimum relative change between iterations in the RMSE",
     )
     ap.add_argument(
-        "--icp_robust",
+        "--icp-robust",
         "-ir",
         type=str2bool,
         default=True,
         help="boolean to include or exclude robust weighting in registration solution",
     )
     ap.add_argument(
-        "--icp_solve_scale",
+        "--icp-solve-scale",
         "-iss",
         type=str2bool,
         default=True,
@@ -285,7 +285,7 @@ def get_args() -> argparse.Namespace:
         ),
     )
     ap.add_argument(
-        "--output_dir", "-o", type=str, help="Directory to place registered output."
+        "--output-dir", "-o", type=str, help="Directory to place registered output."
     )
     ap.add_argument(
         "--version",
@@ -294,7 +294,7 @@ def get_args() -> argparse.Namespace:
         help="Display codem version information",
     )
     ap.add_argument(
-        "--log_type",
+        "--log-type",
         "-l",
         type=str,
         default=CodemRunConfig.LOG_TYPE,
@@ -332,6 +332,7 @@ def create_config(args: argparse.Namespace) -> CodemParameters:
         TIGHT_SEARCH=args.tight_search,
         OUTPUT_DIR=args.output_dir,
         LOG_TYPE=args.log_type,
+        WEBSOCKET_URL=args.websocket_url
     )
     config_dict = dataclasses.asdict(config)
     log = Log(config_dict)

src/vcd/__main__.py

@@ -0,0 +1,3 @@
+from .main import main
+
+main()

src/vcd/main.py

@@ -34,6 +34,8 @@ class VcdRunConfig:
     TRUST_LABELS: bool = False
     COMPUTE_HAG: bool = False
     LOG_TYPE: str = "rich"
+    WEBSOCKET_URL: str = "127.0.0.1:8889"
+
 
     def __post_init__(self) -> None:
         # set output directory
@@ -108,25 +110,25 @@ def get_args() -> argparse.Namespace:
         help="Raster output resolution",
     )
     ap.add_argument(
-        "--min_points",
+        "--min-points",
         type=int,
         default=VcdRunConfig.MIN_POINTS,
         help="Minimum points to cluster around",
     )
     ap.add_argument(
-        "--cluster_tolerance",
+        "--cluster-tolerance",
         type=float,
         default=VcdRunConfig.CLUSTER_TOLERANCE,
         help="Cluster tolerance used by pdal.Filter.cluster",
     )
     ap.add_argument(
-        "--cull_cluster_ids",
+        "--cull-cluster-ids",
         type=str,
         default=",".join(map(str, VcdRunConfig.CULL_CLUSTER_IDS)),
         help="Comma separated list of cluster IDs to cull when producing the meshes",
     )
     ap.add_argument(
-        "--class_labels",
+        "--class-labels",
         type=str,
         default=",".join(map(str, VcdRunConfig.CLASS_LABELS)),
         help="Comma separated list of classification labels to use when producing the meshes",
@@ -146,7 +148,7 @@ def get_args() -> argparse.Namespace:
         ),
     )
     ap.add_argument(
-        "--trust_labels",
+        "--trust-labels",
         action="store_true",
         help=(
             "Trusts existing classification labels in the removal of vegetation/noise, "
@@ -155,15 +157,15 @@ def get_args() -> argparse.Namespace:
         ),
     )
     ap.add_argument(
-        "--compute_hag",
+        "--compute-hag",
         action="store_true",
         help=(
             "Compute height above ground between after scan (non-ground) and before "
             "scan (ground), otherwise compute to nearest neighbor from after to before."
         ),
     )
     ap.add_argument(
-        "--output_dir", "-o", type=str, help="Directory to place VCD output"
+        "--output-dir", "-o", type=str, help="Directory to place VCD output"
     )
     ap.add_argument(
         "--version",
@@ -172,12 +174,18 @@ def get_args() -> argparse.Namespace:
         help="Display codem version information",
     )
     ap.add_argument(
-        "--log_type",
+        "--log-type",
         "-l",
         type=str,
         default=VcdRunConfig.LOG_TYPE,
         help="Specify how to log codem output, options include websocket, rich or console",
     )
+    ap.add_argument(
+        "--websocket-url",
+        type=str,
+        default=VcdRunConfig.WEBSOCKET_URL,
+        help="Url to websocket receiver to connect to"
+    )
     return ap.parse_args()
 
 
@@ -197,6 +205,7 @@ def create_config(args: argparse.Namespace) -> VCDParameters:
         COMPUTE_HAG=args.compute_hag,
         OUTPUT_DIR=args.output_dir,
         LOG_TYPE=args.log_type,
+        WEBSOCKET_URL=args.websocket_url
     )
     config_dict = dataclasses.asdict(config)
     log = Log(config_dict)
@@ -234,12 +243,14 @@ def run_no_console(config: VCDParameters) -> None:
     from codem.lib.progress import WebSocketProgress
 
     logger = config["log"].logger
-    for key, value in config.items():
-        logger.info(f"{key} = {value}")
+
 
     with WebSocketProgress(config["WEBSOCKET_URL"]) as progress:
         change_detection = progress.add_task("Vertical Change Detection...", total=100)
-
+
+        for key, value in config.items():
+            logger.info(f"{key} = {value}")
+
         before = PointCloud(config, "BEFORE")
         progress.advance(change_detection, 14)
 
@@ -342,7 +353,7 @@ def main() -> None:
     config = create_config(args)
     if config["LOG_TYPE"] == "rich":
         run_rich_console(config)
-    elif config["LOG_TYPE"] == "websockets":
+    elif config["LOG_TYPE"] == "websocket":
         run_no_console(config)
     else:
         run_stdout_console(config)  # type: ignore