# greensopinion/vectorvector architecture

> Architecture diagram of the GitHub repository greensopinion/vectorvector, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/greensopinion/vectorvector
- Repository: https://github.com/greensopinion/vectorvector

## Overview

##### Main Components

a) Input Processing Layer:
- GeoTIFF Elevation Data Reader
- CLI Interface (CliOptions.kt)
- Input Validation System

b) Core Processing Components:
- Elevation Processing Pipeline
- Block Management System
- Coordinate Translation System

c) Output Generation Layer:
- Vector Tile Generator
- Hillshade Generator
- Terrarium Tile Generator

d) Storage Layer:
- File System Storage
- MBTiles Storage
- Caching System

##### Key Relationships to Highlight

**[Input Layer] → [Core Processing] → [Output Generation] → [Storage Layer]**

With parallel paths for different output types:
- ┌→ [Contour Generation] →┐
**[Elevation Data] →  ├→ [Hillshade Creation] →┼→ [Storage]**
- → [Terrarium Tiles]    →┘

##### Detailed Component Breakdown

a) Input Processing:
**[CLI Interface] → [Input Validator] → [GeoTIFF Reader]**

b) Core Processing:
**[BlockMapper] → [ElevationInterpolator] → [SlippyMapTranslator]**

c) Output Generation:
**[ContourLineGenerator] → [LineSimplifier]**
**[HornAlgorithm] → [HillshadeRasterSink]**
**[TerrariumSink]**

##### Important Architectural Elements

- Metrics system (MetricsProvider) connecting to all major components
- Caching layer (CachingBlockStore, CachingElevationDataStore)
- Fault tolerance system (FaultBarrierTileSink)

##### Technical Details

- Input Format: GeoTIFF
- Output Formats: MBTiles, Files
- Processing Algorithms:
- Marching Squares (contours)
- Horn Algorithm (hillshade)
- Ramer-Douglas-Peucker (line simplification)

##### Integration Points

Connections to:
- External tile serving systems
- Conversion to PMTiles format
- Visualization tools

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef input fill:#b3d9ff,stroke:#333
    classDef processing fill:#90EE90,stroke:#333
    classDef storage fill:#FFE5B4,stroke:#333
    classDef critical fill:#FFB6C1,stroke:#333
    classDef utility fill:#D3D3D3,stroke:#333

    %% Input Layer
    subgraph InputLayer
        CLI["CLI Interface"]:::input
        InputVal["Input Validator"]:::input
        GeoReader["GeoTIFF Reader"]:::input
    end

    %% Core Processing Layer
    subgraph CoreProcessing
        BlockMap["Block Mapper"]:::processing
        ElevInterp["Elevation Interpolator"]:::processing
        SlippyMap["Slippy Map Translator"]:::processing
        Processor["Main Processor"]:::critical
    end

    %% Output Generation Layer
    subgraph OutputGeneration
        ContourGen["Contour Line Generator"]:::processing
        LineSimp["Line Simplifier"]:::processing
        HornAlg["Horn Algorithm"]:::processing
        HillShade["Hillshade Raster Sink"]:::processing
        TerrSink["Terrarium Sink"]:::processing
        VectorTile["Vector Tile Sink"]:::processing
        FaultBarrier["Fault Barrier"]:::critical
    end

    %% Storage Layer
    subgraph StorageLayer
        FSStore["Filesystem Storage"]:::storage
        MBStore["MBTiles Storage"]:::storage
        CacheBlock["Caching Block Store"]:::storage
        CacheElev["Caching Elevation Store"]:::storage
    end

    %% Metrics System
    MetricsP["Metrics Provider"]:::utility
    PeriodicM["Periodic Metrics"]:::utility

    %% Relationships
    CLI --> InputVal
    InputVal --> GeoReader
    GeoReader --> BlockMap
    BlockMap --> ElevInterp
    ElevInterp --> SlippyMap
    SlippyMap --> Processor

    Processor --> ContourGen
    Processor --> HornAlg
    Processor --> TerrSink

    ContourGen --> LineSimp
    LineSimp --> VectorTile
    HornAlg --> HillShade
    
    VectorTile --> FaultBarrier
    HillShade --> FaultBarrier
    TerrSink --> FaultBarrier

    FaultBarrier --> FSStore
    FaultBarrier --> MBStore
    
    BlockMap --> CacheBlock
    ElevInterp --> CacheElev

    MetricsP --> Processor
    MetricsP --> PeriodicM

    %% Click Events
    click CLI "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/cli/CliOptions.kt"
    click BlockMap "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/elevation/BlockMapper.kt"
    click ElevInterp "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/elevation/ElevationInterpolator.kt"
    click SlippyMap "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/elevation/SlippyMapTranslator.kt"
    click VectorTile "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/VectorTileSink.kt"
    click HornAlg "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/hillshade/HornAlgorithm.kt"
    click HillShade "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/HillshadeRasterSink.kt"
    click TerrSink "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/TerrariumSink.kt"
    click ContourGen "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/contour/ContourLineGenerator.kt"
    click LineSimp "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/contour/LineSimplifier.kt"
    click FSStore "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/repository/FilesystemTileRepository.kt"
    click MBStore "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/repository/MbtilesTileRepository.kt"
    click CacheBlock "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/elevation/CachingBlockStore.kt"
    click CacheElev "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/elevation/CachingElevationDataStore.kt"
    click MetricsP "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/metrics/MetricsProvider.kt"
    click PeriodicM "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/metrics/PeriodicMetrics.kt"
    click FaultBarrier "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/sink/FaultBarrierTileSink.kt"
    click Processor "https://github.com/greensopinion/vectorvector/blob/main/src/main/kotlin/com/greensopinion/vectorvector/Processor.kt"
```
