sequence_widget

frog.gui.measure_script.sequence_widget

Provides a collection of controls for editing a measure script.

Attributes

Classes

AddButtons(sequence)

Bases: QGroupBox

Buttons for adding new instructions.

Create a new AddButtons.

Source code in frog/gui/measure_script/sequence_widget.py

def __init__(self, sequence: SequenceWidget) -> None:
    """Create a new AddButtons."""
    super().__init__("Add instruction")
    self.sequence = sequence

    layout = QVBoxLayout()

    # The number of times to repeat this measurement
    self.count = CountWidget("Measurements")
    layout.addWidget(self.count)

    # Add buttons for preset angles (e.g. zenith, nadir, etc.)
    self.group = QButtonGroup()
    self.group.buttonClicked.connect(self._preset_clicked)
    for preset in ANGLE_PRESETS:
        btn = QPushButton(preset.upper())
        self.group.addButton(btn)
        layout.addWidget(btn)

    # Add button and spinbox for going to a specific angle. Put them next to each
    # other on the same row.
    goto_layout = QHBoxLayout()
    self.angle = QSpinBox()
    self.angle.setSuffix("°")
    self.angle.setMinimum(0)
    self.angle.setMaximum(270)
    self.goto = QPushButton("GOTO")
    self.goto.clicked.connect(self._goto_clicked)
    goto_layout.addWidget(self.angle)
    goto_layout.addWidget(self.goto)

    # Add these widgets to the main layout
    goto_widgets = QWidget()
    goto_widgets.setLayout(goto_layout)
    layout.addWidget(goto_widgets)

    self.setLayout(layout)

Functions

ChangeButtons(sequence)

Bases: QGroupBox

Buttons for modifying existing measure instructions.

Create a new ChangeButtons.

Source code in frog/gui/measure_script/sequence_widget.py

def __init__(self, sequence: SequenceWidget) -> None:
    """Create a new ChangeButtons."""
    super().__init__("Modify instructions")

    self.up = QPushButton("Up")
    self.up.clicked.connect(sequence.move_selected_up)

    self.down = QPushButton("Down")
    self.down.clicked.connect(sequence.move_selected_down)

    self.delete = QPushButton("Delete")
    self.delete.clicked.connect(sequence.delete_selected)

    self.clear = QPushButton("Clear")
    self.clear.clicked.connect(sequence.delete_all)

    layout = QVBoxLayout()
    layout.addWidget(self.up)
    layout.addWidget(self.down)
    layout.addWidget(self.delete)
    layout.addWidget(self.clear)
    self.setLayout(layout)

Functions

SequenceButtons(sequence)

Bases: QWidget

Buttons for changing the sequence of instructions.

Create a new SequenceButtons.

Source code in frog/gui/measure_script/sequence_widget.py

def __init__(self, sequence: SequenceWidget) -> None:
    """Create a new SequenceButtons."""
    super().__init__()

    add_buttons = AddButtons(sequence)
    change_buttons = ChangeButtons(sequence)

    layout = QVBoxLayout()
    layout.addWidget(add_buttons)
    layout.addWidget(change_buttons)
    self.setLayout(layout)

Functions

SequenceModel(sequence)

Bases: QAbstractTableModel

Provides a model of the sequence data for the QTableView.

Create a new SequenceModel.

Parameters:

Name	Type	Description	Default
sequence	list[Measurement]	A list of Measurements	required

Source code in frog/gui/measure_script/sequence_widget.py

def __init__(self, sequence: list[Measurement]) -> None:
    """Create a new SequenceModel.

    Args:
        sequence: A list of Measurements
    """
    super().__init__()
    self._sequence = sequence

Functions

columnCount(*args, **kwargs)

Get the number of data columns.

Source code in frog/gui/measure_script/sequence_widget.py

def columnCount(self, *args: Any, **kwargs: Any) -> int:
    """Get the number of data columns."""
    return 2

data(index, role=Qt.ItemDataRole.DisplayRole)

Provides the model's data.

Source code in frog/gui/measure_script/sequence_widget.py

def data(
    self,
    index: QModelIndex | QPersistentModelIndex,
    role: int = Qt.ItemDataRole.DisplayRole,
) -> Any:
    """Provides the model's data."""
    # Column 0 is angle, column 1 is measurements
    if role == Qt.ItemDataRole.DisplayRole:
        value = getattr(
            self._sequence[index.row()], SequenceModel._COLUMNS[index.column()]
        )
        if isinstance(value, float):
            return f"{value:.0f}°"
        return value

headerData(section, orientation, role=Qt.ItemDataRole.DisplayRole)

Provides header names for the model's data.

Source code in frog/gui/measure_script/sequence_widget.py

def headerData(
    self,
    section: int,
    orientation: Qt.Orientation,
    role: int = Qt.ItemDataRole.DisplayRole,
) -> Any:
    """Provides header names for the model's data."""
    # For column names we use Angle and Measurements
    if (
        orientation == Qt.Orientation.Horizontal
        and role == Qt.ItemDataRole.DisplayRole
    ):
        return SequenceModel._COLUMNS[section].title()

    return super().headerData(section, orientation, role)

rowCount(*args, **kwargs)

Get the number of data rows.

Source code in frog/gui/measure_script/sequence_widget.py

def rowCount(self, *args: Any, **kwargs: Any) -> int:
    """Get the number of data rows."""
    return len(self._sequence)

SequenceWidget(sequence=None)

Bases: QWidget

A widget with a table of measure instructions and controls to modify them.

Create a new SequenceWidget.

Source code in frog/gui/measure_script/sequence_widget.py

def __init__(self, sequence: list[Measurement] | None = None) -> None:
    """Create a new SequenceWidget."""
    super().__init__()

    self.table = QTableView()

    self.sequence = sequence if sequence else []
    """The sequence of measure instructions as a list of angles and counts."""

    self.model = SequenceModel(self.sequence)
    self.table.setModel(self.model)
    self.table.horizontalHeader().setStretchLastSection(True)
    self.table.setSelectionBehavior(QAbstractItemView.SelectionBehavior.SelectRows)

    self.buttons = SequenceButtons(self)

    # Put the table on the left and the buttons on the right
    layout = QHBoxLayout()
    layout.addWidget(self.table)
    layout.addWidget(self.buttons)
    self.setLayout(layout)

Attributes

sequence = sequence if sequence else [] instance-attribute

The sequence of measure instructions as a list of angles and counts.

Functions

add_instruction(angle, measurements)

Add a new measure instruction to the sequence.

Parameters:

Name	Type	Description	Default
angle	str | float	Target angle as a float or a string corresponding to a preset	required
measurements	int	Number of times to take a measurement at this angle	required

Source code in frog/gui/measure_script/sequence_widget.py

def add_instruction(self, angle: str | float, measurements: int) -> None:
    """Add a new measure instruction to the sequence.

    Args:
        angle: Target angle as a float or a string corresponding to a preset
        measurements: Number of times to take a measurement at this angle
    """
    self.sequence.append(Measurement(angle, measurements))
    self.model.layoutChanged.emit()
    self.table.scrollToBottom()

delete_all()

Delete all instructions from the table.

Source code in frog/gui/measure_script/sequence_widget.py

def delete_all(self) -> None:
    """Delete all instructions from the table."""
    if self.sequence and self._confirm_delete_all():
        self.model.beginRemoveRows(QModelIndex(), 0, len(self.sequence) - 1)
        self.sequence.clear()
        self.model.endRemoveRows()

delete_selected()

Remove the currently selected instructions from the table.

Source code in frog/gui/measure_script/sequence_widget.py

def delete_selected(self) -> None:
    """Remove the currently selected instructions from the table."""
    for row in self._get_selected_rows(reverse=True):
        self.model.beginRemoveRows(QModelIndex(), row, row)
        self.sequence.pop(row)
        self.model.endRemoveRows()

move_selected_down()

Move the currently selected instructions down one row.

Source code in frog/gui/measure_script/sequence_widget.py

def move_selected_down(self) -> None:
    """Move the currently selected instructions down one row."""
    selected = self._get_selected_rows(reverse=True)
    if not selected or selected[0] == len(self.sequence) - 1:
        # We can't move down if the bottom item is selected
        return

    # Swap each element with the one below it
    for row in selected:
        self._swap_rows(row, row + 1)

move_selected_up()

Move the currently selected instructions up one row.

Source code in frog/gui/measure_script/sequence_widget.py

def move_selected_up(self) -> None:
    """Move the currently selected instructions up one row."""
    selected = self._get_selected_rows()
    if not selected or selected[0] == 0:
        # We can't move up if the topmost item is selected
        return

    # Swap each element with the one above it
    for row in selected:
        self._swap_rows(row - 1, row)