noise

class GammaNoise(global_settings, component_settings_key: str)[source]

Bases: ProcessingComponentBase

Applies Gamma noise to the defined data field. The noise will be applied to all wavelengths.

Component Settings:

Tags.NOISE_SHAPE (default: 2)
Tags.NOISE_SCALE (default: 2)
Tags.NOISE_MODE (default: Tags.NOISE_MODE_ADDITIVE)
Tags.DATA_FIELD (required)

Initialises the ProcessingComponent object.

Parameters:: component_settings_key – The key where the component settings are stored in

run(device)[source]

Executes the respective simulation module

Parameters:: digital_device_twin – The digital twin that can be used by the digital device_twin.

class GaussianNoise(global_settings, component_settings_key: str)[source]

Bases: ProcessingComponentBase

Applies Gaussian noise to the defined data field. The noise will be applied to all wavelengths. Component Settings:

Tags.NOISE_MEAN (default: 0)
Tags.NOISE_STD (default: 1)
Tags.NOISE_MODE (default: Tags.NOISE_MODE_ADDITIVE)
Tags.NOISE_NON_NEGATIVITY_CONSTRAINT (default: False)
Tags.DATA_FIELD (required)

Initialises the ProcessingComponent object.

Parameters:: component_settings_key – The key where the component settings are stored in

run(device)[source]

Executes the respective simulation module

Parameters:: digital_device_twin – The digital twin that can be used by the digital device_twin.

class PoissonNoise(global_settings, component_settings_key: str)[source]

Bases: ProcessingComponentBase

Applies Poisson noise to the defined data field. The noise will be applied to all wavelengths.

Component Settings:

Tags.NOISE_MEAN (default: 3)
Tags.NOISE_MODE (default: Tags.NOISE_MODE_ADDITIVE)
Tags.DATA_FIELD (required)

Initialises the ProcessingComponent object.

Parameters:: component_settings_key – The key where the component settings are stored in

run(device)[source]

Executes the respective simulation module

Parameters:: digital_device_twin – The digital twin that can be used by the digital device_twin.

class SaltAndPepperNoise(global_settings, component_settings_key: str)[source]

Bases: ProcessingComponentBase

Applies salt and pepper noise to the defined data field. The noise will be applied to all wavelengths.

The noise will be 50% salt and 50% pepper noise, but both can be set to the same value using the NOISE_MIN and NOISE_MAX fields.

Component Settings:

Tags.NOISE_MIN (default: min(data_field))
Tags.NOISE_MAX (default: max(data_field))
Tags.NOISE_FREQUENCY (default: 0.01)
Tags.DATA_FIELD (required)

Initialises the ProcessingComponent object.

Parameters:: component_settings_key – The key where the component settings are stored in

run(device)[source]

Executes the respective simulation module

Parameters:: digital_device_twin – The digital twin that can be used by the digital device_twin.

class UniformNoise(global_settings, component_settings_key: str)[source]

Bases: ProcessingComponentBase

Applies uniform noise to the defined data field. The noise will be applied to all wavelengths.

The noise will be uniformly distributed between [min, max[.

Component Settings:

Tags.NOISE_MIN (default: 0)
Tags.NOISE_MAX (default: 1)
Tags.NOISE_MODE (default: Tags.NOISE_MODE_ADDITIVE)
Tags.DATA_FIELD (required)

Initialises the ProcessingComponent object.

Parameters:: component_settings_key – The key where the component settings are stored in

run(device)[source]

Executes the respective simulation module

Parameters:: digital_device_twin – The digital twin that can be used by the digital device_twin.