DifferenceCombiner

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class DifferenceCombiner[source]

Bases: object

Element-wise difference of two sibling blocks: first - second.

Subtraction maps (post-contrast minus pre-contrast enhancement, two time points of the same sequence) turn absolute intensities into a change signal, which is often the actual biology of interest.

__init__() → None[source]
property spec: Spec

Return the algorithm specification used for provenance.

__call__(blocks: Sequence[DataFrame], *, context: Mapping[str, Any] | None = None) → DataFrame[source]

Subtract the second child block from the first.

Parameters:

  • blocks – Exactly two blocks: minuend first, subtrahend second.

  • context – Carries the child source labels under "sources".

Returns:

One column per paired column, named diff-{first}-{second}.