Skip to content

docs: document surface calibration#697

Open
JoepVanlier wants to merge 3 commits into
mainfrom
surface_example
Open

docs: document surface calibration#697
JoepVanlier wants to merge 3 commits into
mainfrom
surface_example

Conversation

@JoepVanlier

@JoepVanlier JoepVanlier commented Oct 2, 2024

Copy link
Copy Markdown
Member

Why this (work in progress) PR?
Currently, users cannot reproduce the full surface calibration workflow.

This worked example will allow them to do so, and hopefully see the advantage active calibration brings in that situation.
Docs build here.

A few open questions I still have with this:

  • Touchdown seems to result in a bias of approx 100 nm here.
  • The focal shift seems to be around 0.91 for a water objective, which seems low? I would expect this closer to unity.

Edit: Based on Aafke's suggestion I have moved the notebook to the fundamentals section, as it is indeed more related to demonstrating some effects rather than an actual worked example.

@JoepVanlier JoepVanlier force-pushed the surface_example branch 2 times, most recently from 3aba52b to f72e4db Compare October 2, 2024 18:47
Base automatically changed from spaces to main October 7, 2024 11:17
@JoepVanlier JoepVanlier force-pushed the surface_example branch 7 times, most recently from de9a9fd to 52a6f32 Compare October 8, 2024 15:36

@aafkevandenberg aafkevandenberg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Joep, this is super nice, this will be very useful.

I have to read this a couple of times to understand the details. But as a very general initial feedback I would say to splits this notebook in 2:

  1. First just list the steps that a user has to take to start using the activate calibration, in exactly the right order. So, somebody who downloads the notebook just can load his/her own data and quickly go through the steps. (And, link to the page on the pylake docs that explains how to recalibrate the force using the obtained stiffness)
  2. The second part of the docs can explain the background and the mechanisms that are taken into account, and how active and passive calibration are compared.

plt.plot(heights, [calibrations[h]["pc_z"].stiffness for h in keys], 'C2--')
plt.xlabel('Height [um]')
plt.ylabel('Stiffness [pN/nm]');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it would be helpful to add labels 'active calibration' and 'passive calibration' and a legend

@JoepVanlier

JoepVanlier commented Oct 10, 2024

Copy link
Copy Markdown
Member Author

Hi Joep, this is super nice, this will be very useful.

I have to read this a couple of times to understand the details. But as a very general initial feedback I would say to splits this notebook in 2:

1. First just list the steps that a user has to take to start using the activate calibration, in exactly the right order. So, somebody who downloads the notebook just can load his/her own data and quickly go through the steps. (And, link to the page on the pylake docs that explains how to recalibrate the force using the obtained stiffness)

2. The second part of the docs can explain the background and the mechanisms that are taken into account, and how active and passive calibration are compared.

Ah yes, 1 is part of the force calibration docs reshuffle. I spun this off from that branch, since the size of it was getting out of hand. This PR really only addresses point 2 for one more advanced use case (surface calibration).

edit: after discussing, it may be a good idea to move this entire notebook to the fundamentals section, as it contains a lot of detail that a typical use case probably doesn't require

@JoepVanlier JoepVanlier changed the title docs: support surface calibration docs: document surface calibration Nov 26, 2024
@JoepVanlier JoepVanlier force-pushed the surface_example branch 2 times, most recently from 0604ae2 to 43bf2bd Compare December 2, 2024 17:20
@JoepVanlier JoepVanlier force-pushed the surface_example branch 2 times, most recently from cbc3f20 to d2339a7 Compare December 13, 2024 17:19
@JoepVanlier JoepVanlier force-pushed the surface_example branch 2 times, most recently from e35ba92 to 0e5b039 Compare January 31, 2025 10:15
@JoepVanlier JoepVanlier marked this pull request as ready for review January 31, 2025 10:31
@JoepVanlier JoepVanlier requested review from a team, alessiamarcolini and rpauszek January 31, 2025 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants