Python version - Base object

class glow.freq_domain.FwGeneral(It, p_prec={})

Base class for the amplification factor.

Parameters:

ItItGeneral subclass

Time-domain integral object.

p_precdict, optional

Precision parameters.

Attributes:

lensPsiGeneral subclass

Lens object.

ItItGeneral subclass

Time-domain integral object.

p_precdict

Default precision parameters updated with the input. Default keys:

• interp_fill_value – Behaviour of the interpolation function outside the interpolation range. Options:

  • None: Raise an error if extrapolation is attempted.

  • float: Extrapolate with a constant value.

  • 'extrapolate': Linear extrapolation.

• interp_kind (str) – Interpolation method. Any kind recognized by Scipy is allowed. In particular:

  • 'linear'

  • 'cubic'

• T_saddle (float) – Free parameter \(T\) used in the regularization of the saddle points.

eval_It_regfunc(float or array) -> float or array

Evaluate the regular part of \(I(\tau)\), i.e. \(I_\text{reg}=I-I_\text{sing}\).

namestr

(subclass defined) Name of the method.

w_grid, Fw_gridarray

(subclass defined) Grid of points where \(F(w)\) has been computed.

eval_Fwfunc(float or array) -> complex or array

(subclass defined) Final function to evaluate \(F(w)\).

eval_Fw_regfunc(float or array) -> complex or array

(subclass defined) Evaluate the regular part of \(F(w)\), i.e. \(F_\text{reg}=F-F_\text{sing}\).

Methods

__call__(w)	Call eval_Fw().
check_general_input()	Check the input upon initialization.
check_input()	(subclass defined, optional) Check the input of the implementation.
default_general_params()	Fill the default parameters.
default_params()	(subclass defined) Initialize the default parameters.
display_info()	Print internal information in human-readable form.
eval_Fw_sing(w)	Singular contribution to \(F(w)\).
eval_It_sing(tau)	Singular contribution to \(I(\tau)\).
interpolate(xs, ys)	Construct an interpolation function using the options in p_prec.

default_general_params()

Fill the default parameters.

Update the precision parameters common for all methods and then call default_params() (subclass defined).

Returns:

p_precdict

Default precision parameters.

check_general_input()

Check the input upon initialization.

It first calls check_input() (subclass defined) to perform any checks that the user desires. It then checks that the input only updates existing keys in p_prec, otherwise throws a warning.

The idea is that we do not use a wrong name that is then ignored.

Warns:

TimeDomainWarning

Warning

If the subclass will add a new parameter without an entry in default_params(), it must be manually added to self.p_prec_default_keys in check_input() with self.p_prec_default_keys.add(new_key).

display_info()

Print internal information in human-readable form.

interpolate(xs, ys)

Construct an interpolation function using the options in p_prec.

Parameters:

xs, ysfloat, complex or array

Values to interpolate.

Returns:

interp_funcfunc(array) -> array

Interpolation function.

eval_It_sing(tau)

Singular contribution to \(I(\tau)\).

Parameters:

tfloat or array

\(\tau\).

Returns:

Itfloat or array

\(I_\text{sing}(\tau)\).

eval_Fw_sing(w)

Singular contribution to \(F(w)\).

Parameters:

wfloat or array

\(w\).

Returns:

Fwfloat or array

\(F_\text{sing}(w)\).

check_input()

(subclass defined, optional) Check the input of the implementation.

default_params()

(subclass defined) Initialize the default parameters.