Skip to content

Latest commit

 

History

History
147 lines (80 loc) · 2.86 KB

cli-reference.rst

File metadata and controls

147 lines (80 loc) · 2.86 KB
Raw

CLI Reference

visarch

VisArchPy: Data pipelines for extraction, transformation and visualization of architectural visuals in Python.

Syntax

visarch [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • dino Transforms images into visual features using DinoV2.
  • layout Extract images from PDF files using layout analysis.
  • layoutocr Extract images from PDF files using layout and OCR analysis.
  • ocr Extract images from PDF files using OCR analysis.
  • viz Utility for visualizing architectural visuals.

Extraction Pipelines

layout

Extract images from PDF files using layout analysis.

Syntax

visarch layout [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • from-dir Extract images from all PDF files in a directory.
  • from-file Extract images from a single PDF file.
  • settings Show default settings for the pipeline.

ocr

Extract images from PDF files using OCR analysis.

Syntax

visarch ocr [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • from-dir Extract images from all PDF files in a directory.
  • from-file Extract images from a single PDF file.
  • settings Show default settings for the pipeline.

layoutocr

Extract images from PDF files using layout and OCR analysis.

Syntax

visarch layoutocr [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • batch Batch processing for TU Delft's dataset.
  • from-dir Extract images from all PDF files in a directory.
  • from-file Extract images from a single PDF file.
  • settings Show default settings for the pipeline.

Transformation Utilities

dino

Transforms images into visual features using DinoV2.

Syntax

visarch dino [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • from-dir Extract features from all image files in a directory.
  • from-file Extract features from a single image file.

Visualisation Utilities

viz

Utility for visualizing architectural visuals.

Syntax

visarch viz [OPTIONS] COMMAND [ARGS]...

Options

-h, --help Show this message and exit.

Commands

  • bbox-plot Creates a bounding box plot for images in a directory.