MockGainSchedular

class lsst.ts.m2com.MockGainSchedular(min_gain_axial: float, min_gain_tangent: float, num_sample_ramp_up: int, num_sample_ramp_down: int, max_sample_settle: int)

Bases: object

Mock gain schedular to tune the gains for the slewing, settling, and imaging processes.

Notes

The maximum gain is 1.0.

Parameters

min_gain_axialfloat

Minimum gain for the axial actuators. The value should be in (0.0, 1.0).

min_gain_tangentfloat

Minimum gain for the tangent actuators. The value should be in (0.0, 1.0).

num_sample_ramp_upint

Number of samples in the ramping up process. This value can not be 0.

num_sample_ramp_downint

Number of samples in the ramping down process. This value can not be 0.

max_sample_settleint

Maximum number of samples in the settling process. This value can not be 0.

Attributes Summary

MAX_GAIN

Methods Summary

get_gain(is_in_position)	Get the gain values.
reset()	Reset the internal data.

Attributes Documentation

MAX_GAIN = 1.0

Methods Documentation

get_gain(is_in_position: bool) → tuple[float, float]

Get the gain values.

Parameters

is_in_positionbool

Mirror is in position or not.

Returns

float

Gain of the axial actuators.

float

Gain of the tangent actuators.

reset() → None

Reset the internal data.