segmentmodel.py 126 KB
Newer Older
cmaffeo2's avatar
cmaffeo2 committed
1
import pdb
2
from pathlib import Path
3
import numpy as np
4
import random
5
6
7
from .model.arbdmodel import PointParticle, ParticleType, Group, ArbdModel
from .coords import rotationAboutAxis, quaternion_from_matrix, quaternion_to_matrix
from .model.nonbonded import *
8
from copy import copy, deepcopy
9
from .model.nbPot import nbDnaScheme
10

cmaffeo2's avatar
cmaffeo2 committed
11
12
from scipy.special import erf
import scipy.optimize as opt
13
from scipy import interpolate
cmaffeo2's avatar
cmaffeo2 committed
14

15
16
from .model.CanonicalNucleotideAtoms import canonicalNtFwd, canonicalNtRev, seqComplement
from .model.CanonicalNucleotideAtoms import enmTemplateHC, enmTemplateSQ, enmCorrectionsHC
cmaffeo2's avatar
cmaffeo2 committed
17

cmaffeo2's avatar
cmaffeo2 committed
18
19
from .model.spring_from_lp import k_angle as angle_spring_from_lp

20
# import pdb
21
"""
cmaffeo2's avatar
cmaffeo2 committed
22
TODO:
cmaffeo2's avatar
cmaffeo2 committed
23
 + fix handling of crossovers for atomic representation
cmaffeo2's avatar
cmaffeo2 committed
24
 + map to atomic representation
25
    + add nicks
cmaffeo2's avatar
cmaffeo2 committed
26
    + transform ssDNA nucleotides 
cmaffeo2's avatar
cmaffeo2 committed
27
    - shrink ssDNA
cmaffeo2's avatar
cmaffeo2 committed
28
    + shrink dsDNA backbone
29
    + make orientation continuous
cmaffeo2's avatar
cmaffeo2 committed
30
    + sequence
31
    + handle circular dna
32
 + ensure crossover bead potentials aren't applied twice 
33
 + remove performance bottlenecks
34
 - test for large systems
cmaffeo2's avatar
cmaffeo2 committed
35
 + assign sequence
36
 + ENM
37
38
 - rework Location class 
 - remove recursive calls
39
 - document
40
 - develop unit test suite
41
"""
cmaffeo2's avatar
cmaffeo2 committed
42
43
class CircularDnaError(Exception):
    pass
44

cmaffeo2's avatar
cmaffeo2 committed
45
46
47
class ParticleNotConnectedError(Exception):
    pass

48
49
class Location():
    """ Site for connection within an object """
50
    def __init__(self, container, address, type_, on_fwd_strand = True):
51
        ## TODO: remove cyclic references(?)
52
        self.container = container
cmaffeo2's avatar
cmaffeo2 committed
53
        self.address = address  # represents position along contour length in segment
cmaffeo2's avatar
cmaffeo2 committed
54
        # assert( type_ in ("end3","end5") ) # TODO remove or make conditional
55
        self.on_fwd_strand = on_fwd_strand
56
57
        self.type_ = type_
        self.particle = None
58
        self.connection = None
59
        self.is_3prime_side_of_connection = None
60

61
62
        self.prev_in_strand = None
        self.next_in_strand = None
63
64
        
        self.combine = None     # some locations might be combined in bead model 
65
66
67
68
69
70
71

    def get_connected_location(self):
        if self.connection is None:
            return None
        else:
            return self.connection.other(self)

72
    def set_connection(self, connection, is_3prime_side_of_connection):
73
        self.connection = connection # TODO weakref? 
74
        self.is_3prime_side_of_connection = is_3prime_side_of_connection
75

76
77
78
79
80
81
82
    def get_nt_pos(self):
        try:
            pos = self.container.contour_to_nt_pos(self.address, round_nt=True)
        except:
            if self.address == 0:
                pos = 0
            elif self.address == 1:
83
                pos = self.container.num_nt-1
84
85
86
87
            else:
                raise
        return pos

88
89
90
91
92
93
94
    def __repr__(self):
        if self.on_fwd_strand:
            on_fwd = "on_fwd_strand"
        else:
            on_fwd = "on_rev_strand"
        return "<Location {}.{}[{:.2f},{:d}]>".format( self.container.name, self.type_, self.address, self.on_fwd_strand)
        
95
96
97
98
99
100
101
102
103
class Connection():
    """ Abstract base class for connection between two elements """
    def __init__(self, A, B, type_ = None):
        assert( isinstance(A,Location) )
        assert( isinstance(B,Location) )
        self.A = A
        self.B = B
        self.type_ = type_
        
104
105
106
107
108
109
110
    def other(self, location):
        if location is self.A:
            return self.B
        elif location is self.B:
            return self.A
        else:
            raise Exception("OutOfBoundsError")
cmaffeo2's avatar
cmaffeo2 committed
111

112
113
    def delete(self):
        self.A.container.connections.remove(self)
114
115
        if self.B.container is not self.A.container:
            self.B.container.connections.remove(self)
116
117
118
        self.A.connection = None
        self.B.connection = None

cmaffeo2's avatar
cmaffeo2 committed
119
120
121
122
    def __repr__(self):
        return "<Connection {}--{}--{}]>".format( self.A, self.type_, self.B )
        

123
        
124
125
126
# class ConnectableElement(Transformable):
class ConnectableElement():
    """ Abstract base class """
cmaffeo2's avatar
cmaffeo2 committed
127
128
129
130
    def __init__(self, connection_locations=None, connections=None):
        if connection_locations is None: connection_locations = []
        if connections is None: connections = []

131
132
        ## TODO decide on names
        self.locations = self.connection_locations = connection_locations
133
134
        self.connections = connections

cmaffeo2's avatar
cmaffeo2 committed
135
    def get_locations(self, type_=None, exclude=()):
136
137
138
139
140
141
142
143
        locs = [l for l in self.connection_locations if (type_ is None or l.type_ == type_) and l.type_ not in exclude]
        counter = dict()
        for l in locs:
            if l in counter:
                counter[l] += 1
            else:
                counter[l] = 1
        assert( np.all( [counter[l] == 1 for l in locs] ) )
144
145
146
147
        return locs

    def get_location_at(self, address, on_fwd_strand=True, new_type="crossover"):
        loc = None
148
        if (self.num_nt == 1):
149
150
151
152
153
154
155
            # import pdb
            # pdb.set_trace()
            ## Assumes that intrahelical connections have been made before crossovers
            for l in self.locations:
                if l.on_fwd_strand == on_fwd_strand and l.connection is None:
                    assert(loc is None)
                    loc = l
cmaffeo2's avatar
cmaffeo2 committed
156
            # assert( loc is not None )
157
158
159
160
161
162
163
164
        else:
            for l in self.locations:
                if l.address == address and l.on_fwd_strand == on_fwd_strand:
                    assert(loc is None)
                    loc = l
        if loc is None:
            loc = Location( self, address=address, type_=new_type, on_fwd_strand=on_fwd_strand )
        return loc
165

cmaffeo2's avatar
cmaffeo2 committed
166
    def get_connections_and_locations(self, connection_type=None, exclude=()):
167
168
        """ Returns a list with each entry of the form:
            connection, location_in_self, location_in_other """
169
        type_ = connection_type
170
171
        ret = []
        for c in self.connections:
172
            if (type_ is None or c.type_ == type_) and c.type_ not in exclude:
173
                if   c.A.container is self:
174
                    ret.append( [c, c.A, c.B] )
175
                elif c.B.container is self:
176
177
                    ret.append( [c, c.B, c.A] )
                else:
178
179
                    import pdb
                    pdb.set_trace()
180
181
182
                    raise Exception("Object contains connection that fails to refer to object")
        return ret

183
    def _connect(self, other, connection, in_3prime_direction=None):
184
185
        ## TODO fix circular references        
        A,B = [connection.A, connection.B]
186
187
188
189
        if in_3prime_direction is not None:
            A.is_3prime_side_of_connection = not in_3prime_direction
            B.is_3prime_side_of_connection = in_3prime_direction
            
190
        A.connection = B.connection = connection
191
        self.connections.append(connection)
192
193
        if other is not self:
            other.connections.append(connection)
cmaffeo2's avatar
cmaffeo2 committed
194
195
        else:
            raise NotImplementedError("Segments cannot yet be connected to themselves; if you are attempting to make a circular object, try breaking the object into multiple segments")
196
197
198
199
200
201
        l = A.container.locations
        if A not in l: l.append(A)
        l = B.container.locations
        if B not in l: l.append(B)
        

202
203
    # def _find_connections(self, loc):
    #     return [c for c in self.connections if c.A == loc or c.B == loc]
204
205

class SegmentParticle(PointParticle):
cmaffeo2's avatar
cmaffeo2 committed
206
    def __init__(self, type_, position, name="A", **kwargs):
207
        self.name = name
208
        self.contour_position = None
cmaffeo2's avatar
cmaffeo2 committed
209
        PointParticle.__init__(self, type_, position, name=name, **kwargs)
210
211
        self.intrahelical_neighbors = []
        self.other_neighbors = []
cmaffeo2's avatar
cmaffeo2 committed
212
        self.locations = []
213
214
215

    def get_intrahelical_above(self):
        """ Returns bead directly above self """
216
        # assert( len(self.intrahelical_neighbors) <= 2 )
217
        for b in self.intrahelical_neighbors:
218
            if b.get_contour_position(self.parent, self.contour_position) > self.contour_position:
219
220
221
222
                return b

    def get_intrahelical_below(self):
        """ Returns bead directly below self """
223
        # assert( len(self.intrahelical_neighbors) <= 2 )
224
        for b in self.intrahelical_neighbors:
225
            if b.get_contour_position(self.parent, self.contour_position) < self.contour_position:
226
227
                return b

cmaffeo2's avatar
cmaffeo2 committed
228
    def _neighbor_should_be_added(self,b):
229
230
231
        if type(self.parent) != type(b.parent):
            return True

cmaffeo2's avatar
cmaffeo2 committed
232
        c1 = self.contour_position
233
        c2 = b.get_contour_position(self.parent,c1)
cmaffeo2's avatar
cmaffeo2 committed
234
235
        if c2 < c1:
            b0 = self.get_intrahelical_below()
236
        else:
cmaffeo2's avatar
cmaffeo2 committed
237
238
239
            b0 = self.get_intrahelical_above()

        if b0 is not None:            
240
            c0 = b0.get_contour_position(self.parent,c1)
cmaffeo2's avatar
cmaffeo2 committed
241
242
243
244
245
246
247
248
249
250
251
252
253
            if np.abs(c2-c1) < np.abs(c0-c1):
                ## remove b0
                self.intrahelical_neighbors.remove(b0)
                b0.intrahelical_neighbors.remove(self)
                return True
            else:
                return False
        return True
        
    def make_intrahelical_neighbor(self,b):
        add1 = self._neighbor_should_be_added(b)
        add2 = b._neighbor_should_be_added(self)
        if add1 and add2:
254
255
            # assert(len(b.intrahelical_neighbors) <= 1)
            # assert(len(self.intrahelical_neighbors) <= 1)
cmaffeo2's avatar
cmaffeo2 committed
256
257
            self.intrahelical_neighbors.append(b)
            b.intrahelical_neighbors.append(self)
258

259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
    def conceptual_get_position(self, context):
        """ 
        context: object

Q: does this function do too much?
Danger of mixing return values

Q: does context describe the system or present an argument?
        """

        ## Validate Inputs
        ...

        ## Algorithm
        """
context specifies:
  - kind of output: real space, nt within segment, fraction of segment
  - absolute or relative
  - constraints: e.g. if passing through
        """
        """
given context, provide the position
        input
"""

    def get_nt_position(self, seg, near_address=None):
cmaffeo2's avatar
cmaffeo2 committed
285
286
287
288
        """ Returns the "address" of the nucleotide relative to seg in
        nucleotides, taking the shortest (intrahelical) contour length route to seg
        """
        if seg == self.parent:
289
            pos = self.contour_position
cmaffeo2's avatar
cmaffeo2 committed
290
        else:
291
292
            pos = self.get_contour_position(seg,near_address)
        return seg.contour_to_nt_pos(pos)
cmaffeo2's avatar
cmaffeo2 committed
293

294
    def get_contour_position(self,seg, address = None):
cmaffeo2's avatar
cmaffeo2 committed
295
296
297
298
        """ TODO: fix paradigm where a bead maps to exactly one location in a polymer
        - One way: modify get_contour_position to take an optional argument that indicates where in the polymer you are looking from
        """

299
300
301
        if seg == self.parent:
            return self.contour_position
        else:
cmaffeo2's avatar
cmaffeo2 committed
302
303
304
305
306
            cutoff = 30*3
            target_seg = seg

            ## depth-first search
            ## TODO cache distances to nearby locations?
cmaffeo2's avatar
cmaffeo2 committed
307
            def descend_search_tree(seg, contour_in_seg, distance=0, visited_segs=None):
cmaffeo2's avatar
cmaffeo2 committed
308
                nonlocal cutoff
cmaffeo2's avatar
cmaffeo2 committed
309
                if visited_segs is None: visited_segs = []
cmaffeo2's avatar
cmaffeo2 committed
310
311
312
313

                if seg == target_seg:
                    # pdb.set_trace()
                    ## Found a segment in our target
314
315
                    sign = 1 if contour_in_seg == 1 else -1
                    if sign == -1: assert( contour_in_seg == 0 )
cmaffeo2's avatar
cmaffeo2 committed
316
317
                    if distance < cutoff: # TODO: check if this does anything
                        cutoff = distance
318
                    return [[distance, contour_in_seg+sign*seg.nt_pos_to_contour(distance)]], [(seg, contour_in_seg, distance)]
cmaffeo2's avatar
cmaffeo2 committed
319
                if distance > cutoff:
320
                    return None,None
cmaffeo2's avatar
cmaffeo2 committed
321
322
                    
                ret_list = []
323
                hist_list = []
cmaffeo2's avatar
cmaffeo2 committed
324
                ## Find intrahelical locations in seg that we might pass through
325
326
327
328
329
                conn_locs = seg.get_connections_and_locations("intrahelical")
                if isinstance(target_seg, SingleStrandedSegment):
                    tmp = seg.get_connections_and_locations("sscrossover")
                    conn_locs = conn_locs + list(filter(lambda x: x[2].container == target_seg, tmp))
                for c,A,B in conn_locs:
cmaffeo2's avatar
cmaffeo2 committed
330
                    if B.container in visited_segs: continue
331
332
333
                    dx = seg.contour_to_nt_pos( A.address, round_nt=False ) - seg.contour_to_nt_pos( contour_in_seg, round_nt=False)
                    dx = np.abs(dx)
                    results,history = descend_search_tree( B.container, B.address,
cmaffeo2's avatar
cmaffeo2 committed
334
335
336
                                                   distance+dx, visited_segs + [seg] )
                    if results is not None:
                        ret_list.extend( results )
337
338
                        hist_list.extend( history )
                return ret_list,hist_list
cmaffeo2's avatar
cmaffeo2 committed
339

340
            results,history = descend_search_tree(self.parent, self.contour_position)
cmaffeo2's avatar
cmaffeo2 committed
341
342
            if results is None or len(results) == 0:
                raise Exception("Could not find location in segment") # TODO better error
343
344
345
346
            if address is not None:
                return sorted(results,key=lambda x:(x[0],(x[1]-address)**2))[0][1]
            else:
                return sorted(results,key=lambda x:x[0])[0][1]
cmaffeo2's avatar
cmaffeo2 committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
            # nt_pos = self.get_nt_position(seg)
            # return seg.nt_pos_to_contour(nt_pos)

    def update_position(self, contour_position):
        self.contour_position = contour_position
        self.position = self.parent.contour_to_position(contour_position)
        if 'orientation_bead' in self.__dict__:
            o = self.orientation_bead
            o.contour_position = contour_position
            orientation = self.parent.contour_to_orientation(contour_position)
            if orientation is None:
                print("WARNING: local_twist is True, but orientation is None; using identity")
                orientation = np.eye(3)
            o.position = self.position + orientation.dot( np.array((Segment.orientation_bond.r0,0,0)) )
            
cmaffeo2's avatar
cmaffeo2 committed
362
363
364
    def __repr__(self):
        return "<SegmentParticle {} on {}[{:.2f}]>".format( self.name, self.parent, self.contour_position)

365
366

## TODO break this class into smaller, better encapsulated pieces
367
368
369
370
371
372
373
374
375
376
377
class Segment(ConnectableElement, Group):

    """ Base class that describes a segment of DNA. When built from
    cadnano models, should not span helices """

    """Define basic particle types"""
    dsDNA_particle = ParticleType("D",
                                  diffusivity = 43.5,
                                  mass = 300,
                                  radius = 3,                 
                              )
cmaffeo2's avatar
cmaffeo2 committed
378
379
380
381
382
    orientation_particle = ParticleType("O",
                                        diffusivity = 100,
                                        mass = 300,
                                        radius = 1,
                                    )
383

cmaffeo2's avatar
cmaffeo2 committed
384
    # orientation_bond = HarmonicBond(10,2)
385
    orientation_bond = HarmonicBond(30,1.5, rRange = (0,500) )
386
387
388
389
390
391
392

    ssDNA_particle = ParticleType("S",
                                  diffusivity = 43.5,
                                  mass = 150,
                                  radius = 3,                 
                              )

393
    def __init__(self, name, num_nt, 
cmaffeo2's avatar
cmaffeo2 committed
394
                 start_position = None,
395
                 end_position = None, 
cmaffeo2's avatar
cmaffeo2 committed
396
397
                 segment_model = None,
                 **kwargs):
398

cmaffeo2's avatar
cmaffeo2 committed
399
400
        if start_position is None: start_position = np.array((0,0,0))

cmaffeo2's avatar
cmaffeo2 committed
401
        Group.__init__(self, name, children=[], **kwargs)
402
        ConnectableElement.__init__(self, connection_locations=[], connections=[])
403

cmaffeo2's avatar
cmaffeo2 committed
404
405
406
        if 'segname' not in kwargs:
            self.segname = name
        # self.resname = name
cmaffeo2's avatar
cmaffeo2 committed
407
408
409
410
411
        self.start_orientation = None
        self.twist_per_nt = 0

        self.beads = [c for c in self.children] # self.beads will not contain orientation beads

412
413
414
        self._bead_model_generation = 0    # TODO: remove?
        self.segment_model = segment_model # TODO: remove?

415
416
417
418
        self.strand_pieces = dict()
        for d in ('fwd','rev'):
            self.strand_pieces[d] = []

419
        self.num_nt = int(num_nt)
420
        if end_position is None:
421
            end_position = np.array((0,0,self.distance_per_nt*num_nt)) + start_position
422
423
424
        self.start_position = start_position
        self.end_position = end_position

cmaffeo2's avatar
cmaffeo2 committed
425
426
427
428
        ## Used to assign cadnano names to beads
        self._generate_bead_callbacks = []
        self._generate_nucleotide_callbacks = []

429
        ## Set up interpolation for positions
430
431
432
433
        self._set_splines_from_ends()

        self.sequence = None

434
435
436
    def __repr__(self):
        return "<{} {}[{:d}]>".format( type(self), self.name, self.num_nt )

cmaffeo2's avatar
cmaffeo2 committed
437
    def set_splines(self, contours, coords):
438
        tck, u = interpolate.splprep( coords.T, u=contours, s=0, k=1)
439
        self.position_spline_params = (tck,u)
440

441
442
    def set_orientation_splines(self, contours, quaternions):
        tck, u = interpolate.splprep( quaternions.T, u=contours, s=0, k=1)
443
444
445
446
447
448
        self.quaternion_spline_params = (tck,u)

    def get_center(self):
        tck, u = self.position_spline_params
        return np.mean(self.contour_to_position(u), axis=0)

449
450
451
    def _get_location_positions(self):
        return [self.contour_to_nt_pos(l.address) for l in self.locations]

cmaffeo2's avatar
cmaffeo2 committed
452
    def insert_dna(self, at_nt: int, num_nt: int, seq=tuple()):
453
454
455
456
457
458
459
460
461
462
463
464
        assert(np.isclose(np.around(num_nt),num_nt))
        if at_nt < 0:
            raise ValueError("Attempted to insert DNA into {} at a negative location".format(self))
        if at_nt > self.num_nt-1:
            raise ValueError("Attempted to insert DNA into {} at beyond the end of the Segment".format(self))
        if num_nt < 0:
            raise ValueError("Attempted to insert DNA a negative amount of DNA into {}".format(self))

        num_nt = np.around(num_nt)
        nt_positions = self._get_location_positions()
        new_nt_positions = [p if p <= at_nt else p+num_nt for p in nt_positions]

cmaffeo2's avatar
cmaffeo2 committed
465
466
        ## TODO: handle sequence

467
468
469
470
471
472
        self.num_nt = self.num_nt+num_nt

        for l,p in zip(self.locations, new_nt_positions):
            l.address = self.nt_pos_to_contour(p)

    def remove_dna(self, first_nt: int, last_nt: int):
cmaffeo2's avatar
cmaffeo2 committed
473
        """ Removes nucleotides between first_nt and last_nt, inclusive """
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
        assert(np.isclose(np.around(first_nt),first_nt))
        assert(np.isclose(np.around(last_nt),last_nt))
        tmp = min((first_nt,last_nt))
        last_nt = max((first_nt,last_nt))
        fist_nt = tmp

        if first_nt < 0 or first_nt > self.num_nt-2:
            raise ValueError("Attempted to remove DNA from {} starting at an invalid location {}".format(self, first_nt))
        if last_nt < 1 or last_nt > self.num_nt-1:
            raise ValueError("Attempted to remove DNA from {} ending at an invalid location {}".format(self, last_nt))
        if first_nt == last_nt:
            return

        first_nt = np.around(first_nt)
        last_nt = np.around(last_nt)

        nt_positions = self._get_location_positions()

        bad_locations = list(filter(lambda p: p >= first_nt and p <= last_nt, nt_positions))
        if len(bad_locations) > 0:
            raise Exception("Attempted to remove DNA containing locations {} from {} between {} and {}".format(bad_locations,self,first_nt,last_nt))

cmaffeo2's avatar
cmaffeo2 committed
496
497
498
499
500
501
502
503
        removed_nt = last_nt-first_nt+1
        new_nt_positions = [p if p <= last_nt else p-removed_nt for p in nt_positions]
        num_nt = self.num_nt-removed_nt

        if self.sequence is not None and len(self.sequence) == self.num_nt:
            self.sequence = [s for s,i in zip(self.sequence,range(self.num_nt)) 
                                if i < first_nt or i > last_nt]
            assert( len(self.sequence) == num_nt )
504

cmaffeo2's avatar
cmaffeo2 committed
505
        self.num_nt = num_nt
506
507
508
509

        for l,p in zip(self.locations, new_nt_positions):
            l.address = self.nt_pos_to_contour(p)

510
511
512
513
514
515
516
517
518
519
520
521
    def __filter_contours(contours, positions, position_filter, contour_filter):
        u = contours
        r = positions

        ## Filter
        ids = list(range(len(u)))
        if contour_filter is not None:
            ids = list(filter(lambda i: contour_filter(u[i]), ids))
        if position_filter is not None:
            ids = list(filter(lambda i: position_filter(r[i,:]), ids))
        return ids

522
    def translate(self, translation_vector, position_filter=None, contour_filter=None):
523
524
525
526
527
        dr = np.array(translation_vector)
        tck, u = self.position_spline_params
        r = self.contour_to_position(u)

        ids = Segment.__filter_contours(u, r, position_filter, contour_filter)
cmaffeo2's avatar
cmaffeo2 committed
528
        if len(ids) == 0: return
529
530
531

        ## Translate
        r[ids,:] = r[ids,:] + dr[np.newaxis,:]
532
        self.set_splines(u,r)
533
534
535
536
537
538

    def rotate(self, rotation_matrix, about=None, position_filter=None, contour_filter=None):
        tck, u = self.position_spline_params
        r = self.contour_to_position(u)

        ids = Segment.__filter_contours(u, r, position_filter, contour_filter)
cmaffeo2's avatar
cmaffeo2 committed
539
        if len(ids) == 0: return
540
541
542

        if about is None:
            ## TODO: do this more efficiently
543
            r[ids,:] = np.array([rotation_matrix.dot(r[i,:]) for i in ids])
544
545
546
        else:
            dr = np.array(about)
            ## TODO: do this more efficiently
547
            r[ids,:] = np.array([rotation_matrix.dot(r[i,:]-dr) + dr for i in ids])
548

549
        self.set_splines(u,r)
550
551
552
553

        if self.quaternion_spline_params is not None:
            ## TODO: performance: don't shift between quaternion and matrix representations so much
            tck, u = self.quaternion_spline_params
554
            orientations = [self.contour_to_orientation(v) for v in u]
555
556
557
            for i in ids:
                orientations[i,:] = rotation_matrix.dot(orientations[i])
            quats = [quaternion_from_matrix(o) for o in orientations]
558
            self.set_orientation_splines(u, quats)
559

560
    def _set_splines_from_ends(self, resolution=4):
561
        self.quaternion_spline_params = None
562
563
564
565
566
567
        r0 = np.array(self.start_position)[np.newaxis,:]
        r1 = np.array(self.end_position)[np.newaxis,:]
        u = np.linspace(0,1, max(3,self.num_nt//int(resolution)))
        s = u[:,np.newaxis]
        coords = (1-s)*r0 + s*r1
        self.set_splines(u, coords)
568

569
570
571
    def clear_all(self):
        Group.clear_all(self)  # TODO: use super?
        self.beads = []
572
573
574
575
576
        # for c,loc,other in self.get_connections_and_locations():
        #     loc.particle = None
        #     other.particle = None
        for l in self.locations:
            l.particle = None
577

578
    def contour_to_nt_pos(self, contour_pos, round_nt=False):
579
        nt = contour_pos*(self.num_nt) - 0.5
580
        if round_nt:
cmaffeo2's avatar
cmaffeo2 committed
581
            assert( np.isclose(np.around(nt),nt) )
582
583
584
            nt = np.around(nt)
        return nt

585
    def nt_pos_to_contour(self,nt_pos):
586
        return (nt_pos+0.5)/(self.num_nt)
587

588
    def contour_to_position(self,s):
589
        p = interpolate.splev( s, self.position_spline_params[0] )
590
591
592
593
        if len(p) > 1: p = np.array(p).T
        return p

    def contour_to_tangent(self,s):
594
        t = interpolate.splev( s, self.position_spline_params[0], der=1 )
595
596
        t = (t / np.linalg.norm(t,axis=0))
        return t.T
597
598
599
        

    def contour_to_orientation(self,s):
600
        assert( isinstance(s,float) or isinstance(s,int) or len(s) == 1 )   # TODO make vectorized version
601

602
603
604
605
606
        if self.quaternion_spline_params is None:
            axis = self.contour_to_tangent(s)
            axis = axis / np.linalg.norm(axis)
            rotAxis = np.cross(axis,np.array((0,0,1)))
            rotAxisL = np.linalg.norm(rotAxis)
607
            zAxis = np.array((0,0,1))
608
609

            if rotAxisL > 0.001:
610
611
612
                theta = np.arcsin(rotAxisL) * 180/np.pi
                if axis.dot(zAxis) < 0: theta = 180-theta
                orientation0 = rotationAboutAxis( rotAxis/rotAxisL, theta, normalizeAxis=False ).T
613
            else:
614
615
                orientation0 = np.eye(3) if axis.dot(zAxis) > 0 else \
                               rotationAboutAxis( np.array((1,0,0)), 180, normalizeAxis=False )
616
617
618
            if self.start_orientation is not None:
                orientation0 = orientation0.dot(self.start_orientation)

619
620
621
            orientation = rotationAboutAxis( axis, self.twist_per_nt*self.contour_to_nt_pos(s), normalizeAxis=False )
            orientation = orientation.dot(orientation0)
        else:
622
            q = interpolate.splev( s, self.quaternion_spline_params[0] )
623
624
            if len(q) > 1: q = np.array(q).T # TODO: is this needed?
            orientation = quaternion_to_matrix(q)
625

626
        return orientation
627

cmaffeo2's avatar
cmaffeo2 committed
628
    def get_contour_sorted_connections_and_locations(self,type_):
cmaffeo2's avatar
cmaffeo2 committed
629
        sort_fn = lambda c: c[1].address
cmaffeo2's avatar
cmaffeo2 committed
630
        cl = self.get_connections_and_locations(type_)
cmaffeo2's avatar
cmaffeo2 committed
631
        return sorted(cl, key=sort_fn)
632
633
634
    
    def randomize_unset_sequence(self):
        bases = list(seqComplement.keys())
635
        # bases = ['T']        ## FOR DEBUG
636
        if self.sequence is None:
637
            self.sequence = [random.choice(bases) for i in range(self.num_nt)]
638
        else:
639
            assert(len(self.sequence) == self.num_nt) # TODO move
640
641
642
            for i in range(len(self.sequence)):
                if self.sequence[i] is None:
                    self.sequence[i] = random.choice(bases)
643

cmaffeo2's avatar
cmaffeo2 committed
644
645
646
    def _get_num_beads(self, max_basepairs_per_bead, max_nucleotides_per_bead ):
        raise NotImplementedError

647
    def _generate_one_bead(self, contour_position, nts):
648
649
        raise NotImplementedError

cmaffeo2's avatar
cmaffeo2 committed
650
    def _generate_atomic_nucleotide(self, contour_position, is_fwd, seq, scale, strand_segment):
cmaffeo2's avatar
cmaffeo2 committed
651
652
653
654
655
        """ Seq should include modifications like 5T, T3 Tsinglet; direction matters too """

        # print("Generating nucleotide at {}".format(contour_position))
        
        pos = self.contour_to_position(contour_position)
656
        orientation = self.contour_to_orientation(contour_position)
cmaffeo2's avatar
cmaffeo2 committed
657

658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
        """ deleteme
        ## TODO: move this code (?)
        if orientation is None:
            import pdb
            pdb.set_trace()
            axis = self.contour_to_tangent(contour_position)
            angleVec = np.array([1,0,0])
            if axis.dot(angleVec) > 0.9: angleVec = np.array([0,1,0])
            angleVec = angleVec - angleVec.dot(axis)*axis
            angleVec = angleVec/np.linalg.norm(angleVec)
            y = np.cross(axis,angleVec)
            orientation = np.array([angleVec,y,axis]).T
            ## TODO: improve placement of ssDNA
            # rot = rotationAboutAxis( axis, contour_position*self.twist_per_nt*self.num_nt, normalizeAxis=True )
            # orientation = rot.dot(orientation)
        else:
            orientation = orientation                            
        """
cmaffeo2's avatar
cmaffeo2 committed
676
        key = seq
677
678
        nt_dict = canonicalNtFwd if is_fwd else canonicalNtRev

679
        atoms = nt_dict[ key ].generate() # TODO: clone?
cmaffeo2's avatar
cmaffeo2 committed
680
        atoms.orientation = orientation.dot(atoms.orientation)
681
682
683
684
        if isinstance(self, SingleStrandedSegment):
            if scale is not None and scale != 1:
                for a in atoms:
                    a.position = scale*a.position
685
            atoms.position = pos - atoms.atoms_by_name["C1'"].collapsedPosition()
686
687
688
689
690
691
692
693
694
        else:
            if scale is not None and scale != 1:
                if atoms.sequence in ("A","G"):
                    r0 = atoms.atoms_by_name["N9"].position
                else:
                    r0 = atoms.atoms_by_name["N1"].position
                for a in atoms:
                    if a.name[-1] in ("'","P","T"):
                        a.position = scale*(a.position-r0) + r0
695
                    else:
696
                        a.fixed = 1
697
            atoms.position = pos
cmaffeo2's avatar
cmaffeo2 committed
698
699
700
701
702
703
        
        atoms.contour_position = contour_position
        strand_segment.add(atoms)

        for callback in self._generate_nucleotide_callbacks:
            callback(atoms)
cmaffeo2's avatar
cmaffeo2 committed
704
705

        return atoms
706

707
708
    def add_location(self, nt, type_, on_fwd_strand=True):
        ## Create location if needed, add to segment
709
        c = self.nt_pos_to_contour(nt)
710
711
712
713
714
715
        assert(c >= 0 and c <= 1)
        # TODO? loc = self.Location( address=c, type_=type_, on_fwd_strand=is_fwd )
        loc = Location( self, address=c, type_=type_, on_fwd_strand=on_fwd_strand )
        self.locations.append(loc)

    ## TODO? Replace with abstract strand-based model?
716
717
718
719
720

    def add_nick(self, nt, on_fwd_strand=True):
        self.add_3prime(nt,on_fwd_strand)
        self.add_5prime(nt+1,on_fwd_strand)

721
    def add_5prime(self, nt, on_fwd_strand=True):
722
723
        if isinstance(self,SingleStrandedSegment):
            on_fwd_strand = True
724
        self.add_location(nt,"5prime",on_fwd_strand)
725
726

    def add_3prime(self, nt, on_fwd_strand=True):
727
728
        if isinstance(self,SingleStrandedSegment):
            on_fwd_strand = True
729
        self.add_location(nt,"3prime",on_fwd_strand)
730

731
    def get_3prime_locations(self):
cmaffeo2's avatar
cmaffeo2 committed
732
        return sorted(self.get_locations("3prime"),key=lambda x: x.address)
733
    
cmaffeo2's avatar
cmaffeo2 committed
734
    def get_5prime_locations(self):
735
        ## TODO? ensure that data is consistent before _build_model calls
cmaffeo2's avatar
cmaffeo2 committed
736
        return sorted(self.get_locations("5prime"),key=lambda x: x.address)
cmaffeo2's avatar
cmaffeo2 committed
737

738
    def iterate_connections_and_locations(self, reverse=False):
cmaffeo2's avatar
cmaffeo2 committed
739
740
        ## connections to other segments
        cl = self.get_contour_sorted_connections_and_locations()
741
        if reverse:
cmaffeo2's avatar
cmaffeo2 committed
742
            cl = cl[::-1]
743
744
745
            
        for c in cl:
            yield c
cmaffeo2's avatar
cmaffeo2 committed
746

747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
    ## TODO rename
    def _add_strand_piece(self, strand_piece):
        """ Registers a strand segment within this object """

        ## TODO use weakref
        d = 'fwd' if strand_piece.is_fwd else 'rev'

        ## Validate strand_piece (ensure no clashes)
        for s in self.strand_pieces[d]:
            l,h = sorted((s.start,s.end))
            for value in (strand_piece.start,strand_piece.end):
                assert( value < l or value > h )

        ## Add strand_piece in correct order
        self.strand_pieces[d].append(strand_piece)
        self.strand_pieces[d] = sorted(self.strand_pieces[d],
                                       key = lambda x: x.start)

765
    ## TODO rename
766
    def get_strand_segment(self, nt_pos, is_fwd, move_at_least=0.5):
767
        """ Walks through locations, checking for crossovers """
768
769
770
771
        # if self.name in ("6-1","1-1"):
        #     import pdb
        #     pdb.set_trace()
        move_at_least = 0
772
773

        ## Iterate through locations
cmaffeo2's avatar
cmaffeo2 committed
774
        # locations = sorted(self.locations, key=lambda l:(l.address,not l.on_fwd_strand), reverse=(not is_fwd))
775
776
777
778
779
780
        def loc_rank(l):
            nt = l.get_nt_pos()
            ## optionally add logic about type of connection
            return (nt, not l.on_fwd_strand)
        # locations = sorted(self.locations, key=lambda l:(l.address,not l.on_fwd_strand), reverse=(not is_fwd))
        locations = sorted(self.locations, key=loc_rank, reverse=(not is_fwd))
781
782
        # print(locations)

783
        for l in locations:
cmaffeo2's avatar
cmaffeo2 committed
784
785
786
787
            # TODOTODO probably okay
            if l.address == 0:
                pos = 0.0
            elif l.address == 1:
788
                pos = self.num_nt-1
cmaffeo2's avatar
cmaffeo2 committed
789
790
            else:
                pos = self.contour_to_nt_pos(l.address, round_nt=True)
791
792
793

            ## DEBUG

cmaffeo2's avatar
cmaffeo2 committed
794

795
            ## Skip locations encountered before our strand
796
797
798
799
800
801
802
803
            # tol = 0.1
            # if is_fwd:
            #     if pos-nt_pos <= tol: continue 
            # elif   nt_pos-pos <= tol: continue
            if (pos-nt_pos)*(2*is_fwd-1) < move_at_least: continue
            ## TODO: remove move_at_least
            if np.isclose(pos,nt_pos):
                if l.is_3prime_side_of_connection: continue
804
805

            ## Stop if we found the 3prime end
806
            if l.on_fwd_strand == is_fwd and l.type_ == "3prime" and l.connection is None:
807
                # print("  found end at",l)
808
                return pos, None, None, None, None
809
810
811
812
813
814
815
816

            ## Check location connections
            c = l.connection
            if c is None: continue
            B = c.other(l)            

            ## Found a location on the same strand?
            if l.on_fwd_strand == is_fwd:
817
818
                # print("  passing through",l)
                # print("from {}, connection {} to {}".format(nt_pos,l,B))
819
                Bpos = B.get_nt_pos()
820
                return pos, B.container, Bpos, B.on_fwd_strand, 0.5
821
822
823
                
            ## Stop at other strand crossovers so basepairs line up
            elif c.type_ == "crossover":
824
                if nt_pos == pos: continue
825
                # print("  pausing at",l)
826
                return pos, l.container, pos+(2*is_fwd-1), is_fwd, 0
827
828
829
830
831
832

        raise Exception("Shouldn't be here")
        # print("Shouldn't be here")
        ## Made it to the end of the segment without finding a connection
        return 1*is_fwd, None, None, None

833
834
835
    def get_nearest_bead(self, contour_position):
        if len(self.beads) < 1: return None
        cs = np.array([b.contour_position for b in self.beads]) # TODO: cache
836
        # TODO: include beads in connections?
837
838
839
        i = np.argmin((cs - contour_position)**2)

        return self.beads[i]
840

841
842
843
844
845
846
847
848
849
    def _get_atomic_nucleotide(self, nucleotide_idx, is_fwd=True):
        d = 'fwd' if is_fwd else 'rev'
        for s in self.strand_pieces[d]:
            try:
                return s.get_nucleotide(nucleotide_idx)
            except:
                pass
        raise Exception("Could not find nucleotide in {} at {}.{}".format( self, nucleotide_idx, d ))

850
851
    def get_all_consecutive_beads(self, number):
        assert(number >= 1)
cmaffeo2's avatar
cmaffeo2 committed
852
        ## Assume that consecutive beads in self.beads are bonded
853
        ret = []
cmaffeo2's avatar
cmaffeo2 committed
854
855
        for i in range(len(self.beads)-number+1):
            tmp = [self.beads[i+j] for j in range(0,number)]
856
            ret.append( tmp )
857
        return ret   
858

859
    def _add_bead(self,b):
860
        
861
862
863
        # assert(b.parent is None)
        if b.parent is not None:
            b.parent.children.remove(b)
864
        self.add(b)
865
866
867
868
869
870
        self.beads.append(b) # don't add orientation bead
        if "orientation_bead" in b.__dict__: # TODO: think of a cleaner approach
            o = b.orientation_bead
            o.contour_position = b.contour_position
            if o.parent is not None:
                o.parent.children.remove(o)
871
            self.add(o)
872
873
874
875
876
877
878
879
            self.add_bond(b,o, Segment.orientation_bond, exclude=True)

    def _rebuild_children(self, new_children):
        # print("_rebuild_children on %s" % self.name)
        old_children = self.children
        old_beads = self.beads
        self.children = []
        self.beads = []
880
881

        if True:
882
883
            ## TODO: remove this if duplicates are never found 
            # print("Searching for duplicate particles...")
884
            ## Remove duplicates, preserving order
885
886
887
888
            tmp = []
            for c in new_children:
                if c not in tmp:
                    tmp.append(c)
889
                else:
890
                    print("  DUPLICATE PARTICLE FOUND!")
891
892
            new_children = tmp

893
894
895
896
897
        for b in new_children:
            self.beads.append(b)
            self.children.append(b)
            if "orientation_bead" in b.__dict__: # TODO: think of a cleaner approach
                self.children.append(b.orientation_bead)
898
899
900
901
902
            
        # tmp = [c for c in self.children if c not in old_children]
        # assert(len(tmp) == 0)
        # tmp = [c for c in old_children if c not in self.children]
        # assert(len(tmp) == 0)
903
904
        assert(len(old_children) == len(self.children))
        assert(len(old_beads) == len(self.beads))
905

906

cmaffeo2's avatar
cmaffeo2 committed
907
    def _generate_beads(self, bead_model, max_basepairs_per_bead, max_nucleotides_per_bead):
908

909
        """ Generate beads (positions, types, etc) and bonds, angles, dihedrals, exclusions """
cmaffeo2's avatar
cmaffeo2 committed
910
        ## TODO: decide whether to remove bead_model argument
911
        ##       (currently unused)
cmaffeo2's avatar
cmaffeo2 committed
912

913
        ## First find points between-which beads must be generated
914
915
916
        # conn_locs = self.get_contour_sorted_connections_and_locations()
        # locs = [A for c,A,B in conn_locs]
        # existing_beads = [l.particle for l in locs if l.particle is not None]
cmaffeo2's avatar
cmaffeo2 committed
917
918
        # if self.name == "S001":
        #     pdb.set_trace()
919

920
921
922
923
        # pdb.set_trace()
        existing_beads0 = { (l.particle, l.particle.get_contour_position(self,l.address))
                            for l in self.locations if l.particle is not None }
        existing_beads = sorted( list(existing_beads0), key=lambda bc: bc[1] )
924

925
926
927
        # if self.num_nt == 1 and all([l.particle is not None for l in self.locations]):
        #     pdb.set_trace()
        #     return
928

929
        for b,c in existing_beads:
930
931
932
            assert(b.parent is not None)

        ## Add ends if they don't exist yet
933
        ## TODOTODO: test 1 nt segments?
934
        if len(existing_beads) == 0 or existing_beads[0][0].get_nt_position(self,0) >= 0.5:
cmaffeo2's avatar
cmaffeo2 committed
935
936
            # if len(existing_beads) > 0:            
            #     assert(existing_beads[0].get_nt_position(self) >= 0.5)
937
            b = self._generate_one_bead( self.nt_pos_to_contour(0), 0)
938
            existing_beads = [(b,0)] + existing_beads
cmaffeo2's avatar
cmaffeo2 committed
939

940
        if existing_beads[-1][0].get_nt_position(self,1)-(self.num_nt-1) < -0.5 or len(existing_beads)==1:
941
            b = self._generate_one_bead( self.nt_pos_to_contour(self.num_nt-1), 0)
942
            existing_beads.append( (b,1) )
943
944
945
946
        assert(len(existing_beads) > 1)

        ## Walk through existing_beads, add beads between
        tmp_children = []       # build list of children in nice order
947
        last = None
cmaffeo2's avatar
cmaffeo2 committed
948

949
        for I in range(len(existing_beads)-1):
950
951
952
            eb1,eb2 = [existing_beads[i][0] for i in (I,I+1)]
            ec1,ec2 = [existing_beads[i][1] for i in (I,I+1)]
            assert( (eb1,ec1) is not (eb2,ec2) )
953

cmaffeo2's avatar
cmaffeo2 committed
954
955
956
957
            # if np.isclose(eb1.position[2], eb2.position[2]):
            #     import pdb
            #     pdb.set_trace()

958
            # print(" %s working on %d to %d" % (self.name, eb1.position[2], eb2.position[2]))
959
            e_ds = ec2-ec1
960
            num_beads = self._get_num_beads( e_ds, max_basepairs_per_bead, max_nucleotides_per_bead )
cmaffeo2's avatar
cmaffeo2 committed
961
962
963
964
965
966

            ## Ensure there is a ssDNA bead between dsDNA beads
            if num_beads == 0 and isinstance(self,SingleStrandedSegment) and isinstance(eb1.parent,DoubleStrandedSegment) and isinstance(eb2.parent,DoubleStrandedSegment):
                num_beads = 1
            ## TODO similarly ensure there is a dsDNA bead between ssDNA beads

967