bsmschema.models.Contrast
bsmschema.models.Contrast¶
- object Contrast¶
Contrasts are weighted sums of parameter estimates (betas) generated by a model fit, and define the outputs of a
Node.While
"t"and"pass"contrasts are passed as inputs to the next node,"F"contrasts are terminal and are not passed as inputs to following nodes.- field Name: str [Required]¶
The name of the contrast. Must be unique in
Node.Contrastsand must not appear inDummyContrasts.Contrastsfor the same Node.This name will be attached to output statistical maps via the
"contrast"entity.
- field ConditionList: List[Union[Literal[1], str]] [Required]¶
A list of variables used to compute the contrast. Must be a strict subset of the variables listed in
Model.X.
- field Weights: Union[List[Union[int, float, str]], List[List[Union[int, float, str]]]] [Required]¶
A 1D or 2D array of weights. The array must have exactly the same number of total elements as in ConditionList. For t-tests, a 1D array must be passed. For F-tests, either a 1D or a 2D array may be passed. Variables are mapped 1-to-1 onto weights in the order they appear in ConditionList. Fractional values MAY be passed as strings (e.g., “1/3”).
- field Test: Literal['pass', 't', 'F'] [Required]¶
The type of test statistic to compute on the contrast. The special value “pass” indicates that no statistical test is to be performed.