Source code for tracklib.algo.Selection

"""
Class to manage selection of GPS tracks

Overall picture of selection process : selection is performed by a selector 
object, containing an arbitrary number of constraints, combined by OR, AND or 
XOR operator. Since only a single operator is allowed in the selector, a 
"global selector" is provided to the users to combine the output of several 
individual selectors. Again, the output may be combined with OR, AND or XOR.
For example, given two circles C1 and C2, and two rectangles R1 and R2, to 
select tracks crossing either C1 or C2, and either R1 or R2, we would like to 
write the following combination of constraints : F = (C1 + C2).(R1 + R2), 
where + and . operators denote OR and AND respectively. Such a constraint 
requires two different combination rules, and therefore cannot be expressed 
with a single selector. A solution is to create two disjonctive (OR) type 
selectors S1 and S2 with S1 = C1 + C2 and S2 = R1 + R2. Then S1 and S2 are 
combined in a conjunctive (AND) type global selector. Note that boolean 
algebraic rules show that it is possible as well to combine 4 conjunctive-
type selectors (C1.R1, C1.R2, C2.R1 and C2.R2) in a disjunctive-type global 
selector. 
Constraints may be based on:

   - a geometrical shape (Rectangle, circle or polygon in Geometrics). This 
     is the standard type of constraint. Different modes are:

        - MODE_CROSSES: tracks crossing shape interior/boundary are selected
        - MODE_INSIDE : tracks remaining fully inside the shape are selected
        - MODE_GETS_IN: tracks getting in (at least once) shape are selected
        - MODE_INSIDE : tracks getting out (at least once) shape are selected

   - a track t as a reference. Available modes are:

        - MODE_CROSSES : tracks  intersecting t (at least once) are selected
        - MODE_PARALLEL: tracks  following t are selected

   - a "toll gate" segment, defined by two Coords objects: tracks crossing 
     (at least once) the toll gate are selected 

All these constraint may be provided with an additional time constraint, 
specifying the time interval (between two GPSTime dates) where crossing /
containing / getting in / getting out... operations are tested. 
Besides, there are two types of selection:

   - TYPE_SELECT: tracks abiding by constraints are returned as they are
   - TYPE_CUT_AND_SELECT: tracks abiding by constraints are cut and returned


General constraint syntax:

>>> # Declaration of a TimeConstraint
>>> t1 = TimeConstraint(initial_date, final_date, options)
>>> # Add comment here
>>> c1 = Constraint(shape, t1, options)
>>> c2 = TrackConstraint(track, t2, options)
>>> c3 = TollGateConstraint(shape, t3, options)
>>> # Add comment here
>>> s1 = Selector(c1, c2, ..., options)
>>> s2 = Selector(c3, c4, ..., options)
>>> # Add comment here
>>> selector = GlobalSelector([s1, s2, ...], options)

"""

import matplotlib.pyplot as plt

from tracklib.core.ObsCoords import ENUCoords, GeoCoords
from tracklib.core.Track import Track
from tracklib.core.TrackCollection import TrackCollection
from tracklib.core.Obs import Obs

import tracklib.core.Utils as utils
import tracklib.util.Geometry as Geometry

from tracklib.core.ObsTime import ObsTime
from tracklib.algo.Geometrics import Rectangle


MODE_CROSSES = 0
MODE_INSIDE = 1
MODE_GETS_IN = 2
MODE_GETS_OUT = 3

MODE_CROSSES = 0
MODE_PARALLEL = 1

TYPE_SELECT = 0
TYPE_CUT_AND_SELECT = 1

COMBINATION_AND = 0
COMBINATION_OR = 1
COMBINATION_XOR = 2


[docs]def printMode(constraint): """TODO""" if constraint.mode == MODE_CROSSES: return "CROSS" if constraint.mode == MODE_INSIDE: return "INSIDE" if constraint.mode == MODE_GETS_IN: return "GETS IN" if constraint.mode == MODE_GETS_OUT: return "GETS OUT"
# ------------------------------- TIME CONSTRAINTS ----------------------------
[docs]class TimeConstraint: """Time constraints"""
[docs] def __init__(self, begin=None, end=None, pattern=None): """TODO""" if begin is None: self.minTimestamp = ObsTime(0, 0, 0, 0, 0, 0) else: self.minTimestamp = begin if end is None: self.maxTimestamp = ObsTime(2100, 0, 0, 0, 0, 0) else: self.maxTimestamp = end self.pattern = pattern
[docs] def __str__(self): """TODO""" output = "Temporal constraint: \n" if self.minTimestamp - ObsTime(0, 0, 0, 0, 0, 0) != 0: if self.maxTimestamp - ObsTime(2100, 0, 0, 0, 0, 0) != 0: output += " -" + str(self.minTimestamp) + " <= t <= " output += str(self.maxTimestamp) + "\n" if not self.pattern is None: output += " - timestamp pattern: " + self.pattern return output
[docs] def setMinTimestamp(self, timestamp): """TODO""" self.minTimestamp = timestamp
[docs] def setMaxTimestamp(self, timestamp): """TODO""" self.maxTimestamp = timestamp
[docs] def contains(self, timestamp): """TODO""" output = (self.minTimestamp <= timestamp) and (timestamp <= self.maxTimestamp) if not (self.pattern is None): output = output & utils.compLike(str(timestamp), self.pattern) return output
# ------------------------------- CONSTRAINTS ---------------------------- # ------------------------------------------------- # Special case of constraint defined by a track # -------------------------------------------------
[docs]class TrackConstraint: """TODO"""
[docs] def __init__( self, track, res=1, buffer=10, prop=0.5, length=0, time=None, mode=MODE_PARALLEL, type=TYPE_SELECT, ): """TODO""" self.track = track self.time = time self.type = type self.prop = prop self.mode = mode self.length = length self.segments = [] for i in range(1, len(track), 1): pt1 = track[i].position.copy() pt2 = pt1.copy() dx = track[i].position.getX() - track[i - 1].position.getX() dy = track[i].position.getY() - track[i - 1].position.getY() R = (dx * dx + dy * dy) ** (0.5) if R == 0: continue pt1.translate(+buffer * dy / R, -buffer * dx / R) pt2.translate(-buffer * dy / R, +buffer * dx / R) self.segments.append(Track([Obs(pt1), Obs(pt2)]))
[docs] def __str__(self): """TODO""" output = "Track-based selecting constraint (mode '" + printMode(self) + "')" output += " with " + str(self.time).lower() return output
[docs] def plot(self, sym="r-"): """TODO""" plt.plot(self.track.getX(), self.track.getY(), sym) for i in range(len(self.segments)): plt.plot(self.segments[i].getX(), self.segments[i].getY(), sym)
[docs] def contains(self, track): """TODO""" if self.mode == MODE_PARALLEL: counter = 0 lgth = 0 for i in range(len(self.segments)): if Geometry.intersects(self.segments[i], track): counter += 1 lgth += self.track[i].position.distance2DTo( self.track[i + 1].position ) if (counter > self.prop * len(self.segments)) and ( lgth > self.length ): return True return False else: return Geometry.intersects(self.track, track)
[docs] def select(self, tracks): """TODO""" if self.type == TYPE_SELECT: output = TrackCollection() for track in tracks: if self.contains(track): output.addTrack(track) return output if self.type == TYPE_CUT_AND_SELECT: output = TrackCollection() for track in tracks: t = self.shape.select(track) if t.size() > 0: output.addTrack(t) return output
# ------------------------------------------------- # Special case of constraint defined by a segment # -------------------------------------------------
[docs]class TollGateConstraint: """TODO"""
[docs] def __init__(self, pt1, pt2, time=None, type=TYPE_SELECT): """TODO""" self.gate = Track([Obs(pt1), Obs(pt2)]) self.time = time self.type = type
[docs] def __str__(self): """TODO""" output = "Toll gate selecting constraint" if not self.time is None: output += " with " + str(self.time).lower() return output
[docs] def plot(self, sym="ro-"): """TODO""" plt.plot(self.gate.getX(), self.gate.getY(), sym)
[docs] def contains(self, track): """TODO""" return Geometry.intersects(self.gate, track)
[docs] def select(self, tracks): """TODO""" if self.type == TYPE_SELECT: output = TrackCollection() for track in tracks: if self.contains(track): output.addTrack(track) return output if self.type == TYPE_CUT_AND_SELECT: return tracks
[docs]class Constraint: """TODO"""
[docs] def __init__( self, shape=None, time=None, mode=MODE_CROSSES, type=TYPE_SELECT, srid="ENU" ): """TODO""" if shape is None: if srid.upper in ["GEO", "GeoCoords"]: shape = Rectangle(GeoCoords(-180, -90), GeoCoords(180, 90)) else: shape = Rectangle(ENUCoords(-1e300, -1e300), ENUCoords(1e300, 1e300)) self.shape = shape self.mode = mode self.type = type if time is None: self.time = TimeConstraint() else: self.time = time
[docs] def __str__(self): """TODO""" output = str(type(self.shape))[33:-2] + "-shaped selecting constraint " output += "(mode '" + str(printMode(self)) + "')" output += " with " + str(self.time).lower() return output
[docs] def setShape(self, shape): """TODO""" self.shape = shape
[docs] def contains(self, track): """TODO""" if not str(type(self.shape))[33:-2] in ["Circle", "Rectangle", "Polygon"]: return False if self.mode == MODE_CROSSES: for i in range(len(track)): if self.shape.contains(track[i].position): if self.time.contains(track[i].timestamp): return True return False if self.mode == MODE_INSIDE: for i in range(len(track)): if not self.shape.contains(track[i].position): return False if not self.time.contains(track[i].timestamp): return False return True if self.mode == MODE_GETS_IN: if not self.shape.contains(track[0].position): for i in range(1, len(track)): if self.shape.contains(track[i].position): if self.time.contains(track[i].timestamp): return True return False if self.mode == MODE_GETS_OUT: if self.shape.contains(track[0].position): for i in range(1, len(track)): if not self.shape.contains(track[i].position): if self.time.contains(track[i].timestamp): return True return False
[docs] def select(self, tracks): """TODO""" if self.type == TYPE_SELECT: output = TrackCollection() for track in tracks: if self.contains(track): output.addTrack(track) return output if self.type == TYPE_CUT_AND_SELECT: output = TrackCollection() for track in tracks: t = self.shape.select(track) if t.size() > 0: output.addTrack(t) return output
[docs] def plot(self, sym): """TODO""" self.shape.plot(sym)
# ------------------------------- SELECTOR ----------------------------
[docs]class Selector: """TODO"""
[docs] def __init__(self, constraints, combination=COMBINATION_AND): """TODO""" self.constraints = utils.listify(constraints) self.combination = combination
def __len__(self): """TODO""" return len(self.constraints)
[docs] def __str__(self): """TODO""" if self.combination == COMBINATION_AND: output = "Conjunctive" if self.combination == COMBINATION_OR: output = "Disjonctive" if self.combination == COMBINATION_XOR: output = "Exclusive disjonction" output += " selector with following constraint(s):\n" for i in range(len(self)): output += " (" + str(i + 1) + ") " + str(self.constraints[i]) + "\n" return output
[docs] def setCombinationMode(self, combination): """TODO""" self.combination = combination
[docs] def addConstraint(self, constraint): """TODO""" self.constraints.append(constraint)
[docs] def plot(self, sym=["r-", "g-", "b-"]): """TODO""" sym = utils.listify(sym) for i in range(len(self)): self.constraints[i].plot(sym[i % len(sym)])
def __combine(self, bool1, bool2): """TODO""" if self.combination == COMBINATION_AND: return bool1 and bool2 if self.combination == COMBINATION_OR: return bool1 or bool2 if self.combination == COMBINATION_XOR: return (bool1 and not (bool2)) or (not (bool1) and bool2) def __initCombination(self): """TODO""" if self.combination == COMBINATION_AND: return True if self.combination == COMBINATION_OR: return False if self.combination == COMBINATION_XOR: return False
[docs] def contains(self, track): """TODO""" inside = self.__initCombination() for c in self.constraints: inside = self.__combine(inside, c.contains(track)) return inside
# --------------------------- GLOBAL SELECTOR ---------------------------
[docs]class GlobalSelector: """TODO"""
[docs] def __init__(self, selectors, combination=COMBINATION_AND): """TODO""" self.selectors = utils.listify(selectors) self.combination = combination
def __len__(self): """TODO""" return len(self.selectors)
[docs] def numberOfConstraints(self): """TODO""" count = 0 for i in range(len(self)): count += len(self.selectors) return count
[docs] def __str__(self): """TODO""" alphabet = ["a", "b", "c", "d", "e", "f", "g", "h", "i"] if self.combination == COMBINATION_AND: output = "Conjunctive" if self.combination == COMBINATION_OR: output = "Disjonctive" if self.combination == COMBINATION_XOR: output = "Exclusive disjonction" output += " global selector with following selector(s):\n" for i in range(len(self)): output += " (" + alphabet[i].upper() + ") " + str(self.selectors[i]) return output
[docs] def plot(self): """TODO""" for i in range(len(self.selectors)): self.selectors[i].plot()
def __combine(self, bool1, bool2): """TODO""" if self.combination == COMBINATION_AND: return bool1 and bool2 if self.combination == COMBINATION_OR: return bool1 or bool2 if self.combination == COMBINATION_XOR: return (bool1 and not (bool2)) or (not (bool1) and bool2) def __initCombination(self): """TODO""" if self.combination == COMBINATION_AND: return True if self.combination == COMBINATION_OR: return False if self.combination == COMBINATION_XOR: return False
[docs] def addSelector(self, selector): """TODO""" self.selectors.append(selector)
[docs] def setCombinationMode(self, combination): """TODO""" self.combination = combination
[docs] def contains(self, track): """TODO""" inside = self.__initCombination() for s in self.selectors: inside = self.__combine(inside, s.contains(track)) return inside