return_avg_tables

HSTB.kluster.fqpr_convenience.return_avg_tables(fqpr_inst=None, avg_bin_size=1.0, avg_angle=45.0, avg_line=None, overwrite_existing_avg=True)

Helper function for building the angle varying gain tables used during backscatter processing. This function is also wrapped into generate_new_mosaic, so you will most likely use it there.

Will return a list of the avg table dict for each fqpr_inst provided, and if new tables are created, will also save the table to the ‘avg_table’ attribute in each fqpr object.

Parameters

• fqpr_inst (Optional[list]) – list of instances of fqpr_generation.Fqpr class that contains generated backscatter data, see perform_all_processing or reload_data.

• avg_bin_size (float) – the size of the bins in the avg table in degrees.

• avg_angle (float) – reference angle used in the angle varying gain process

• avg_line (Optional[str]) – multibeam file name used for the subset of data used in angle varying gain process. if None, will use the first line in the first dataset

• overwrite_existing_avg (bool) – if True, will overwrite the existing avg table with a new one. if False, will use the existing avg table.

Returns

dictionary of {angles (degrees): avg correctors (dB)}

Return type

dict