vtools package

Subpackages

• vtools.data package
  • Submodules
  • vtools.data.dst module
    • Daylight Savings Time Conversion
    • dst_st()
  • vtools.data.gap module
    • Enum
      • Enum.__dict__
      • Enum.__doc__
      • Enum.__module__
      • Enum.__weakref__
      • Enum._generate_next_value_()
      • Enum._member_map_
      • Enum._member_names_
      • Enum._member_type_
      • Enum._missing_()
      • Enum._value2member_map_
      • Enum.name
      • Enum.value
    • GapSpec
      • GapSpec.__annotations__
      • GapSpec.__dataclass_fields__
      • GapSpec.__dataclass_params__
      • GapSpec.__dict__
      • GapSpec.__doc__
      • GapSpec.__eq__()
      • GapSpec.__hash__
      • GapSpec.__init__()
      • GapSpec.__match_args__
      • GapSpec.__module__
      • GapSpec.__repr__()
      • GapSpec.__weakref__
      • GapSpec.ensure_room
      • GapSpec.max_len
      • GapSpec.min_len
      • GapSpec.n_gaps
      • GapSpec.seed
      • GapSpec.strategy
    • GapStrategy
      • GapStrategy.BOTH
      • GapStrategy.STAGGERED
      • GapStrategy.TARGET_ONLY
      • GapStrategy.__doc__
      • GapStrategy.__module__
    • _choose_gap_windows()
    • apply_gaps()
    • auto
      • auto.__dict__
      • auto.__doc__
      • auto.__module__
      • auto.__weakref__
      • auto.value
    • dataclass()
    • 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()
    • rename_columns()
    • 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.colname_align module
    • Main features
    • Usage pattern
    • _coerce_inputs_strict()
    • align_inputs_pair_strict()
    • align_inputs_strict()
    • align_names()
  • 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
    • _coerce_fixed_duration()
    • calculate_lag()
    • icrosscorr()
    • mincrosscorr()
    • to_offset()
  • vtools.functions.merge module
    • _reindex_to_continuous()
    • align_inputs_strict()
    • reduce()
    • ts_merge()
    • ts_splice()
  • vtools.functions.neighbor_fill module
    • Highlights
    • Example
    • Notes
    • DFMFill
      • DFMFill.__doc__
      • DFMFill.__init__()
      • DFMFill.__module__
      • DFMFill._constrain()
      • DFMFill.param_names
      • DFMFill.start_params
      • DFMFill.update()
    • ElasticNetCV
      • ElasticNetCV.__abstractmethods__
      • ElasticNetCV.__annotations__
      • ElasticNetCV.__doc__
      • ElasticNetCV.__init__()
      • ElasticNetCV.__module__
      • ElasticNetCV._abc_impl
      • ElasticNetCV._get_estimator()
      • ElasticNetCV._is_multitask()
      • ElasticNetCV._more_tags()
      • ElasticNetCV._parameter_constraints
      • ElasticNetCV.path()
      • ElasticNetCV.set_fit_request()
      • ElasticNetCV.set_score_request()
    • FillResult
      • FillResult.__annotations__
      • FillResult.__dataclass_fields__
      • FillResult.__dataclass_params__
      • FillResult.__dict__
      • FillResult.__doc__
      • FillResult.__eq__()
      • FillResult.__hash__
      • FillResult.__init__()
      • FillResult.__match_args__
      • FillResult.__module__
      • FillResult.__repr__()
      • FillResult.__weakref__
      • FillResult.filled
      • FillResult.metrics
      • FillResult.model_info
      • FillResult.pi_lower
      • FillResult.pi_upper
      • FillResult.to_dict()
      • FillResult.yhat
    • HuberT
      • HuberT.__doc__
      • HuberT.__init__()
      • HuberT.__module__
      • HuberT._subset()
      • HuberT.psi()
      • HuberT.psi_deriv()
      • HuberT.rho()
      • HuberT.weights()
    • KNeighborsRegressor
      • KNeighborsRegressor.__abstractmethods__
      • KNeighborsRegressor.__annotations__
      • KNeighborsRegressor.__doc__
      • KNeighborsRegressor.__init__()
      • KNeighborsRegressor.__module__
      • KNeighborsRegressor._abc_impl
      • KNeighborsRegressor._more_tags()
      • KNeighborsRegressor._parameter_constraints
      • KNeighborsRegressor.fit()
      • KNeighborsRegressor.predict()
      • KNeighborsRegressor.set_score_request()
    • MLEModel
      • MLEModel.__annotations__
      • MLEModel.__doc__
      • MLEModel.__getitem__()
      • MLEModel.__init__()
      • MLEModel.__module__
      • MLEModel.__setitem__()
      • MLEModel._clone_from_init_kwds()
      • MLEModel._forecasts_error_partial_derivatives()
      • MLEModel._get_extension_time_varying_matrices()
      • MLEModel._get_index_with_final_state()
      • MLEModel._get_init_kwds()
      • MLEModel._hessian_complex_step()
      • MLEModel._hessian_finite_difference()
      • MLEModel._hessian_oim()
      • MLEModel._hessian_opg()
      • MLEModel._hessian_param_defaults
      • MLEModel._hessian_param_names
      • MLEModel._loglike_param_defaults
      • MLEModel._loglike_param_names
      • MLEModel._res_classes
      • MLEModel._score_complex_step()
      • MLEModel._score_finite_difference()
      • MLEModel._score_harvey()
      • MLEModel._score_obs_harvey()
      • MLEModel._score_param_defaults
      • MLEModel._score_param_names
      • MLEModel._validate_can_fix_params()
      • MLEModel._validate_out_of_sample_exog()
      • MLEModel._wrap_results()
      • MLEModel.clone()
      • MLEModel.filter()
      • MLEModel.fit()
      • MLEModel.fit_constrained()
      • MLEModel.fix_params()
      • MLEModel.from_formula()
      • MLEModel.handle_params()
      • MLEModel.hessian()
      • MLEModel.impulse_responses()
      • MLEModel.initial_variance
      • MLEModel.initialization
      • MLEModel.initialize_approximate_diffuse()
      • MLEModel.initialize_known()
      • MLEModel.initialize_statespace()
      • MLEModel.initialize_stationary()
      • MLEModel.loglike()
      • MLEModel.loglikelihood_burn
      • MLEModel.loglikeobs()
      • MLEModel.observed_information_matrix()
      • MLEModel.opg_information_matrix()
      • MLEModel.param_names
      • MLEModel.prepare_data()
      • MLEModel.score()
      • MLEModel.score_obs()
      • MLEModel.set_conserve_memory()
      • MLEModel.set_filter_method()
      • MLEModel.set_inversion_method()
      • MLEModel.set_smoother_output()
      • MLEModel.set_stability_method()
      • MLEModel.simulate()
      • MLEModel.simulation_smoother()
      • MLEModel.smooth()
      • MLEModel.start_params
      • MLEModel.state_names
      • MLEModel.tolerance
      • MLEModel.transform_jacobian()
      • MLEModel.transform_params()
      • MLEModel.untransform_params()
      • MLEModel.update()
    • Pipeline
      • Pipeline.__abstractmethods__
      • Pipeline.__annotations__
      • Pipeline.__doc__
      • Pipeline.__getitem__()
      • Pipeline.__init__()
      • Pipeline.__len__()
      • Pipeline.__module__
      • Pipeline.__sklearn_is_fitted__()
      • Pipeline._abc_impl
      • Pipeline._can_fit_transform()
      • Pipeline._can_inverse_transform()
      • Pipeline._can_transform()
      • Pipeline._check_method_params()
      • Pipeline._estimator_type
      • Pipeline._final_estimator
      • Pipeline._fit()
      • Pipeline._iter()
      • Pipeline._log_message()
      • Pipeline._more_tags()
      • Pipeline._parameter_constraints
      • Pipeline._required_parameters
      • Pipeline._sk_visual_block_()
      • Pipeline._validate_steps()
      • Pipeline.classes_
      • Pipeline.decision_function()
      • Pipeline.feature_names_in_
      • Pipeline.fit()
      • Pipeline.fit_predict()
      • Pipeline.fit_transform()
      • Pipeline.get_feature_names_out()
      • Pipeline.get_metadata_routing()
      • Pipeline.get_params()
      • Pipeline.inverse_transform()
      • Pipeline.n_features_in_
      • Pipeline.named_steps
      • Pipeline.predict()
      • Pipeline.predict_log_proba()
      • Pipeline.predict_proba()
      • Pipeline.score()
      • Pipeline.score_samples()
      • Pipeline.set_output()
      • Pipeline.set_params()
      • Pipeline.set_score_request()
      • Pipeline.transform()
    • RLM
      • RLM.__annotations__
      • RLM.__doc__
      • RLM.__init__()
      • RLM.__module__
      • RLM._estimate_scale()
      • RLM._initialize()
      • RLM._update_history()
      • RLM.deviance()
      • RLM.fit()
      • RLM.information()
      • RLM.loglike()
      • RLM.predict()
      • RLM.score()
    • StandardScaler
      • StandardScaler.__annotations__
      • StandardScaler.__doc__
      • StandardScaler.__init__()
      • StandardScaler.__module__
      • StandardScaler._more_tags()
      • StandardScaler._parameter_constraints
      • StandardScaler._reset()
      • StandardScaler._sklearn_auto_wrap_output_keys
      • StandardScaler.fit()
      • StandardScaler.inverse_transform()
      • StandardScaler.partial_fit()
      • StandardScaler.set_fit_request()
      • StandardScaler.set_inverse_transform_request()
      • StandardScaler.set_partial_fit_request()
      • StandardScaler.set_transform_request()
      • StandardScaler.transform()
    • _add_lagged_X()
    • _align()
    • _as_series_like()
    • _assert_same_regular_grid()
    • _compute_metrics()
    • _dfm_params_to_vector()
    • _fit_dfm()
    • _fit_huber()
    • _fit_lagged_elasticnet()
    • _fit_loess()
    • _fit_ols()
    • _fit_resid_interp()
    • _fit_rolling_regression()
    • _fit_substitute()
    • _forward_chain_splits()
    • _inv_logit()
    • _logit()
    • _mask_overlap()
    • _opt_debug()
    • _phi_from_logit()
    • _suggest_lags()
    • asdict()
    • dataclass()
    • dfm_pack_params()
    • fill_from_neighbor()
    • fit_loess_time_value()
    • load_dfm_params()
    • lowess()
    • save_dfm_params()
    • write_filled_csv_with_yaml_header()
  • vtools.functions.period_op module
    • period_op()
    • window_op()
  • 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.separate_species module
    • create_arg_parser()
    • main()
    • plot_result()
    • run_example()
    • separate_species()
    • write_th()
  • 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
    • Functions
    • 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
    • _parse_max_snap()
    • _resolve_gap_endpoints_subset_snap()
    • align_inputs_pair_strict()
    • transition_ts()
  • vtools.functions.unit_conversions module
    • Notes
    • References
    • _get_converter()
    • _norm()
    • _rewrap_like()
    • _want_cf_units()
    • celsius_to_fahrenheit()
    • cfs_to_cms()
    • cms_to_cfs()
    • convert_units()
    • 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