threeML.config.plotting_structure module

class threeML.config.plotting_structure.BinnedSpectrumPlot(data_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, model_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, background_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, n_colors: int = 5, step: bool = False, show_legend: bool = True, show_residuals: bool = True, data_color: Optional[str] = None, model_color: Optional[str] = None, background_color: Optional[str] = None, show_background: bool = False, data_mpl_kwargs: Optional[Dict[str, Any]] = None, model_mpl_kwargs: Optional[Dict[str, Any]] = None, background_mpl_kwargs: Optional[Dict[str, Any]] = None)[source]

Bases: object

background_cmap: MPLCmap = 'Set1'
background_color: str | None = None
background_mpl_kwargs: Dict[str, Any] | None = None
data_cmap: MPLCmap = 'Set1'
data_color: str | None = None
data_mpl_kwargs: Dict[str, Any] | None = None
model_cmap: MPLCmap = 'Set1'
model_color: str | None = None
model_mpl_kwargs: Dict[str, Any] | None = None
n_colors: int = 5
show_background: bool = False
show_legend: bool = True
show_residuals: bool = True
step: bool = False
class threeML.config.plotting_structure.ContourStyle(alpha: float = 0.4)[source]

Bases: object

alpha: float = 0.4
class threeML.config.plotting_structure.CornerStyle(show_titles: bool = True, smooth: float = 0.9, title_fmt: str = '.2g', bins: int = 25, quantiles: List[float] = <factory>, fill_contours: bool = True, cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.viridis: 'viridis'>, extremes: str = 'white', contourf_kwargs: Dict[str, Any] = <factory>, levels: List[float] = <factory>)[source]

Bases: object

bins: int = 25
cmap: MPLCmap = 'viridis'
contourf_kwargs: Dict[str, Any]
extremes: str = 'white'
fill_contours: bool = True
levels: List[float]
quantiles: List[float]
show_titles: bool = True
smooth: float = 0.9
title_fmt: str = '.2g'
class threeML.config.plotting_structure.DataHistPlot(counts_color: str = '#500472', background_color: str = '#79cbb8', warn_channels_color: str = '#C79BFE', bad_channels_color: str = '#FE3131', masked_channels_color: str = '#566573')[source]

Bases: object

background_color: str = '#79cbb8'
bad_channels_color: str = '#FE3131'
counts_color: str = '#500472'
masked_channels_color: str = '#566573'
warn_channels_color: str = '#C79BFE'
class threeML.config.plotting_structure.FermiSpectrumPlot(total_model_color: str = 'k', show_background_sources: bool = True, shade_fixed_sources: bool = True, shade_secondary_sources: bool = False, fixed_sources_color: str = 'grey', secondary_sources_color: str = 'k', data_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, model_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, background_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, step: bool = False, show_legend: bool = True, show_residuals: bool = True, data_color: Optional[str] = None, model_color: Optional[str] = None, background_color: Optional[str] = None, data_mpl_kwargs: Optional[Dict[str, Any]] = None, model_mpl_kwargs: Optional[Dict[str, Any]] = None, background_mpl_kwargs: Optional[Dict[str, Any]] = None)[source]

Bases: object

background_cmap: MPLCmap = 'Set1'
background_color: str | None = None
background_mpl_kwargs: Dict[str, Any] | None = None
data_cmap: MPLCmap = 'Set1'
data_color: str | None = None
data_mpl_kwargs: Dict[str, Any] | None = None
fixed_sources_color: str = 'grey'
model_cmap: MPLCmap = 'Set1'
model_color: str | None = None
model_mpl_kwargs: Dict[str, Any] | None = None
secondary_sources_color: str = 'k'
shade_fixed_sources: bool = True
shade_secondary_sources: bool = False
show_background_sources: bool = True
show_legend: bool = True
show_residuals: bool = True
step: bool = False
total_model_color: str = 'k'
class threeML.config.plotting_structure.GenericPlotting(use_threeml_style: bool = True, mplstyle: str = 'threeml.mplstyle', residual_plot: threeML.config.plotting_structure.ResidualPlot = <factory>)[source]

Bases: object

mplstyle: str = 'threeml.mplstyle'
residual_plot: ResidualPlot
use_threeml_style: bool = True
class threeML.config.plotting_structure.LegendStyle(loc: str = 'best', fancybox: bool = True, shadow: bool = True)[source]

Bases: object

fancybox: bool = True
loc: str = 'best'
shadow: bool = True
class threeML.config.plotting_structure.MPLCmap(value)

Bases: Enum

An enumeration.

Accent = 'Accent'
Accent_r = 'Accent_r'
Blues = 'Blues'
Blues_r = 'Blues_r'
BrBG = 'BrBG'
BrBG_r = 'BrBG_r'
BuGn = 'BuGn'
BuGn_r = 'BuGn_r'
BuPu = 'BuPu'
BuPu_r = 'BuPu_r'
CMRmap = 'CMRmap'
CMRmap_r = 'CMRmap_r'
Dark2 = 'Dark2'
Dark2_r = 'Dark2_r'
GnBu = 'GnBu'
GnBu_r = 'GnBu_r'
Grays = 'Grays'
Greens = 'Greens'
Greens_r = 'Greens_r'
Greys = 'Greys'
Greys_r = 'Greys_r'
OrRd = 'OrRd'
OrRd_r = 'OrRd_r'
Oranges = 'Oranges'
Oranges_r = 'Oranges_r'
PRGn = 'PRGn'
PRGn_r = 'PRGn_r'
Paired = 'Paired'
Paired_r = 'Paired_r'
Pastel1 = 'Pastel1'
Pastel1_r = 'Pastel1_r'
Pastel2 = 'Pastel2'
Pastel2_r = 'Pastel2_r'
PiYG = 'PiYG'
PiYG_r = 'PiYG_r'
PuBu = 'PuBu'
PuBuGn = 'PuBuGn'
PuBuGn_r = 'PuBuGn_r'
PuBu_r = 'PuBu_r'
PuOr = 'PuOr'
PuOr_r = 'PuOr_r'
PuRd = 'PuRd'
PuRd_r = 'PuRd_r'
Purples = 'Purples'
Purples_r = 'Purples_r'
RdBu = 'RdBu'
RdBu_r = 'RdBu_r'
RdGy = 'RdGy'
RdGy_r = 'RdGy_r'
RdPu = 'RdPu'
RdPu_r = 'RdPu_r'
RdYlBu = 'RdYlBu'
RdYlBu_r = 'RdYlBu_r'
RdYlGn = 'RdYlGn'
RdYlGn_r = 'RdYlGn_r'
Reds = 'Reds'
Reds_r = 'Reds_r'
Set1 = 'Set1'
Set1_r = 'Set1_r'
Set2 = 'Set2'
Set2_r = 'Set2_r'
Set3 = 'Set3'
Set3_r = 'Set3_r'
Spectral = 'Spectral'
Spectral_r = 'Spectral_r'
Wistia = 'Wistia'
Wistia_r = 'Wistia_r'
YlGn = 'YlGn'
YlGnBu = 'YlGnBu'
YlGnBu_r = 'YlGnBu_r'
YlGn_r = 'YlGn_r'
YlOrBr = 'YlOrBr'
YlOrBr_r = 'YlOrBr_r'
YlOrRd = 'YlOrRd'
YlOrRd_r = 'YlOrRd_r'
afmhot = 'afmhot'
afmhot_r = 'afmhot_r'
autumn = 'autumn'
autumn_r = 'autumn_r'
binary = 'binary'
binary_r = 'binary_r'
bone = 'bone'
bone_r = 'bone_r'
brg = 'brg'
brg_r = 'brg_r'
bwr = 'bwr'
bwr_r = 'bwr_r'
cividis = 'cividis'
cividis_r = 'cividis_r'
cool = 'cool'
cool_r = 'cool_r'
coolwarm = 'coolwarm'
coolwarm_r = 'coolwarm_r'
copper = 'copper'
copper_r = 'copper_r'
cubehelix = 'cubehelix'
cubehelix_r = 'cubehelix_r'
flag = 'flag'
flag_r = 'flag_r'
gist_earth = 'gist_earth'
gist_earth_r = 'gist_earth_r'
gist_gray = 'gist_gray'
gist_gray_r = 'gist_gray_r'
gist_grey = 'gist_grey'
gist_heat = 'gist_heat'
gist_heat_r = 'gist_heat_r'
gist_ncar = 'gist_ncar'
gist_ncar_r = 'gist_ncar_r'
gist_rainbow = 'gist_rainbow'
gist_rainbow_r = 'gist_rainbow_r'
gist_stern = 'gist_stern'
gist_stern_r = 'gist_stern_r'
gist_yarg = 'gist_yarg'
gist_yarg_r = 'gist_yarg_r'
gist_yerg = 'gist_yerg'
gnuplot = 'gnuplot'
gnuplot2 = 'gnuplot2'
gnuplot2_r = 'gnuplot2_r'
gnuplot_r = 'gnuplot_r'
gray = 'gray'
gray_r = 'gray_r'
grey = 'grey'
hot = 'hot'
hot_r = 'hot_r'
hsv = 'hsv'
hsv_r = 'hsv_r'
inferno = 'inferno'
inferno_r = 'inferno_r'
jet = 'jet'
jet_r = 'jet_r'
magma = 'magma'
magma_r = 'magma_r'
nipy_spectral = 'nipy_spectral'
nipy_spectral_r = 'nipy_spectral_r'
ocean = 'ocean'
ocean_r = 'ocean_r'
pink = 'pink'
pink_r = 'pink_r'
plasma = 'plasma'
plasma_r = 'plasma_r'
prism = 'prism'
prism_r = 'prism_r'
rainbow = 'rainbow'
rainbow_r = 'rainbow_r'
seismic = 'seismic'
seismic_r = 'seismic_r'
spring = 'spring'
spring_r = 'spring_r'
summer = 'summer'
summer_r = 'summer_r'
tab10 = 'tab10'
tab10_r = 'tab10_r'
tab20 = 'tab20'
tab20_r = 'tab20_r'
tab20b = 'tab20b'
tab20b_r = 'tab20b_r'
tab20c = 'tab20c'
tab20c_r = 'tab20c_r'
terrain = 'terrain'
terrain_r = 'terrain_r'
turbo = 'turbo'
turbo_r = 'turbo_r'
twilight = 'twilight'
twilight_r = 'twilight_r'
twilight_shifted = 'twilight_shifted'
twilight_shifted_r = 'twilight_shifted_r'
viridis = 'viridis'
viridis_r = 'viridis_r'
winter = 'winter'
winter_r = 'winter_r'
class threeML.config.plotting_structure.ModelPlotting(point_source_plot: threeML.config.plotting_structure.PointSourcePlot = <factory>)[source]

Bases: object

point_source_plot: PointSourcePlot
class threeML.config.plotting_structure.PlotStyle(linestyle: str | None = '-', linewidth: float | None = 1.7)[source]

Bases: object

linestyle: str | None = '-'
linewidth: float | None = 1.7
class threeML.config.plotting_structure.PointSourcePlot(fit_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, contour_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, bayes_cmap: threeML.config.plotting_structure.MPLCmap = <MPLCmap.Set1: 'Set1'>, plot_style: threeML.config.plotting_structure.PlotStyle = <factory>, contour_style: threeML.config.plotting_structure.ContourStyle = <factory>, show_legend: bool = True, legend_style: threeML.config.plotting_structure.LegendStyle = <factory>, flux_unit: str = '1/(keV s cm2)', emin: float = 10.0, emax: float = 10000.0, num_ene: int = 100, ene_unit: str = 'keV')[source]

Bases: object

bayes_cmap: MPLCmap = 'Set1'
contour_cmap: MPLCmap = 'Set1'
contour_style: ContourStyle
emax: float = 10000.0
emin: float = 10.0
ene_unit: str = 'keV'
fit_cmap: MPLCmap = 'Set1'
flux_unit: str = '1/(keV s cm2)'
legend_style: LegendStyle
num_ene: int = 100
plot_style: PlotStyle
show_legend: bool = True
class threeML.config.plotting_structure.ResidualPlot(linewidth: float = 1, marker: str = '.', size: float = 3, legend_font_size: float = 6.94)[source]

Bases: object

legend_font_size: float = 6.94
linewidth: float = 1
marker: str = '.'
size: float = 3