CoupledModality¶
- class sofia_redux.scan.channels.modality.coupled_modality.CoupledModality(modality, name=None, identity=None, gain_provider=None)[source]¶
Bases:
CorrelatedModalityCreate a coupled modality.
Unlike the standard modality, a coupled modality must be supplied with a parent modality. The modes of the parent are added to the coupled modality as coupled modes.
- Parameters:
- modalityModality
- namestr, optional
The name of the coupled modality.
- identitystr, optional
A shorthand abbreviation for the coupled modality.
- gain_providerGainProvider or str, optional
If a string is provided, a FieldGainProvider will be created that defined the gain as that field of the channel group data. If a gain provider is explicitly provided, it will be used instead.