Multiply another DataBundle#

Summary#

Multiply a DataBundle element using another DataBundle

Metadata#

  • Module ID: MultiplyDatabundles

  • Module path: /home/runner/work/MoDaCor/MoDaCor/src/modacor/modules/base_modules/multiply_databundles.py

  • Module version: 20251212.1

  • Keywords: multiply, scaling, databundle

Required data keys#

  • signal

Modifies#

  • signal: signal, uncertainties, units

Required arguments#

  • None

Default configuration#

{
  "multiplicand_data_key": "signal",
  "multiplier_data_key": "signal"
}

Argument specification#

Argument

Type

Required

Default

Description

multiplicand_data_key

str

No

signal

BaseData key to modify in the multiplicand DataBundle.

multiplier_data_key

str

No

signal

BaseData key to read from the multiplier DataBundle.

References#

DOI 10.1088/0953-8984/25/38/383201

Notes#

        This multiplies one DataBundle's signal with another, useful for scaling or combining data.
        'with_processing_keys' in the configuration should contain two keys, the operation
        will multiply the first key's DataBundle by the second key's DataBundle.