spyfit.io.sfit4.read_summary

spyfit.io.sfit4.read_summary(filename, spdim='spectrum', wcoord='spec_wn', scoord='spec_scan', bcoord='spec_band', bdim='band', sdim='scan')

Read retrieval summary in SFIT4 output ascii files.

Use this function to load ‘out.summary’.

Parameters:

filename : str

Name or path to the file.

spdim : str

Name of the dimension of the spectral data (default: ‘spectrum’). spectral data or coordinates for all fitted micro-windows (i.e., bands and scans) will be flattened as a 1-d array.

wcoord : str

Name of the wavenumber coordinate for spectral data (default: ‘spec_wn’).

scoord : str

Name of the coordinate for spectral scans (default: ‘spec_scan’).

bcoord : str

Name of the coordinate for spectral bands (default: ‘spec_band’).

bdim : str

Name of the dimension of the bands (default: ‘band’).

sdim : str

Name of the dimension of the scans (default: ‘scan’).

Returns:

dataset : dict

A CDM-structured dictionary.