def file_vs_value_plot(
a_x: Axis, field_name: str, row: pd.DataFrame, range_columns: List[str], fontsize: float, pad: float
) -> None:
"""Create a dot plot with one point per file"""
assert field_name in ["rt_peak", "peak_height"]
a_x.tick_params(direction="in", length=1, pad=pad, width=0.1, labelsize=fontsize)
num_files = len(range_columns)
a_x.scatter(range(num_files), row[:num_files], s=0.2)
if field_name == "rt_peak":
a_x.axhline(y=row["atlas RT peak"], color="r", linestyle="-", linewidth=0.2)
range_columns += ["atlas RT peak"]
a_x.set_ylim(np.nanmin(row.loc[range_columns]) - 0.12, np.nanmax(row.loc[range_columns]) + 0.12)
else:
a_x.set_yscale("log")
a_x.set_ylim(bottom=1e4, top=1e10)
a_x.set_xlim(-0.5, num_files + 0.5)
a_x.xaxis.set_major_locator(mticker.FixedLocator(np.arange(0, num_files, 1.0)))
_ = [s.set_linewidth(0.1) for s in a_x.spines.values()]
# truncate name so it fits above a single subplot
a_x.set_title(row.name[:33], pad=pad, fontsize=fontsize)
a_x.set_xlabel("Files", labelpad=pad, fontsize=fontsize)
ylabel = "Actual RTs" if field_name == "rt_peak" else "Peak Height"
a_x.set_ylabel(ylabel, labelpad=pad, fontsize=fontsize)
def control_plot(data: (List[int], List[float], pd.Series, np.array),
upper_control_limit: (int, float),
lower_control_limit: (int, float),
highlight_beyond_limits: bool = True,
highlight_zone_a: bool = True,
highlight_zone_b: bool = True,
highlight_zone_c: bool = True,
highlight_trend: bool = True,
highlight_mixture: bool = True,
highlight_stratification: bool = True,
highlight_overcontrol: bool = True,
ax: Axis = None):
"""
Create a control plot based on the input data.
:param data: a list, pandas.Series, or numpy.array representing the data set
:param upper_control_limit: an integer or float which represents the upper control limit, commonly called the UCL
:param lower_control_limit: an integer or float which represents the upper control limit, commonly called the UCL
:param highlight_beyond_limits: True if points beyond limits are to be highlighted
:param highlight_zone_a: True if points that are zone A violations are to be highlighted
:param highlight_zone_b: True if points that are zone B violations are to be highlighted
:param highlight_zone_c: True if points that are zone C violations are to be highlighted
:param highlight_trend: True if points that are trend violations are to be highlighted
:param highlight_mixture: True if points that are mixture violations are to be highlighted
:param highlight_stratification: True if points that are stratification violations are to be highlighted
:param highlight_overcontrol: True if points that are overcontrol violations are to be hightlighted
:param ax: an instance of matplotlib.axis.Axis
:return: None
"""
data = coerce(data)
if ax is None:
fig, ax = plt.subplots()
ax.plot(data)
ax.set_title('Zone Control Chart')
spec_range = (upper_control_limit - lower_control_limit) / 2
spec_center = lower_control_limit + spec_range
zone_c_upper_limit = spec_center + spec_range / 3
zone_c_lower_limit = spec_center - spec_range / 3
zone_b_upper_limit = spec_center + 2 * spec_range / 3
zone_b_lower_limit = spec_center - 2 * spec_range / 3
zone_a_upper_limit = spec_center + spec_range
zone_a_lower_limit = spec_center - spec_range
ax.axhline(spec_center, linestyle='--', color='red', alpha=0.6)
ax.axhline(zone_c_upper_limit, linestyle='--', color='red', alpha=0.5)
ax.axhline(zone_c_lower_limit, linestyle='--', color='red', alpha=0.5)
ax.axhline(zone_b_upper_limit, linestyle='--', color='red', alpha=0.3)
ax.axhline(zone_b_lower_limit, linestyle='--', color='red', alpha=0.3)
ax.axhline(zone_a_upper_limit, linestyle='--', color='red', alpha=0.2)
ax.axhline(zone_a_lower_limit, linestyle='--', color='red', alpha=0.2)
left, right = ax.get_xlim()
right_plus = (right - left) * 0.01 + right
ax.text(right_plus, upper_control_limit, s='UCL', va='center')
ax.text(right_plus, lower_control_limit, s='LCL', va='center')
ax.text(right_plus, (spec_center + zone_c_upper_limit) / 2,
s='Zone C',
va='center')
ax.text(right_plus, (spec_center + zone_c_lower_limit) / 2,
s='Zone C',
va='center')
ax.text(right_plus, (zone_b_upper_limit + zone_c_upper_limit) / 2,
s='Zone B',
va='center')
ax.text(right_plus, (zone_b_lower_limit + zone_c_lower_limit) / 2,
s='Zone B',
va='center')
ax.text(right_plus, (zone_a_upper_limit + zone_b_upper_limit) / 2,
s='Zone A',
va='center')
ax.text(right_plus, (zone_a_lower_limit + zone_b_lower_limit) / 2,
s='Zone A',
va='center')
plot_params = {'alpha': 0.3, 'zorder': -10, 'markersize': 14}
if highlight_beyond_limits:
beyond_limits_violations = control_beyond_limits(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(beyond_limits_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(beyond_limits_violations,
'o',
color='red',
label='beyond limits',
**plot_params)
if highlight_zone_a:
zone_a_violations = control_zone_a(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_a_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_a_violations,
'o',
color='orange',
label='zone a violations',
**plot_params)
if highlight_zone_b:
zone_b_violations = control_zone_b(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_b_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_b_violations,
'o',
color='blue',
label='zone b violations',
**plot_params)
if highlight_zone_c:
zone_c_violations = control_zone_c(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_c_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_c_violations,
'o',
color='green',
label='zone c violations',
**plot_params)
if highlight_trend:
zone_trend_violations = control_zone_trend(data=data)
if len(zone_trend_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_trend_violations,
'o',
color='purple',
label='trend violations',
**plot_params)
if highlight_mixture:
zone_mixture_violations = control_zone_mixture(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_mixture_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_mixture_violations,
'o',
color='brown',
label='mixture violations',
**plot_params)
if highlight_stratification:
zone_stratification_violations = control_zone_stratification(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_stratification_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_stratification_violations,
'o',
color='orange',
label='stratification violations',
**plot_params)
if highlight_overcontrol:
zone_overcontrol_violations = control_zone_overcontrol(
data=data,
upper_control_limit=upper_control_limit,
lower_control_limit=lower_control_limit)
if len(zone_overcontrol_violations):
plot_params['zorder'] -= 1
plot_params['markersize'] -= 1
ax.plot(zone_overcontrol_violations,
'o',
color='blue',
label='overcontrol violations',
**plot_params)
ax.legend()