SpectrumEstimate._index#

SpectrumEstimate._index(name)[source]#

Resolve a series label.

Parameters:

name (str) – A label from names.

Return type:

int

Returns:

Its position on the matrix axes.

Raises:

SpecificationError – If the label is unknown.

Example

>>> rng = np.random.default_rng(0)
>>> est = WelchSpectrum(rng.standard_normal((256, 2))).compute()
>>> est._index("y2")
1
>>> est._index("z")
Traceback (most recent call last):
    ...
cultivars.exceptions.SpecificationError: unknown series 'z'; the estimate has ...