klassez Logo
  • Introduction
  • Installation
    • A note on matplotlib backends
  • Import instructions
  • User Guide and Examples
    • Processing of a “raw” 1D spectrum
      • The class pSpectrum_1D
    • Processing of a “raw” 2D spectrum
      • Computing projections
    • Simulating data
      • Simulate 1D data
      • Simulate 2D data
    • Processing of a “raw” pseudo-2D spectrum
      • “Classic” pseudo-2D processing
      • DOSY spectra
    • Processing of a DOSY_T1
    • Analyzing data in KLASSEZ
      • Evaluate Signal to Noise Ratio
      • Integrate 1D spectra
      • Deconvolution of 1D datasets
        • Creating an initial guess for the fit
        • The .vf files
        • Editing the initial guess via GUI
        • Doing the fit
        • Plot results
      • Integrate a pseudo-2D spectrum
      • Fitting a DOSY
      • Fitting a DOSY-T1
    • Example scripts
      • Reading and processing of 1D spectra
      • Fit 1D spectrum
      • Read and process 2D spectrum
      • Read and process a pseudo-2D and fit DOSY
      • Read, process and fit a DOSY-T1
  • Make figures with KLASSEZ
    • The basics: figure panels and subplots
      • Customizing subplots
    • Plot spectra with KLASSEZ
      • Learn with examples: superimposed plot of two spectra
        • Figure panel and subplots
        • Adding artists
        • Setting the axes limits
        • Cosmetic stuff
        • Saving the figure
      • Example script: superimposed plot of two spectra
        • Input files
        • Processing script
  • List of modules and functions
    • CONFIG Module
      • XtermColors
        • XtermColors.__call__()
        • XtermColors.__init__()
        • XtermColors.reset
        • XtermColors.styles
      • cprint()
      • cron()
      • safe_kws()
    • MISC Module
      • avg_antidiag()
      • binomial_triangle()
      • calcres()
      • cmap2list()
      • data2wav()
      • detect_jumps()
      • edit_checkboxes()
      • expformat()
      • find_nearest()
      • freq2ppm()
      • get_datadir_filename()
      • get_extent()
      • get_ylim()
      • hankel()
      • hz2pt()
      • in2px()
      • key_to_limits()
      • lenslice()
      • limits_to_key()
      • listsqueeze()
      • load_ser()
      • makeacqus_1D()
      • makeacqus_1D_jeol()
      • makeacqus_1D_oxford()
      • makeacqus_1D_spinsolve()
      • makeacqus_1D_varian()
      • makeacqus_2D()
      • makeacqus_pp3D()
      • mathformat()
      • merge_dict()
      • molfrac()
      • nuc_format()
      • polyn()
      • ppm2freq()
      • ppmfind()
      • pretty_scale()
      • px2in()
      • read_fid_acqus_1D()
      • read_fid_acqus_2D()
      • readlistfile()
      • set_fontsizes()
      • set_ylim()
      • show_cmap()
      • split_acqus_2D()
      • split_procs_2D()
      • sum_overlay()
      • trim_data()
      • trim_data_2D()
      • unhankel()
      • write_acqus_1D()
      • write_acqus_2D()
      • write_ser()
      • zero_crossing()
    • PROCESSING Module
      • abc()
      • abc_v2()
      • abs()
      • abs2()
      • abs2_v2()
      • abs_v2()
      • acme()
      • align()
      • apk()
      • apodf()
      • blp()
      • cadzow()
      • cadzow_2D()
      • calc_nc()
      • calibration()
      • convdta()
      • convolve()
      • eae()
      • em()
      • extend_taq()
      • fp()
      • ft()
      • gm()
      • gmb()
      • hilbert()
      • hilbert2()
      • ift()
      • integral()
      • integrate()
      • inv_convolve()
      • inv_fp()
      • inv_xfb()
      • iterCadzow()
      • lp()
      • lrd()
      • make_scale()
      • mask_sgn_basl()
      • mcr()
      • mcr_als()
      • mcr_stack()
      • mcr_unpack()
      • pknl()
      • print()
      • ps()
      • qfil()
      • qpol()
      • qsin()
      • quad()
      • repack_2D()
      • rev()
      • rndc()
      • rpbc()
      • simplisma()
      • sin()
      • sl_bas()
      • sl_bas_onidx()
      • smooth_g()
      • split_echo_train()
      • splitcomb()
      • stack_fids()
      • sum_echo_train()
      • tabula_rasa()
      • td_eff()
      • tp_hyper()
      • unpack_2D()
      • whittaker_smoother()
      • xfb()
      • zf()
    • FIGURES Module
      • ax1D()
      • ax2D()
      • ax_diffplot()
      • ax_heatmap()
      • diffplot()
      • dotmd()
      • dotmd_2D()
      • draw_bare_contour()
      • figure1D()
      • figure1D_multi()
      • figure2D()
      • figure2D_multi()
      • heatmap()
      • ongoing_fit()
      • plot_1D()
      • plot_2D()
      • plot_fid()
      • plot_fid_re()
      • plot_p3D()
      • redraw_contours()
      • sns_heatmap()
      • stacked_plot()
    • SIM Module
      • calc_splitting()
      • f_gaussian()
      • f_lorentzian()
      • f_pvoigt()
      • f_skgaussian()
      • gaussian_filter()
      • load_sim_1D()
      • load_sim_2D()
      • mult_noise()
      • multiplet()
      • noisegen()
      • sim_1D()
      • sim_2D()
      • t_2Dgaussian()
      • t_2Dlorentzian()
      • t_2Dpvoigt()
      • t_2Dvoigt()
      • t_gaussian()
      • t_lorentzian()
      • t_pvoigt()
      • t_voigt()
      • water7()
    • FIT Module
      • CostFunc
        • CostFunc.__call__()
        • CostFunc.__init__()
        • CostFunc.asymm_huber()
        • CostFunc.asymm_truncated_quadratic()
        • CostFunc.huber()
        • CostFunc.method_selector()
        • CostFunc.squared_sum()
        • CostFunc.truncated_quadratic()
      • DosyFit
        • DosyFit.__init__()
        • DosyFit.data
        • DosyFit.data_from_integrals()
        • DosyFit.data_from_vf()
        • DosyFit.dofit()
        • DosyFit.fetch_dosy_par()
        • DosyFit.get_fit_lines()
        • DosyFit.iguess()
        • DosyFit.load_fit()
        • DosyFit.parse_pprog()
        • DosyFit.plot()
        • DosyFit.select_model()
      • DosyFit_pp3D
        • DosyFit_pp3D.__init__()
        • DosyFit_pp3D.dofit()
        • DosyFit_pp3D.fetch_dosy_par()
        • DosyFit_pp3D.get_fit_lines()
        • DosyFit_pp3D.iguess()
        • DosyFit_pp3D.integrate_planes()
        • DosyFit_pp3D.load_fit()
        • DosyFit_pp3D.merge_planes()
        • DosyFit_pp3D.model()
        • DosyFit_pp3D.plot()
        • DosyFit_pp3D.select_model()
      • Peak
        • Peak.__call__()
        • Peak.__init__()
        • Peak.get_fid()
        • Peak.par()
      • SINC_ObjFunc
        • SINC_ObjFunc.__call__()
        • SINC_ObjFunc.__init__()
        • SINC_ObjFunc.g1()
        • SINC_ObjFunc.g2()
        • SINC_ObjFunc.g3()
      • Voigt_Fit
        • Voigt_Fit.__init__()
        • Voigt_Fit.dofit()
        • Voigt_Fit.edit_iguess()
        • Voigt_Fit.edit_result()
        • Voigt_Fit.get_fit_lines()
        • Voigt_Fit.iguess()
        • Voigt_Fit.load_fit()
        • Voigt_Fit.plot()
        • Voigt_Fit.res_histogram()
        • Voigt_Fit.to_tragico()
      • Voigt_Fit_2D
        • Voigt_Fit_2D.__init__()
        • Voigt_Fit_2D.draw_coord()
        • Voigt_Fit_2D.draw_crossmarks()
        • Voigt_Fit_2D.fit()
        • Voigt_Fit_2D.iguess()
        • Voigt_Fit_2D.load_coord()
        • Voigt_Fit_2D.load_fit()
        • Voigt_Fit_2D.load_iguess()
        • Voigt_Fit_2D.make_peaks()
        • Voigt_Fit_2D.peak_pick()
        • Voigt_Fit_2D.plot()
      • Voigt_Fit_P2D
        • Voigt_Fit_P2D.__init__()
        • Voigt_Fit_P2D.dofit()
        • Voigt_Fit_P2D.get_fit_lines()
        • Voigt_Fit_P2D.iguess()
        • Voigt_Fit_P2D.load_fit()
        • Voigt_Fit_P2D.plot()
        • Voigt_Fit_P2D.res_histogram()
      • ax_histogram()
      • bin_data()
      • build_2D_sgn()
      • calc_R2()
      • fit_dosy()
      • fit_dosy_multi()
      • fit_int()
      • gaussian_fit()
      • histogram()
      • lr()
      • lsp()
      • make_iguess_dosy()
      • make_signal()
      • model_dste()
      • model_dstebp()
      • model_ste()
      • model_stebp()
      • peak_pick_2D()
      • plot_fit()
      • plot_fit_P2D()
      • plot_fit_dosy()
      • plot_fit_dosy_multi()
      • polyn_basl()
      • print()
      • read_dy()
      • read_vf()
      • read_vf_P2D()
      • sinc_phase()
      • smooth_spl()
      • test_correl()
      • test_ks()
      • test_randomsign()
      • test_residuals()
      • voigt_fit_2D()
      • voigt_fit_P2D()
      • voigt_fit_indep()
      • write_dy()
      • write_vf()
      • write_vf_P2D()
    • ANAL Module
      • get_trace()
      • integral_2D()
      • integrate()
      • integrate_2D()
      • integrate_p2D()
      • noise_std()
      • read_igrl()
      • select_for_integration()
      • select_traces()
      • snr()
      • snr_2D()
      • snr_gui()
      • snr_gui_2D()
      • write_igrl()
    • GUI Module
      • edit_vf()
      • gen_iguess_2D()
      • get_region()
      • interactive_basl_windows()
      • interactive_echo_param()
      • interactive_fp()
      • interactive_phase_1D()
      • interactive_phase_2D()
      • interactive_qfil()
      • interactive_smoothing()
      • interactive_xfb()
      • make_iguess()
      • make_iguess_P2D()
      • make_iguess_auto()
      • make_iguess_dosy_panel()
      • make_polynomion_baseline()
    • SPECTRA Module
      • DOSY
        • DOSY.__init__()
        • DOSY.diffplot()
        • DOSY.integrate()
        • DOSY.process()
        • DOSY.read_integrals()
      • DOSY_T1
        • DOSY_T1.__init__()
        • DOSY_T1.adjph()
        • DOSY_T1.getplane()
        • DOSY_T1.integrate()
        • DOSY_T1.pknl()
        • DOSY_T1.plot()
        • DOSY_T1.process()
        • DOSY_T1.read_procs()
        • DOSY_T1.write_procs()
      • Pseudo_2D
        • Pseudo_2D.S
        • Pseudo_2D.__init__()
        • Pseudo_2D.abs()
        • Pseudo_2D.abs_v2()
        • Pseudo_2D.add_noise()
        • Pseudo_2D.adjph()
        • Pseudo_2D.align()
        • Pseudo_2D.basl()
        • Pseudo_2D.cal()
        • Pseudo_2D.convdta()
        • Pseudo_2D.integrate()
        • Pseudo_2D.mount()
        • Pseudo_2D.pknl()
        • Pseudo_2D.plot()
        • Pseudo_2D.plot_md()
        • Pseudo_2D.plot_stacked()
        • Pseudo_2D.process()
        • Pseudo_2D.projf1()
        • Pseudo_2D.projf2()
        • Pseudo_2D.qfil()
        • Pseudo_2D.read_integrals()
        • Pseudo_2D.rpbc()
        • Pseudo_2D.scan()
        • Pseudo_2D.strip()
        • Pseudo_2D.to_wav()
        • Pseudo_2D.write_integrals()
      • Spectrum_1D
        • Spectrum_1D.S
        • Spectrum_1D.__init__()
        • Spectrum_1D.abs()
        • Spectrum_1D.abs_v2()
        • Spectrum_1D.acme()
        • Spectrum_1D.add_noise()
        • Spectrum_1D.adjph()
        • Spectrum_1D.apk()
        • Spectrum_1D.basl()
        • Spectrum_1D.blp()
        • Spectrum_1D.cal()
        • Spectrum_1D.convdta()
        • Spectrum_1D.integrate()
        • Spectrum_1D.inv_process()
        • Spectrum_1D.mc()
        • Spectrum_1D.pknl()
        • Spectrum_1D.plot()
        • Spectrum_1D.process()
        • Spectrum_1D.qfil()
        • Spectrum_1D.read_integrals()
        • Spectrum_1D.read_procs()
        • Spectrum_1D.rpbc()
        • Spectrum_1D.scan()
        • Spectrum_1D.to_vf()
        • Spectrum_1D.to_wav()
        • Spectrum_1D.write_acqus()
        • Spectrum_1D.write_integrals()
        • Spectrum_1D.write_procs()
        • Spectrum_1D.write_ser()
      • Spectrum_2D
        • Spectrum_2D.S
        • Spectrum_2D.__init__()
        • Spectrum_2D.add_noise()
        • Spectrum_2D.adjph()
        • Spectrum_2D.cal()
        • Spectrum_2D.calf1()
        • Spectrum_2D.calf2()
        • Spectrum_2D.convdta()
        • Spectrum_2D.eae()
        • Spectrum_2D.integrate()
        • Spectrum_2D.inv_process()
        • Spectrum_2D.mc()
        • Spectrum_2D.pknl()
        • Spectrum_2D.plot()
        • Spectrum_2D.process()
        • Spectrum_2D.projf1()
        • Spectrum_2D.projf2()
        • Spectrum_2D.qfil()
        • Spectrum_2D.read_procs()
        • Spectrum_2D.scan()
        • Spectrum_2D.splitcomb()
        • Spectrum_2D.strip()
        • Spectrum_2D.to_wav()
        • Spectrum_2D.write_acqus()
        • Spectrum_2D.write_integrals()
        • Spectrum_2D.write_pdata()
        • Spectrum_2D.write_procs()
        • Spectrum_2D.write_ser()
        • Spectrum_2D.xf1()
        • Spectrum_2D.xf2()
      • pDOSY
        • pDOSY.__init__()
        • pDOSY.write_procs()
      • pSpectrum_1D
        • pSpectrum_1D.__init__()
      • pSpectrum_2D
        • pSpectrum_2D.__init__()
      • wf0
klassez
  • Search

© Copyright 2025, Francesco Bruno and Letizia Fiorucci.

Built with Sphinx using a theme provided by Read the Docs.