attune.curve.TopasCurve

class attune.curve.TopasCurve(setpoints, dependents, name, interaction=None, kind='curve', method=<class 'attune.interpolator._linear.Linear'>, subcurve=None, source_setpoints=None, fmt=None, **kwargs)[source]
__init__(setpoints, dependents, name, interaction=None, kind='curve', method=<class 'attune.interpolator._linear.Linear'>, subcurve=None, source_setpoints=None, fmt=None, **kwargs)

Create a Curve object.

Parameters
  • setpoints (attune.Setpoints) – The setpoint destinations for the curve.

  • dependents (list of Dependent objects) – Dependent positions for each setpoint.

  • name (str) – Name of curve.

  • kind (string) – The kind of curve (for saving).

  • method (interpolation class) – The interpolation method to use.

Methods

__init__(setpoints, dependents, name[, …])

Create a Curve object.

coerce_dependents()

Coerce the dependent positions to lie exactly along the interpolation positions.

convert(units, *[, convert_dependents])

Convert the setpoints to new units.

copy()

Copy the curve object.

get_dependent_positions(setpoint[, units, full])

Get the dependent positions for a destination setpoint.

get_limits([units])

Get the edges of the curve.

get_source_setpoint(setpoint[, units])

Get setpoint of source curve.

interpolate([interpolate_subcurve])

Generate the interploator object.

map_setpoints(setpoints[, units])

Map the curve onto new tune points using the curve’s own interpolation method.

offset_by(dependent, amount)

Offset a dependent by some ammount.

offset_to(dependent, destination, setpoint)

Offset a dependent such that it evaluates to destination at setpoint.

plot([autosave, save_path, title])

Plot the curve.

read(filepaths, interaction_string)

Create a curve object from a TOPAS crv file.

read_all(filepaths)

rename_dependent(old_name, new_name)

save([save_directory, plot, verbose, full])

Save a curve object.

sort()

Attributes

dependent_names

Get dependent names.

dependent_units

Get dependent names.