all_data¶

Important note: To keep roll and pitch information retained after conversion to the standard multibeam format it is important to call the function all_data.match_attitude.

Basic utilities for working with the .all file format

class auvlib.data_tools.all_data.StreamParser¶

Class for parsing all data directly from a network stream

parse_packet(self: auvlib.data_tools.all_data.StreamParser, arg0: unicode) → bool¶: Parse a string containing the packet load, and call the set callbacks with the corresponding data types

set_mbes_callback(self: auvlib.data_tools.all_data.StreamParser, arg0: Callable[[auvlib.data_tools.all_data.all_mbes_ping], None]) → None¶: Callback to call when encountering all_mbes_ping packets

set_nav_entry_callback(self: auvlib.data_tools.all_data.StreamParser, arg0: Callable[[auvlib.data_tools.all_data.all_nav_entry], None]) → None¶: Callback to call when encountering all_nav_entry packets

class auvlib.data_tools.all_data.all_echosounder_depth¶

Class for the all single-beam echosounder depth

depth_¶: Depth

first_in_file_¶: Is first measurement in file?

id_¶: Sequential ID of measurement

static parse_file(arg0: unicode) → List[auvlib.data_tools.all_data.all_echosounder_depth]¶: Parse all_echosounder_depth from .all file

static parse_folder(arg0: unicode) → List[auvlib.data_tools.all_data.all_echosounder_depth]¶: Parse all_echosounder_depth from folder of .all files

static read_data(arg0: unicode) → List[auvlib.data_tools.all_data.all_echosounder_depth]¶: Read all_echosounder_depth::EntriesT from .cereal file

time_stamp_¶: UNIX timestamp

time_string_¶: Readable date of measurement

class auvlib.data_tools.all_data.all_mbes_ping¶

Class for the all multibeam type

beams¶: Positions of hist in sensor coordinates

first_in_file_¶: Is first measurement in file?

heading_¶: Radian yaw in ENU coordinates

id_¶: Sequential ID of measurement

static parse_file(arg0: unicode) → List[auvlib.data_tools.all_data.all_mbes_ping]¶: Parse all_mbes_ping from .all file

static parse_folder(arg0: unicode) → List[auvlib.data_tools.all_data.all_mbes_ping]¶: Parse all_mbes_ping from folder of .all files

static read_data(arg0: unicode) → List[auvlib.data_tools.all_data.all_mbes_ping]¶: Read all_mbes_ping::PingsT from .cereal file

reflectivities¶: Return reflectivities

sound_vel_¶: Sound velocity

time_stamp_¶: UNIX timestamp

time_string_¶: Readable date of measurement

transducer_depth_¶: Depth of sensor

class auvlib.data_tools.all_data.all_nav_attitude¶

Class for the all nav attitude entry

first_in_file_¶: Is first measurement in file?

id_¶: Sequential ID of measurement

static parse_file(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_attitude]¶: Parse all_nav_attitude from .all file

static parse_folder(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_attitude]¶: Parse all_nav_attitude from folder of .all files

static read_data(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_attitude]¶: Read all_nav_attitude::EntriesT from .cereal file

samples¶: The measurements

time_stamp_¶: UNIX timestamp

time_string_¶: Readable date of measurement

class auvlib.data_tools.all_data.all_nav_attitude_sample¶

Class for the all nav attitude sample entry

heading¶: Radian yaw in ENU coordinates

heave¶: Heave

ms_since_start¶: Milliseconds since start of measurements

pitch¶: Radian pitch in ENU coordinates

roll¶: Radian roll in ENU coordinates

class auvlib.data_tools.all_data.all_nav_depth¶

Class for the all nav depth entry

first_in_file_¶: Is first measurement in file?

height¶: Height

height_type¶: TODO

id_¶: Sequential ID of measurement

static parse_file(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_depth]¶: Parse all_nav_depth from .all file

static parse_folder(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_depth]¶: Parse all_nav_depth from folder of .all files

static read_data(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_depth]¶: Read all_nav_depth::EntriesT from .cereal file

time_stamp_¶: UNIX timestamp

time_string_¶: Readable date of measurement

class auvlib.data_tools.all_data.all_nav_entry¶

Class for the all nav entry

course_over_ground_¶: TODO

depth_¶: Depth

first_in_file_¶: Is first measurement in file?

heading_¶: Radian yaw in ENU coordinates

id_¶: Sequential ID of measurement

lat_¶: Latitude

long_¶: Longitude

static parse_file(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_entry]¶: Parse all_nav_entry from .all file

static parse_folder(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_entry]¶: Parse all_nav_entry from folder of .all files

static read_data(arg0: unicode) → List[auvlib.data_tools.all_data.all_nav_entry]¶: Read all_nav_entry::EntriesT from .cereal file

time_stamp_¶: UNIX timestamp

time_string_¶: Readable date of measurement

auvlib.data_tools.all_data.convert_attitudes(arg0: List[auvlib.data_tools.all_data.all_nav_attitude]) → List[auvlib.data_tools.std_data.attitude_entry]¶: Convert all_nav_attitude::EntriesT to std_data::attitude_entry::EntriesT

auvlib.data_tools.all_data.convert_matched_entries(arg0: List[auvlib.data_tools.all_data.all_mbes_ping], arg1: List[auvlib.data_tools.all_data.all_nav_entry]) → List[auvlib.data_tools.std_data.mbes_ping]¶: Matches all_mbes_ping::PingsT and all_nav_entry::EntriesT and assign pos data to pings

auvlib.data_tools.all_data.convert_sound_speeds(arg0: List[auvlib.data_tools.all_data.all_mbes_ping]) → List[csv_data::csv_asvp_sound_speed]¶: Convert all_mbes_ping::PingsT to csv_asvp_sound_speed::EntriesT

auvlib.data_tools.all_data.match_attitude(arg0: List[auvlib.data_tools.std_data.mbes_ping], arg1: List[auvlib.data_tools.all_data.all_nav_attitude]) → List[auvlib.data_tools.std_data.mbes_ping]¶: Match mbes_ping::PingsT and all_nav_attitude::EntriesT and assign attitude data to pings

auvlib.data_tools.all_data.write_data(*args, **kwargs)¶

Overloaded function.

write_data(arg0: List[auvlib.data_tools.all_data.all_mbes_ping], arg1: unicode) -> None

Write all_mbes_ping::PingsT to .cereal file

write_data(arg0: List[auvlib.data_tools.all_data.all_nav_entry], arg1: unicode) -> None

Write all_nav_entry::EntriesT to .cereal file

write_data(arg0: List[auvlib.data_tools.all_data.all_nav_depth], arg1: unicode) -> None

Write all_nav_depth::EntriesT to .cereal file

write_data(arg0: List[auvlib.data_tools.all_data.all_nav_attitude], arg1: unicode) -> None

Write all_nav_attitude::EntriesT to .cereal file

write_data(arg0: List[auvlib.data_tools.all_data.all_echosounder_depth], arg1: unicode) -> None

Write all_echosounder_depth::EntriesT to .cereal file