Dataset accessor methods

Each of the following functions can be used in an object-oriented style thanks to xarray’s accessor mechanism. The class shnitsel._generated_accessors.DatasetAccessor is registered as an accessor upon import of shnitsel.xarray, which means that it is instatiated as the sh property of every xarray.Dataset.

In practice, this means that instead of writing

shnitsel.core.postprocess.to_xyz(ds)

you can write

ds.sh.to_xyz()

The shnitsel.xarray.DSShnitselAccessor is opinionated about whether a method is suitable for the xarray.Dataset in question. The list of suitable When working in a notebook, the HTML representation of the accessor (type ds.sh) will show suitable methods and explain why the others are unsuitable. This information is also available through the ds.sh.suitable list and the ds.sh.unsuitable dictionary.

Dataset.sh.assign_fosc()	Wrapper for shnitsel.core.postprocess.assign_fosc().
Dataset.sh.assign_levels([levels])	Wrapper for shnitsel.core.xrhelpers.assign_levels().
Dataset.sh.broaden_gauss(fosc[, agg_dim, ...])	Wrapper for shnitsel.core.postprocess.broaden_gauss().
Dataset.sh.calc_pops()	Wrapper for shnitsel.core.postprocess.calc_pops().
Dataset.sh.default_mol()	Wrapper for shnitsel.core.postprocess.default_mol().
Dataset.sh.energy_filtranda()	Wrapper for shnitsel.core.filtre.energy_filtranda().
Dataset.sh.expand_midx(midx_name, ...)	Wrapper for shnitsel.core.xrhelpers.expand_midx().
Dataset.sh.find_hops()	Wrapper for shnitsel.core.postprocess.find_hops().
Dataset.sh.flatten_levels(idx_name, levels)	Wrapper for shnitsel.core.xrhelpers.flatten_levels().
Dataset.sh.get_cutoffs()	Wrapper for shnitsel.core.filtre.get_cutoffs().
Dataset.sh.get_inter_state()	Wrapper for shnitsel.core.postprocess.get_inter_state().
Dataset.sh.get_per_state()	Wrapper for shnitsel.core.postprocess.get_per_state().
Dataset.sh.iconds_to_frames()	Wrapper for shnitsel.core.parse.sharc_icond.iconds_to_frames().
Dataset.sh.mgroupby(levels)	Wrapper for shnitsel.core.xrhelpers.mgroupby().
Dataset.sh.msel(**kwargs)	Wrapper for shnitsel.core.xrhelpers.msel().
Dataset.sh.pca_and_hops()	Wrapper for shnitsel.core.postprocess.pca_and_hops().
Dataset.sh.save_frames(path[, complevel])	Wrapper for shnitsel.core.xrhelpers.save_frames().
Dataset.sh.sel_trajs(trajids_or_mask[, invert])	Wrapper for shnitsel.core.xrhelpers.sel_trajs().
Dataset.sh.setup_frames([to_time, ...])	Wrapper for shnitsel.core.postprocess.setup_frames().
Dataset.sh.spectra_all_times()	Wrapper for shnitsel.core.plot.spectra3d.spectra_all_times().
Dataset.sh.truncate(cutoffs)	Wrapper for shnitsel.core.filtre.truncate().
Dataset.sh.ts_to_time([delta_t, old])	Wrapper for shnitsel.core.postprocess.ts_to_time().
Dataset.sh.validate()	Wrapper for shnitsel.core.postprocess.validate().
Dataset.sh.write_ase(db_path, kind[, keys, ...])	Wrapper for shnitsel.core.ase.write_ase().