vtools package

Subpackages

• vtools.data package
  • Submodules
  • vtools.data.dst module
    • Daylight Savings Time Conversion
    • dst_st()
  • vtools.data.gap module
    • describe_null()
    • describe_series_gaps()
    • example_gap()
    • gap_count()
    • gap_distance()
    • gap_size()
  • vtools.data.sample_series module
    • bessel_df()
    • extra()
    • interval()
    • jay_flinchem_chirptest()
    • small_subtide()
  • vtools.data.timeseries module
    • PchipInterpolator
      • PchipInterpolator.__doc__
      • PchipInterpolator.__init__()
      • PchipInterpolator.__module__
      • PchipInterpolator._edge_case()
      • PchipInterpolator._find_derivatives()
      • PchipInterpolator.axis
      • PchipInterpolator.c
      • PchipInterpolator.extrapolate
      • PchipInterpolator.x
    • datetime_elapsed()
    • days()
    • elapsed_datetime()
    • example()
    • extrapolate_ts()
    • hours()
    • is_regular()
    • minutes()
    • months()
    • rts()
    • rts_formula()
    • seconds()
    • time_overlap()
    • to_dataframe()
    • transition_ts()
    • years()
  • vtools.data.vis_gap module
    • generate_sample_data()
    • interactive_gap_plot()
    • plot_missing_data()
  • vtools.data.vtime module
    • days()
    • dst_to_standard_naive()
    • hours()
    • minutes()
    • months()
    • seconds()
    • years()
  • Module contents
• vtools.datastore package
  • Submodules
  • vtools.datastore.read_ts module
    • read_ts()
  • Module contents
• vtools.functions package
  • Submodules
  • vtools.functions.climatology module
    • apply_climatology()
    • climatology()
    • climatology_quantiles()
  • vtools.functions.envelope module
    • PchipInterpolator
      • PchipInterpolator.__annotations__
      • PchipInterpolator.__doc__
      • PchipInterpolator.__init__()
      • PchipInterpolator.__module__
      • PchipInterpolator._edge_case()
      • PchipInterpolator._find_derivatives()
      • PchipInterpolator.axis
      • PchipInterpolator.c
      • PchipInterpolator.extrapolate
      • PchipInterpolator.x
    • chunked_loess_smoothing()
    • filter_extrema_ngood()
    • find_peaks()
    • find_raw_extrema()
    • generate_pink_noise()
    • generate_simplified_mixed_tide()
    • interpolate_envelope()
    • lowess()
    • main()
    • savgol_filter()
    • select_salient_extrema()
    • smooth_series()
    • smooth_series2()
    • tidal_envelope()
  • vtools.functions.error_detect module
    • _nrepeat()
    • bounds_test()
    • despike()
    • example()
    • example2()
    • med_outliers()
    • median_test()
    • nrepeat()
    • steep_then_nan()
    • threshold()
  • vtools.functions.example2 module
    • main()
  • vtools.functions.filter module
    • _gf1d()
    • _lanczos_impl()
    • butter()
    • butterworth()
    • convert_span_to_nstep()
    • cosine_lanczos()
    • cosine_lanczos5()
    • filtfilt()
    • firwin()
    • gaussian_filter1d()
    • generate_godin_fir()
    • godin()
    • hours()
    • lanczos()
    • lfilter()
    • lowpass_cosine_lanczos_filter_coef()
    • lowpass_lanczos_filter_coef()
    • minutes()
    • process_cutoff()
    • seconds()
    • ts_gaussian_filter()
  • vtools.functions.frequency_response module
    • butterworth()
    • compare_response()
    • cosine_lanczos()
    • cosine_lanczos5()
    • freqz()
    • godin()
    • inset_axes()
    • lanczos()
    • lowpass_cosine_lanczos_filter_coef()
    • lowpass_lanczos_filter_coef()
    • main()
    • mark_inset()
    • ts_gaussian_filter()
    • unit_impulse_ts()
  • vtools.functions.interannual module
    • interannual()
    • interannual_sample()
    • interannual_ticks_labels()
  • vtools.functions.interpolate module
    • _monotonic_spline()
    • _ratsp1()
    • interpolate_to_index()
    • monotonic_spline()
    • rhist()
    • rhist_bound()
    • rhist_coef()
    • rhist_example()
    • rhist_val()
    • rhistinterp()
    • tridiagonal()
  • vtools.functions.lag_cross_correlation module
    • calculate_lag()
    • icrosscorr()
    • mincrosscorr()
  • vtools.functions.merge module
    • _apply_names()
    • _reindex_to_continuous()
    • reduce()
    • ts_merge()
    • ts_splice()
  • vtools.functions.period_op module
    • period_op()
    • window_op()
  • vtools.functions.read_dss module
    • check_exclude()
    • read_dss()
  • vtools.functions.savitzky_golay module
    • _build_vander()
    • _evaluate_poly()
    • _polyfit_window()
    • main()
    • savgol_filter_numba()
    • savgol_filter_weighted()
    • savgol_filter_werror()
    • solve_leastsq()
    • solve_polyfit()
  • vtools.functions.skill_metrics module
    • _main()
    • corr_coefficient()
    • mean_error()
    • median_error()
    • mse()
    • rmse()
    • skill_score()
    • tmean_error()
    • willmott_score()
  • vtools.functions.tidalhl module
    • cosine_lanczos()
    • filter_where_na()
    • get_phase_diff()
    • get_smoothed_resampled()
    • get_tidal_amplitude()
    • get_tidal_amplitude_diff()
    • get_tidal_hl()
    • get_tidal_hl_rolling()
    • get_tidal_hl_zerocrossing()
    • get_tidal_phase_diff()
    • limit_to_indices()
    • lmax()
    • lmin()
    • periods_per_window()
    • tidal_highs()
    • tidal_lows()
    • where_changed()
    • where_same()
    • zerocross()
  • vtools.functions.tidalhours module
    • cdiff()
    • cosine_lanczos5()
    • diff_h()
    • find_slack()
    • hilbert()
    • hour_tide()
    • hour_tide_fn()
    • interp1d
      • interp1d.__dict__
      • interp1d.__doc__
      • interp1d.__init__()
      • interp1d.__module__
      • interp1d.__weakref__
      • interp1d._call_linear()
      • interp1d._call_linear_np()
      • interp1d._call_nan_spline()
      • interp1d._call_nearest()
      • interp1d._call_previousnext()
      • interp1d._call_spline()
      • interp1d._check_and_update_bounds_error_for_extrapolation()
      • interp1d._check_bounds()
      • interp1d._evaluate()
      • interp1d._y_axis
      • interp1d._y_extra_shape
      • interp1d.dtype
      • interp1d.fill_value
    • tidal_hour_signal()
    • tidal_hour_signal2()
  • vtools.functions.transition module
    • PchipInterpolator
      • PchipInterpolator.__annotations__
      • PchipInterpolator.__doc__
      • PchipInterpolator.__init__()
      • PchipInterpolator.__module__
      • PchipInterpolator._edge_case()
      • PchipInterpolator._find_derivatives()
      • PchipInterpolator.axis
      • PchipInterpolator.c
      • PchipInterpolator.extrapolate
      • PchipInterpolator.x
    • transition_ts()
  • vtools.functions.unit_conversions module
    • celsius_to_fahrenheit()
    • cfs_to_cms()
    • cms_to_cfs()
    • ec_psu_25c()
    • fahrenheit_to_celsius()
    • ft_to_m()
    • m_to_ft()
    • psu_ec_25c()
    • psu_ec_25c_scalar()
    • psu_ec_resid()
  • Module contents

Module contents

Top-level package for vtools. Most functions can be directly imported from vtools namespace