diff --git a/docs/_config.yaml b/docs/_config.yaml deleted file mode 100644 index ac8cfa5..0000000 --- a/docs/_config.yaml +++ /dev/null @@ -1,17 +0,0 @@ -title: Segment-Lidar Documentation -description: Documentation for segment-lidar package. - -# Development server config, needed to load some of the content -webrick: - headers: - Access-Control-Allow-Origin: "*" - -# Theme settings -site_author: Anass Yarroudh -repo_url: 'https://github.com/Yarroudh/segment-lidar' -edit_on_github: true -github_docs_folder: false -sticky_navigation: true -prev_next_buttons_location: both -search_enabled: true -hljs_style: github-gist diff --git a/docs/_sources/tutorial.rst.txt b/docs/_sources/tutorial.rst.txt index 033b616..376722a 100644 --- a/docs/_sources/tutorial.rst.txt +++ b/docs/_sources/tutorial.rst.txt @@ -63,6 +63,8 @@ The pinhole view can be defined either by providing the intrinsic and extrinsic viewpoint = view.PinholeView(intrinsic=K, rotation=R, translation=T) +K is a 3x3 intrinsic matrix, R is a 3x3 rotation matrix and T is a 3x1 translation vector. + or by using the interactive mode: .. code-block:: python @@ -99,7 +101,7 @@ labels `labels`: .. code-block:: python - labels, *_ = model.segment(points=cloud, image_path="raster.tif", labels_path="labeled.tif") + labels, *_ = model.segment(points=cloud, view=view, image_path="raster.tif", labels_path="labeled.tif") 7. Save results to **.las/.laz** file using the **write** method of the SamLidar instance: @@ -126,7 +128,7 @@ Now, the entire code should look like this: cloud, non_ground, ground = model.csf(points) # Segment the point cloud - labels, *_ = instance.segment(points=cloud, image_path="raster.tif", labels_path="labeled.tif") + labels, *_ = instance.segment(points=cloud, view=view, image_path="raster.tif", labels_path="labeled.tif") # Save results model.write(points=points, non_ground=non_ground, ground=ground, segment_ids=labels, save_path="segmented.las") diff --git a/docs/searchindex.js b/docs/searchindex.js index a60c8f9..44f671e 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["citation", "index", "installation", "license", "module", "tutorial"], "filenames": ["citation.rst", "index.rst", "installation.rst", "license.rst", "module.rst", "tutorial.rst"], "titles": ["Citation", "Welcome to segment-lidar\u2019s documentation!", "Installation", "License", "API", "Basic tutorial"], "terms": {"The": [0, 1, 4, 5], "us": [0, 1, 2, 3, 4, 5], "open": [0, 1], "sourc": [0, 1, 2, 3], "softwar": [0, 3], "repositori": [0, 1, 5], "ha": 0, "becom": 0, "increasingli": 0, "preval": 0, "scientif": 0, "research": [0, 1], "If": [0, 1, 2, 4], "you": [0, 1, 2, 5], "thi": [0, 1, 2, 3, 4, 5], "your": [0, 1, 5], "pleas": [0, 1, 2, 5], "make": [0, 2, 5], "sure": [0, 2, 5], "cite": [0, 1], "appropri": 0, "work": [0, 1], "recommend": [0, 2], "format": [0, 4], "i": [0, 1, 2, 3, 4, 5], "provid": [0, 3, 4, 5], "accompani": 0, "bibtex": 0, "addition": [0, 5], "compli": 0, "ani": [0, 3, 4], "licens": [0, 1], "term": 0, "condit": [0, 3], "associ": 0, "misc": [0, 1], "yarroudh": [0, 1, 2, 3], "2023": [0, 1, 3], "samlidar": [0, 1, 2, 4, 5], "author": [0, 1, 3], "anass": [0, 1, 3], "titl": [0, 1], "lidar": [0, 5], "automat": [0, 1, 5], "unsupervis": [0, 1, 5], "segment": [0, 4, 5], "anyth": [0, 1, 5], "model": [0, 1], "sam": [0, 1, 5], "from": [0, 1, 2, 3, 4, 5], "meta": [0, 1], "ai": [0, 1], "year": [0, 1], "howpublish": [0, 1], "github": [0, 1, 2], "url": [0, 1], "http": [0, 1, 2], "com": [0, 1, 2], "A": [0, 3, 4], "retriev": [0, 5], "packag": 1, "specif": [1, 3], "design": 1, "instanc": [1, 5], "aerial": 1, "data": [1, 3, 4], "It": 1, "bring": 1, "togeth": 1, "power": 1, "develop": 1, "geospati": [1, 4, 5], "samgeo": 1, "solut": 1, "paper": 1, "publish": 1, "veri": 1, "soon": 1, "latest": 1, "code": [1, 3, 5], "avail": 1, "build": 1, "top": [1, 4, 5], "exist": 1, "when": [1, 5], "algorithm": [1, 4, 5], "within": 1, "also": 1, "origin": [1, 4], "specifi": [1, 5], "instal": [1, 5], "basic": 1, "tutori": 1, "api": 1, "citat": 1, "contact": 1, "via": 1, "email": 1, "ayarroudh": 1, "ulieg": [1, 3], "akharroubi": 1, "question": 1, "issu": 1, "tracker": 1, "bug": 1, "report": 1, "featur": 1, "request": 1, "addit": 1, "etc": 1, "guid": 2, "describ": 2, "pypi": 2, "befor": [2, 5], "need": 2, "run": 2, "follow": [2, 3, 5], "command": 2, "conda": 2, "n": [2, 4], "python": [2, 5], "3": [2, 3, 4, 5], "9": [2, 4], "activ": 2, "new": [2, 5], "name": [2, 3], "we": [2, 5], "feel": 2, "free": 2, "test": [2, 5], "other": [2, 3], "version": 2, "note": 2, "mandatori": 2, "highli": 2, "altern": 2, "can": [2, 4, 5], "virtualenv": 2, "easili": 2, "pip": [2, 5], "Or": 2, "git": 2, "clone": 2, "cd": 2, "setup": 2, "py": 2, "To": 2, "correctli": 2, "c": [2, 3], "import": [2, 5], "segment_lidar": [2, 4, 5], "print": 2, "__version__": 2, "success": 2, "should": [2, 5], "see": [2, 5], "have": [2, 4, 5], "bsd": 3, "claus": 3, "copyright": 3, "univers": 3, "li\u00e8g": 3, "geomat": 3, "unit": [3, 4], "redistribut": 3, "binari": 3, "form": [3, 5], "without": 3, "modif": 3, "ar": [3, 4, 5], "permit": 3, "met": 3, "must": 3, "retain": 3, "abov": 3, "notic": 3, "list": [3, 5], "disclaim": 3, "reproduc": 3, "document": [3, 5], "materi": 3, "distribut": 3, "neither": 3, "holder": 3, "nor": 3, "its": [3, 5], "contributor": 3, "mai": 3, "endors": 3, "promot": 3, "product": 3, "deriv": 3, "prior": 3, "written": 3, "permiss": 3, "BY": 3, "THE": 3, "AND": 3, "AS": 3, "express": 3, "OR": 3, "impli": 3, "warranti": 3, "includ": 3, "BUT": 3, "NOT": 3, "limit": 3, "TO": 3, "OF": 3, "merchant": 3, "fit": 3, "FOR": 3, "particular": 3, "purpos": [3, 5], "IN": 3, "NO": 3, "event": 3, "shall": 3, "BE": 3, "liabl": 3, "direct": 3, "indirect": 3, "incident": 3, "special": 3, "exemplari": 3, "consequenti": 3, "damag": 3, "procur": 3, "substitut": 3, "good": 3, "servic": 3, "loss": 3, "profit": 3, "busi": 3, "interrupt": 3, "howev": 3, "caus": 3, "ON": 3, "theori": 3, "liabil": 3, "whether": [3, 4, 5], "contract": 3, "strict": 3, "tort": 3, "neglig": 3, "otherwis": 3, "aris": 3, "wai": 3, "out": 3, "even": 3, "IF": 3, "advis": 3, "possibl": [3, 5], "SUCH": 3, "class": [4, 5], "ckpt_path": [4, 5], "str": 4, "model_typ": [4, 5], "vit_h": [4, 5], "resolut": [4, 5], "float": 4, "0": [4, 5], "25": [4, 5], "height": 4, "int": 4, "512": 4, "width": 4, "distance_threshold": 4, "none": [4, 5], "devic": [4, 5], "cuda": [4, 5], "sam_kwarg": [4, 5], "bool": 4, "fals": [4, 5], "intrins": [4, 5], "ndarrai": 4, "rotat": [4, 5], "translat": [4, 5], "interact": 4, "base": 4, "object": 4, "csf": [4, 5], "point": [4, 5], "class_threshold": [4, 5], "5": [4, 5], "cloth_resolut": 4, "2": [4, 5], "iter": 4, "500": [4, 5], "slope_smooth": 4, "tupl": 4, "appli": [4, 5], "cloth": [4, 5], "simul": [4, 5], "filter": [4, 5], "ground": [4, 5], "cloud": [4, 5], "paramet": [4, 5], "np": 4, "input": [4, 5], "numpi": 4, "arrai": 4, "where": 4, "each": 4, "row": 4, "repres": 4, "x": 4, "y": 4, "z": 4, "coordin": 4, "option": [4, 5], "threshold": 4, "valu": [4, 5], "classifi": 4, "non": [4, 5], "default": [4, 5], "number": 4, "boolean": 4, "indic": [4, 5], "enabl": 4, "slope": 4, "smooth": 4, "return": [4, 5], "contain": [4, 5], "three": 4, "indinc": 4, "type": [4, 5], "mask": [4, 5], "crop_n_lay": [4, 5], "1": [4, 5], "crop_n_points_downscale_factor": [4, 5], "min_mask_region_area": [4, 5], "200": [4, 5], "points_per_sid": [4, 5], "pred_iou_thresh": [4, 5], "stability_score_thresh": [4, 5], "92": [4, 5], "read": [4, 5], "path": [4, 5], "classif": 4, "file": [4, 5], "rais": 4, "valueerror": 4, "support": 4, "view": [4, 5], "topview": [4, 5], "pinholeview": [4, 5], "image_path": [4, 5], "raster": [4, 5], "tif": [4, 5], "labels_path": [4, 5], "label": [4, 5], "id": 4, "imag": [4, 5], "union": 4, "viewpoint": [4, 5], "save": [4, 5], "output": 4, "rgb": 4, "text_prompt": 4, "text": 4, "box_threshold": 4, "24": 4, "text_threshold": 4, "15": 4, "write": [4, 5], "segment_id": [4, 5], "non_ground": [4, 5], "save_path": [4, 5], "la": [4, 5], "laz": [4, 5], "correspond": [4, 5], "true": [4, 5], "convert": 4, "pinhol": [4, 5], "camera": [4, 5], "vice": 4, "versa": 4, "cloud_to_imag": 4, "an": [4, 5], "extrins": [4, 5], "4x4": 4, "matrix": 4, "fx": 4, "fy": 4, "cx": 4, "cy": 4, "6x1": 4, "shape": 4, "6": [4, 5], "assum": 4, "white": 4, "color": 4, "255": 4, "last": 4, "column": 4, "per": 4, "pixel": 4, "distanc": 4, "greater": 4, "than": [4, 5], "ignor": 4, "valid": 4, "invalid": 4, "image_to_cloud": 4, "": 4, "planar": 4, "minx": 4, "minimum": 4, "bound": 4, "box": 4, "maxx": 4, "maximum": 4, "mini": 4, "maxi": 4, "In": 5, "learn": 5, "how": 5, "modul": 5, "get": 5, "start": 5, "system": 5, "For": 5, "more": 5, "inform": 5, "refer": 5, "page": 5, "download": 5, "here": 5, "pointcloud": 5, "wa": 5, "ahn": 5, "4": 5, "visit": 5, "viewer": 5, "click": 5, "link": 5, "below": 5, "vit": 5, "h": 5, "vit_l": 5, "l": 5, "vit_b": 5, "b": 5, "necessari": 5, "defin": 5, "choos": 5, "between": 5, "exampl": 5, "do": 5, "either": 5, "k": 5, "r": 5, "t": 5, "creat": 5, "instanti": 5, "sam_vit_h_4b8939": 5, "pth": 5, "method": 5, "argument": 5, "perform": 5, "requir": 5, "result": 5, "respect": 5, "_": 5, "now": 5, "entir": 5, "look": 5, "like": 5, "load": 5, "8": 5, "scalar": 5, "field": 5, "call": 5, "visual": 5, "further": 5, "process": 5, "recommand": 5, "cloudcompar": 5, "figur": 5, "show": 5, "allow": 5, "gui": 5, "move": 5, "zoom": 5, "mous": 5, "open3d": 5, "detail": 5, "onc": 5, "done": 5, "press": 5, "p": 5, "esc": 5, "quit": 5, "o": 5, "60": 5, "85": 5, "laundri": 5, "makedir": 5, "exist_ok": 5, "set": 5, "These": 5, "pass": 5, "tabl": 5, "descript": 5, "infer": 5, "kwarg": 5, "geo": 5, "spatial": 5, "10": 5, "90": 5, "about": 5, "complet": 5}, "objects": {"segment_lidar": [[4, 0, 0, "-", "samlidar"], [4, 0, 0, "-", "view"]], "segment_lidar.samlidar": [[4, 1, 1, "", "SamLidar"]], "segment_lidar.samlidar.SamLidar": [[4, 2, 1, "", "csf"], [4, 1, 1, "", "mask"], [4, 2, 1, "", "read"], [4, 2, 1, "", "segment"], [4, 1, 1, "", "text_prompt"], [4, 2, 1, "", "write"]], "segment_lidar.view": [[4, 1, 1, "", "PinholeView"], [4, 1, 1, "", "TopView"]], "segment_lidar.view.PinholeView": [[4, 2, 1, "", "cloud_to_image"], [4, 2, 1, "", "image_to_cloud"]], "segment_lidar.view.TopView": [[4, 2, 1, "", "cloud_to_image"], [4, 2, 1, "", "image_to_cloud"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"citat": 0, "welcom": 1, "segment": [1, 2], "lidar": [1, 2], "": 1, "document": 1, "about": 1, "content": 1, "support": 1, "instal": 2, "step": 2, "1": 2, "creat": 2, "an": 2, "environ": 2, "2": 2, "licens": 3, "api": 4, "basic": 5, "tutori": 5, "prerequisit": 5, "sampl": 5, "data": 5, "model": 5, "checkpoint": 5, "usag": 5, "interact": 5, "mode": 5, "configur": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Citation": [[0, "citation"]], "Welcome to segment-lidar\u2019s documentation!": [[1, "welcome-to-segment-lidar-s-documentation"]], "About": [[1, "about"]], "Contents": [[1, null]], "Support": [[1, "support"]], "Installation": [[2, "installation"]], "Step 1: Create an environment": [[2, "step-1-create-an-environment"]], "Step 2: Install segment-lidar": [[2, "step-2-install-segment-lidar"]], "License": [[3, "license"]], "API": [[4, "module-segment_lidar.samlidar"]], "Basic tutorial": [[5, "basic-tutorial"]], "Prerequisites": [[5, "prerequisites"]], "Sample data": [[5, "sample-data"]], "Model checkpoints": [[5, "model-checkpoints"]], "Basic usage": [[5, "basic-usage"]], "Interactive mode": [[5, "interactive-mode"]], "Configuration": [[5, "configuration"]]}, "indexentries": {"pinholeview (class in segment_lidar.view)": [[4, "segment_lidar.view.PinholeView"]], "samlidar (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar"]], "samlidar.mask (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar.mask"]], "samlidar.text_prompt (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar.text_prompt"]], "topview (class in segment_lidar.view)": [[4, "segment_lidar.view.TopView"]], "cloud_to_image() (segment_lidar.view.pinholeview method)": [[4, "segment_lidar.view.PinholeView.cloud_to_image"]], "cloud_to_image() (segment_lidar.view.topview method)": [[4, "segment_lidar.view.TopView.cloud_to_image"]], "csf() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.csf"]], "image_to_cloud() (segment_lidar.view.pinholeview method)": [[4, "segment_lidar.view.PinholeView.image_to_cloud"]], "image_to_cloud() (segment_lidar.view.topview method)": [[4, "segment_lidar.view.TopView.image_to_cloud"]], "module": [[4, "module-segment_lidar.samlidar"], [4, "module-segment_lidar.view"]], "read() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.read"]], "segment() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.segment"]], "segment_lidar.samlidar": [[4, "module-segment_lidar.samlidar"]], "segment_lidar.view": [[4, "module-segment_lidar.view"]], "write() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.write"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["citation", "index", "installation", "license", "module", "tutorial"], "filenames": ["citation.rst", "index.rst", "installation.rst", "license.rst", "module.rst", "tutorial.rst"], "titles": ["Citation", "Welcome to segment-lidar\u2019s documentation!", "Installation", "License", "API", "Basic tutorial"], "terms": {"The": [0, 1, 4, 5], "us": [0, 1, 2, 3, 4, 5], "open": [0, 1], "sourc": [0, 1, 2, 3], "softwar": [0, 3], "repositori": [0, 1, 5], "ha": 0, "becom": 0, "increasingli": 0, "preval": 0, "scientif": 0, "research": [0, 1], "If": [0, 1, 2, 4], "you": [0, 1, 2, 5], "thi": [0, 1, 2, 3, 4, 5], "your": [0, 1, 5], "pleas": [0, 1, 2, 5], "make": [0, 2, 5], "sure": [0, 2, 5], "cite": [0, 1], "appropri": 0, "work": [0, 1], "recommend": [0, 2], "format": [0, 4], "i": [0, 1, 2, 3, 4, 5], "provid": [0, 3, 4, 5], "accompani": 0, "bibtex": 0, "addition": [0, 5], "compli": 0, "ani": [0, 3, 4], "licens": [0, 1], "term": 0, "condit": [0, 3], "associ": 0, "misc": [0, 1], "yarroudh": [0, 1, 2, 3], "2023": [0, 1, 3], "samlidar": [0, 1, 2, 4, 5], "author": [0, 1, 3], "anass": [0, 1, 3], "titl": [0, 1], "lidar": [0, 5], "automat": [0, 1, 5], "unsupervis": [0, 1, 5], "segment": [0, 4, 5], "anyth": [0, 1, 5], "model": [0, 1], "sam": [0, 1, 5], "from": [0, 1, 2, 3, 4, 5], "meta": [0, 1], "ai": [0, 1], "year": [0, 1], "howpublish": [0, 1], "github": [0, 1, 2], "url": [0, 1], "http": [0, 1, 2], "com": [0, 1, 2], "A": [0, 3, 4], "retriev": [0, 5], "packag": 1, "specif": [1, 3], "design": 1, "instanc": [1, 5], "aerial": 1, "data": [1, 3, 4], "It": 1, "bring": 1, "togeth": 1, "power": 1, "develop": 1, "geospati": [1, 4, 5], "samgeo": 1, "solut": 1, "paper": 1, "publish": 1, "veri": 1, "soon": 1, "latest": 1, "code": [1, 3, 5], "avail": 1, "build": 1, "top": [1, 4, 5], "exist": 1, "when": [1, 5], "algorithm": [1, 4, 5], "within": 1, "also": 1, "origin": [1, 4], "specifi": [1, 5], "instal": [1, 5], "basic": 1, "tutori": 1, "api": 1, "citat": 1, "contact": 1, "via": 1, "email": 1, "ayarroudh": 1, "ulieg": [1, 3], "akharroubi": 1, "question": 1, "issu": 1, "tracker": 1, "bug": 1, "report": 1, "featur": 1, "request": 1, "addit": 1, "etc": 1, "guid": 2, "describ": 2, "pypi": 2, "befor": [2, 5], "need": 2, "run": 2, "follow": [2, 3, 5], "command": 2, "conda": 2, "n": [2, 4], "python": [2, 5], "3": [2, 3, 4, 5], "9": [2, 4], "activ": 2, "new": [2, 5], "name": [2, 3], "we": [2, 5], "feel": 2, "free": 2, "test": [2, 5], "other": [2, 3], "version": 2, "note": 2, "mandatori": 2, "highli": 2, "altern": 2, "can": [2, 4, 5], "virtualenv": 2, "easili": 2, "pip": [2, 5], "Or": 2, "git": 2, "clone": 2, "cd": 2, "setup": 2, "py": 2, "To": 2, "correctli": 2, "c": [2, 3], "import": [2, 5], "segment_lidar": [2, 4, 5], "print": 2, "__version__": 2, "success": 2, "should": [2, 5], "see": [2, 5], "have": [2, 4, 5], "bsd": 3, "claus": 3, "copyright": 3, "univers": 3, "li\u00e8g": 3, "geomat": 3, "unit": [3, 4], "redistribut": 3, "binari": 3, "form": [3, 5], "without": 3, "modif": 3, "ar": [3, 4, 5], "permit": 3, "met": 3, "must": 3, "retain": 3, "abov": 3, "notic": 3, "list": [3, 5], "disclaim": 3, "reproduc": 3, "document": [3, 5], "materi": 3, "distribut": 3, "neither": 3, "holder": 3, "nor": 3, "its": [3, 5], "contributor": 3, "mai": 3, "endors": 3, "promot": 3, "product": 3, "deriv": 3, "prior": 3, "written": 3, "permiss": 3, "BY": 3, "THE": 3, "AND": 3, "AS": 3, "express": 3, "OR": 3, "impli": 3, "warranti": 3, "includ": 3, "BUT": 3, "NOT": 3, "limit": 3, "TO": 3, "OF": 3, "merchant": 3, "fit": 3, "FOR": 3, "particular": 3, "purpos": [3, 5], "IN": 3, "NO": 3, "event": 3, "shall": 3, "BE": 3, "liabl": 3, "direct": 3, "indirect": 3, "incident": 3, "special": 3, "exemplari": 3, "consequenti": 3, "damag": 3, "procur": 3, "substitut": 3, "good": 3, "servic": 3, "loss": 3, "profit": 3, "busi": 3, "interrupt": 3, "howev": 3, "caus": 3, "ON": 3, "theori": 3, "liabil": 3, "whether": [3, 4, 5], "contract": 3, "strict": 3, "tort": 3, "neglig": 3, "otherwis": 3, "aris": 3, "wai": 3, "out": 3, "even": 3, "IF": 3, "advis": 3, "possibl": [3, 5], "SUCH": 3, "class": [4, 5], "ckpt_path": [4, 5], "str": 4, "model_typ": [4, 5], "vit_h": [4, 5], "resolut": [4, 5], "float": 4, "0": [4, 5], "25": [4, 5], "height": 4, "int": 4, "512": 4, "width": 4, "distance_threshold": 4, "none": [4, 5], "devic": [4, 5], "cuda": [4, 5], "sam_kwarg": [4, 5], "bool": 4, "fals": [4, 5], "intrins": [4, 5], "ndarrai": 4, "rotat": [4, 5], "translat": [4, 5], "interact": 4, "base": 4, "object": 4, "csf": [4, 5], "point": [4, 5], "class_threshold": [4, 5], "5": [4, 5], "cloth_resolut": 4, "2": [4, 5], "iter": 4, "500": [4, 5], "slope_smooth": 4, "tupl": 4, "appli": [4, 5], "cloth": [4, 5], "simul": [4, 5], "filter": [4, 5], "ground": [4, 5], "cloud": [4, 5], "paramet": [4, 5], "np": 4, "input": [4, 5], "numpi": 4, "arrai": 4, "where": 4, "each": 4, "row": 4, "repres": 4, "x": 4, "y": 4, "z": 4, "coordin": 4, "option": [4, 5], "threshold": 4, "valu": [4, 5], "classifi": 4, "non": [4, 5], "default": [4, 5], "number": 4, "boolean": 4, "indic": [4, 5], "enabl": 4, "slope": 4, "smooth": 4, "return": [4, 5], "contain": [4, 5], "three": 4, "indinc": 4, "type": [4, 5], "mask": [4, 5], "crop_n_lay": [4, 5], "1": [4, 5], "crop_n_points_downscale_factor": [4, 5], "min_mask_region_area": [4, 5], "200": [4, 5], "points_per_sid": [4, 5], "pred_iou_thresh": [4, 5], "stability_score_thresh": [4, 5], "92": [4, 5], "read": [4, 5], "path": [4, 5], "classif": 4, "file": [4, 5], "rais": 4, "valueerror": 4, "support": 4, "view": [4, 5], "topview": [4, 5], "pinholeview": [4, 5], "image_path": [4, 5], "raster": [4, 5], "tif": [4, 5], "labels_path": [4, 5], "label": [4, 5], "id": 4, "imag": [4, 5], "union": 4, "viewpoint": [4, 5], "save": [4, 5], "output": 4, "rgb": 4, "text_prompt": 4, "text": 4, "box_threshold": 4, "24": 4, "text_threshold": 4, "15": 4, "write": [4, 5], "segment_id": [4, 5], "non_ground": [4, 5], "save_path": [4, 5], "la": [4, 5], "laz": [4, 5], "correspond": [4, 5], "true": [4, 5], "convert": 4, "pinhol": [4, 5], "camera": [4, 5], "vice": 4, "versa": 4, "cloud_to_imag": 4, "an": [4, 5], "extrins": [4, 5], "4x4": 4, "matrix": [4, 5], "fx": 4, "fy": 4, "cx": 4, "cy": 4, "6x1": 4, "shape": 4, "6": [4, 5], "assum": 4, "white": 4, "color": 4, "255": 4, "last": 4, "column": 4, "per": 4, "pixel": 4, "distanc": 4, "greater": 4, "than": [4, 5], "ignor": 4, "valid": 4, "invalid": 4, "image_to_cloud": 4, "": 4, "planar": 4, "minx": 4, "minimum": 4, "bound": 4, "box": 4, "maxx": 4, "maximum": 4, "mini": 4, "maxi": 4, "In": 5, "learn": 5, "how": 5, "modul": 5, "get": 5, "start": 5, "system": 5, "For": 5, "more": 5, "inform": 5, "refer": 5, "page": 5, "download": 5, "here": 5, "pointcloud": 5, "wa": 5, "ahn": 5, "4": 5, "visit": 5, "viewer": 5, "click": 5, "link": 5, "below": 5, "vit": 5, "h": 5, "vit_l": 5, "l": 5, "vit_b": 5, "b": 5, "necessari": 5, "defin": 5, "choos": 5, "between": 5, "exampl": 5, "do": 5, "either": 5, "k": 5, "r": 5, "t": 5, "3x3": 5, "3x1": 5, "vector": 5, "creat": 5, "instanti": 5, "sam_vit_h_4b8939": 5, "pth": 5, "method": 5, "argument": 5, "perform": 5, "requir": 5, "result": 5, "respect": 5, "_": 5, "now": 5, "entir": 5, "look": 5, "like": 5, "load": 5, "8": 5, "scalar": 5, "field": 5, "call": 5, "visual": 5, "further": 5, "process": 5, "recommand": 5, "cloudcompar": 5, "figur": 5, "show": 5, "allow": 5, "gui": 5, "move": 5, "zoom": 5, "mous": 5, "open3d": 5, "detail": 5, "onc": 5, "done": 5, "press": 5, "p": 5, "esc": 5, "quit": 5, "o": 5, "60": 5, "85": 5, "laundri": 5, "makedir": 5, "exist_ok": 5, "set": 5, "These": 5, "pass": 5, "tabl": 5, "descript": 5, "infer": 5, "kwarg": 5, "geo": 5, "spatial": 5, "10": 5, "90": 5, "about": 5, "complet": 5}, "objects": {"segment_lidar": [[4, 0, 0, "-", "samlidar"], [4, 0, 0, "-", "view"]], "segment_lidar.samlidar": [[4, 1, 1, "", "SamLidar"]], "segment_lidar.samlidar.SamLidar": [[4, 2, 1, "", "csf"], [4, 1, 1, "", "mask"], [4, 2, 1, "", "read"], [4, 2, 1, "", "segment"], [4, 1, 1, "", "text_prompt"], [4, 2, 1, "", "write"]], "segment_lidar.view": [[4, 1, 1, "", "PinholeView"], [4, 1, 1, "", "TopView"]], "segment_lidar.view.PinholeView": [[4, 2, 1, "", "cloud_to_image"], [4, 2, 1, "", "image_to_cloud"]], "segment_lidar.view.TopView": [[4, 2, 1, "", "cloud_to_image"], [4, 2, 1, "", "image_to_cloud"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"]}, "titleterms": {"citat": 0, "welcom": 1, "segment": [1, 2], "lidar": [1, 2], "": 1, "document": 1, "about": 1, "content": 1, "support": 1, "instal": 2, "step": 2, "1": 2, "creat": 2, "an": 2, "environ": 2, "2": 2, "licens": 3, "api": 4, "basic": 5, "tutori": 5, "prerequisit": 5, "sampl": 5, "data": 5, "model": 5, "checkpoint": 5, "usag": 5, "interact": 5, "mode": 5, "configur": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Citation": [[0, "citation"]], "Welcome to segment-lidar\u2019s documentation!": [[1, "welcome-to-segment-lidar-s-documentation"]], "About": [[1, "about"]], "Contents": [[1, null]], "Support": [[1, "support"]], "Installation": [[2, "installation"]], "Step 1: Create an environment": [[2, "step-1-create-an-environment"]], "Step 2: Install segment-lidar": [[2, "step-2-install-segment-lidar"]], "License": [[3, "license"]], "API": [[4, "module-segment_lidar.samlidar"]], "Basic tutorial": [[5, "basic-tutorial"]], "Prerequisites": [[5, "prerequisites"]], "Sample data": [[5, "sample-data"]], "Model checkpoints": [[5, "model-checkpoints"]], "Basic usage": [[5, "basic-usage"]], "Interactive mode": [[5, "interactive-mode"]], "Configuration": [[5, "configuration"]]}, "indexentries": {"pinholeview (class in segment_lidar.view)": [[4, "segment_lidar.view.PinholeView"]], "samlidar (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar"]], "samlidar.mask (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar.mask"]], "samlidar.text_prompt (class in segment_lidar.samlidar)": [[4, "segment_lidar.samlidar.SamLidar.text_prompt"]], "topview (class in segment_lidar.view)": [[4, "segment_lidar.view.TopView"]], "cloud_to_image() (segment_lidar.view.pinholeview method)": [[4, "segment_lidar.view.PinholeView.cloud_to_image"]], "cloud_to_image() (segment_lidar.view.topview method)": [[4, "segment_lidar.view.TopView.cloud_to_image"]], "csf() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.csf"]], "image_to_cloud() (segment_lidar.view.pinholeview method)": [[4, "segment_lidar.view.PinholeView.image_to_cloud"]], "image_to_cloud() (segment_lidar.view.topview method)": [[4, "segment_lidar.view.TopView.image_to_cloud"]], "module": [[4, "module-segment_lidar.samlidar"], [4, "module-segment_lidar.view"]], "read() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.read"]], "segment() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.segment"]], "segment_lidar.samlidar": [[4, "module-segment_lidar.samlidar"]], "segment_lidar.view": [[4, "module-segment_lidar.view"]], "write() (segment_lidar.samlidar.samlidar method)": [[4, "segment_lidar.samlidar.SamLidar.write"]]}}) \ No newline at end of file diff --git a/docs/tutorial.html b/docs/tutorial.html index cfe65b7..da1ea0b 100644 --- a/docs/tutorial.html +++ b/docs/tutorial.html @@ -139,6 +139,7 @@

Basic usage
viewpoint = view.PinholeView(intrinsic=K, rotation=R, translation=T)
+

K is a 3x3 intrinsic matrix, R is a 3x3 rotation matrix and T is a 3x1 translation vector.

or by using the interactive mode:

viewpoint = view.PinholeView(interactive=True)
@@ -164,7 +165,7 @@

Basic usage
labels, *_ = model.segment(points=cloud, image_path="raster.tif", labels_path="labeled.tif")
+
labels, *_ = model.segment(points=cloud, view=view, image_path="raster.tif", labels_path="labeled.tif")
 

 

 
    
@@ -189,7 +190,7 @@ 
    Basic usagecloud, non_ground, ground = model.csf(points)
 
 # Segment the point cloud
-labels, *_ = instance.segment(points=cloud, image_path="raster.tif", labels_path="labeled.tif")
+labels, *_ = instance.segment(points=cloud, view=view, image_path="raster.tif", labels_path="labeled.tif")
 
 # Save results
 model.write(points=points, non_ground=non_ground, ground=ground, segment_ids=labels, save_path="segmented.las")