Noise package

mesohops.dynamics.hops_noise class

class HopsNoise(noise_param, noise_corr)

Bases: mesohops.util.dynamic_dict.Dict_wDefaults

This is the BaseClass for defining a hops noise trajectory. All noise classes will inherit from here. Anything that defines the input-output structure of a noise trajectory should be controlled from this class - rather than any of the model-specific child classes.

NOTE: This class is only well defined within the context of a specific calculation where the system-bath parameters have been set. YOU SHOULDN’T INSTANTIATE ONE OF THESE CLASSES YOURSELF. IF YOU FEEL THE NEED TO, YOU ARE PROBABLY DOING SOMETHING STRANGE.

get_noise(self, t_axis)

Gets the noise.

Parameters

1. t_axislist

List of time points.

Returns

1. noiselist

List of lists of noise values sampled at the given time points.

mesohops.dynamics.noise_fft module

class FFTFilterNoise(noise_param, noise_corr)

Bases: mesohops.dynamics.hops_noise.HopsNoise

This is a class that describes the noise function for a calculation.

NOTE: This class is only well defined within the context of a specific calculation where the system-bath parameters have been set. YOU SHOULDN’T INSTANTIATE ONE OF THESE CLASSES YOURSELF. IF YOU FEEL THE NEED TO, YOU ARE PROBABLY DOING SOMETHING STRANGE.

prepare_noise(self)

This function is defined for each specific noise model (children classes of HopsNoise class) and provides the specific rules for calculating a noise trajectory using.

Parameters

None

Returns

None

mesohops.dynamics.noise_trajectories module

class NoiseTrajectory

Bases: abc.ABC

This is the abstract base class for Noise objects.

A noise object has two guaranteed functions: - get_noise(t_axis) - get_taxis()

class NumericNoiseTrajectory(noise, t_axis, spline_interpolation=False)

Bases: mesohops.dynamics.noise_trajectories.NoiseTrajectory

This is the class for noise that is explicitly calculated.

get_noise(self, taxis_req)

Returns the noise values for the selected times.

NOTE: INTERPOLATION SHOULD BE IMPLEMENTED BY DEFAULT. USE FCSPLINE

FROM RICHARD TO DO IT!

Parameters

1. taxis_reqlist

List of requested time points.

Returns

1. noiselist

List of lists of noise at the requested time points.

mesohops.dynamics.noise_zero module

class ZeroNoise(noise_param, noise_corr)

Bases: mesohops.dynamics.hops_noise.HopsNoise

This is a class that describes the noise function for a calculation.

NOTE: This class is only well defined within the context of a specific calculation where the system-bath parameters have been set. YOU SHOULDN’T INSTANTIATE ONE OF THESE CLASSES YOURSELF. IF YOU FEEL THE NEED TO, YOU ARE PROBABLY DOING SOMETHING STRANGE.

get_noise(self, t_axis)

Returns a zero array of the correct length.

Parameters

1. taxislist

List of time points.

Returns

1. list_zeroslist

List of zeros.

prepare_noise(self)

This function is defined for each specific noise model (children classes of HopsNoise class) and provides the specific rules for calculating a noise trajectory using

Parameters

None

Returns

None

mesohops.dynamics.prepare_functions module

prepare_noise(noise_param, system_param, flag=1)

Return the proper noise class given the user inputs.

Parameters

1. noise_paramdict

Dictionary of noise parameter.

2. system_paramdict

Dictionary of system parameters.

3. flagint

1-NOISE1 parameters, 2-NOISE2 parameters.

Returns

1. noiseinstance(HopsNoise)