attune.Arrangement

class attune.Arrangement(name: str, tunes: Dict[str, DiscreteTune | Tune | dict])[source]

Bases: object

__init__(name: str, tunes: Dict[str, DiscreteTune | Tune | dict])[source]

Arrangement of several Tunes to form one cohesive set.

Tunes may represent either motors or other arrangements, however semantic meaning is provided by the Instrument which contains the Arrangement, to the arrangement, they are all string keys mapped to tunes.

All tunes must have the same independent units, and must overlap.

Parameters:
  • name (str) – A name for this Arrangement, used to identify this Arrangement from other Arrangements which may depend on this one.

  • tunes (Dict[str, Tune]) – Mapping of names to Tune objects which compose the Arrangement

as_dict()[source]

Dictionary representation of the Arrangement

property ind_max

The maximum independant (input) value for this arrangement.

property ind_min

The minimum independant (input) value for this arrangement.

property independent

Returns a 1-dimensional numpy array with the set of all unique independent points.

Points closer together than 1/1000th of the total dynamic range are considered identical.

Only returns points within range of all tunes.

items()[source]

Return the names and tunes in the arrangment.

keys()[source]

Return the names of the tunes in the arrangment.

property name

The name of the arrangement.

property tunes

The tunes in the arrangement.

values()[source]

Return the tunes in the arrangment.