pybtls.output.output_config.OutputConfig#

class OutputConfig(self: pybtls.lib.libbtls._ConfigDataCore)[source]#

Bases: _ConfigDataCore

Methods

`set_BM_output`	Config for conducting block-max analysis to load events and writing data to HDD.
`set_POT_output`	Config for conducting peak-over-threshold analysis to load events and writing data to HDD.
`set_event_output`	Config for recording all load events to HDD.
`set_fatigue_output`	Config for recording fatigue event, doing rainflow count and writing data to HDD.
`set_stats_output`	Config for doing statistic to the flow and writing data to HDD.
`set_vehicle_file_output`	Config for recording the vehicles (in the generated traffic) to HDD.

set_event_output(write_time_history=False, write_each_event=False, buffer_size=10000)[source]#

Config for recording all load events to HDD.

Parameters:

write_time_history (bool, optional) – Whether to write time history data to HDD. The default is False.
write_each_event (bool, optional) – Whether to write each event to HDD. The default is False.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None

set_vehicle_file_output(write_vehicle_file=False, vehicle_file_format=4, vehicle_file_name='output_traffic.txt', buffer_size=10000)[source]#

Config for recording the vehicles (in the generated traffic) to HDD.

Parameters:

write_vehicle_file (bool, optional) – Whether to write vehicles to HDD. The default is False.
vehicle_file_format (int, optional) – The format of the vehicle file. The default is 4.
vehicle_file_name (str, optional) – The name of the vehicle file. The default is “output_traffic.txt”.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None

set_BM_output(write_vehicle=False, write_summary=False, write_mixed=False, block_size_days=1, block_size_secs=0, buffer_size=10000)[source]#

Config for conducting block-max analysis to load events and writing data to HDD.

Parameters:

write_vehicle (bool, optional) – Whether to write vehicles to HDD. The default is False.
write_summary (bool, optional) – Whether to write summary data to HDD. The default is False.
write_mixed (bool, optional) – Whether to write mixed data to HDD. The default is False.
block_size_days (int, optional) – The block size in days. The default is 1.
block_size_secs (int, optional) – The block size in seconds. The default is 0.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None

set_POT_output(write_vehicle=False, write_summary=False, write_counter=False, POT_size_days=1, POT_size_secs=0, buffer_size=10000)[source]#

Config for conducting peak-over-threshold analysis to load events and writing data to HDD.

Parameters:

write_vehicle (bool, optional) – Whether to write vehicles to HDD. The default is False.
write_summary (bool, optional) – Whether to write summary data to HDD. The default is False.
write_counter (bool, optional) – Whether to write counter data to HDD. The default is False.
POT_size_days (int, optional) – The POT size in days. The default is 1.
POT_size_secs (int, optional) – The POT size in seconds. The default is 0.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None

set_stats_output(write_flow_stats=False, write_overall=False, write_intervals=False, interval_size=3600, buffer_size=10000)[source]#

Config for doing statistic to the flow and writing data to HDD.

Parameters:

write_flow_stats (bool, optional) – Whether to write flow statistics to HDD. The default is False.
write_overall (bool, optional) – Whether to write overall statistics to HDD. The default is False.
write_intervals (bool, optional) – Whether to write interval statistics to HDD. The default is False.
interval_size (int, optional) – The interval size in seconds. The default is 3600.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None

set_fatigue_output(write_fatigue_event=False, write_rainflow_output=False, rainflow_decimal=1, rainflow_cut_off=0.0, buffer_size=10000)[source]#

Config for recording fatigue event, doing rainflow count and writing data to HDD.

Parameters:

write_fatigue_event (bool, optional) – Whether to write fatigue event to HDD. The default is False.
write_rainflow_output (bool, optional) – Whether to write rainflow count result to HDD. The default is False.
rainflow_decimal (int, optional) – The decimal of rainflow count. The default is 1.
rainflow_cut_off (float, optional) – The cut off value of rainflow count. The default is 0.0.
buffer_size (int, optional) – The buffer size for writing data to HDD. The default is 10000.

Return type:

None