Documents · Verb reference

correlation_cube

Factory placeholder for a future correlation cube operation.

Callable type: Reserved / planned API · Browse: placeholder

Availability: Not implemented. Configuration may raise NotImplementedError; applying a returned stage always does.

Usage

from cubedynamics import verbs as v
v.correlation_cube(other, dim='time')

Arguments

Argument	Meaning	Default
other	The comparison cube captured by the factory.	required
dim	Dimension over which correlations would be computed once implemented.	'time'

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

For an explicit xarray calculation on aligned observed cubes, use xr.corr(left, right, dim='time'). This is not an implementation of v.correlation_cube.

Works with

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

See also

• Learn: verbs
• Noun library
• Verbs by purpose
• All public callables (A–Z)

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.