params Namespace Reference

Classes
class	Parameters
	Struct to hold simulation parameters. More...

Enumerations
enum class	CoordinateFrame { ENU , UTM , ECEF }
	Defines the coordinate systems supported for scenario definition. More...

Functions
RealType	c () noexcept
	Get the speed of light.
RealType	boltzmannK () noexcept
	Get the Boltzmann constant.
RealType	startTime () noexcept
	Get the start time for the simulation.
RealType	endTime () noexcept
	Get the end time for the simulation.
RealType	simSamplingRate () noexcept
	Get the simulation sampling rate.
RealType	rate () noexcept
	Get the rendering sample rate.
unsigned	randomSeed () noexcept
	Get the random seed.
unsigned	adcBits () noexcept
	Get the ADC quantization bits.
unsigned	renderFilterLength () noexcept
	Get the render filter length.
unsigned	renderThreads () noexcept
	Get the number of worker threads.
unsigned	oversampleRatio () noexcept
	Get the oversampling ratio.
void	setC (RealType cValue) noexcept
	Set the speed of light.
void	setTime (const RealType startTime, const RealType endTime) noexcept
	Set the start and end times for the simulation.
void	setSimSamplingRate (const RealType rate) noexcept
	Set the simulation sampling rate.
void	setRate (RealType rateValue)
	Set the rendering sample rate.
void	setRandomSeed (const unsigned seed) noexcept
	Set the random seed.
void	setAdcBits (const unsigned bits) noexcept
	Set the ADC quantization bits.
void	setOversampleRatio (unsigned ratio)
	Set the oversampling ratio.
void	setOrigin (const double lat, const double lon, const double alt) noexcept
	Set the geodetic origin for the KML generator.
double	originLatitude () noexcept
double	originLongitude () noexcept
double	originAltitude () noexcept
std::expected< void, std::string >	setThreads (const unsigned threads) noexcept
	Set the number of worker threads.
void	setCoordinateSystem (const CoordinateFrame frame, const int zone, const bool north) noexcept
	Set the coordinate system for the scenario.
CoordinateFrame	coordinateFrame () noexcept
int	utmZone () noexcept
bool	utmNorthHemisphere () noexcept
	NLOHMANN_JSON_SERIALIZE_ENUM (CoordinateFrame, {{CoordinateFrame::ENU, "ENU"}, {CoordinateFrame::UTM, "UTM"}, {CoordinateFrame::ECEF, "ECEF"}}) void to_json(nlohmann
void	from_json (const nlohmann::json &j, Parameters &p)

Variables
Parameters	params

Enumeration Type Documentation

CoordinateFrame

enum class params::CoordinateFrame

strong

Defines the coordinate systems supported for scenario definition.

Enumerator
ENU	East-North-Up local tangent plane (default)
UTM	Universal Transverse Mercator.
ECEF	Earth-Centered, Earth-Fixed.

Definition at line 28 of file parameters.h.

    {
        ENU, ///< East-North-Up local tangent plane (default)
        UTM, ///< Universal Transverse Mercator
        ECEF ///< Earth-Centered, Earth-Fixed
    };

Function Documentation

adcBits()

unsigned params::adcBits ( )

noexcept

Get the ADC quantization bits.

Returns

Number of ADC quantization bits.

Definition at line 121 of file parameters.h.

{ return params.adc_bits; }

Referenced by processing::quantizeAndScaleWindow().

Here is the caller graph for this function:

boltzmannK()

RealType params::boltzmannK ( )

noexcept

Get the Boltzmann constant.

Returns

The Boltzmann constant.

Definition at line 85 of file parameters.h.

{ return params.boltzmann_k; }

Referenced by processing::applyThermalNoise().

Here is the caller graph for this function:

c()

RealType params::c ( )

noexcept

Get the speed of light.

Returns

The speed of light in meters per second.

Definition at line 79 of file parameters.h.

{ return params.c; }

Referenced by simulation::calculateDirectPathContribution(), simulation::calculatePreviewLinks(), simulation::calculateReflectedPathContribution(), fers_get_antenna_pattern(), simulation::solveRe(), and simulation::solveReDirect().

Here is the caller graph for this function:

coordinateFrame()

CoordinateFrame params::coordinateFrame ( )

noexcept

Definition at line 272 of file parameters.h.

{ return params.coordinate_frame; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

endTime()

RealType params::endTime ( )

noexcept

Get the end time for the simulation.

Returns

End time for the simulation.

Definition at line 97 of file parameters.h.

{ return params.end; }

Referenced by fers_signal::from_json(), radar::Receiver::getWindowCount(), serial::json_to_world(), radar::processRawSchedule(), core::runEventDrivenSim(), core::World::scheduleInitialEvents(), and setTime().

Here is the caller graph for this function:

from_json()

void params::from_json	(	const nlohmann::json &	j,
		Parameters &	p
	)

Definition at line 516 of file json_serializer.cpp.

    {
        p.start = j.at("starttime").get<RealType>();
        p.end = j.at("endtime").get<RealType>();
        p.rate = j.at("rate").get<RealType>();
        p.c = j.value("c", Parameters::DEFAULT_C);
        p.sim_sampling_rate = j.value("simSamplingRate", 1000.0);
        p.adc_bits = j.value("adc_bits", 0);
        p.oversample_ratio = j.value("oversample", 1);
        p.random_seed = j.value<std::optional<unsigned>>("randomseed", std::nullopt);
 
        const auto& origin = j.at("origin");
        p.origin_latitude = origin.at("latitude").get<double>();
        p.origin_longitude = origin.at("longitude").get<double>();
        p.origin_altitude = origin.at("altitude").get<double>();
 
        const auto& cs = j.at("coordinatesystem");
        p.coordinate_frame = cs.at("frame").get<CoordinateFrame>();
        if (p.coordinate_frame == CoordinateFrame::UTM)
        {
            p.utm_zone = cs.at("zone").get<int>();
            p.utm_north_hemisphere = cs.at("hemisphere").get<std::string>() == "N";
        }
    }

References params::Parameters::adc_bits, params::Parameters::c, params::Parameters::coordinate_frame, params::Parameters::DEFAULT_C, params::Parameters::end, params::Parameters::origin_altitude, params::Parameters::origin_latitude, params::Parameters::origin_longitude, params::Parameters::oversample_ratio, params::Parameters::random_seed, params::Parameters::rate, params::Parameters::sim_sampling_rate, params::Parameters::start, UTM, params::Parameters::utm_north_hemisphere, and params::Parameters::utm_zone.

NLOHMANN_JSON_SERIALIZE_ENUM()

params::NLOHMANN_JSON_SERIALIZE_ENUM	(	CoordinateFrame	,
		{{CoordinateFrame::ENU, "ENU"}, {CoordinateFrame::UTM, "UTM"}, {CoordinateFrame::ECEF, "ECEF"}}
	)

Definition at line 485 of file json_serializer.cpp.

                                 {{CoordinateFrame::ENU, "ENU"},
                                  {CoordinateFrame::UTM, "UTM"},
                                  {CoordinateFrame::ECEF, "ECEF"}})
 
    void to_json(nlohmann::json& j, const Parameters& p)
    {
        j = nlohmann::json{{"starttime", p.start},
                           {"endtime", p.end},
                           {"rate", p.rate},
                           {"c", p.c},
                           {"simSamplingRate", p.sim_sampling_rate},
                           {"adc_bits", p.adc_bits},
                           {"oversample", p.oversample_ratio}};
 
        if (p.random_seed.has_value())
        {
            j["randomseed"] = p.random_seed.value();
        }
 
        j["origin"] = {
            {"latitude", p.origin_latitude}, {"longitude", p.origin_longitude}, {"altitude", p.origin_altitude}};
 
        j["coordinatesystem"] = {{"frame", p.coordinate_frame}};
        if (p.coordinate_frame == CoordinateFrame::UTM)
        {
            j["coordinatesystem"]["zone"] = p.utm_zone;
            j["coordinatesystem"]["hemisphere"] = p.utm_north_hemisphere ? "N" : "S";
        }
    }

References ECEF, ENU, and UTM.

originAltitude()

double params::originAltitude ( )

noexcept

Definition at line 240 of file parameters.h.

{ return params.origin_altitude; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

originLatitude()

double params::originLatitude ( )

noexcept

Definition at line 236 of file parameters.h.

{ return params.origin_latitude; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

originLongitude()

double params::originLongitude ( )

noexcept

Definition at line 238 of file parameters.h.

{ return params.origin_longitude; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

oversampleRatio()

unsigned params::oversampleRatio ( )

noexcept

Get the oversampling ratio.

Returns

The oversampling ratio.

Definition at line 139 of file parameters.h.

{ return params.oversample_ratio; }

Referenced by processing::applyThermalNoise(), fers_signal::downsample(), processing::finalizeCwReceiver(), serial::json_to_world(), fers_signal::Signal::load(), processing::renderWindow(), core::runEventDrivenSim(), processing::runPulsedFinalizer(), radar::Transmitter::setPrf(), radar::Receiver::setWindowProperties(), and fers_signal::upsample().

Here is the caller graph for this function:

randomSeed()

unsigned params::randomSeed ( )

noexcept

Get the random seed.

Returns

The current random seed value.

Definition at line 115 of file parameters.h.

{ return params.random_seed.value_or(0); }

rate()

RealType params::rate ( )

noexcept

Get the rendering sample rate.

Returns

The rendering sample rate.

Definition at line 109 of file parameters.h.

{ return params.rate; }

Referenced by serial::addChunkToFile(), processing::applyThermalNoise(), processing::finalizeCwReceiver(), noise::ClockModelGenerator::getSample(), serial::json_to_world(), processing::renderWindow(), core::runEventDrivenSim(), processing::runPulsedFinalizer(), radar::Transmitter::setPrf(), setSimSamplingRate(), and radar::Receiver::setWindowProperties().

Here is the caller graph for this function:

renderFilterLength()

unsigned params::renderFilterLength ( )

noexcept

Get the render filter length.

Returns

The length of the render filter.

Definition at line 127 of file parameters.h.

{ return params.filter_length; }

Referenced by fers_signal::Signal::render().

Here is the caller graph for this function:

renderThreads()

unsigned params::renderThreads ( )

noexcept

Get the number of worker threads.

Returns

The number of worker threads.

Definition at line 133 of file parameters.h.

{ return params.render_threads; }

Referenced by fers_run_simulation().

Here is the caller graph for this function:

setAdcBits()

void params::setAdcBits ( const unsigned  bits )

noexcept

Set the ADC quantization bits.

Parameters

bits	The new ADC quantization bits.

Definition at line 201 of file parameters.h.

    {
        params.adc_bits = bits;
        LOG(logging::Level::DEBUG, "ADC quantization bits set to: {}", bits);
    }

References logging::DEBUG, and LOG.

setC()

void params::setC ( RealType  cValue )

noexcept

Set the speed of light.

Parameters

cValue

The new speed of light.

Definition at line 145 of file parameters.h.

    {
        params.c = cValue;
        LOG(logging::Level::INFO, "Propagation speed (c) set to: {:.5f}", cValue);
    }

References logging::INFO, and LOG.

setCoordinateSystem()

void params::setCoordinateSystem ( const CoordinateFrame  frame, const int  zone, const bool  north  )

noexcept

Set the coordinate system for the scenario.

Parameters

frame	The coordinate frame (ENU, UTM, ECEF).
zone	The UTM zone, if applicable.
north	The UTM hemisphere (true for North), if applicable.

Definition at line 265 of file parameters.h.

    {
        params.coordinate_frame = frame;
        params.utm_zone = zone;
        params.utm_north_hemisphere = north;
    }

setOrigin()

void params::setOrigin ( const double  lat, const double  lon, const double  alt  )

noexcept

Set the geodetic origin for the KML generator.

Parameters

lat	The latitude of the origin.
lon	The longitude of the origin.
alt	The altitude of the origin (MSL).

Definition at line 228 of file parameters.h.

    {
        params.origin_latitude = lat;
        params.origin_longitude = lon;
        params.origin_altitude = alt;
        LOG(logging::Level::INFO, "Origin set to lat: {}, lon: {}, alt: {}", lat, lon, alt);
    }

References logging::INFO, and LOG.

setOversampleRatio()

void params::setOversampleRatio

(

unsigned

ratio

)

Set the oversampling ratio.

Parameters

ratio

The new oversampling ratio.

Exceptions

std::runtime_error

if the ratio is zero.

Definition at line 212 of file parameters.h.

    {
        if (ratio == 0)
        {
            throw std::runtime_error("Oversample ratio must be >= 1");
        }
        params.oversample_ratio = ratio;
        LOG(logging::Level::DEBUG, "Oversampling enabled with ratio: {}", ratio);
    }

References logging::DEBUG, and LOG.

setRandomSeed()

void params::setRandomSeed ( const unsigned  seed )

noexcept

Set the random seed.

Parameters

seed	The new random seed value.

Definition at line 191 of file parameters.h.

    {
        params.random_seed = seed;
        LOG(logging::Level::DEBUG, "Random seed set to: {}", seed);
    }

References logging::DEBUG, and LOG.

setRate()

void params::setRate

(

RealType

rateValue

)

Set the rendering sample rate.

Parameters

rateValue

The new sample rate for rendering.

Definition at line 177 of file parameters.h.

    {
        if (rateValue <= 0)
        {
            throw std::runtime_error("Sampling rate must be > 0");
        }
        params.rate = rateValue;
        LOG(logging::Level::DEBUG, "Sample rate set to: {:.5f}", rateValue);
    }

References logging::DEBUG, and LOG.

setSimSamplingRate()

void params::setSimSamplingRate ( const RealType  rate )

noexcept

Set the simulation sampling rate.

Parameters

rate	The new simulation sampling rate.

Definition at line 167 of file parameters.h.

    {
        params.sim_sampling_rate = rate;
        LOG(logging::Level::DEBUG, "Simulation sampling rate set to: {:.5f} Hz", rate);
    }

References logging::DEBUG, LOG, and rate().

Here is the call graph for this function:

setThreads()

std::expected< void, std::string > params::setThreads ( const unsigned  threads )

noexcept

Set the number of worker threads.

Parameters

threads

The number of worker threads.

Returns

A std::expected<void, std::string> indicating success or an error message if the number of threads is invalid.

Definition at line 248 of file parameters.h.

    {
        if (threads == 0)
        {
            return std::unexpected("Thread count must be >= 1");
        }
        params.render_threads = threads;
        LOG(logging::Level::INFO, "Number of worker threads set to: {}", threads);
        return {};
    }

References logging::INFO, and LOG.

Referenced by fers_set_thread_count().

Here is the caller graph for this function:

setTime()

void params::setTime ( const RealType  startTime, const RealType  endTime  )

noexcept

Set the start and end times for the simulation.

Parameters

startTime	Start time for the simulation.
endTime	End time for the simulation.

Definition at line 156 of file parameters.h.

    {
        params.start = startTime;
        params.end = endTime;
        LOG(logging::Level::INFO, "Simulation time set from {:.5f} to {:.5f} seconds", startTime, endTime);
    }

References endTime(), logging::INFO, LOG, and startTime().

Here is the call graph for this function:

simSamplingRate()

RealType params::simSamplingRate ( )

noexcept

Get the simulation sampling rate.

Returns

The simulation sampling rate.

Definition at line 103 of file parameters.h.

{ return params.sim_sampling_rate; }

Referenced by simulation::calculateResponse().

Here is the caller graph for this function:

startTime()

RealType params::startTime ( )

noexcept

Get the start time for the simulation.

Returns

Start time for the simulation.

Definition at line 91 of file parameters.h.

{ return params.start; }

Referenced by processing::finalizeCwReceiver(), fers_signal::from_json(), radar::Receiver::getWindowCount(), serial::json_to_world(), radar::processRawSchedule(), core::runEventDrivenSim(), core::World::scheduleInitialEvents(), and setTime().

Here is the caller graph for this function:

utmNorthHemisphere()

bool params::utmNorthHemisphere ( )

noexcept

Definition at line 276 of file parameters.h.

{ return params.utm_north_hemisphere; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

utmZone()

int params::utmZone ( )

noexcept

Definition at line 274 of file parameters.h.

{ return params.utm_zone; }

Referenced by serial::KmlGenerator::generateKml().

Here is the caller graph for this function:

Variable Documentation

params

Parameters params::params

Definition at line 73 of file parameters.h.

Referenced by fers_load_scenario_from_xml_file(), fers_load_scenario_from_xml_string(), serial::json_to_world(), serial::parseSimulation(), serial::parseSimulationFromString(), serial::world_to_json(), and serial::world_to_xml_string().