Skip to content

Instantly share code, notes, and snippets.

@kmobs
Last active May 7, 2024 08:07
Show Gist options
  • Save kmobs/3a09cc28ec79e62f28d8db2179be7909 to your computer and use it in GitHub Desktop.
Save kmobs/3a09cc28ec79e62f28d8db2179be7909 to your computer and use it in GitHub Desktop.
Calculating the damping ratio for your hardware:

Prerequisite - Outdated. I don't use the resonance testing branch or pulses method anymore.

I recommend running Dmitry’s latest resonance testing branch and using the pulses method outlined below:

https://github.com/Klipper3d/klipper/issues/4560
https://github.com/dmbutyugin/klipper/tree/resonance-test-methods

I would only go down this path if you're getting ghosting with really high speed prints. On the Annex Engineering K3 for example, no matter how perfect the graphs looked, I was still getting some ghosting. That prompted me to go down this path. I'm now able to print at 20-30k acceleration, 250-350mm/s, and 15scv with perfect quality that can usually only be seen at significantly slower speeds.

The default settings in Klipper have the damping ratio set to .1. This should be fine for most people with sane settings. I like to go for the insane.

Calculating your damping ratio

Once you have your graph generated, you can pull the raw CSV values into your favorite graphing software. We will use the half power method to calculate the damping ratio. Find your highest resonant frequency and divide the amplitude at this point 1.41 (or the square root of 2). Note the frequency of the intersects at this amplitude.

image

The two formulas that we will use are Q=f0/(f2-f1) where f0 is your highest resonant frequency, f2 is your higher frequency at the half power intersect, and f1 is the lower. The second formula is Q=1/(2*damping ratio) From this you can solve for your damping ratio. Damping ratio = (f2-f1)/(2f0)

Alternatively, look in the comments below for a nice R script and instructions for how to run it in a docker container if you don't have R installed.

Verifying your damping ratio

You can then test your value. To do this, you need to make a small (hacky) change to input_shaper.py if you want to iterate them both at the same time. In input_shaper.py in the extras folder of your klipper directory, change the line damping_ratio_x, damping_ratio_y) on line 135 to damping_ratio_x, damping_ratio_x) You’ll need to completely restart your klipper instance with systemctl restart klipper via ssh. Or just restart your pi completely. Do not just restart via the UI of fluidd/mainsail

You can then use the resonance test STL and iterate your damping value with the tuning tower command. TUNING_TOWER COMMAND=SET_INPUT_SHAPER PARAMETER=DAMPING_RATIO_X START=<some value> = <some value>

Alternatively, you could create a new macro and iterate through that (from KenadyDawg44)

gcode:
    {% set RATIO = params.RATIO|default(0.1) %}
    SET_INPUT_SHAPER DAMPING_RATIO_X={RATIO}
    SET_INPUT_SHAPER DAMPING_RATIO_Y={RATIO}

I personally iterated from 0 to .11ish with a factor of .002. You can then inspect the output and where you think it looks best. Your calculated value should get you in just about the right space if your IS graphs are clean.

Don't forget to undo the change listed above in input_shaper.py and restart klipper again.

To apply your newly found value add it to your [input_shaper] section of your config. For me, I added the following to it:

[input_shaper]
...
damping_ratio_x: 0.06
damping_ratio_y: 0.06

Results

bIRD#0068 from Discord had the following graphs and was able to calculate their damping ratio. These result images are the same gcode and frequency, but changing the damping ratio from the default of 0.1 to the calculated ones

0.0468 on x
0.0332 on y
Input shaper X Input Shaper Y
shaper_calibrate_x shaper_calibrate_y
Before After
image image
@churls5495
Copy link

I wrote an R script to recreate the plot above and calculate the Damping Ratio given the resonances_*.csv file:

resonances <- read.csv("/PATH/TO/resonances_*.csv")

peak_power<-max(resonances$psd_xyz)
peak_freq<-resonances$freq[resonances$psd_xyz==peak_power]
half_power<-peak_power/sqrt(2)

install.packages("rootSolve")
library(rootSolve)
roots<-uniroot.all(approxfun(resonances$freq,resonances$psd_xyz-half_power),c(1,135))

plot(resonances$freq,resonances$psd_xyz,
     type = "l",
     main = "Frequency Response and Damping Ratio",
     xlab = "Frequency [Hz]",
     ylab = "Power")
abline(h=half_power,v=roots)
points(peak_freq,peak_power)
Damping_Ratio=(roots[2]-roots[1])/(2*peak_freq)
Damping_Ratio

@GijsvanDulmen
Copy link

You could use docker for running the Rscript above:
docker run -ti -v "$PWD":/home/docker -w /home/docker -u root r-base /bin/sh

Run it like this within the container:
Rscript yourscript.R

Be sure to alter the path to your resonances csv and your script.

@lbibass
Copy link

lbibass commented Nov 13, 2022

I have revised versions of the scripts that are a lot easier to use.

For the X axis:

resonances <- read.csv(dir('/tmp/', full.names=T, pattern="^resonances_x"))

peak_power<-max(resonances$psd_xyz)
peak_freq<-resonances$freq[resonances$psd_xyz==peak_power]
half_power<-peak_power/sqrt(2)

# install.packages("rootSolve")
library(rootSolve)
roots<-uniroot.all(approxfun(resonances$freq,resonances$psd_xyz-half_power),c(1,135))

plot(resonances$freq,resonances$psd_xyz,
     type = "l",
     main = "Frequency Response and Damping Ratio",
     xlab = "Frequency [Hz]",
     ylab = "Power")
abline(h=half_power,v=roots)
points(peak_freq,peak_power)
Damping_Ratio=(roots[2]-roots[1])/(2*peak_freq)
Damping_Ratio

for the Y axis:

resonances <- read.csv(dir('/tmp/', full.names=T, pattern="^resonances_y"))

peak_power<-max(resonances$psd_xyz)
peak_freq<-resonances$freq[resonances$psd_xyz==peak_power]
half_power<-peak_power/sqrt(2)

# install.packages("rootSolve")
library(rootSolve)
roots<-uniroot.all(approxfun(resonances$freq,resonances$psd_xyz-half_power),c(1,135))

plot(resonances$freq,resonances$psd_xyz,
     type = "l",
     main = "Frequency Response and Damping Ratio",
     xlab = "Frequency [Hz]",
     ylab = "Power")
abline(h=half_power,v=roots)
points(peak_freq,peak_power)
Damping_Ratio=(roots[2]-roots[1])/(2*peak_freq)
Damping_Ratio

@churls5495
Copy link

churls5495 commented Nov 13, 2022

Por que no los dos? You can run this to get both X and Y damping ratios if you've generated both CSVs:

resonances_X <- read.csv(dir('/tmp/', full.names=T, pattern="^resonances_x"))
resonances_Y <- read.csv(dir('/tmp/', full.names=T, pattern="^resonances_y"))

peak_power_X<-max(resonances_X$psd_xyz)
peak_power_Y<-max(resonances_Y$psd_xyz)

peak_freq_X<-resonances_X$freq[resonances_X$psd_xyz==peak_power_X]
peak_freq_Y<-resonances_Y$freq[resonances_Y$psd_xyz==peak_power_Y]

half_power_X<-peak_power_X/sqrt(2)
half_power_Y<-peak_power_Y/sqrt(2)

install.packages("rootSolve")
library(rootSolve)

roots_X<-uniroot.all(approxfun(resonances_X$freq,resonances_X$psd_xyz-half_power_X),c(1,135))
roots_Y<-uniroot.all(approxfun(resonances_Y$freq,resonances_Y$psd_xyz-half_power_Y),c(1,135))

Damping_Ratio_X=(roots_X[2]-roots_X[1])/(2*peak_freq_X)
Damping_Ratio_Y=(roots_Y[2]-roots_Y[1])/(2*peak_freq_Y)

Damping_Ratio_X
Damping_Ratio_Y

@lbibass
Copy link

lbibass commented Nov 16, 2022

@churls5495 I didn't know how to do that in R. It was just easier for me to do two different files. But thanks for that extra revision!

@churls5495
Copy link

Check out this repo which automates the above - https://github.com/lhndo/ResHelper

@celtare21
Copy link

Little question. Does it matter in what order you do the calibration? For example, I first do SHAPER_CALIBRATE and then calculate the dampening freq. Is this the correct order? Does order even matter?

@churls5495
Copy link

@celtare21 you must execute the test_resonances command so that it can output the CSV required to compute the damping ratio. shaper_calibrate will not do this.

@himanshugoel2797
Copy link

himanshugoel2797 commented Jun 28, 2023

I put together a Python script to calculate the damping ratio, might be a bit more convenient to run:

# Script reads input shaper csv file and computes damping ratio as (f2 - f1) / (2 * f0) where f0 is the peak psd_xyz amplitude frequency and f1 and f2 are the frequencies at which the amplitude is 1/sqrt(2) of the peak amplitude.
# CSV columns:
# freq, psd_x, psd_y, psd_z, psd_xyz

import sys
import numpy as np
import pandas as pd
import scipy.interpolate as interpolate


# Read input file
if len(sys.argv) < 2:
    print("Usage: %s <input file>" % sys.argv[0])
    sys.exit(1)

input_file = sys.argv[1]
df = pd.read_csv(input_file, sep=',', header=0, names=['freq', 'psd_x', 'psd_y', 'psd_z', 'psd_xyz'])

peak_amplitude = df['psd_xyz'].max()
peak_freq = df['freq'][df['psd_xyz'].idxmax()]
f_ampl = peak_amplitude / np.sqrt(2)

# Interpolate psd_xyz to find frequency at which psd_xyz is 1/sqrt(2) of peak amplitude on both sides of peak frequency
f1 = interpolate.interp1d(df['psd_xyz'][df['freq'] < peak_freq], df['freq'][df['freq'] < peak_freq])(f_ampl)
f2 = interpolate.interp1d(df['psd_xyz'][df['freq'] > peak_freq], df['freq'][df['freq'] > peak_freq])(f_ampl)

# Compute damping ratio
damping_ratio = (f2 - f1) / (2 * peak_freq)

print("Peak frequency: %f" % peak_freq)
print("Damping ratio: %f" % damping_ratio)

Just takes the csv file as an argument

@poernahi
Copy link

The graph and csv produced by klipper is the PSD of the vibration, which corresponds to power or amplitude squared. The half power method is done by looking for width at half-maximum of the power graph, which corresponds to 1/sqrt(2) of the amplitude graph.

I would expect the correct damping ratio to be measured from 1/2 of the PSD instead of 1/sqrt(2). Were the measurements accurate using 1/sqrt(2)?

@poernahi
Copy link

NASA published a way to get better estimate from the same graph. See equation 83.

It is noted in the document that the f_hi-f_low/2*f_peak method accurate if zeta < 0.05. See equation 67.

https://ntrs.nasa.gov/api/citations/20170005173/downloads/20170005173.pdf

@vgdh
Copy link

vgdh commented Dec 11, 2023

On the photos its not clear that the print got better after changing the damping ratio. Is it really worth the fuss?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment