Components
Accordion
accordion
Accordion
Accordion()
A class representing an accordion component.
The Accordion class is used to create an accordion component with various sub-components such as file input, color pickers, switches, menus, and sliders.
Attributes:
Name | Type | Description |
---|---|---|
file_input |
FileInputComponent
|
The file input component. |
color_picker_ch1 |
Colorpicker
|
The color picker for channel 1. |
color_picker_ch2 |
Colorpicker
|
The color picker for channel 2. |
color_picker_result |
Colorpicker
|
The color picker for the result. |
method_selector |
MethodSelector
|
The selector for methods. |
selector |
Selector
|
The selector component. |
data_selector |
DataSelector
|
The data selector component. |
int_slider |
IntSlider
|
The integer slider component. |
gen_nav |
GeneratorNavigator
|
The generator navigator component. |
blocksize_selector |
BlocksizeSelector
|
The blocksize selector component. |
channel_selector_input |
ChannelSelector
|
The channel selector for input. |
channel_selector_output |
ChannelSelector
|
The channel selector for output. |
window_selector |
WindowSelector
|
The selector for the windows. |
overlap_selector |
OverlapSelector
|
The selector for the overlaps. |
exporter_selector |
ExporterSelector
|
The selector for the exporters. |
file_exporter |
FileExporter
|
The file exporter component. |
toggle_group |
ToggleGroup
|
The toggle group component. |
toggle_y_axis |
ToggleYAxis
|
The toggle for the y-axis. |
toggle_x_axis |
ToggleXAxis
|
The toggle for the x-axis. |
accordion |
Accordion
|
The accordion component. |
Source code in src/fft_analysator/gui/components/accordion.py
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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|
component
property
component
Blocksize Selector
blocksize_selector
BlocksizeSelector
BlocksizeSelector()
A class representing a block size selector.
Attributes:
Name | Type | Description |
---|---|---|
blocksize_selector |
Select
|
The block size selector widget. |
sizes |
list
|
A list of available block sizes. |
_component |
Select
|
The internal block size selector component. |
Source code in src/fft_analysator/gui/components/blocksize_selector.py
15 16 17 18 19 20 21 |
|
component
property
component
Get the block size selector component.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Channel Selector
channel_selector
ChannelSelector
ChannelSelector()
A class used to represent a Channel Selector widget.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
list
|
A list of options for the selector widget. Initially empty. |
_component |
object
|
The panel Select widget with specific parameters. |
Source code in src/fft_analysator/gui/components/channel_selector.py
17 18 19 20 21 22 23 24 |
|
component
property
component
Color Picker
color_picker
Colorpicker
Colorpicker()
A class used to represent a Color Picker widget.
Attributes:
Name | Type | Description |
---|---|---|
color_picker |
object
|
An instance of the panel ColorPicker widget. |
_component |
object
|
The panel ColorPicker widget with specific parameters. |
Source code in src/fft_analysator/gui/components/color_picker.py
16 17 18 19 20 21 |
|
component
property
component
Data Selector
data_selector
DataSelector
DataSelector()
A class used to represent a Data Selector widget.
This class encapsulates a panel Select widget and provides an interface for populating it with options and retrieving the selected option.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
list
|
A list of options for the selector widget. Initially empty. |
_component |
object
|
The panel Select widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The selector attribute is initialized as a panel Select widget. The options attribute is initialized as an empty list. The _component attribute is initialized as a panel Select widget with specific parameters.
Source code in src/fft_analysator/gui/components/data_selector.py
23 24 25 26 27 28 29 30 31 32 33 34 |
|
component
property
component
Exporter Selector
exporter_selector
ExporterSelector
ExporterSelector()
A class used to select the export format.
Attributes:
Name | Type | Description |
---|---|---|
export_selector |
Select
|
An instance of the Panel Select widget. |
options |
list
|
A list of available export formats. |
_component |
Select
|
The Panel Select widget with specific parameters. |
Attributes:
Name | Type | Description |
---|---|---|
export_selector |
Select
|
An instance of the Panel Select widget. |
options |
list
|
A list of available export formats. |
_component |
Select
|
The Panel Select widget with specific parameters. |
Source code in src/fft_analysator/gui/components/exporter_selector.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
|
component
property
component
Exporter
exporter
FileExporter
FileExporter()
A class used to export files.
Attributes:
Name | Type | Description |
---|---|---|
file_input_button |
Button
|
An instance of the Panel Button widget. |
_component |
Button
|
The Panel Button widget with specific parameters. |
dir_path |
str
|
The directory path where the file will be saved. |
Attributes:
Name | Type | Description |
---|---|---|
file_input_button |
Button
|
An instance of the Panel Button widget. |
_component |
Button
|
The Panel Button widget with specific parameters. |
dir_path |
str
|
The directory path where the file will be saved. |
Source code in src/fft_analysator/gui/components/exporter.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
|
component
property
component
select_directory
select_directory(event, data, chn1, chn2, method, ext, window, overlap)
Selects the directory and saves the data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event that triggers the directory selection. |
required |
data |
array
|
The data to be saved. |
required |
chn1 |
int
|
The first channel. |
required |
chn2 |
int
|
The second channel. |
required |
method |
str
|
The method used. |
required |
ext |
str
|
The file extension. |
required |
window |
str
|
The window type. |
required |
overlap |
float
|
The overlap value. |
required |
Returns:
Type | Description |
---|---|
None |
Source code in src/fft_analysator/gui/components/exporter.py
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 |
|
File Input Tkinter
file_input_tkinter
FileInputComponent
FileInputComponent()
A class used to represent a File Input Component.
Attributes:
Name | Type | Description |
---|---|---|
file_input_button |
object
|
An instance of the panel Button widget. |
_component |
object
|
The panel Button widget with specific parameters. |
file_paths |
str
|
The paths of the selected files. Initially None. |
Methods:
Name | Description |
---|---|
select_files |
Opens a file dialog to select files. |
component |
Gets the stored widget. |
The file_input_button attribute is initialized as a panel Button widget. The _component attribute is initialized as a panel Button widget with specific parameters. The file_paths attribute is initialized as None.
Source code in src/fft_analysator/gui/components/file_input_tkinter.py
25 26 27 28 29 30 31 32 33 34 35 36 |
|
component
property
component
select_files
select_files(event)
Opens a file dialog to select files.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event object passed by the panel Button widget. |
required |
Source code in src/fft_analysator/gui/components/file_input_tkinter.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
|
Generator Navigator
generator_navigator
GeneratorNavigator
GeneratorNavigator(int_slider_callback)
A class used to represent a Generator Navigator.
Attributes:
Name | Type | Description |
---|---|---|
button_back |
object
|
An instance of the panel Button widget for navigating backwards. |
button_forward |
object
|
An instance of the panel Button widget for navigating forwards. |
reset_button |
object
|
An instance of the panel Button widget for resetting. |
index_box |
object
|
An instance of the panel IntInput widget for inputting index. |
goto_button |
object
|
An instance of the panel Button widget for going to a specific index. |
_component |
object
|
The panel Row widget with specific parameters. |
int_slider_callback |
object
|
The callback function for the integer slider. |
Methods:
Name | Description |
---|---|
int_slider_next |
Increments the value of the integer slider. |
int_slider_previous |
Decrements the value of the integer slider. |
int_slider_reset |
Resets the value of the integer slider. |
int_slider_goto |
Sets the value of the integer slider to the value of the index box. |
component |
Gets the stored widget. |
The button_back, button_forward, reset_button, index_box, and goto_button attributes are initialized as panel Button widgets. The _component attribute is initialized as a panel Row widget with specific parameters. The int_slider_callback attribute is set to the provided callback function.
Source code in src/fft_analysator/gui/components/generator_navigator.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
component
property
component
int_slider_goto
int_slider_goto(event)
Sets the value of the integer slider to the value of the index box.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event object passed by the panel Button widget. |
required |
Source code in src/fft_analysator/gui/components/generator_navigator.py
90 91 92 93 94 95 96 97 98 99 |
|
int_slider_next
int_slider_next(event)
Increments the value of the integer slider.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event object passed by the panel Button widget. |
required |
Source code in src/fft_analysator/gui/components/generator_navigator.py
60 61 62 63 64 65 66 67 68 |
|
int_slider_previous
int_slider_previous(event)
Decrements the value of the integer slider.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event object passed by the panel Button widget. |
required |
Source code in src/fft_analysator/gui/components/generator_navigator.py
70 71 72 73 74 75 76 77 78 |
|
int_slider_reset
int_slider_reset(event)
Resets the value of the integer slider.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
object
|
The event object passed by the panel Button widget. |
required |
Source code in src/fft_analysator/gui/components/generator_navigator.py
80 81 82 83 84 85 86 87 88 |
|
Integer Slider
int_slider
IntSlider
IntSlider()
A helper class used to represent a helper Integer Slider widget to store the logic for the generator navigation buttons.
Attributes:
Name | Type | Description |
---|---|---|
int_slider |
object
|
An instance of the panel IntSlider widget. |
_component |
object
|
The panel IntSlider widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The int_slider attribute is initialized as a panel IntSlider widget. The _component attribute is initialized as a panel IntSlider widget with specific parameters.
Source code in src/fft_analysator/gui/components/int_slider.py
20 21 22 23 24 25 26 27 28 29 |
|
component
property
component
Methode Selector
method_selector
MethodSelector
MethodSelector()
A class used to represent a Method Selector widget.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
list
|
A list of options for the selector widget. |
_component |
object
|
The panel Select widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The selector attribute is initialized as a panel Select widget. The options attribute is initialized with a list of analysis methods. The _component attribute is initialized as a panel Select widget with specific parameters.
Source code in src/fft_analysator/gui/components/method_selector.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
component
property
component
Overlap Selector
overlap_selector
OverlapSelector
OverlapSelector()
A class used to represent an Overlap Selector widget.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
list
|
A list of options for the selector widget. |
_component |
object
|
The panel Select widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The selector attribute is initialized as a panel Select widget. The options attribute is initialized with a list of overlap options. The _component attribute is initialized as a panel Select widget with specific parameters.
Source code in src/fft_analysator/gui/components/overlap_selector.py
20 21 22 23 24 25 26 27 28 29 30 31 |
|
component
property
component
Selector
selector
Selector
Selector()
A class used to represent a Selector widget.
This class encapsulates a panel Select widget and provides an interface for populating it with options and retrieving the selected option.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
list
|
A list of options for the selector widget. Initially empty. |
_component |
object
|
The panel Select widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The selector attribute is initialized as a panel Select widget. The options attribute is initialized as an empty list. The _component attribute is initialized as a panel Select widget with specific parameters.
Source code in src/fft_analysator/gui/components/selector.py
23 24 25 26 27 28 29 30 31 32 33 |
|
component
property
component
Gets the stored widget.
This method returns the panel Select widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Toggle Group
toggle_group
ToggleGroup
ToggleGroup()
A class used to represent a ToggleGroup widget.
This class encapsulates a panel ToggleGroup widget and provides an interface for populating it with options and retrieving the selected option.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel ToggleGroup widget. |
options |
list
|
A list of options for the ToggleGroup widget. Initially empty. |
_component |
object
|
The panel Select widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The toggle_group attribute is initialized as a panel ToggleGroup widget. The options attribute is initialized as an empty list. The _component attribute is initialized as a panel ToggleGroup widget with specific parameters.
Source code in src/fft_analysator/gui/components/toggle_group.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|
component
property
component
Gets the stored widget.
This method returns the panel ToggleGroup widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Toggle Group x-axis
toggle_x_axis
ToggleXAxis
ToggleXAxis()
A class used to represent a ToggleGroup widget.
This class encapsulates a panel ToggleGroup widget and provides an interface for populating it with options and retrieving the selected option.
Attributes
selector : object An instance of the panel ToggleGroup widget. options : list A list of options for the ToggleGroup widget. Initially empty. _component : object The panel Select widget with specific parameters.
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The toggle_group attribute is initialized as a panel ToggleGroup widget. The options attribute is initialized as an empty list. The _component attribute is initialized as a panel ToggleGroup widget with specific parameters.
Source code in src/fft_analysator/gui/components/toggle_x_axis.py
24 25 26 27 28 29 30 31 32 33 34 35 36 |
|
component
property
component
Gets the stored widget.
This method returns the panel ToggleGroup widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Toggle Group y-axis
toggle_y_axis
ToggleYAxis
ToggleYAxis()
A class used to represent a ToggleGroup widget.
This class encapsulates a panel ToggleGroup widget and provides an interface for populating it with options and retrieving the selected option.
Attributes
selector : object An instance of the panel ToggleGroup widget. options : list A list of options for the ToggleGroup widget. Initially empty. _component : object The panel Select widget with specific parameters.
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The toggle_group attribute is initialized as a panel ToggleGroup widget. The options attribute is initialized as an empty list. The _component attribute is initialized as a panel ToggleGroup widget with specific parameters.
Source code in src/fft_analysator/gui/components/toggle_y_axis.py
24 25 26 27 28 29 30 31 32 33 34 35 36 |
|
component
property
component
Gets the stored widget.
This method returns the panel ToggleGroup widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Tabs
tabs
Tabs
Tabs()
A class used to represent a Tabs widget.
This class encapsulates a panel Tabs widget and provides an interface for interacting with it.
Attributes:
Name | Type | Description |
---|---|---|
tabs |
object
|
An instance of the panel Tabs widget. |
str_signal_tab |
str
|
The title of the signal tab. |
str_frequency_response_tab |
str
|
The title of the frequency response tab. |
str_impulse_response_tab |
str
|
The title of the impulse response tab. |
str_analysis_function_tab |
str
|
The title of the analysis function tab. |
_component |
object
|
The panel Tabs widget with specific parameters. |
Methods:
Name | Description |
---|---|
component |
Gets the stored widget. |
The tabs attribute is initialized as a panel Tabs widget. The str_signal_tab, str_frequency_response_tab, str_impulse_response_tab, and str_analysis_function_tab attributes are initialized with specific string values. The _component attribute is initialized as a panel Tabs widget with specific parameters.
Source code in src/fft_analysator/gui/components/tabs.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
|
component
property
component
Gets the stored widget.
This method returns the panel Tabs widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |
Window Selector
window_selector
WindowSelector
WindowSelector()
A class used to represent a Window Selector widget.
This class encapsulates a panel Select widget and provides an interface for populating it with window options and retrieving the selected option.
Attributes:
Name | Type | Description |
---|---|---|
selector |
object
|
An instance of the panel Select widget. |
options |
(list): A list of options for the selector widget. |
|
_component |
object
|
The panel Select widget with specific parameters. |
Methods
component() Gets the stored widget.
The selector attribute is initialized as a panel Select widget. The options attribute is initialized with a list of window options. The _component attribute is initialized as a panel Select widget with specific parameters.
Source code in src/fft_analysator/gui/components/window_selector.py
24 25 26 27 28 29 30 31 32 33 34 35 |
|
component
property
component
Gets the stored widget.
This method returns the panel Select widget stored in the _component attribute.
Returns:
Name | Type | Description |
---|---|---|
_component |
object
|
The stored widget. |