|
Voyant API 0.8.0
|
#include <cstdarg>#include <cstdint>#include <cstdlib>#include <ostream>#include <new>Go to the source code of this file.
Functions | |
| CarbonClientHandleC * | carbon_client_new (const CarbonConfigC *config) |
| bool | carbon_client_start (CarbonClientHandleC *handle) |
| void | carbon_client_stop (CarbonClientHandleC *handle) |
| bool | carbon_client_is_running (const CarbonClientHandleC *handle) |
| int32_t | carbon_client_copy_latest_into (CarbonClientHandleC *handle, uint8_t *dest, uintptr_t len) |
| void | carbon_client_free (CarbonClientHandleC *handle) |
| CarbonConfigC * | carbon_config_new () |
| CarbonConfigC * | carbon_config_from_json (const char *path) |
| void | carbon_config_free (CarbonConfigC *cfg) |
| void | carbon_config_set_bind_addr (CarbonConfigC *cfg, const char *v) |
| void | carbon_config_set_group_addr (CarbonConfigC *cfg, const char *v) |
| void | carbon_config_set_interface_addr (CarbonConfigC *cfg, const char *v) |
| void | carbon_config_set_use_msg_timestamp (CarbonConfigC *cfg, bool v) |
| void | carbon_config_set_batch_size (CarbonConfigC *cfg, uintptr_t v) |
| void | carbon_config_set_recv_buffer_size (CarbonConfigC *cfg, uintptr_t v) |
| void | carbon_config_set_receiver_channel_capacity (CarbonConfigC *cfg, uintptr_t v) |
| void | carbon_config_set_pfa (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_vel_corr_factor (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_bandwidth_hz (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_elevation_fov_deg (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_keep_invalid_points (CarbonConfigC *cfg, bool v) |
| void | carbon_config_set_range_min (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_range_max (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_doppler_min (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_doppler_max (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_azimuth_deg_min (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_azimuth_deg_max (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_elevation_deg_min (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_elevation_deg_max (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_spatial_range_threshold (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_spatial_doppler_threshold (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_spatial_min_neighbors (CarbonConfigC *cfg, uint8_t v) |
| void | carbon_config_set_interp_range_threshold (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_interp_doppler_threshold (CarbonConfigC *cfg, float v) |
| void | carbon_config_set_missing_elevations (CarbonConfigC *cfg, const uint8_t *elevations, uintptr_t len) |
| void | carbon_config_set_mirror_peaks (CarbonConfigC *cfg, bool v) |
| void | carbon_config_set_mirror_group_addr (CarbonConfigC *cfg, const char *v) |
| void | carbon_config_set_mirror_bind_addr (CarbonConfigC *cfg, const char *v) |
| void | carbon_config_set_eval_mode (CarbonConfigC *cfg, bool v) |
| void | carbon_config_set_report_dir (CarbonConfigC *cfg, const char *v) |
| int32_t carbon_client_copy_latest_into | ( | CarbonClientHandleC * | handle, |
| uint8_t * | dest, | ||
| uintptr_t | len | ||
| ) |
Copies the latest frame into dest if a new one is available.
| void carbon_client_free | ( | CarbonClientHandleC * | handle | ) |
Frees a CarbonClientHandle. Stops the client if running. Safe to call with null.
| bool carbon_client_is_running | ( | const CarbonClientHandleC * | handle | ) |
Returns true if the client is running and no OS shutdown has been requested.
| CarbonClientHandleC * carbon_client_new | ( | const CarbonConfigC * | config | ) |
Creates and initializes a CarbonClientHandle from a CarbonConfig. The config is cloned internally — it can be freed immediately after this call.
| config | Pointer to a CarbonConfig created via carbon_config_new(). |
| bool carbon_client_start | ( | CarbonClientHandleC * | handle | ) |
Start receiving and processing data.
| void carbon_client_stop | ( | CarbonClientHandleC * | handle | ) |
Stop receiving and processing data. Safe to call multiple times. The client can be restarted by calling carbon_client_start() again.
| void carbon_config_free | ( | CarbonConfigC * | cfg | ) |
Frees a CarbonConfig. Safe to call with null.
| CarbonConfigC * carbon_config_from_json | ( | const char * | path | ) |
Load a CarbonConfig from a JSON file. Missing fields default to their standard values. Returns null on failure (file not found, parse error, or validation failure).
| path | Null-terminated path to the JSON config file. |
| CarbonConfigC * carbon_config_new | ( | ) |
Creates a new CarbonConfig with default values.
| void carbon_config_set_azimuth_deg_max | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Maximum azimuth filter in degrees.
| void carbon_config_set_azimuth_deg_min | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Minimum azimuth filter in degrees.
| void carbon_config_set_bandwidth_hz | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Chirp sweep bandwidth in Hz.
| void carbon_config_set_batch_size | ( | CarbonConfigC * | cfg, |
| uintptr_t | v | ||
| ) |
Maximum number of peaks messages per batch before flushing to the pipeline.
| void carbon_config_set_bind_addr | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Set the UDP bind address including port (e.g. "0.0.0.0:5678")
| void carbon_config_set_doppler_max | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Maximum Doppler filter in m/s.
| void carbon_config_set_doppler_min | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Minimum Doppler filter in m/s.
| void carbon_config_set_elevation_deg_max | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Maximum elevation filter in degrees.
| void carbon_config_set_elevation_deg_min | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Minimum elevation filter in degrees.
| void carbon_config_set_elevation_fov_deg | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Elevation field of view in degrees.
| void carbon_config_set_eval_mode | ( | CarbonConfigC * | cfg, |
| bool | v | ||
| ) |
Enable timing and drop statistics evaluation with generated reports.
| void carbon_config_set_group_addr | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Set the multicast group address (e.g. "224.0.0.0")
| void carbon_config_set_interface_addr | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Set the network interface address (e.g. "0.0.0.0" for default)
| void carbon_config_set_interp_doppler_threshold | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Doppler threshold for elevation interpolation in m/s. Default: 0.25
| void carbon_config_set_interp_range_threshold | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Range threshold for elevation interpolation in meters. Default: 5.0
| void carbon_config_set_keep_invalid_points | ( | CarbonConfigC * | cfg, |
| bool | v | ||
| ) |
Keep invalid points in the assembled point cloud. Default: false.
| void carbon_config_set_mirror_bind_addr | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Bind address for the peaks mirror sender (e.g. "127.0.0.1:0").
| void carbon_config_set_mirror_group_addr | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Multicast group address for peaks mirroring (e.g. "224.0.0.1:5555").
| void carbon_config_set_mirror_peaks | ( | CarbonConfigC * | cfg, |
| bool | v | ||
| ) |
Enable multicast mirroring of raw peaks for external logging.
| void carbon_config_set_missing_elevations | ( | CarbonConfigC * | cfg, |
| const uint8_t * | elevations, | ||
| uintptr_t | len | ||
| ) |
Missing elevation indices to interpolate (must be even: 0, 2, 4, ... 254). Setting this enables elevation interpolation. Default: disabled (empty).
| void carbon_config_set_pfa | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Probability of False Alarm for optional SNR thresholding. Recommended range: [1e-6, 1e-3].
| void carbon_config_set_range_max | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Maximum range filter in meters.
| void carbon_config_set_range_min | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Minimum range filter in meters.
| void carbon_config_set_receiver_channel_capacity | ( | CarbonConfigC * | cfg, |
| uintptr_t | v | ||
| ) |
Channel capacity for batched messages from receiver to pipeline.
| void carbon_config_set_recv_buffer_size | ( | CarbonConfigC * | cfg, |
| uintptr_t | v | ||
| ) |
Size of the pre-allocated UDP receive buffer in bytes.
| void carbon_config_set_report_dir | ( | CarbonConfigC * | cfg, |
| const char * | v | ||
| ) |
Directory for evaluation report files. Only used when eval mode is enabled. Default: "./reports"
| void carbon_config_set_spatial_doppler_threshold | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Doppler threshold for spatial outlier filter in m/s. Default: 0.1
| void carbon_config_set_spatial_min_neighbors | ( | CarbonConfigC * | cfg, |
| uint8_t | v | ||
| ) |
Minimum number of neighbors for a point to pass the spatial outlier filter. Default: 1
| void carbon_config_set_spatial_range_threshold | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Range threshold for spatial outlier filter in meters. Default: 0.1
| void carbon_config_set_use_msg_timestamp | ( | CarbonConfigC * | cfg, |
| bool | v | ||
| ) |
Use timestamps from received packets instead of system time on receipt.
| void carbon_config_set_vel_corr_factor | ( | CarbonConfigC * | cfg, |
| float | v | ||
| ) |
Velocity correction multiplier.