# dekuliutesla/citygaussian architecture

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

- Interactive diagram: https://gitdiagram.com/dekuliutesla/citygaussian
- Repository: https://github.com/dekuliutesla/citygaussian

## Overview

##### Main System Components

a) Data Processing Pipeline:
- Input Layer (Images, COLMAP data)
- Data Parsing System (internal/dataparsers/)
- Data Preprocessing Components (utils/)

b) Core Processing Components:
- Gaussian Model System (internal/models/)
- Rendering System (internal/renderers/)
- Density Control System (internal/density_controllers/)

c) Training and Optimization:
- Multi-GPU Training System
- Optimization Components (internal/optimizers.py)
- Scheduling System (internal/schedulers.py)

##### Key Relationships to Highlight

**Raw Data → Data Parser → Preprocessor → Gaussian Model**
- ↓
- Density Controller
- ↓
- Renderer System
- ↓
- Optimization Loop

##### Special Architectural Elements

Create dedicated sections for:
- Multi-GPU Distribution System
- Model Partitioning System
- Memory Management System
- Viewer Components (internal/viewer/)

##### Important Details

a) Data Flow Specifications:
- Image input pipeline
- COLMAP integration
- Point cloud processing
- Mesh extraction

b) Processing Modules:
- Gaussian splatting core
- Appearance embedding
- Geometric processing
- Scene partitioning

c) Output Systems:
- Rendering pipeline
- Mesh generation
- Video creation
- Web viewer

##### Implementation Details

- Key configuration parameters
- Critical file paths
- Important class hierarchies
- Plugin points for extensibility

##### The scalability aspects

Remember to highlight the unique features of CityGaussian, such as:
- Multi-GPU reconstruction with controllable memory cost
- Model partition and data assignment systems
- Mesh extraction capabilities
- Trajectory-aligned rendering
- Integration with Gaussian Lightning features

This will create a comprehensive yet understandable representation of the system's architecture that a principal software engineer can use to understand and work with the system.

## Diagram (Mermaid)

```mermaid
classDiagram
    class RawData {
        +Images: Array
        +PointCloud: Array
        +processData()
        +validateFormat()
        +extractMetadata()
    }
    class COLMAP {
        -SparseModel: Object
        -DenseModel: Object
        +extractData()
        +reconstructScene()
        +estimatePoses()
        +generatePointCloud()
    }
    
    class DataParser {
        -inputFormat: String
        -validationRules: Object
        +parse()
        +validate()
        +transformFormat()
        +handleErrors()
        +generateReport()
    }
    
    class Preprocess {
        -cleaningParams: Object
        -transformRules: Array
        +clean()
        +transform()
        +normalizeData()
        +filterOutliers()
        +augmentData()
    }
    
    class GaussianModel {
        -parameters: Object
        -embeddings: Array
        -optimizationState: Object
        +train()
        +predict()
        +updateParameters()
        +calculateGradients()
        +backpropagate()
    }
    
    class DensityControl {
        -densityMap: Array
        -thresholds: Object
        +adjust()
        +optimize()
        +calculateDensity()
        +redistributePoints()
        +balanceLoad()
    }
    
    class RenderSystem {
        -renderQueue: Array
        -outputFormats: Array
        +render()
        +export()
        +queueFrame()
        +applyPostProcessing()
        +handleViewport()
    }
    
    class MultiGPU {
        -deviceMap: Object
        -syncStrategy: String
        +distribute()
        +sync()
        +balanceLoad()
        +handleFailover()
        +monitorPerformance()
    }
    
    class Optimizer {
        -learningRate: Float
        -optimizationState: Object
        +optimize()
        +update()
        +adjustLearningRate()
        +calculateLoss()
        +checkConvergence()
    }
    
    class Scheduler {
        -schedule: Array
        -priorities: Object
        +schedule()
        +manage()
        +allocateResources()
        +handleConflicts()
        +optimizeWorkflow()
    }
    
    class ModelPart {
        -partitions: Array
        -boundaries: Object
        +partition()
        +merge()
        +optimizeBoundaries()
        +handleOverlap()
        +validateIntegrity()
    }
    
    class MemoryMgmt {
        -memoryMap: Object
        -cacheStrategy: String
        +allocate()
        +free()
        +optimizeUsage()
        +handleSwapping()
        +monitorConsumption()
    }
    
    class CameraSys {
        -poses: Array
        -intrinsics: Object
        +calibrate()
        +position()
        +estimateMotion()
        +optimizePoses()
        +validateCalibration()
    }
    
    class Config {
        -settings: Object
        -defaults: Object
        +load()
        +validate()
        +override()
        +exportSettings()
        +resetToDefault()
    }
    
    class Metrics {
        -measurements: Array
        -benchmarks: Object
        +measure()
        +report()
        +compareResults()
        +trackProgress()
        +generateVisuals()
    }
    
    class ModelComp {
        -components: Array
        -state: Object
        +initialize()
        +update()
        +validateState()
        +optimizePerformance()
        +handleErrors()
    }
    
    class Viewer {
        -viewport: Object
        -interactions: Array
        +display()
        +interact()
        +handleInput()
        +updateView()
        +exportScene()
    }
    
    class MeshGen {
        -meshData: Object
        -quality: Float
        +generate()
        +export()
        +optimizeMesh()
        +calculateNormals()
        +reduceFaces()
    }
    
    class VideoOut {
        -frameBuffer: Array
        -encodingParams: Object
        +render()
        +save()
        +encodeFrames()
        +applyEffects()
        +optimizeBitrate()
    }

    RawData --> DataParser
    COLMAP --> DataParser
    DataParser --> Preprocess
    Preprocess --> GaussianModel
    GaussianModel --> DensityControl
    DensityControl --> RenderSystem
    RenderSystem --> Optimizer
    Optimizer --> Scheduler
    ModelPart --> GaussianModel
    MemoryMgmt --> MultiGPU
    CameraSys --> RenderSystem
    Config --> MultiGPU
    Metrics --> Optimizer
    ModelComp --> GaussianModel
    RenderSystem --> Viewer
    RenderSystem --> MeshGen
    RenderSystem --> VideoOut
```
