imgmarker.gui package¶

Submodules¶

imgmarker.gui.mark module¶

Full license found at _YOUR_INSTALLATION_DIRECTORY_/imgmarker/LICENSE

class imgmarker.gui.mark.Mark(*args: Any, **kwargs: Any)¶

Bases: QGraphicsPathItem

Class for creating marks and associating label to mark

Attributes:

center
color
size
size_value
view_center
wcs_center

Methods

__call__(*args, **kwargs)

Call self as a function.

draw

property center: PixCoord¶

property color¶

draw()¶

property size¶

property size_value¶

property view_center¶

property wcs_center: WorldCoord¶

class imgmarker.gui.mark.MarkLabel(*args: Any, **kwargs: Any)¶

Bases: QGraphicsProxyWidget

Mark label and its attributes associated with a particular mark

Methods

__call__(*args, **kwargs)

Call self as a function.

autoresize
enter
eventFilter
focusInEvent
keyPressEvent

autoresize()¶

enter()¶

eventFilter(source, event)¶

focusInEvent(event)¶

keyPressEvent(event)¶

imgmarker.gui.pyqt module¶

Full license found at _YOUR_INSTALLATION_DIRECTORY_/imgmarker/LICENSE

imgmarker.gui.widget module¶

Full license found at _YOUR_INSTALLATION_DIRECTORY_/imgmarker/LICENSE

class imgmarker.gui.widget.DefaultDialog(*args: Any, **kwargs: Any)¶

Bases: QFileDialog

Methods

__call__(*args, **kwargs)

Call self as a function.

closeEvent
keyPressEvent
selectedFiles

closeEvent(a0)¶

keyPressEvent(a0)¶

selectedFiles()¶

class imgmarker.gui.widget.PosWidget(*args: Any, **kwargs: Any)¶

Bases: QWidget

Shows coordinates

Methods

__call__(*args, **kwargs)

Call self as a function.

cleartext
hidewcs
showwcs

cleartext()¶

hidewcs()¶

showwcs()¶

class imgmarker.gui.widget.QHLine(*args: Any, **kwargs: Any)¶

Bases: QFrame

Methods

__call__(*args, **kwargs)

Call self as a function.

class imgmarker.gui.widget.QVLine(*args: Any, **kwargs: Any)¶

Bases: QFrame

Methods

__call__(*args, **kwargs)

Call self as a function.

class imgmarker.gui.widget.RestrictedLineEdit(*args: Any, **kwargs: Any)¶

Bases: QLineEdit

Methods

__call__(*args, **kwargs)

Call self as a function.

focusOutEvent
keyPressEvent

focusOutEvent(a0)¶

keyPressEvent(a0)¶

imgmarker.gui.window module¶

Full license found at _YOUR_INSTALLATION_DIRECTORY_/imgmarker/LICENSE

class imgmarker.gui.window.AboutWindow(*args: Any, **kwargs: Any)¶

Bases: QWidget

Class for the window that displays information about Image Marker.

Methods

`__call__`(args, *kwargs)	Call self as a function.
`show`()	Shows the window and moves it to the front.

show()¶: Shows the window and moves it to the front.

class imgmarker.gui.window.BlurWindow(*args: Any, **kwargs: Any)¶

Bases: QWidget

Class for the blur adjustment window.

Methods

__call__(*args, **kwargs)

Call self as a function.

show
slider_moved

show()¶

slider_moved(pos)¶

class imgmarker.gui.window.ControlsWindow(*args: Any, **kwargs: Any)¶

Bases: QWidget

Class for the window that displays the controls.

Methods

`__call__`(args, *kwargs)	Call self as a function.
`show`()	Shows the window and moves it to the front.

update_text

show()¶: Shows the window and moves it to the front.

update_text()¶

class imgmarker.gui.window.FrameWindow(*args: Any, **kwargs: Any)¶

Bases: QWidget

Class for the window for switching between frames in an image.

Methods

__call__(*args, **kwargs)

Call self as a function.

show
slider_moved
value_changed

show()¶

slider_moved(pos)¶

value_changed(value)¶

class imgmarker.gui.window.MainWindow(*args: Any, **kwargs: Any)¶

Bases: QMainWindow

Class for the main window.

Attributes:

blur_max
interval
stretch

Methods

`__call__`(args, *kwargs)	Call self as a function.
`categorize`(i)	Categorize the current image.
`del_markfile`(path)	Deletes a markfile.
`del_usermarks`([mode])	Deletes marks, either the selected one or all.
`enter`()	Enter the text in the comment box into the image.
`favorite`(state)	Favorite the current image.
`get_comment`()	If the image has a comment, sets the text of the comment box to the image's comment.
`import_ims`()	Method for the open image directory dialog.
`import_markfile`(**kwargs)	Method for opening a catalog file.
`inview`(x, y)	Checks if x and y are contained within the image.
`keyPressEvent`(a0)	Checks which keyboard button was pressed and calls the appropriate function.
`mark`([group, test])	Add a mark to the current image.
`mouseMoveEvent`(a0)	Operations executed when the mouse cursor is moved.
`mousePressEvent`(a0)	Checks which mouse button was pressed and calls the appropriate function.
`open`()	Method for the open save directory dialog.
`save`()	Method for saving image data
`shift`(delta)	Move back or forward delta number of images.
`toggle_mark_labels`(path)	Toggles whether or not mark labels are shown.
`toggle_marks`(path)	Toggles whether or not marks are shown.
`toggle_randomize`(state)	Updates the config file for randomization and reloads unseen images.
`update_categories`()	Resets all category boxes to unchecked, then checks the boxes based on the current image's categories.
`update_comments`()	Updates image comment with the contents of the comment box.
`update_favorites`()	Update favorite boxes based on the contents of favorite_list.
`update_images`()	Updates previous image with a new image.
`update_marks`()	Redraws all marks in image.
`update_pos`()

closeEvent
copy_to_clipboard
n_marks
redo_prev_mark
shiftframe
undo_prev_mark
update_colors
update_duplicates
update_mark_menu

property blur_max¶

categorize(i: int) → None¶: Categorize the current image.

closeEvent(a0)¶

copy_to_clipboard()¶

del_markfile(path)¶: Deletes a markfile.

del_usermarks(mode='selected')¶: Deletes marks, either the selected one or all.

enter()¶: Enter the text in the comment box into the image.

favorite(state) → None¶: Favorite the current image.

get_comment()¶: If the image has a comment, sets the text of the comment box to the image’s comment.

import_ims() → None¶: Method for the open image directory dialog.

import_markfile(**kwargs)¶: Method for opening a catalog file.

property interval¶

inview(x: int | float, y: int | float)¶

Checks if x and y are contained within the image.

Parameters:

x: int OR float: x coordinate
y: int OR float: y coordinate

Returns:

True if the (x,y) is contained within the image, False otherwise.

keyPressEvent(a0)¶: Checks which keyboard button was pressed and calls the appropriate function.

mark(group: int = 0, test=False) → None¶: Add a mark to the current image.

mouseMoveEvent(a0)¶: Operations executed when the mouse cursor is moved.

mousePressEvent(a0)¶: Checks which mouse button was pressed and calls the appropriate function.

n_marks(path)¶

open() → None¶: Method for the open save directory dialog.

redo_prev_mark()¶

save() → None¶: Method for saving image data

shift(delta: int)¶: Move back or forward delta number of images.

shiftframe(delta: int)¶

property stretch¶

toggle_mark_labels(path)¶: Toggles whether or not mark labels are shown.

toggle_marks(path)¶: Toggles whether or not marks are shown.

toggle_randomize(state)¶: Updates the config file for randomization and reloads unseen images.

undo_prev_mark()¶

update_categories()¶: Resets all category boxes to unchecked, then checks the boxes based on the current image’s categories.

update_colors(path)¶

update_comments()¶: Updates image comment with the contents of the comment box.

update_duplicates(percentage)¶

update_favorites()¶: Update favorite boxes based on the contents of favorite_list.

update_images()¶: Updates previous image with a new image.

update_mark_menu()¶

update_marks()¶: Redraws all marks in image.

update_pos()¶

class imgmarker.gui.window.MarkMenu(*args: Any, **kwargs: Any)¶

Bases: QMenu

Methods

__call__(*args, **kwargs)

Call self as a function.

color_action
labels_action
marks_action
menu_setup
update_color
update_menu

color_action(path)¶

labels_action(path)¶

marks_action(path)¶

menu_setup(path: str)¶

update_color(path)¶

update_menu(path: str)¶

class imgmarker.gui.window.SettingsWindow(*args: Any, **kwargs: Any)¶

Bases: QWidget

Class for the window for settings.

Methods

__call__(*args, **kwargs)

Call self as a function.

check_max_marks
closeEvent
duplicate_percentage_state
keyPressEvent
show
update_config
update_duplicate_percentage

check_max_marks()¶

closeEvent(a0)¶

duplicate_percentage_state()¶

keyPressEvent(event)¶

show()¶

update_config()¶

update_duplicate_percentage()¶

Module contents¶

Full license found at _YOUR_INSTALLATION_DIRECTORY_/imgmarker/LICENSE

class imgmarker.gui.Screen¶

Bases: object

Methods

center
height
width

static center()¶

static height()¶

static width()¶