jupyter/tool_3d_mask.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# How to 3D mask with vapc"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Notebook Overview\n",
    "\n",
    "This notebook demonstrates how to use the `vapc` library to perform 3D masking on point cloud data. \n",
    "\n",
    "The following steps have been completed so far:\n",
    "\n",
    "1. Importing the `vapc` library and disabled trace and timeit modes.\n",
    "2. Defining the parameters :\n",
    "\n",
    "   - **Input File**: Specifies the path to the input `\".laz\"` or `\".las\"` file.\n",
    "   - **Output Directory**: Defines where the processed file will be saved.\n",
    "   - **Voxel Size**: Sets the size of each voxel for spatial aggregation.\n",
    "   - **Save As**: Indicates the format of the output format (`\".laz\"`, `\".las\"`, `\".ply\"`).\n",
    "   - **Reduce To**: Indicates if the point cloud should be reduced to a single point per voxel (`False`, `\"center_of_gravity\"`, `\"center_of_voxel\"`, `\"closest_to_center_of_gravity\"`).\n",
    "   - **vapc_command**: Dictionary containing configurations for the masking process.\n",
    "\n",
    "3. Executing the user-defined `vapc` command to apply a mask to the input point cloud data and saving the output to the indicated folder."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import vapc\n",
    "\n",
    "# Activate silent mode:\n",
    "vapc.enable_trace(False)\n",
    "vapc.enable_timeit(False)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Adding new dimension raw_classification\n",
      "Adding new dimension scan_angle_rank\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "True"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "infile = r\"../tests/test_data/vapc_in.laz\"\n",
    "out_dir = r\"../tests/test_data_output/\"\n",
    "voxel_size = 0.1\n",
    "save_as = \".laz\"\n",
    "reduce_to = False\n",
    "vapc_command = {\n",
    "            \"tool\":\"mask\",\n",
    "            \"args\":{\n",
    "                    \"maskfile\":r\"../tests/test_data/small_mask.laz\",\n",
    "                    \"segment_in_or_out\":\"in\",\n",
    "                    \"buffer_size\":1\n",
    "                }\n",
    "        }\n",
    "\n",
    "vapc.do_vapc_on_files(\n",
    "    file=infile,\n",
    "    out_dir=out_dir,\n",
    "    voxel_size=voxel_size,\n",
    "    vapc_command=vapc_command,\n",
    "    reduce_to=reduce_to,\n",
    "    save_as=save_as)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.16"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}