waveform_factory.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-only
//
// Copyright (c) 2006-2008 Marc Brooker and Michael Inggs
// Copyright (c) 2008-present FERS Contributors (see AUTHORS.md).
//
// See the GNU GPLv2 LICENSE file in the FERS project root for more information.
 
/**
 * @file waveform_factory.h
 * @brief Interface for loading waveform data into RadarSignal objects.
 */
 
#pragma once
 
#include <memory>
#include <string>
 
#include "core/config.h"
#include "core/sim_id.h"
#include "signal/radar_signal.h"
 
namespace serial
{
    /**
     * @brief Loads a radar waveform from a file and returns a RadarSignal object.
     *
     * @param name The name of the radar signal.
     * @param filename The path to the file containing the waveform data.
     * @param power The power of the radar signal in the waveform.
     * @param carrierFreq The carrier frequency of the radar signal.
     * @param id Optional explicit waveform identifier.
     * @param kind Radar mode assigned to the loaded samples.
     * @return A unique pointer to a RadarSignal object loaded with the waveform data.
     * @throws std::runtime_error If the file cannot be opened or the file format is unrecognized.
     */
    [[nodiscard]] std::unique_ptr<fers_signal::RadarSignal>
    loadWaveformFromFile(const std::string& name, const std::string& filename, RealType power, RealType carrierFreq,
                         const SimId id = 0,
                         fers_signal::FileWaveformKind kind = fers_signal::FileWaveformKind::Pulsed);
}