OFCData¶
- class lsst.ts.ofc.ofc_data.OFCData(name=None, config_dir=None, log=None, **kwargs)¶
Bases:
BaseOFCData
Optical Feedback Control Data.
This container class provides a unified interface to all the data used by the OFC and its ancillary classes. It provides utiliy to load, inspect and update the different configuration files used by these classes.
- Parameters
- name
string
orNone
, optional Name of the instrument/configuration. This must map to a directory inside
data_path
.- config_dir
string
orNone
, optional Path to configuration directory. If
None
(default) use data provided with the module. If astring
is provided it must map to a valid path.- log
logging.Logger
orNone
, optional Optional logging class to be used for logging operations. If
None
, creates a new logger.- kwargs
dict
Additional keyword arguments. Value are passed over to the
BaseOFCData
parent class.
- name
- Raises
- RuntimeError
If input
config_dir
does not exists.
- Attributes
- bend_mode
dict
Dictionary to hold bending mode data. The data is read alongside the other files when the name is set.
- config_dir
pathlib.Path
Path to the directory storing configuration files.
- dof_idx
dict
ofstring
Index of Degree of Freedom (DOF).
- field_idx
dict
ofstring
Mapping between sensor name and field index.
- gq_points: `np.ndarray` of `float`
Gaussian Quadrature points for LSST field.
- image_quality_weight
np.ndarray
offloat
Image quality weight for the Gaussian Quadrature points.
- intrinsic_zk
dict
ofstring
Intrinsic zernike coefficients per band per detector for a specific instrument configuration.
- log
logging.Logger
Logger class used for logging operations.
- name
string
Name of the instrument configuration. This is used to define where
intrinsic_zk
andy2
will be read from.- sensitivity_matrix
np.ndarray
offloat
Sensitivity matrix M.
- start_task
asyncio.Future
Asyncio future that tracks whether the class is setup and ready or not.
- xref
string
Define how the control strategy will handle the reference point.
- xref_list
list
ofstring
Available reference point strategies.
- y2_correction
np.ndarray
offloat
Y2 correction.
- bend_mode
Attributes Summary
Delta coefficient for the normalized point-source sensitivity (PSSN).
Methods Summary
configure_instrument
(instrument)Configure instrument concurrently.
load_yaml_file
(file_path)Load yaml file.
Attributes Documentation
- comp_dof_idx¶
- delta¶
Delta coefficient for the normalized point-source sensitivity (PSSN).
This delta defines the range where PSSN=1-alpha^2 sigma^2 is accurate to 0.001. What we are concerned with is that the system could be trying to achieve tiny PSSN gains at the price of large control motions. This only applies to converged states. In converged states, of course the Zernikes will be within the range defined by delta. For more details, please check the page 19-21 in: https://docushare.lsst.org/docushare/dsweb/Get/Document-18041/150513.pptx.pdf
- Returns
np.array
offloat
Delta coefficient.
- dof_idx¶
- dof_idx_mask¶
- name¶
- xref¶
- xref_list¶
Methods Documentation