Skip to content

Documents · Verb reference

compare_aoi_signature

Compare one AOI signature with another over shared time.

Callable type: Grammar verb / pipe stage · Browse: compatibility

Compatibility / legacy: Compatibility workflow: new code can collect_blocks then compare_blocks. This is not a drop-in signature replacement.

Usage

from cubedynamics import verbs as v
v.compare_aoi_signature(other, *, variables=None, time_dim=None, unit_dim='unit', join='inner')

Arguments

Argument Meaning Default
other See implementation docstring below; no parameter-specific description supplied. required
variables See implementation docstring below; no parameter-specific description supplied. None
time_dim See implementation docstring below; no parameter-specific description supplied. None
unit_dim See implementation docstring below; no parameter-specific description supplied. 'unit'
join See implementation docstring below; no parameter-specific description supplied. 'inner'

Accepts

Consult the input parameters and implementation notes below. This namespace also includes direct helpers, not only pipe factories.

Returns

The public docstring does not specify a return contract. Do not assume a pipe-ready return; consult the linked implementation.

Order / grammar behavior

A pipe passes the preceding result to the next callable. Confirm that the previous step's dimensions and semantic state satisfy the input contract. Reductions can remove dimensions; plotting may produce side effects.

Minimal example

A standalone, reviewed real-data example is not yet available for this helper. See the linked workflow and implementation notes; this reference does not substitute generated observations or invent an executable example.

Works with

Use only the input types documented by this callable; not every helper accepts every noun or VirtualCube.

See also

Implementation notes

No additional implementation notes in the current docstring.

Implementation source. Signatures and descriptions on this page are generated from this checkout, not hand-maintained copies.