Core Components
Most people will want to use PumpIA through the modules and collections as described in usage, however the core components and how they iteract are described for anyone who wants more control over them, or who wants to embed them in their own program.
The Manager
This is the central piece of the program, it controls the loading of all images and links all the other components together. Use the manager to get the treeviews and widgets for the controls within the program. Users can right click on different entries in treeviews for different options. There is typically only one manager per program.
Viewers
These are the widgets which show the images. There are a few different kinds depending on if the image loaded should be limited. Viewers have multiple shortcuts to make it easier for the end user, see user interface.
Images
Different classes which represent images and collections of images. Also see file handling.
Regions of Interest
These represent regions of interest of different shapes.
Contents
- The Manager
Manager
Manager.patients
Manager.general_images
Manager.select_time
Manager.focus
Manager.selected
Manager.current_action
Manager.roi_action
Manager.viewers
Manager.popup_menu_options
Manager.load_folder()
Manager.load_image()
Manager.load_images()
Manager.load_dicom()
Manager.update_trees()
Manager.add_roi()
Manager.delete_current_roi()
Manager.show_tags()
Manager.copy_filepath()
Manager.copy_filepath_as_posix()
Manager.copy_directory()
Manager.copy_directory_as_posix()
Manager.update_viewers()
Manager.get_tree_frame()
Manager.get_mouse_options_combobox()
Manager.set_current_action()
Manager.get_roi_options_frame()
Manager.set_current_roi_action()
- Viewers
BaseViewer
BaseViewer.manager
BaseViewer.allow_drag_drop
BaseViewer.allow_drawing_rois
BaseViewer.validation_command
BaseViewer.preload_command
BaseViewer.mouse_x
BaseViewer.mouse_y
BaseViewer.last_event_time
BaseViewer.center
BaseViewer.current_slice
BaseViewer.manual_override
BaseViewer.image
BaseViewer.pil_image
BaseViewer.pil_tkimage
BaseViewer.zoom_factor
BaseViewer.current_image
BaseViewer.add_load_trace()
BaseViewer.remove_load_trace()
BaseViewer.can_show_image()
BaseViewer.unload_images()
BaseViewer.load_image()
BaseViewer.viewer_to_image_pos()
BaseViewer.image_to_viewer_pos()
BaseViewer.update()
BaseViewer.reset_image()
BaseViewer.manual_roi_draw()
BaseViewer.stop_manual_roi_draw()
BaseViewer.change_slice()
BaseViewer.set_slice()
BaseViewer.change_zoom()
BaseViewer.window_level()
BaseViewer.set_window_level()
BaseViewer.move_image()
BaseViewer.set_image_loc()
Viewer
ArrayViewer
MonochromeViewer
DicomViewer
MonochromeDicomViewer
- Images
BaseImageSet
ArrayImage
ArrayImage.x
ArrayImage.y
ArrayImage.zoom
ArrayImage.rotation
ArrayImage.shape
ArrayImage.num_samples
ArrayImage.mode
ArrayImage.is_multisample
ArrayImage.is_rgb
ArrayImage.current_slice
ArrayImage.location
ArrayImage.num_slices
ArrayImage.array
ArrayImage.current_slice_array
ArrayImage.vmax
ArrayImage.vmin
ArrayImage.window
ArrayImage.level
ArrayImage.rois
ArrayImage.roi_names
ArrayImage.user_window
ArrayImage.user_level
ArrayImage.pixel_size
ArrayImage.aspect
ArrayImage.z_profile
ArrayImage.get_rois()
ArrayImage.add_roi()
ArrayImage.remove_roi()
ArrayImage.change_slice()
ArrayImage.reset()
FileImageSet
ImageCollection
- Regions of Interest
BaseROI
BaseROI.image
BaseROI.slice_num
BaseROI.cache_values
BaseROI.colour
BaseROI.active_colour
BaseROI.active
BaseROI.hidden
BaseROI.id_string
BaseROI.storage_string
BaseROI.tag
BaseROI.pixel_values
BaseROI.pixel_array
BaseROI.mask
BaseROI.area
BaseROI.perimeter
BaseROI.mean
BaseROI.std
BaseROI.xmin
BaseROI.xmax
BaseROI.ymin
BaseROI.ymax
BaseROI.xcent
BaseROI.ycent
BaseROI.values_str
BaseROI.menu_options
BaseROI.delete_cache()
BaseROI.point_is_in()
BaseROI.point_is_on()
BaseROI.move()
BaseROI.enlarge()
BaseROI.resize_bbox()
BaseROI.rotate()
BaseROI.copy_to_image()
BaseROI.move_to_image()
Angle
PointROI
EllipseROI
RectangleROI
LineROI