lumicks.pylake.fdcurve.FdCurve¶
-
class
FdCurve
(file, start, stop, name, force='2', distance='1')¶ An FD curve exported from Bluelake
By default, the primary force and distance channels are
downsampled_force2
anddistance1
. Alternatives can be selected usingFdCurve.with_channels()
. Note that it does not modify the FD curve in place but returns a copy.Attributes: - file : lumicks.pylake.File
The parent file. Used to look up channel data.
- start, stop : int
The time range (ns) of this FD curve within the file.
- name : str
The name of this FD curve as it appeared in the timeline.
-
__init__
(file, start, stop, name, force='2', distance='1')¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(file, start, stop, name[, force, …])Initialize self. distance_range_selector
([show, max_gap])from_dataset
(h5py_dset, file, **kwargs)plot_scatter
(**kwargs)Plot the FD curve points range_selector
([show])with_baseline_corrected_x
()Return a copy of this F,d curve with baseline correction applied to force channel. with_channels
(force, distance)Return a copy of this FD curve with difference primary force and distance channels with_offset
([force_offset, distance_offset])Add a constant force offset from the force data in this F,d curve. Attributes
d
The primary distance channel associated with this FD curve distance1
distance2
downsampled_force1
downsampled_force1x
downsampled_force1y
downsampled_force1z
downsampled_force2
downsampled_force2x
downsampled_force2y
downsampled_force2z
downsampled_force3
downsampled_force3x
downsampled_force3y
downsampled_force3z
downsampled_force4
downsampled_force4x
downsampled_force4y
downsampled_force4z
f
The primary force channel associated with this FD curve -
plot_scatter
(**kwargs)¶ Plot the FD curve points
Parameters: - **kwargs
Forwarded to
~matplotlib.pyplot.scatter
.
-
with_baseline_corrected_x
()¶ Return a copy of this F,d curve with baseline correction applied to force channel. Note: only the x component is available with baseline correction. Note: All previous data manipulations (eg. subtraction of another curve) will be lost.
-
with_channels
(force, distance)¶ Return a copy of this FD curve with difference primary force and distance channels
-
with_offset
(force_offset=0, distance_offset=0)¶ Add a constant force offset from the force data in this F,d curve. Note that points where the distance is defined as zero are ignored and that subtracting a distance offset bigger than the minimum distance in the F,d curve will result in an error.
Parameters: - force_offset : float
- distance_offset : float
-
d
¶ The primary distance channel associated with this FD curve
-
f
¶ The primary force channel associated with this FD curve