segmentmodel.py 132 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
42
 - refactor parts of Segment into an abstract_polymer class
 - make each call generate_bead_model, generate_atomic_model, generate_oxdna_model return an object with only have a reference to original object
43
"""
cmaffeo2's avatar
cmaffeo2 committed
44
45
class CircularDnaError(Exception):
    pass
46

cmaffeo2's avatar
cmaffeo2 committed
47
48
49
class ParticleNotConnectedError(Exception):
    pass

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

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

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

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

78
79
80
81
82
83
84
    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:
85
                pos = self.container.num_nt-1
86
87
88
89
            else:
                raise
        return pos

90
91
92
93
94
95
96
    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)
        
97
98
99
100
101
102
103
104
105
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_
        
106
107
108
109
110
111
112
    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
113

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

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

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

133
134
        ## TODO decide on names
        self.locations = self.connection_locations = connection_locations
135
136
        self.connections = connections

cmaffeo2's avatar
cmaffeo2 committed
137
    def get_locations(self, type_=None, exclude=()):
138
139
140
141
142
143
144
145
        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] ) )
146
147
148
149
        return locs

    def get_location_at(self, address, on_fwd_strand=True, new_type="crossover"):
        loc = None
150
        if (self.num_nt == 1):
151
152
153
154
155
156
157
            # 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
158
            # assert( loc is not None )
159
160
161
162
163
164
165
166
        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
167

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

185
    def _connect(self, other, connection, in_3prime_direction=None):
186
187
        ## TODO fix circular references        
        A,B = [connection.A, connection.B]
188
189
190
191
        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
            
192
        A.connection = B.connection = connection
193
        self.connections.append(connection)
194
195
        if other is not self:
            other.connections.append(connection)
cmaffeo2's avatar
cmaffeo2 committed
196
197
        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")
198
199
200
201
202
203
        l = A.container.locations
        if A not in l: l.append(A)
        l = B.container.locations
        if B not in l: l.append(B)
        

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

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

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

224
    def get_intrahelical_below(self, all_types=True):
225
        """ Returns bead directly below self """
226
        # assert( len(self.intrahelical_neighbors) <= 2 )
227
        for b in self.intrahelical_neighbors:
228
            if b.get_contour_position(self.parent, self.contour_position) < self.contour_position:
229
230
                if all_types or isinstance(b,type(self)):
                    return b
231

cmaffeo2's avatar
cmaffeo2 committed
232
    def _neighbor_should_be_added(self,b):
233
234
235
        if type(self.parent) != type(b.parent):
            return True

cmaffeo2's avatar
cmaffeo2 committed
236
        c1 = self.contour_position
237
        c2 = b.get_contour_position(self.parent,c1)
cmaffeo2's avatar
cmaffeo2 committed
238
239
        if c2 < c1:
            b0 = self.get_intrahelical_below()
240
        else:
cmaffeo2's avatar
cmaffeo2 committed
241
242
243
            b0 = self.get_intrahelical_above()

        if b0 is not None:            
244
            c0 = b0.get_contour_position(self.parent,c1)
cmaffeo2's avatar
cmaffeo2 committed
245
246
247
248
249
250
251
252
253
254
255
256
257
            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:
258
259
            # assert(len(b.intrahelical_neighbors) <= 1)
            # assert(len(self.intrahelical_neighbors) <= 1)
cmaffeo2's avatar
cmaffeo2 committed
260
261
            self.intrahelical_neighbors.append(b)
            b.intrahelical_neighbors.append(self)
262

263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
    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
289
290
291
292
        """ Returns the "address" of the nucleotide relative to seg in
        nucleotides, taking the shortest (intrahelical) contour length route to seg
        """
        if seg == self.parent:
293
            pos = self.contour_position
cmaffeo2's avatar
cmaffeo2 committed
294
        else:
295
296
            pos = self.get_contour_position(seg,near_address)
        return seg.contour_to_nt_pos(pos)
cmaffeo2's avatar
cmaffeo2 committed
297

298
    def get_contour_position(self,seg, address = None):
cmaffeo2's avatar
cmaffeo2 committed
299
300
301
302
        """ 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
        """

303
304
305
        if seg == self.parent:
            return self.contour_position
        else:
cmaffeo2's avatar
cmaffeo2 committed
306
307
308
309
310
            cutoff = 30*3
            target_seg = seg

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

                if seg == target_seg:
                    # pdb.set_trace()
                    ## Found a segment in our target
318
319
                    sign = 1 if contour_in_seg == 1 else -1
                    if sign == -1: assert( contour_in_seg == 0 )
cmaffeo2's avatar
cmaffeo2 committed
320
321
                    if distance < cutoff: # TODO: check if this does anything
                        cutoff = distance
322
                    return [[distance, contour_in_seg+sign*seg.nt_pos_to_contour(distance)]], [(seg, contour_in_seg, distance)]
cmaffeo2's avatar
cmaffeo2 committed
323
                if distance > cutoff:
324
                    return None,None
cmaffeo2's avatar
cmaffeo2 committed
325
326
                    
                ret_list = []
327
                hist_list = []
cmaffeo2's avatar
cmaffeo2 committed
328
                ## Find intrahelical locations in seg that we might pass through
329
330
331
332
333
                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
334
                    if B.container in visited_segs: continue
335
336
337
                    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
338
339
340
                                                   distance+dx, visited_segs + [seg] )
                    if results is not None:
                        ret_list.extend( results )
341
342
                        hist_list.extend( history )
                return ret_list,hist_list
cmaffeo2's avatar
cmaffeo2 committed
343

344
            results,history = descend_search_tree(self.parent, self.contour_position)
cmaffeo2's avatar
cmaffeo2 committed
345
346
            if results is None or len(results) == 0:
                raise Exception("Could not find location in segment") # TODO better error
347
348
349
350
            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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
            # 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
366
367
368
    def __repr__(self):
        return "<SegmentParticle {} on {}[{:.2f}]>".format( self.name, self.parent, self.contour_position)

369
370

## TODO break this class into smaller, better encapsulated pieces
371
372
373
374
375
376
377
378
379
380
381
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
382
383
384
385
386
    orientation_particle = ParticleType("O",
                                        diffusivity = 100,
                                        mass = 300,
                                        radius = 1,
                                    )
387

cmaffeo2's avatar
cmaffeo2 committed
388
    # orientation_bond = HarmonicBond(10,2)
389
    orientation_bond = HarmonicBond(30,1.5, rRange = (0,500) )
390
391
392
393
394
395
396

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

397
    def __init__(self, name, num_nt, 
cmaffeo2's avatar
cmaffeo2 committed
398
                 start_position = None,
399
                 end_position = None, 
cmaffeo2's avatar
cmaffeo2 committed
400
401
                 segment_model = None,
                 **kwargs):
402

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

cmaffeo2's avatar
cmaffeo2 committed
405
        Group.__init__(self, name, children=[], **kwargs)
406
        ConnectableElement.__init__(self, connection_locations=[], connections=[])
407

cmaffeo2's avatar
cmaffeo2 committed
408
409
410
        if 'segname' not in kwargs:
            self.segname = name
        # self.resname = name
cmaffeo2's avatar
cmaffeo2 committed
411
412
413
414
415
        self.start_orientation = None
        self.twist_per_nt = 0

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

416
417
418
        self._bead_model_generation = 0    # TODO: remove?
        self.segment_model = segment_model # TODO: remove?

419
420
421
422
        self.strand_pieces = dict()
        for d in ('fwd','rev'):
            self.strand_pieces[d] = []

423
        self.num_nt = int(num_nt)
424
        if end_position is None:
425
            end_position = np.array((0,0,self.distance_per_nt*num_nt)) + start_position
426
427
428
        self.start_position = start_position
        self.end_position = end_position

cmaffeo2's avatar
cmaffeo2 committed
429
430
431
432
        ## Used to assign cadnano names to beads
        self._generate_bead_callbacks = []
        self._generate_nucleotide_callbacks = []

433
        ## Set up interpolation for positions
434
435
436
437
        self._set_splines_from_ends()

        self.sequence = None

438
439
440
    def __repr__(self):
        return "<{} {}[{:d}]>".format( type(self), self.name, self.num_nt )

cmaffeo2's avatar
cmaffeo2 committed
441
    def set_splines(self, contours, coords):
442
        tck, u = interpolate.splprep( coords.T, u=contours, s=0, k=1)
443
        self.position_spline_params = (tck,u)
444

445
446
    def set_orientation_splines(self, contours, quaternions):
        tck, u = interpolate.splprep( quaternions.T, u=contours, s=0, k=1)
447
448
449
450
451
452
        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)

453
454
455
    def _get_location_positions(self):
        return [self.contour_to_nt_pos(l.address) for l in self.locations]

cmaffeo2's avatar
cmaffeo2 committed
456
    def insert_dna(self, at_nt: int, num_nt: int, seq=tuple()):
457
458
459
460
461
462
463
464
465
466
467
468
        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
469
470
        ## TODO: handle sequence

471
472
473
474
475
476
        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
477
        """ Removes nucleotides between first_nt and last_nt, inclusive """
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
        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
500
501
502
503
504
505
506
507
        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 )
508

cmaffeo2's avatar
cmaffeo2 committed
509
        self.num_nt = num_nt
510
511
512
513

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

514
515
516
517
518
519
520
521
522
523
524
525
    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

526
    def translate(self, translation_vector, position_filter=None, contour_filter=None):
527
528
529
530
531
        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
532
        if len(ids) == 0: return
533
534
535

        ## Translate
        r[ids,:] = r[ids,:] + dr[np.newaxis,:]
536
        self.set_splines(u,r)
537
538
539
540
541
542

    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
543
        if len(ids) == 0: return
544
545
546

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

553
        self.set_splines(u,r)
554
555
556
557

        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
558
            orientations = [self.contour_to_orientation(v) for v in u]
559
560
561
            for i in ids:
                orientations[i,:] = rotation_matrix.dot(orientations[i])
            quats = [quaternion_from_matrix(o) for o in orientations]
562
            self.set_orientation_splines(u, quats)
563

564
    def _set_splines_from_ends(self, resolution=4):
565
        self.quaternion_spline_params = None
566
567
568
569
570
571
        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)
572

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

582
    def contour_to_nt_pos(self, contour_pos, round_nt=False):
583
        nt = contour_pos*(self.num_nt) - 0.5
584
        if round_nt:
cmaffeo2's avatar
cmaffeo2 committed
585
            assert( np.isclose(np.around(nt),nt) )
586
587
588
            nt = np.around(nt)
        return nt

589
    def nt_pos_to_contour(self,nt_pos):
590
        return (nt_pos+0.5)/(self.num_nt)
591

592
    def contour_to_position(self,s):
593
        p = interpolate.splev( s, self.position_spline_params[0] )
594
595
596
597
        if len(p) > 1: p = np.array(p).T
        return p

    def contour_to_tangent(self,s):
598
        t = interpolate.splev( s, self.position_spline_params[0], der=1 )
599
600
        t = (t / np.linalg.norm(t,axis=0))
        return t.T
601
602
603
        

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

606
607
608
609
610
        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)
611
            zAxis = np.array((0,0,1))
612
613

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

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

630
        return orientation
631

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

cmaffeo2's avatar
cmaffeo2 committed
648
649
650
    def _get_num_beads(self, max_basepairs_per_bead, max_nucleotides_per_bead ):
        raise NotImplementedError

651
    def _generate_one_bead(self, contour_position, nts):
652
653
        raise NotImplementedError

cmaffeo2's avatar
cmaffeo2 committed
654
    def _generate_atomic_nucleotide(self, contour_position, is_fwd, seq, scale, strand_segment):
cmaffeo2's avatar
cmaffeo2 committed
655
656
657
658
659
        """ 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)
660
        orientation = self.contour_to_orientation(contour_position)
cmaffeo2's avatar
cmaffeo2 committed
661

662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
        """ 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
680
        key = seq
681
682
        nt_dict = canonicalNtFwd if is_fwd else canonicalNtRev

683
        atoms = nt_dict[ key ].generate() # TODO: clone?
cmaffeo2's avatar
cmaffeo2 committed
684
        atoms.orientation = orientation.dot(atoms.orientation)
685
686
687
688
        if isinstance(self, SingleStrandedSegment):
            if scale is not None and scale != 1:
                for a in atoms:
                    a.position = scale*a.position
689
            atoms.position = pos - atoms.atoms_by_name["C1'"].collapsedPosition()
690
691
692
693
694
695
696
697
698
        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
699
                    else:
700
                        a.fixed = 1
701
            atoms.position = pos
cmaffeo2's avatar
cmaffeo2 committed
702
703
704
705
706
707
        
        atoms.contour_position = contour_position
        strand_segment.add(atoms)

        for callback in self._generate_nucleotide_callbacks:
            callback(atoms)
cmaffeo2's avatar
cmaffeo2 committed
708
709

        return atoms
710

711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
    def _generate_oxdna_nucleotide(self, contour_position, is_fwd, seq):
        bp_center = self.contour_to_position(contour_position)
        orientation = self.contour_to_orientation(contour_position)

        DefaultOrientation = rotationAboutAxis([0,0,1], 90)
        if is_fwd: 
            DefaultOrientation = rotationAboutAxis([1,0,0], 180).dot(DefaultOrientation)

        o = orientation.dot(DefaultOrientation)

        if isinstance(self, SingleStrandedSegment):
            pos = bp_center
        else:
            pos = bp_center - 5*o.dot(np.array((1,0,0)))

        nt = PointParticle("oxdna_nt", position= pos,
                             orientation = o)

        nt.contour_position = contour_position
        return nt


733
734
    def add_location(self, nt, type_, on_fwd_strand=True):
        ## Create location if needed, add to segment
735
        c = self.nt_pos_to_contour(nt)
736
737
738
739
740
741
        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?
742
743
744
745
746

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

747
    def add_5prime(self, nt, on_fwd_strand=True):
748
749
        if isinstance(self,SingleStrandedSegment):
            on_fwd_strand = True
750
        self.add_location(nt,"5prime",on_fwd_strand)
751
752

    def add_3prime(self, nt, on_fwd_strand=True):
753
754
        if isinstance(self,SingleStrandedSegment):
            on_fwd_strand = True
755
        self.add_location(nt,"3prime",on_fwd_strand)
756

757
    def get_3prime_locations(self):
cmaffeo2's avatar
cmaffeo2 committed
758
        return sorted(self.get_locations("3prime"),key=lambda x: x.address)
759
    
cmaffeo2's avatar
cmaffeo2 committed
760
    def get_5prime_locations(self):
761
        ## TODO? ensure that data is consistent before _build_model calls
cmaffeo2's avatar
cmaffeo2 committed
762
        return sorted(self.get_locations("5prime"),key=lambda x: x.address)
cmaffeo2's avatar
cmaffeo2 committed
763

764
    def iterate_connections_and_locations(self, reverse=False):
cmaffeo2's avatar
cmaffeo2 committed
765
766
        ## connections to other segments
        cl = self.get_contour_sorted_connections_and_locations()
767
        if reverse:
cmaffeo2's avatar
cmaffeo2 committed
768
            cl = cl[::-1]
769
770
771
            
        for c in cl:
            yield c
cmaffeo2's avatar
cmaffeo2 committed
772

773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
    ## 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)

791
    ## TODO rename
792
    def get_strand_segment(self, nt_pos, is_fwd, move_at_least=0.5):
793
        """ Walks through locations, checking for crossovers """
794
795
796
797
        # if self.name in ("6-1","1-1"):
        #     import pdb
        #     pdb.set_trace()
        move_at_least = 0
798
799

        ## Iterate through locations
cmaffeo2's avatar
cmaffeo2 committed
800
        # locations = sorted(self.locations, key=lambda l:(l.address,not l.on_fwd_strand), reverse=(not is_fwd))
801
802
803
804
805
806
        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))
807
808
        # print(locations)

809
        for l in locations:
cmaffeo2's avatar
cmaffeo2 committed
810
811
812
813
            # TODOTODO probably okay
            if l.address == 0:
                pos = 0.0
            elif l.address == 1:
814
                pos = self.num_nt-1
cmaffeo2's avatar
cmaffeo2 committed
815
816
            else:
                pos = self.contour_to_nt_pos(l.address, round_nt=True)
817
818
819

            ## DEBUG

cmaffeo2's avatar
cmaffeo2 committed
820

821
            ## Skip locations encountered before our strand
822
823
824
825
826
827
828
829
            # 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
830
831

            ## Stop if we found the 3prime end
832
            if l.on_fwd_strand == is_fwd and l.type_ == "3prime" and l.connection is None:
833
                # print("  found end at",l)
834
                return pos, None, None, None, None
835
836
837
838
839
840
841
842

            ## 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:
843
844
                # print("  passing through",l)
                # print("from {}, connection {} to {}".format(nt_pos,l,B))
845
                Bpos = B.get_nt_pos()
846
                return pos, B.container, Bpos, B.on_fwd_strand, 0.5
847
848
849
                
            ## Stop at other strand crossovers so basepairs line up
            elif c.type_ == "crossover":
850
                if nt_pos == pos: continue
851
                # print("  pausing at",l)
852
                return pos, l.container, pos+(2*is_fwd-1), is_fwd, 0
853
854
855
856
857
858

        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

859
860
861
    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
862
        # TODO: include beads in connections?
863
864
865
        i = np.argmin((cs - contour_position)**2)

        return self.beads[i]
866

867
868
869
870
871
872
873
874
875
    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 ))

876
877
    def get_all_consecutive_beads(self, number):
        assert(number >= 1)
cmaffeo2's avatar
cmaffeo2 committed
878
        ## Assume that consecutive beads in self.beads are bonded
879
        ret = []
cmaffeo2's avatar
cmaffeo2 committed
880
881
        for i in range(len(self.beads)-number+1):
            tmp = [self.beads[i+j] for j in range(0,number)]
882
            ret.append( tmp )
883
        return ret   
884

885
    def _add_bead(self,b):
886
        
887
888
889
        # assert(b.parent is None)
        if b.parent is not None:
            b.parent.children.remove(b)
890
        self.add(b)
891
892
893
894
895
896
        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)
897
            self.add(o)
898
899
900
901
902
903
904
905
            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 = []
906
907

        if True:
908
909
            ## TODO: remove this if duplicates are never found 
            # print("Searching for duplicate particles...")
910
            ## Remove duplicates, preserving order
911
912
913
914
            tmp = []
            for c in new_children:
                if c not in tmp:
                    tmp.append(c)
915
                else:
916
                    print("  DUPLICATE PARTICLE FOUND!")
917
918
            new_children = tmp

919
920
921
922
923
        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)
924
925
926
927
928
            
        # 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)
929
930
        assert(len(old_children) == len(self.children))
        assert(len(old_beads) == len(self.beads))
931

932

cmaffeo2's avatar
cmaffeo2 committed
933
    def _generate_beads(self, bead_model, max_basepairs_per_bead, max_nucleotides_per_bead):
934

935
        """ Generate beads (positions, types, etc) and bonds, angles, dihedrals, exclusions """
cmaffeo2's avatar
cmaffeo2 committed
936
        ## TODO: decide whether to remove bead_model argument
937
        ##       (currently unused)
cmaffeo2's avatar
cmaffeo2 committed
938

939
        ## First find points between-which beads must be generated
940
941
942
        # 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
943
944
        # if self.name == "S001":
        #     pdb.set_trace()
945

946
947
948
949
        # 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] )
950

951
952
953
        # if self.num_nt == 1 and all([l.particle is not None for l in self.locations]):
        #     pdb.set_trace()
        #     return
954

955
        for b,c in existing_beads:
956
957
958
            assert(b.parent is not None)

        ## Add ends if they don't exist yet
959
        ## TODOTODO: test 1 nt segments?
960
        if len(existing_beads) == 0 or existing_beads[0][0].get_nt_position(self,0) >= 0.5:
cmaffeo2's avatar
cmaffeo2 committed
961
962
            # if len(existing_beads) > 0:            
            #     assert(existing_beads[0].get_nt_position(self) >= 0.5)
963
964
965
            c = self.nt_pos_to_contour(0)
            if self.num_nt == 1: c -= 0.4
            b = self._generate_one_bead(c, 0)
966
            existing_beads = [(b,0)] + existing_beads
cmaffeo2's avatar
cmaffeo2 committed
967

968
        if existing_beads[-1][0].get_nt_position(self,1)-(self.num_nt-1) < -0.5 or len(existing_beads)==1:
969
970
971
            c = self.nt_pos_to_contour(self.num_nt-1)
            if self.num_nt == 1: c += 0.4
            b = self._generate_one_bead(c, 0)
972
            existing_beads.append( (b,1) )
973
974
975
976
        assert(len(existing_beads) > 1)

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