Struct to hold simulation parameters. More...
#include "parameters.h"
Public Member Functions | |
| void | reset () noexcept |
| Resets the parameters to their default-constructed state. | |
Public Attributes | |
| RealType | c = DEFAULT_C |
| Speed of light (modifiable) | |
| RealType | boltzmann_k = DEFAULT_BOLTZMANN_K |
| Boltzmann constant. | |
| RealType | start = 0 |
| Start time for the simulation. | |
| RealType | end = 0 |
| End time for the simulation. | |
| RealType | sim_sampling_rate = 1000 |
| Temporal sampling rate (Hz) that determines time-step resolution for radar pulse simulation. | |
| double | origin_latitude = -33.957652 |
| Geodetic origin latitude. | |
| double | origin_longitude = 18.4611991 |
| Geodetic origin longitude. | |
| double | origin_altitude = 111.01 |
| Geodetic origin altitude (in meters) | |
| CoordinateFrame | coordinate_frame = CoordinateFrame::ENU |
| Scenario coordinate frame. | |
| int | utm_zone = 0 |
| UTM zone (1-60), if applicable. | |
| bool | utm_north_hemisphere = true |
| UTM hemisphere, if applicable. | |
| RealType | rate = 0 |
| Rendering sample rate. | |
| std::optional< unsigned > | random_seed |
| Random seed for simulation. | |
| unsigned | adc_bits = 0 |
| ADC quantization bits. | |
| unsigned | filter_length = 33 |
| Default render filter length. | |
| unsigned | render_threads = 1 |
| Number of worker threads to use for parallel tasks. | |
| std::string | simulation_name |
| The name of the simulation, from the XML. | |
| unsigned | oversample_ratio = 1 |
| Oversampling ratio. | |
Static Public Attributes | |
| static constexpr RealType | DEFAULT_C = 299792458.0 |
| Speed of light (m/s) | |
| static constexpr RealType | DEFAULT_BOLTZMANN_K = 1.3806503e-23 |
| Boltzmann constant. | |
Detailed Description
Struct to hold simulation parameters.
Definition at line 39 of file parameters.h.
Member Function Documentation
◆ reset()
|
noexcept |
Resets the parameters to their default-constructed state.
This ensures all members are restored to the values specified by their default member initializers.
Definition at line 70 of file parameters.h.
Referenced by serial::parseSimulation(), and serial::parseSimulationFromString().
Here is the caller graph for this function:Member Data Documentation
◆ adc_bits
| unsigned params::Parameters::adc_bits = 0 |
ADC quantization bits.
Definition at line 59 of file parameters.h.
Referenced by params::from_json().
◆ boltzmann_k
| RealType params::Parameters::boltzmann_k = DEFAULT_BOLTZMANN_K |
Boltzmann constant.
Definition at line 44 of file parameters.h.
◆ c
Speed of light (modifiable)
Definition at line 43 of file parameters.h.
Referenced by params::from_json().
◆ coordinate_frame
| CoordinateFrame params::Parameters::coordinate_frame = CoordinateFrame::ENU |
Scenario coordinate frame.
Definition at line 54 of file parameters.h.
Referenced by params::from_json().
◆ DEFAULT_BOLTZMANN_K
|
staticconstexpr |
Boltzmann constant.
Definition at line 42 of file parameters.h.
◆ DEFAULT_C
|
staticconstexpr |
◆ end
| RealType params::Parameters::end = 0 |
End time for the simulation.
Definition at line 46 of file parameters.h.
Referenced by params::from_json().
◆ filter_length
| unsigned params::Parameters::filter_length = 33 |
Default render filter length.
Definition at line 60 of file parameters.h.
◆ origin_altitude
| double params::Parameters::origin_altitude = 111.01 |
Geodetic origin altitude (in meters)
Definition at line 53 of file parameters.h.
Referenced by params::from_json().
◆ origin_latitude
| double params::Parameters::origin_latitude = -33.957652 |
Geodetic origin latitude.
Definition at line 51 of file parameters.h.
Referenced by params::from_json().
◆ origin_longitude
| double params::Parameters::origin_longitude = 18.4611991 |
Geodetic origin longitude.
Definition at line 52 of file parameters.h.
Referenced by params::from_json().
◆ oversample_ratio
| unsigned params::Parameters::oversample_ratio = 1 |
◆ random_seed
| std::optional<unsigned> params::Parameters::random_seed |
Random seed for simulation.
Definition at line 58 of file parameters.h.
Referenced by fers_load_scenario_from_xml_file(), fers_load_scenario_from_xml_string(), params::from_json(), and serial::json_to_world().
◆ rate
| RealType params::Parameters::rate = 0 |
Rendering sample rate.
Definition at line 57 of file parameters.h.
Referenced by params::from_json().
◆ render_threads
| unsigned params::Parameters::render_threads = 1 |
Number of worker threads to use for parallel tasks.
Definition at line 61 of file parameters.h.
◆ sim_sampling_rate
| RealType params::Parameters::sim_sampling_rate = 1000 |
Temporal sampling rate (Hz) that determines time-step resolution for radar pulse simulation.
Definition at line 47 of file parameters.h.
Referenced by params::from_json().
◆ simulation_name
| std::string params::Parameters::simulation_name |
The name of the simulation, from the XML.
Definition at line 62 of file parameters.h.
Referenced by serial::json_to_world(), and serial::world_to_json().
◆ start
| RealType params::Parameters::start = 0 |
Start time for the simulation.
Definition at line 45 of file parameters.h.
Referenced by params::from_json().
◆ utm_north_hemisphere
| bool params::Parameters::utm_north_hemisphere = true |
UTM hemisphere, if applicable.
Definition at line 56 of file parameters.h.
Referenced by params::from_json().
◆ utm_zone
| int params::Parameters::utm_zone = 0 |
UTM zone (1-60), if applicable.
Definition at line 55 of file parameters.h.
Referenced by params::from_json().
The documentation for this class was generated from the following file:
- packages/libfers/src/core/parameters.h
