Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

map_variable docstring #1168

Merged
merged 3 commits into from
Mar 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion WrightTools/data/_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -1263,10 +1263,14 @@ def level(self, channel, axis, npts, *, verbose=True):
def map_variable(
self, variable, points, input_units="same", *, name=None, parent=None, verbose=True
) -> "Data":
"""Map points of an axis to new points using linear interpolation.
"""
Map points of an axis to new points using linear interpolation.

Out-of-bounds points are written nan.

Non-mapped variables are kept in the data object only if they are
orthogonal to the mapped variable (see `kit.orthogonal`).

Parameters
----------
variable : string
Expand Down
Loading