Copy DataBundle keys#

Summary#

Copy selected BaseData entries between DataBundles.

Metadata#

  • Module ID: CopyDataBundleKeys

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

  • Module version: 20260525.1

  • Keywords: copy, databundle, static

Required data keys#

  • None

Modifies#

  • None

Required arguments#

  • with_processing_keys

Default configuration#

{
  "copy": true,
  "copy_axes": true,
  "data_keys": null,
  "key_map": null,
  "with_processing_keys": null
}

Argument specification#

Argument

Type

Required

Default

Description

copy

bool

No

True

Deep-copy copied values. If False, attach the same objects by reference.

copy_axes

bool

No

True

Pass with_axes to BaseData.copy when copy is True.

data_keys

list or str or NoneType

No

-

Source keys to copy to the target DataBundle under the same names.

key_map

dict or NoneType

No

-

Mapping of source key to target key. Mutually exclusive with data_keys.

with_processing_keys

list

Yes

-

Two processing keys: target then source.

Notes#

Use this to attach static maps such as Q, Psi, Omega, pixel_index, or masks to each sample without recomputing the static branch.