#
# CompoundMixin.py -- enable compound capabilities.
#
# This is open-source software licensed under a BSD license.
# Please see the file LICENSE.txt for details.
#
import sys
import traceback
from functools import reduce
import numpy as np
from ginga.canvas import coordmap
__all__ = ['CompoundMixin']
[docs]class CompoundMixin(object):
"""A CompoundMixin is a mixin class that makes an object that is an
aggregation of other objects.
It is used to make generic compound drawing types as well as (for example)
layers of canvases on top of an image.
"""
def __init__(self):
# holds a list of objects to be drawn
self.objects = []
if not hasattr(self, 'crdmap'):
self.crdmap = None
if not hasattr(self, 'coord'):
self.coord = None
self.opaque = False
self._contains_reduce = np.logical_or
def __contains__(self, key):
return key in self.objects
[docs] def get_llur(self):
"""
Get lower-left and upper-right coordinates of the bounding box
of this compound object.
Returns
-------
x1, y1, x2, y2: a 4-tuple of the lower-left and upper-right coords
"""
points = np.array([obj.get_llur() for obj in self.objects])
t_ = points.T
x1, y1 = t_[0].min(), t_[1].min()
x2, y2 = t_[2].max(), t_[3].max()
return (x1, y1, x2, y2)
[docs] def get_edit_points(self, viewer):
x1, y1, x2, y2 = self.get_llur()
return [(x1, y1), (x2, y1), (x2, y2), (x1, y2)]
[docs] def contains_pts(self, pts):
if len(self.objects) == 0:
x_arr, y_arr = np.asarray(pts).T
return np.full(x_arr.shape, False, dtype=np.bool)
return reduce(self._contains_reduce,
map(lambda obj: obj.contains_pts(pts), self.objects))
[docs] def get_items_at(self, pt):
res = []
for obj in self.objects:
if obj.is_compound() and not obj.opaque:
# non-opaque compound object, list up compatible members
res.extend(obj.get_items_at(pt))
elif obj.contains_pt(pt):
#res.insert(0, obj)
res.append(obj)
return res
[docs] def get_objects_by_kind(self, kind):
return filter(lambda obj: obj.kind == kind, self.objects)
[docs] def get_objects_by_kinds(self, kinds):
return filter(lambda obj: obj.kind in kinds, self.objects)
[docs] def select_contains_pt(self, viewer, pt):
for obj in self.objects:
if obj.select_contains_pt(viewer, pt):
return True
return False
[docs] def select_items_at(self, viewer, pt, test=None):
res = []
try:
for obj in self.objects:
if obj.is_compound() and not obj.opaque:
# non-opaque compound object, list up compatible members
res.extend(obj.select_items_at(viewer, pt, test=test))
is_inside = obj.select_contains_pt(viewer, pt)
if test is None:
if is_inside:
res.append(obj)
elif test(obj, pt, is_inside):
# custom test
res.append(obj)
except Exception as e:
#print("error selecting objects: %s" % (str(e)))
try:
# log traceback, if possible
(type, value, tb) = sys.exc_info()
tb_str = "".join(traceback.format_tb(tb))
self.logger.error("Traceback:\n%s" % (tb_str))
except Exception:
tb_str = "Traceback information unavailable."
self.logger.error(tb_str)
res = []
return res
[docs] def initialize(self, canvas, viewer, logger):
# TODO: this needs to be merged with the code in CanvasObject
self.viewer = viewer
self.logger = logger
if self.crdmap is None:
if self.coord == 'offset':
self.crdmap = coordmap.OffsetMapper(viewer, self.ref_obj)
else:
try:
self.crdmap = viewer.get_coordmap(self.coord)
except Exception as e:
# last best effort--a generic data mapper
self.crdmap = coordmap.DataMapper(viewer)
# initialize children
for obj in self.objects:
obj.initialize(canvas, viewer, logger)
[docs] def inherit_from(self, obj):
self.crdmap = obj.crdmap
self.logger = obj.logger
self.viewer = obj.viewer
[docs] def is_compound(self):
return True
[docs] def use_coordmap(self, mapobj):
for obj in self.objects:
obj.use_coordmap(mapobj)
[docs] def draw(self, viewer):
for obj in self.objects:
obj.draw(viewer)
[docs] def get_objects(self):
return self.objects
[docs] def has_object(self, obj):
return obj in self.objects
[docs] def delete_object(self, obj):
self.objects.remove(obj)
[docs] def delete_objects(self, objects):
for obj in objects:
self.delete_object(obj)
[docs] def delete_all_objects(self):
self.objects[:] = []
[docs] def roll_objects(self, n):
num = len(self.objects)
if num == 0:
return
n = n % num
self.objects = self.objects[-n:] + self.objects[:-n]
[docs] def swap_objects(self):
num = len(self.objects)
if num >= 2:
l = self.objects
self.objects = l[:num - 2] + [l[num - 1], l[num - 2]]
[docs] def set_attr_all(self, **kwdargs):
for obj in self.objects:
for attrname, val in kwdargs.items():
if hasattr(obj, attrname):
setattr(obj, attrname, val)
[docs] def add_object(self, obj, belowThis=None):
obj.initialize(self, self.viewer, self.logger)
if belowThis is None:
self.objects.append(obj)
else:
index = self.objects.index(belowThis)
self.objects.insert(index, obj)
[docs] def raise_object(self, obj, aboveThis=None):
if aboveThis is None:
# no reference object--move to top
self.objects.remove(obj)
self.objects.append(obj)
else:
# Force an error if the reference object doesn't exist in list
index = self.objects.index(aboveThis)
self.objects.remove(obj)
index = self.objects.index(aboveThis)
self.objects.insert(index + 1, obj)
[docs] def lower_object(self, obj, belowThis=None):
if belowThis is None:
# no reference object--move to bottom
self.objects.remove(obj)
self.objects.insert(0, obj)
else:
# Force an error if the reference object doesn't exist in list
index = self.objects.index(belowThis)
self.objects.remove(obj)
index = self.objects.index(belowThis)
self.objects.insert(index, obj)
[docs] def rotate(self, theta, xoff=0, yoff=0):
for obj in self.objects:
obj.rotate(theta, xoff=xoff, yoff=yoff)
[docs] def move_delta_pt(self, off_pt):
for obj in self.objects:
obj.move_delta_pt(off_pt)
[docs] def scale_by_factors(self, factors):
for obj in self.objects:
obj.scale_by_factors(factors)
[docs] def get_reference_pt(self):
# Reference point for a compound object is the average of all
# it's contituents reference points
points = np.asarray([obj.get_reference_pt()
for obj in self.objects])
t_ = points.T
x, y = np.average(t_[0]), np.average(t_[1])
return (x, y)
get_center_pt = get_reference_pt
[docs] def get_points(self):
res = []
for obj in self.objects:
res.extend(list(obj.get_points()))
return res
### NON-PEP8 EQUIVALENTS -- TO BE DEPRECATED ###
getItemsAt = get_items_at
getObjects = get_objects
deleteObject = delete_object
deleteObjects = delete_objects
deleteAllObjects = delete_all_objects
setAttrAll = set_attr_all
addObject = add_object
raiseObject = raise_object
lowerObject = lower_object
# END