Skip to main content
  • Home
  • Documentation
  • FAQ
  • Downloads
  • Support
  • Current Release Notes
  • Ferret Users Guide
    • Users Guide Index
    • Commands Reference
    • 1. Introduction
    • 2. Data Set Basics
    • 3. Variables & Expressions
    • 4. Grids & Regions
    • 5. Animations & Gif Images
    • 6. Customizing Plots
    • 7. Handling String Data Symbols
    • 8. Working with Special Data Sets
    • 9. Computing Environment
    • 10. Converting to NetCDF
    • 11. Writing External Functions
    • Glossary
    • Appendix A: Functions
    • Appendix B: PPLUS Guide
    • Appendix C: Ferret-Specific PPLUS Enhancements
  • Previous Release Notes
  • Tutorials and Demos
    • Ferret Tour
    • DSG files: Discrete Sampling Geometries Demo
    • Ferret sorting demo
    • Fast Fourier Transforms demo
    • Empirical Orthogonal Functions demo
    • Ferret objective analysis demo
    • Ferret Palette Demo
    • Map projections
    • Ferret polygon vector demo
    • Ferret Graticules demo
    • Ferret Polytube Demo
    • Ferret Polymark Demo
    • Ferret Constant-Array demo
    • Ferret land_detail demo
    • COADS Tour
    • Levitus Tour
    • Use OPeNDAP
    • Ferret binary read demo
  • PyFerret
    • PyFerret Downloads and Install ../../faq/ferret-faqs.html
    • What is PyFerret?
    • Why use PyFerret?
    • PyFerret for the Ferret user
    • PyFerret command syntax: quick-start notes
    • PyFerret for the Python user
    • Graphics in PyFerret ?
    • New Ferret functionality
    • PyFerret Python functions and constants
    • PyFerret Python objects and methods
    • Ferret external functions in Python
    • Ferret Fortran external functions
    • PyFerret metadata-and-data dictionaries
  • OPeNDAP
    • OPeNDAP usage in Ferret
    • Use OPeNDAP Demo
    • Test OPeNDAP

LSL_LOWPASS

Appendix A Sec28.

LSL_LOWPASS

LSL_LOWPASS(A, cutoff_period, filter_span) Returns the argument filtered with Least Squares Lanzcos filter in time.

Arguments:

A

Variable with a regular time axis; may be a function of x, y, and/or z

 

cutoff_period

Cutoff period (the period at which the filter attains 1/2 amplitude)
in units of delta-T the time-axis increment

 

filter_span

number of input data points used in each filtered output point.

Result Axes:

X

Inherited from A

 

Y

Inherited from A

 

Z

Inherited from A

 

T

Inherited from A

This function low-pass filters an equally spaced time series using least-squares approximation to the ideal low-pass filter of Bloomfield with Lanczos convergence factors. It is very similar to subroutine LOPASS in Chapter 6, p. 149, of Bloomfield, P., 1976, Fourier Analysis of Time Series: An Introduction, John Wiley & Sons, New York, 258 pp.

The main difference is that the present routine takes account of missing values in the input time series Values near the ends and near gaps are filled with the missing value flag.

The cutoff period (measured in units of delta t) is the period at which the filter attains 1/2 amplitude or 1/4 "energy". The cutoff_period must be less than or equal to N, the length of the time axis.

The filter span is the number of input data points used in each filtered output point. A wide filter gives a narrow frequency response transition band, but leads to ringing near data discontinuities and loss of filtered values at the end points and surrounding missing values. A narrow filter reduces ringing and output data loss, but gives a wider frequency transition width, i.e. it falls off less rapidly at frequencies higher than the cutoff. The filter transition region lies in the period range between N*cutoff_period/(N + cutoff_period) and N*cutoff_period/(N - cutoff_period). The filter span should be an odd integer. It is set to the next lower odd number if the input is even.

Note on tidal filtering: For hourly time series containing tidal signals, some investigators use this filter with a 35-hour cutoff period and a filter span of xxx hours to remove at least 99.5 % of the energy for periods less than 25 hours.

Adapted from Bloomfield by E. D. Cokelet, NOAA/PMEL, 3 Dec 1999