Skip to content

plot_settings

Plot settings menus

CommonSettings(plotstate) #

Common plot settings, with debouncers.

Parameters:

Name Type Description Default
plotstate PlotState

plot variables

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
@sl.component
def CommonSettings(plotstate: PlotState) -> ValueElement:
    """Common plot settings, with debouncers.

    Args:
        plotstate: plot variables
    """
    plottype = plotstate.plottype
    logx = sl.use_reactive(getattr(plotstate, "logx").value)
    logy = sl.use_reactive(getattr(plotstate, "logy").value)
    flipx = sl.use_reactive(getattr(plotstate, "flipx").value)
    flipy = sl.use_reactive(getattr(plotstate, "flipy").value)
    logcolor = sl.use_reactive(getattr(plotstate, "logcolor").value)

    # debouncing values
    # BUG: non-threaded until https://github.com/widgetti/solara/issues/1011 is fixed
    db_logx = sl.lab.use_task(debounce(logx.value),
                              dependencies=[logx.value],
                              prefer_threaded=False)
    if db_logx.value == logx.value:
        plotstate.logx.set(db_logx.value)
    db_logy = sl.lab.use_task(debounce(logy.value),
                              dependencies=[logy.value],
                              prefer_threaded=False)
    if db_logy.value == logy.value:
        plotstate.logy.set(db_logy.value)
    db_flipx = sl.lab.use_task(debounce(flipx.value),
                               dependencies=[flipx.value],
                               prefer_threaded=False)
    if db_flipx.value == flipx.value:
        plotstate.flipx.set(db_flipx.value)
    db_flipy = sl.lab.use_task(debounce(flipy.value),
                               dependencies=[flipy.value],
                               prefer_threaded=False)
    if db_flipy.value == flipy.value:
        plotstate.flipy.set(db_flipy.value)
    logcolor = sl.use_reactive(getattr(plotstate, "logcolor").value)
    db_logcolor = sl.lab.use_task(debounce(logcolor.value),
                                  dependencies=[logcolor.value],
                                  prefer_threaded=False)
    if db_logcolor.value == logcolor.value:
        plotstate.logcolor.set(db_logcolor.value)

    with sl.Card(margin=0) as main:
        with Columns([1, 1]):
            with sl.Column():
                if plottype != "heatmap":
                    sl.Switch(label="Log x", value=logx)
                sl.Switch(label="Flip x", value=flipx)
            with sl.Column():
                if plottype != "heatmap":
                    sl.Switch(label="Log y", value=logy)
                if plottype != "histogram":
                    sl.Switch(label="Flip y", value=flipy)
        if plottype != "histogram":
            sl.Switch(label="Color logscale", value=logcolor)
    return main

HeatmapMenu(plotstate, columns) #

Settings for HeatmapPlot

Parameters:

Name Type Description Default
plotstate PlotState

plot variables

 required
columns list[str]

list of valid columns

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
@sl.component()
def HeatmapMenu(plotstate: PlotState, columns):
    """Settings for HeatmapPlot

    Args:
        plotstate: plot variables
        columns (list[str]): list of valid columns
    """
    nbins = sl.use_reactive(getattr(plotstate, "nbins").value)
    db_nbins = sl.lab.use_task(debounce(nbins.value, 0.05),
                               dependencies=[nbins.value],
                               prefer_threaded=False)
    if db_nbins.value == nbins.value:
        plotstate.nbins.set(db_nbins.value)
    with sl.Column() as main:
        with sl.Card(margin=0):
            with Columns([3, 3, 1], gutters_dense=True):
                SingleAutocomplete(
                    label="Column x",
                    values=[
                        col for col in columns if col != plotstate.y.value
                    ],
                    value=plotstate.x.value,
                    on_value=plotstate.x.set,
                )
                SingleAutocomplete(
                    label="Column y",
                    values=[
                        col for col in columns if col != plotstate.x.value
                    ],
                    value=plotstate.y.value,
                    on_value=plotstate.y.set,
                )
                sl.Button(
                    icon=True,
                    icon_name="mdi-swap-horizontal",
                    on_click=plotstate.swap_axes,
                )
        with sl.Card(margin=0):
            with sl.Column():
                SingleAutocomplete(
                    label="Column to Bin",
                    values=columns,
                    value=plotstate.color.value,
                    on_value=plotstate.color.set,
                    disabled=(str(plotstate.bintype.value) == "count"),
                )
                sl.SliderInt(
                    label="Number of Bins",
                    value=nbins,
                    step=2,
                    min=2,
                    max=240,
                )
                with Columns([1, 1]):
                    with sl.Column():
                        SingleAutocomplete(
                            label="Binning type",
                            values=plotstate.Lookup["bintypes"],
                            value=plotstate.bintype.value,
                            on_value=plotstate.bintype.set,
                        )
                    with sl.Column():
                        SingleAutocomplete(
                            label="Colorscale",
                            values=list(
                                plotstate.Lookup["colorscales"].keys()),
                            value=plotstate.colorscale.value,
                            on_value=plotstate.colorscale.set,
                        )
    return main

HistogramMenu(plotstate, columns) #

Settings for HistogramPlot

Parameters:

Name Type Description Default
plotstate PlotState

plot variables

 required
columns list[str]

list of valid columns

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
@sl.component()
def HistogramMenu(plotstate: PlotState, columns):
    """Settings for HistogramPlot

    Args:
        plotstate: plot variables
        columns (list[str]): list of valid columns
    """
    nbins = sl.use_reactive(getattr(plotstate, "nbins").value)
    db_nbins = sl.lab.use_task(debounce(nbins.value, 0.05),
                               dependencies=[nbins.value],
                               prefer_threaded=False)
    if db_nbins.value == nbins.value:
        plotstate.nbins.set(db_nbins.value)

    with sl.Column():
        with Card(margin=0):
            with sl.Column():
                SingleAutocomplete(
                    label="Column",
                    values=columns,
                    value=plotstate.x.value,
                    on_value=plotstate.x.set,
                )
        with Card(margin=0):
            sl.SliderInt(
                label="Number of Bins",
                value=nbins,
                step=5,
                min=10,
                max=200,
            )

ScatterMenu(plotstate, columns) #

Settings for ScatterPlot

Parameters:

Name Type Description Default
plotstate PlotState

plot variables

 required
columns list[str]

list of valid columns

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
@sl.component()
def ScatterMenu(plotstate: PlotState, columns):
    """Settings for ScatterPlot

    Args:
        plotstate: plot variables
        columns (list[str]): list of valid columns
    """
    with sl.Column() as main:
        with Card(margin=0):
            with Columns([8, 8, 2], gutters_dense=True):
                SingleAutocomplete(
                    label="Column x",
                    values=[
                        col for col in columns if col != plotstate.y.value
                    ],
                    value=plotstate.x.value,
                    on_value=plotstate.x.set,
                )
                SingleAutocomplete(
                    label="Column y",
                    values=[
                        col for col in columns if col != plotstate.x.value
                    ],
                    value=plotstate.y.value,
                    on_value=plotstate.y.set,
                )
                sl.Button(
                    icon=True,
                    icon_name="mdi-swap-horizontal",
                    on_click=plotstate.swap_axes,
                )
        with Card(margin=0):
            with sl.Column():
                SingleAutocomplete(
                    label="Color",
                    values=columns,
                    value=plotstate.color.value,
                    on_value=plotstate.color.set,
                )
                with sl.Row(gap="2px"):
                    SingleAutocomplete(
                        label="Colorscale",
                        values=list(plotstate.Lookup["colorscales"].keys()),
                        value=plotstate.colorscale.value,
                        on_value=plotstate.colorscale.set,
                    )
    return main

TableMenu(state) #

Settings menu for Statistics Table view.

Parameters:

Name Type Description Default
state PlotState

plot variables

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
@sl.component()
def TableMenu(state: PlotState):
    """Settings menu for Statistics Table view.

    Args:
        state: plot variables

    """
    with sl.Column():
        AutocompleteSelect(
            label="Column",
            value=state.columns.value,
            on_value=state.columns.set,
            values=SubsetState.subsets.value[state.subset.value].columns +
            list(VCData.columns.value.keys()),
            multiple=True,
        )
    return

debounce(value, sleep=0.1) #

Generates a debouncer function

Parameters:

Name Type Description Default
value Any

value to debounce

 required
sleep float

time for debounce in seconds. defaults to 0.1s.

 0.1
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
def debounce(value: Any, sleep: float = 0.1):
    """Generates a debouncer function

    Args:
        value: value to debounce
        sleep: time for debounce in seconds. defaults to 0.1s.
    """

    async def debouncer():
        await asyncio.sleep(sleep)
        return value

    return debouncer

show_settings(type, plotstate) #

Wrapper to case switch logic for menus

Parameters:

Name Type Description Default
type str

plottype, any of 'histogram','scatter','heatmap'

 required
plotstate PlotState

plot variables

 required
Source code in src/sdss_explorer/dashboard/components/views/plot_settings.py 
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
def show_settings(type: str, plotstate: PlotState):
    """Wrapper to case switch logic for menus

    Args:
        type: plottype, any of `'histogram','scatter','heatmap'`
        plotstate: plot variables

    """
    subset = SubsetState.subsets.value.get(plotstate.subset.value,
                                           Subset(name="temp"))
    columns = list(VCData.columns.value.keys()) + subset.columns
    sl.lab.use_task(
        plotstate.reset_values,
        dependencies=[
            subset.df,
            subset.dataset,
            len(SubsetState.subsets.value),
            SubsetState.subsets.value,
            VCData.columns.value,
        ],
    )
    name, names = (
        subset.name,
        [ss.name for ss in SubsetState.subsets.value.values()],
    )

    # specific plot controls
    with sl.Column():
        SingleAutocomplete(
            label="Subset",
            values=names,
            value=name,
            on_value=plotstate.update_subset,
        )
        if (type == "stats") or (type == "targets"):
            TableMenu(plotstate)
        else:
            with sl.Columns([1, 1]):
                if type == "scatter":
                    ScatterMenu(plotstate, columns)
                elif type == "histogram":
                    HistogramMenu(plotstate, columns)
                elif type == "heatmap":
                    HeatmapMenu(plotstate, columns)
                CommonSettings(plotstate)
    return