NonlinearModality

class sofia_redux.scan.channels.modality.non_linear_modality.NonlinearModality(modality, name=None, identity=None, gain_provider=None)

Bases: Modality

Create a non-linear modality.

Unlike the standard modality, a non-linear modality must be supplied with a parent modality. The modes of the parent are used to create non-linear response modes in the non-linear modality.

Parameters:

modalityModality

namestr, optional

The name of the non-linear modality.

identitystr, optional

A shorthand abbreviation for the non-linear 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.