Skip to content

chainconsumer.Truth

Bases: BetterBase

Source code in src/chainconsumer/truth.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
class Truth(BetterBase):
    location: dict[str, float] = Field(
        default=...,
        description="The truth value, either as dictionary or pandas series which will be converted to a dict)",
    )
    name: str | None = Field(default=None, description="The name of the truth line")
    color: ColorInput = Field(default="black", description="The color of the truth line")
    line_width: float = Field(default=1.0, description="The width of the truth line")
    line_style: str = Field(default="--", description="The style of the truth line")
    alpha: float = Field(default=1.0, description="The alpha of the truth line")
    zorder: int = Field(default=100, description="The zorder of the truth line")
    marker: str | None = Field(default=None, description="The truth marker style for the contour plots")
    marker_size: float = Field(default=150.0, description="The truth marker size for the contour plots")
    marker_edge_width: float = Field(
        default=_DEFAULT_EDGE_WIDTH, description="The truth marker edge width for the contour plots"
    )

    @field_validator("location")
    @classmethod
    def _ensure_dict(cls, v):
        if isinstance(v, dict):
            return v
        elif isinstance(v, pd.Series):
            return v.to_dict()
        raise ValidationError("Truth must be a dict or a pandas Series")

    @model_validator(mode="after")
    def validate_model(self):
        if self.marker is not None and self.is_filled_marker and self.marker_edge_width > _DEFAULT_EDGE_WIDTH:
            msg = (
                f"It seems you are trying to make the marker {self.marker} thicker. "
                "Alas, this is not possible. Matplotlib only lets you make the marker "
                "edge thicker if the marker is filled. Which, FYI, means picking from "
                "one of the following markers: "
                f"{', '.join(Line2D.filled_markers)}"
            )
            raise ValueError(msg)
        return self

    @property
    def is_filled_marker(self) -> bool:
        return self.marker in Line2D.filled_markers

    @property
    def _kwargs(self) -> dict[str, Any]:
        return {
            "ls": self.line_style,
            "c": self.color,
            "lw": self.line_width,
            "alpha": self.alpha,
            "zorder": self.zorder,
        }

    @property
    def _marker_kwargs(self) -> dict[str, Any]:
        result = {
            "marker": self.marker,
            "s": self.marker_size,
            "color": self.color,
            "alpha": self.alpha,
            "zorder": self.zorder,
        }
        if self.is_filled_marker:
            result["edgecolor"] = self.color
            result["facecolor"] = self.color
            result["linewidth"] = self.marker_edge_width
        return result

location class-attribute instance-attribute 

location: dict[str, float] = Field(default=..., description='The truth value, either as dictionary or pandas series which will be converted to a dict)')

name class-attribute instance-attribute 

name: str | None = Field(default=None, description='The name of the truth line')

color class-attribute instance-attribute 

color: ColorInput = Field(default='black', description='The color of the truth line')

line_width class-attribute instance-attribute 

line_width: float = Field(default=1.0, description='The width of the truth line')

line_style class-attribute instance-attribute 

line_style: str = Field(default='--', description='The style of the truth line')

alpha class-attribute instance-attribute 

alpha: float = Field(default=1.0, description='The alpha of the truth line')

zorder class-attribute instance-attribute 

zorder: int = Field(default=100, description='The zorder of the truth line')

marker class-attribute instance-attribute 

marker: str | None = Field(default=None, description='The truth marker style for the contour plots')

marker_size class-attribute instance-attribute 

marker_size: float = Field(default=150.0, description='The truth marker size for the contour plots')

marker_edge_width class-attribute instance-attribute 

marker_edge_width: float = Field(default=_DEFAULT_EDGE_WIDTH, description='The truth marker edge width for the contour plots')

is_filled_marker property 

is_filled_marker: bool

validate_model 

validate_model()
Source code in src/chainconsumer/truth.py 
39
40
41
42
43
44
45
46
47
48
49
50
@model_validator(mode="after")
def validate_model(self):
    if self.marker is not None and self.is_filled_marker and self.marker_edge_width > _DEFAULT_EDGE_WIDTH:
        msg = (
            f"It seems you are trying to make the marker {self.marker} thicker. "
            "Alas, this is not possible. Matplotlib only lets you make the marker "
            "edge thicker if the marker is filled. Which, FYI, means picking from "
            "one of the following markers: "
            f"{', '.join(Line2D.filled_markers)}"
        )
        raise ValueError(msg)
    return self