xeofs.models.RotatorFactory

class xeofs.models.RotatorFactory(**kwargs)

Bases: object

Factory class for creating rotators.

Parameters:

• n_rot (int) – Number of modes to be rotated.

• power (int) – Defines the power of Promax rotation. Choosing power=1 equals a Varimax solution (the default is 1).

• max_iter (int) – Number of maximal iterations for obtaining the rotation matrix (the default is 1000).

• rtol (float) – Relative tolerance to be achieved for early stopping the iteration process (the default is 1e-8).

__init__(**kwargs)

Methods

__init__(**kwargs)
create_rotator(model)	Create a rotator for the given model.

create_rotator(model: EOF | ComplexEOF | MCA | ComplexMCA) → EOFRotator | ComplexEOFRotator | MCARotator | ComplexMCARotator

Create a rotator for the given model.

Parameters:

model (xeofs model) – Model to be rotated.

Returns:

Rotator for the given model.

Return type:

xeofs Rotator