Struct braid_config_data::MainbrainConfig
source · pub struct MainbrainConfig {
pub cal_fname: Option<PathBuf>,
pub output_base_dirname: PathBuf,
pub tracking_params: TrackingParams,
pub lowlatency_camdata_udp_addr: Option<String>,
pub lowlatency_camdata_udp_port: u16,
pub http_api_server_addr: String,
pub model_server_addr: SocketAddr,
pub save_empty_data2d: bool,
pub secret_base64: Option<String>,
pub packet_capture_dump_fname: Option<PathBuf>,
pub acquisition_duration_allowed_imprecision_msec: Option<f64>,
pub write_buffer_size_num_messages: usize,
}
Expand description
The sub-configuration of BraidConfig for mainbrain
- the central
component of Braid that integrates information from multiple cameras and
performs tracking.
Fields§
§cal_fname: Option<PathBuf>
Filename of the camera calibration, optional.
Can contain shell variables such as ~
, $A
, or ${B}
.
If the filename ends with .pymvg or .json, it will be treated as a pymvg calibration file. Else it will be treated considered in the flydra XML calibration format.
output_base_dirname: PathBuf
Directory where data should be saved. Can contain shell variables. Defaults to DEFAULT_OUTPUT_BASE_DIRNAME.
tracking_params: TrackingParams
Parameters for Kalman filter and data association
lowlatency_camdata_udp_addr: Option<String>
Address of UDP port to send low-latency detection data
lowlatency_camdata_udp_port: u16
§http_api_server_addr: String
Address of HTTP port for control API. This is specified in the format
IP:PORT
where:
IP
can be:
- a numerical IPv4 address:
- e.g.
1.1.1.1
uses the specific IP 127.0.0.1
for the loopback interface0.0.0.0
to open the server on all available IPv4 interfaces
- e.g.
- a numerical IPv6 address:
- e.g.
[2001:db8:3333:4444:5555:6666:7777:8888]
uses the specific IP [::1]
for the loopback interface[::]
to open the server on all available IPv6 interfaces
- e.g.
- a hostname which resolves to an IP address (depending on your DNS
configuration, resolves to either IPv4 or IPv6):
localhost
resolves to the IP address of the loopback interface- e.g.
hostname
for a specific IP address
PORT
can be:
0
allows the operating system to choose an unassigned port dynamically- e.g.
1234
uses the specific port
Set to 0.0.0.0:0
to be automatically assigned a public IP address with
a dynamically assigned port.
The default value is set to DEFAULT_HTTP_API_SERVER_ADDR.
model_server_addr: SocketAddr
Address of HTTP port for model server emitting realtime tracking results
save_empty_data2d: bool
Save rows to data2d_distorted where nothing detected (saves timestamps)
secret_base64: Option<String>
Secret to use for signing HTTP cookies (base64 encoded)
packet_capture_dump_fname: Option<PathBuf>
For debugging: filename to store captured packet data.
acquisition_duration_allowed_imprecision_msec: Option<f64>
Threshold duration before logging error (msec).
If the image acquisition timestamp precedes the computed trigger timestamp, clearly an error has happened. This error must lie in the computation of the trigger timestamp. This specifies the threshold error at which an error is logged. (The underlying source of such errors remains unknown.)
write_buffer_size_num_messages: usize
The size of the buffer, in number of messages, used by the channel for sending data to disk.
Trait Implementations§
source§impl Clone for MainbrainConfig
impl Clone for MainbrainConfig
source§fn clone(&self) -> MainbrainConfig
fn clone(&self) -> MainbrainConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MainbrainConfig
impl Debug for MainbrainConfig
source§impl Default for MainbrainConfig
impl Default for MainbrainConfig
source§impl<'de> Deserialize<'de> for MainbrainConfig
impl<'de> Deserialize<'de> for MainbrainConfig
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for MainbrainConfig
impl RefUnwindSafe for MainbrainConfig
impl Send for MainbrainConfig
impl Sync for MainbrainConfig
impl Unpin for MainbrainConfig
impl UnwindSafe for MainbrainConfig
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.