carbon_config.hpp

Go to the documentation of this file.

// Copyright (c) 2024-2025 Voyant Photonics, Inc.
// All rights reserved.
 
#pragma once
 
#include <carbon_client_ffi.hpp>
#include <cstdint>
#include <memory>
#include <string>
#include <vector>

class CarbonConfig
{
public:
    CarbonConfig();
    ~CarbonConfig();

    static std::unique_ptr<CarbonConfig> fromJson(const std::string& path);
 
    // Non-copyable, non-movable (owns raw FFI pointer)
    CarbonConfig(const CarbonConfig&)            = delete;
    CarbonConfig& operator=(const CarbonConfig&) = delete;
    CarbonConfig(CarbonConfig&&)                 = delete;
    CarbonConfig& operator=(CarbonConfig&&)      = delete;
 
    // ── Connection ────────────────────────────────────────────────────────────
    CarbonConfig& setBindAddr(const std::string& v);
    CarbonConfig& setGroupAddr(const std::string& v);
    CarbonConfig& setInterfaceAddr(const std::string& v);

    CarbonConfig& setObserverOnly(bool v);

    CarbonConfig& setStreamTransport(StreamTransport v);
 
    // ── Receiver ──────────────────────────────────────────────────────────────
    CarbonConfig& setUseMsgTimestamp(bool v);
    CarbonConfig& setBatchSize(size_t v);
    CarbonConfig& setRecvBufferSize(size_t v);
    CarbonConfig& setReceiverChannelCapacity(size_t v);
 
    // ── DSP ───────────────────────────────────────────────────────────────────
    CarbonConfig& setVelCorrFactor(float v);
    CarbonConfig& setBandwidthHz(float v);
    CarbonConfig& setElevationFovDeg(float v);
 
    // ── Peak Combiner ────────────────────────────────────────────────────────
    CarbonConfig& setPeakCombineTwinOnly(bool v);         
    CarbonConfig& setPeakCombineClusterMinSize(size_t v); 
    CarbonConfig& setPeakCombineBeatThreshHz(float v);    
    CarbonConfig& setPeakCombineBeatOutlierRemoval(bool v);     
    CarbonConfig& setPeakCombineSnrPreThresholdEnabled(bool v); 
    CarbonConfig& setPeakCombineSnrPreThresholdMaxDb(float v);  
    CarbonConfig& setPeakCombineSnrPreThresholdMinDb(float v);  
    CarbonConfig& setPeakCombineSnrPreThresholdSlopeDbPerHz(float v); 
 
    // ── RD Outlier (shared peak + point thresholds) ───────────────────────────
    CarbonConfig& setRdOutlierRangeThreshMinM(float v);     
    CarbonConfig& setRdOutlierRangeThreshMaxM(float v);     
    CarbonConfig& setRdOutlierDopplerThreshMinMps(float v); 
    CarbonConfig& setRdOutlierDopplerThreshMaxMps(float v); 
    CarbonConfig& setRdOutlierRefRangeM(float v);           
 
    // ── Frame Assembler ───────────────────────────────────────────────────────
    CarbonConfig& setKeepInvalidPoints(bool v);
 
    // ── Geometric Bounds ──────────────────────────────────────────────────────
    CarbonConfig& setRangeMin(float v);
    CarbonConfig& setRangeMax(float v);
    CarbonConfig& setDopplerMin(float v);
    CarbonConfig& setDopplerMax(float v);
    CarbonConfig& setAzimuthDegMin(float v);
    CarbonConfig& setAzimuthDegMax(float v);
    CarbonConfig& setElevationDegMin(float v);
    CarbonConfig& setElevationDegMax(float v);
 
    // ── Spatial Outlier Filter ────────────────────────────────────────────────
    CarbonConfig& setSpatialFilterEnabled(bool v); 
    CarbonConfig& setSpatialMinValidNeighbors(uint8_t v); 
    CarbonConfig& setSpatialPointClusterSize(uint8_t v);  
    CarbonConfig& setSpatialSupportThreshold(float v);    
 
    // ── Elevation Interpolator ────────────────────────────────────────────────
    CarbonConfig& setInterpRangeThreshold(float v);
    CarbonConfig& setInterpDopplerThreshold(float v);
    CarbonConfig& setMissingElevations(const std::vector<uint8_t>& elevations);
 
    // ── Eval ──────────────────────────────────────────────────────────────────
    CarbonConfig& setEvalMode(bool v);
    CarbonConfig& setReportDir(const std::string& v);
 
    // ── SDL ───────────────────────────────────────────────────────────────────────
    CarbonConfig& setFpgaTargetAddr(const std::string& v);
    CarbonConfig& setSdlTimeoutSec(float v);
    CarbonConfig& setSdlMaxRetries(uint8_t v);
 
private:
    friend class CarbonClient;
    CarbonConfigC* cfg_;                       // opaque pointer — type defined in carbon_client_ffi.hpp
    explicit CarbonConfig(CarbonConfigC* raw); // takes ownership
};