accml_lib.core.model.output package

Submodules

accml_lib.core.model.output.orbit module

Orbit model as used at BESSY II

Based on 4 button bpms. Button data made available next to x and y

Todo

can that be the start for a more general orbit model

class accml_lib.core.model.output.orbit.BPMButtons(a, b, c, d)

Bases: object

Todo

consider renaming bpm buttons to give them more meaning

Parameters:

• a (float)

• b (float)

• c (float)

• d (float)

a: float

b: float

c: float

d: float

class accml_lib.core.model.output.orbit.BPMPosition(x, y)

Bases: object

transversal position as read by a single bpm

If not available marked as nan. 64 bits provide enough data to store 32 bit int without conversion loss.

Note bpm data are in nm

Todo

naming that’s more universal than x and y e.g. hor(izontal) and vert(ical)

Will be an interesting concept e.g. at Novosibirsk’s recovery linac. Then these should be rather dispersion_plan / non dispersion plane

Parameters:

• x (float)

• y (float)

x: float

y: float

class accml_lib.core.model.output.orbit.BPMReading(name, pos, btns)

Bases: object

Parameters:

• name (Hashable)

• pos (BPMPosition)

• btns (BPMButtons)

btns: BPMButtons

name: Hashable

pos: BPMPosition

class accml_lib.core.model.output.orbit.Orbit(orbit)

Bases: object

Parameters:

orbit (Sequence[BPMReading])

get_element(id_)

Return type:

BPMReading

Parameters:

id_ (Hashable)

Todo

consider to return a more descriptive Exception if identifier is not found

identifiers()

Return type:

Sequence[Hashable]

orbit: Sequence[BPMReading]

accml_lib.core.model.output.result module

class accml_lib.core.model.output.result.ReadTogether(data, start, end)

Bases: object

data taken together

Parameters:

• data (Sequence[SingleReading])

• start (datetime)

• end (datetime)

data: Sequence[SingleReading]

end: datetime

get(key)

start: datetime

to_jsons(**kwargs)

class accml_lib.core.model.output.result.Result(data, orig_data)

Bases: object

Parameters:

• data (Sequence[ResultOfExecutionStep])

• orig_data (Sequence[ResultOfExecutionStep])

data: Sequence[ResultOfExecutionStep]

in the expected view / context of the caller

orig_data: Sequence[ResultOfExecutionStep]

in the expected view / context as produced by the backend

class accml_lib.core.model.output.result.ResultOfExecutionStep(cmds, data)

Bases: object

Parameters:

• cmds (Sequence[Command])

• data (Sequence[ReadTogether])

cmds: Sequence[Command]

the relevant commands reflecting state changes the idea is that with data one can reconstruct in which state the machine or accelerator was

data: Sequence[ReadTogether]

class accml_lib.core.model.output.result.SingleFloat(value)

Bases: object

Parameters:

value (float)

value: float

class accml_lib.core.model.output.result.SingleReading(name, payload, cmd)

Bases: object

e.g. reading from one device or tune of the machine

Parameters:

• name (str)

• payload (object)

• cmd (ReadCommand)

cmd: ReadCommand

classmethod from_jsons(obj, **kwargs)

name: str

payload: object

to_jsons(**kwargs)

accml_lib.core.model.output.result.register_deserializer_for_single_reading(t_fork)

accml_lib.core.model.output.result.register_serializer_for_read_together(t_fork)

accml_lib.core.model.output.result.register_serializer_for_single_reading(t_fork)

accml_lib.core.model.output.tune module

class accml_lib.core.model.output.tune.CorrectionStat(mean, std, min, max)

Bases: object

Parameters:

• mean (float)

• std (float)

• min (float)

• max (float)

max: float

mean: float

min: float

std: float

class accml_lib.core.model.output.tune.Tune(x, y)

Bases: object

Todo

merge

it with accml.app.tune.model.MeasuredTuneResponseItem?

Parameters:

• x (float)

• y (float)

x: float

horizontal

y: float

vertical

Module contents