scripts/last-dotplot
author Martin C. Frith
Wed Nov 08 11:36:01 2017 +0900 (2017-11-08)
changeset 904 c2f50cd4e29d
parent 903 3af6b02e3f9c
child 905 8d52cef22afa
permissions -rwxr-xr-x
Tweak dotplot labels
Martin@1
     1
#! /usr/bin/env python
Martin@1
     2
Martin@272
     3
# Read pair-wise alignments in MAF or LAST tabular format: write an
Martin@272
     4
# "Oxford grid", a.k.a. dotplot.
Martin@1
     5
Martin@1
     6
# TODO: Currently, pixels with zero aligned nt-pairs are white, and
Martin@1
     7
# pixels with one or more aligned nt-pairs are black.  This can look
Martin@1
     8
# too crowded for large genome alignments.  I tried shading each pixel
Martin@1
     9
# according to the number of aligned nt-pairs within it, but the
Martin@1
    10
# result is too faint.  How can this be done better?
Martin@1
    11
Martin@875
    12
import gzip
Martin@896
    13
from fnmatch import fnmatchcase
Martin@903
    14
import subprocess
Martin@896
    15
import itertools, optparse, os, re, sys
Martin@475
    16
Martin@475
    17
# Try to make PIL/PILLOW work:
Martin@475
    18
try: from PIL import Image, ImageDraw, ImageFont, ImageColor
Martin@475
    19
except ImportError: import Image, ImageDraw, ImageFont, ImageColor
Martin@1
    20
Martin@844
    21
def myOpen(fileName):  # faster than fileinput
Martin@904
    22
    if fileName is None:
Martin@904
    23
        return []
Martin@844
    24
    if fileName == "-":
Martin@844
    25
        return sys.stdin
Martin@875
    26
    if fileName.endswith(".gz"):
Martin@875
    27
        return gzip.open(fileName)
Martin@844
    28
    return open(fileName)
Martin@844
    29
Martin@644
    30
def warn(message):
Martin@866
    31
    if opts.verbose:
Martin@866
    32
        prog = os.path.basename(sys.argv[0])
Martin@866
    33
        sys.stderr.write(prog + ": " + message + "\n")
Martin@644
    34
Martin@840
    35
def croppedBlocks(blocks, range1, range2):
Martin@840
    36
    cropBeg1, cropEnd1 = range1
Martin@840
    37
    cropBeg2, cropEnd2 = range2
Martin@840
    38
    if blocks[0][0] < 0: cropBeg1, cropEnd1 = -cropEnd1, -cropBeg1
Martin@840
    39
    if blocks[0][1] < 0: cropBeg2, cropEnd2 = -cropEnd2, -cropBeg2
Martin@840
    40
    for beg1, beg2, size in blocks:
Martin@840
    41
        b1 = max(cropBeg1, beg1)
Martin@840
    42
        e1 = min(cropEnd1, beg1 + size)
Martin@840
    43
        if b1 >= e1: continue
Martin@840
    44
        offset = beg2 - beg1
Martin@840
    45
        b2 = max(cropBeg2, b1 + offset)
Martin@840
    46
        e2 = min(cropEnd2, e1 + offset)
Martin@840
    47
        if b2 >= e2: continue
Martin@840
    48
        yield b2 - offset, b2, e2 - b2
Martin@840
    49
Martin@482
    50
def tabBlocks(beg1, beg2, blocks):
Martin@482
    51
    '''Get the gapless blocks of an alignment, from LAST tabular format.'''
Martin@482
    52
    for i in blocks.split(","):
Martin@482
    53
        if ":" in i:
Martin@482
    54
            x, y = i.split(":")
Martin@482
    55
            beg1 += int(x)
Martin@482
    56
            beg2 += int(y)
Martin@482
    57
        else:
Martin@482
    58
            size = int(i)
Martin@482
    59
            yield beg1, beg2, size
Martin@482
    60
            beg1 += size
Martin@482
    61
            beg2 += size
Martin@272
    62
Martin@482
    63
def mafBlocks(beg1, beg2, seq1, seq2):
Martin@482
    64
    '''Get the gapless blocks of an alignment, from MAF format.'''
Martin@482
    65
    size = 0
Martin@482
    66
    for x, y in itertools.izip(seq1, seq2):
Martin@482
    67
        if x == "-":
Martin@482
    68
            if size:
Martin@482
    69
                yield beg1, beg2, size
Martin@482
    70
                beg1 += size
Martin@482
    71
                beg2 += size
Martin@482
    72
                size = 0
Martin@482
    73
            beg2 += 1
Martin@482
    74
        elif y == "-":
Martin@482
    75
            if size:
Martin@482
    76
                yield beg1, beg2, size
Martin@482
    77
                beg1 += size
Martin@482
    78
                beg2 += size
Martin@482
    79
                size = 0
Martin@482
    80
            beg1 += 1
Martin@272
    81
        else:
Martin@482
    82
            size += 1
Martin@482
    83
    if size: yield beg1, beg2, size
Martin@272
    84
Martin@482
    85
def alignmentInput(lines):
Martin@482
    86
    '''Get alignments and sequence lengths, from MAF or tabular format.'''
Martin@482
    87
    mafCount = 0
Martin@272
    88
    for line in lines:
Martin@272
    89
        w = line.split()
Martin@272
    90
        if line[0].isdigit():  # tabular format
Martin@482
    91
            chr1, beg1, seqlen1 = w[1], int(w[2]), int(w[5])
Martin@482
    92
            if w[4] == "-": beg1 -= seqlen1
Martin@482
    93
            chr2, beg2, seqlen2 = w[6], int(w[7]), int(w[10])
Martin@482
    94
            if w[9] == "-": beg2 -= seqlen2
Martin@847
    95
            blocks = tabBlocks(beg1, beg2, w[11])
Martin@482
    96
            yield chr1, seqlen1, chr2, seqlen2, blocks
Martin@272
    97
        elif line[0] == "s":  # MAF format
Martin@482
    98
            if mafCount == 0:
Martin@482
    99
                chr1, beg1, seqlen1, seq1 = w[1], int(w[2]), int(w[5]), w[6]
Martin@482
   100
                if w[4] == "-": beg1 -= seqlen1
Martin@482
   101
                mafCount = 1
Martin@482
   102
            else:
Martin@482
   103
                chr2, beg2, seqlen2, seq2 = w[1], int(w[2]), int(w[5]), w[6]
Martin@482
   104
                if w[4] == "-": beg2 -= seqlen2
Martin@847
   105
                blocks = mafBlocks(beg1, beg2, seq1, seq2)
Martin@482
   106
                yield chr1, seqlen1, chr2, seqlen2, blocks
Martin@482
   107
                mafCount = 0
Martin@272
   108
Martin@897
   109
def seqRequestFromText(text):
Martin@840
   110
    if ":" in text:
Martin@840
   111
        pattern, interval = text.rsplit(":", 1)
Martin@840
   112
        if "-" in interval:
Martin@840
   113
            beg, end = interval.rsplit("-", 1)
Martin@840
   114
            return pattern, int(beg), int(end)  # beg may be negative
Martin@840
   115
    return text, 0, sys.maxsize
Martin@840
   116
Martin@897
   117
def rangeFromSeqName(seqRequests, name, seqLen):
Martin@897
   118
    if not seqRequests: return 0, seqLen
Martin@651
   119
    base = name.split(".")[-1]  # allow for names like hg19.chr7
Martin@897
   120
    for pat, beg, end in seqRequests:
Martin@896
   121
        if fnmatchcase(name, pat) or fnmatchcase(base, pat):
Martin@840
   122
            return max(beg, 0), min(end, seqLen)
Martin@844
   123
    return None
Martin@651
   124
Martin@851
   125
def updateSeqs(isTrim, seqNames, seqLimits, seqName, seqRange, blocks, index):
Martin@851
   126
    if seqName not in seqLimits:
Martin@851
   127
        seqNames.append(seqName)
Martin@839
   128
    if isTrim:
Martin@839
   129
        beg = blocks[0][index]
Martin@839
   130
        end = blocks[-1][index] + blocks[-1][2]
Martin@839
   131
        if beg < 0: beg, end = -end, -beg
Martin@839
   132
        if seqName in seqLimits:
Martin@839
   133
            b, e = seqLimits[seqName]
Martin@839
   134
            seqLimits[seqName] = min(b, beg), max(e, end)
Martin@839
   135
        else:
Martin@839
   136
            seqLimits[seqName] = beg, end
Martin@839
   137
    else:
Martin@840
   138
        seqLimits[seqName] = seqRange
Martin@839
   139
Martin@651
   140
def readAlignments(fileName, opts):
Martin@839
   141
    '''Get alignments and sequence limits, from MAF or tabular format.'''
Martin@897
   142
    seqRequests1 = map(seqRequestFromText, opts.seq1)
Martin@897
   143
    seqRequests2 = map(seqRequestFromText, opts.seq2)
Martin@840
   144
Martin@482
   145
    alignments = []
Martin@851
   146
    seqNames1 = []
Martin@851
   147
    seqNames2 = []
Martin@839
   148
    seqLimits1 = {}
Martin@839
   149
    seqLimits2 = {}
Martin@844
   150
    lines = myOpen(fileName)
Martin@838
   151
    for seqName1, seqLen1, seqName2, seqLen2, blocks in alignmentInput(lines):
Martin@897
   152
        range1 = rangeFromSeqName(seqRequests1, seqName1, seqLen1)
Martin@844
   153
        if not range1: continue
Martin@897
   154
        range2 = rangeFromSeqName(seqRequests2, seqName2, seqLen2)
Martin@844
   155
        if not range2: continue
Martin@847
   156
        b = list(croppedBlocks(list(blocks), range1, range2))
Martin@840
   157
        if not b: continue
Martin@840
   158
        aln = seqName1, seqName2, b
Martin@482
   159
        alignments.append(aln)
Martin@851
   160
        updateSeqs(opts.trim1, seqNames1, seqLimits1, seqName1, range1, b, 0)
Martin@851
   161
        updateSeqs(opts.trim2, seqNames2, seqLimits2, seqName2, range2, b, 1)
Martin@851
   162
    return alignments, seqNames1, seqNames2, seqLimits1, seqLimits2
Martin@1
   163
Martin@1
   164
def natural_sort_key(my_string):
Martin@1
   165
    '''Return a sort key for "natural" ordering, e.g. chr9 < chr10.'''
Martin@1
   166
    parts = re.split(r'(\d+)', my_string)
Martin@1
   167
    parts[1::2] = map(int, parts[1::2])
Martin@1
   168
    return parts
Martin@1
   169
Martin@898
   170
def prettyNum(n):
Martin@898
   171
    t = str(n)
Martin@898
   172
    groups = []
Martin@898
   173
    while t:
Martin@898
   174
        groups.append(t[-3:])
Martin@898
   175
        t = t[:-3]
Martin@904
   176
    return ",".join(reversed(groups))
Martin@898
   177
Martin@846
   178
def sizeText(size):
Martin@846
   179
    suffixes = "bp", "kb", "Mb", "Gb"
Martin@846
   180
    for i, x in enumerate(suffixes):
Martin@846
   181
        j = 10 ** (i * 3)
Martin@846
   182
        if size < j * 10:
Martin@846
   183
            return "%.2g" % (1.0 * size / j) + x
Martin@846
   184
        if size < j * 1000 or i == len(suffixes) - 1:
Martin@846
   185
            return "%.0f" % (1.0 * size / j) + x
Martin@846
   186
Martin@898
   187
def labelText(seqRange, labelOpt):
Martin@898
   188
    seqName, beg, end = seqRange
Martin@898
   189
    if labelOpt == 1:
Martin@898
   190
        return seqName + ": " + sizeText(end - beg)
Martin@898
   191
    if labelOpt == 2:
Martin@904
   192
        return seqName + ":" + prettyNum(beg) + ": " + sizeText(end - beg)
Martin@898
   193
    if labelOpt == 3:
Martin@904
   194
        return seqName + ":" + prettyNum(beg) + "-" + prettyNum(end)
Martin@898
   195
    return seqName
Martin@846
   196
Martin@899
   197
def rangeLabels(seqRanges, labelOpt, font, fontsize, image_mode, textRot):
Martin@899
   198
    if fontsize:
Martin@899
   199
        image_size = 1, 1
Martin@899
   200
        im = Image.new(image_mode, image_size)
Martin@899
   201
        draw = ImageDraw.Draw(im)
Martin@899
   202
    x = y = 0
Martin@899
   203
    for r in seqRanges:
Martin@899
   204
        text = labelText(r, labelOpt)
Martin@899
   205
        if fontsize:
Martin@899
   206
            x, y = draw.textsize(text, font=font)
Martin@899
   207
            if textRot:
Martin@899
   208
                x, y = y, x
Martin@899
   209
        yield text, x, y
Martin@899
   210
Martin@851
   211
def getSeqInfo(sortOpt, seqNames, seqLimits,
Martin@898
   212
               font, fontsize, image_mode, labelOpt, textRot):
Martin@1
   213
    '''Return miscellaneous information about the sequences.'''
Martin@851
   214
    if sortOpt == 1:
Martin@851
   215
        seqNames.sort(key=natural_sort_key)
Martin@850
   216
    seqSizes = [seqLimits[i][1] - seqLimits[i][0] for i in seqNames]
Martin@866
   217
    for i in seqNames:
Martin@866
   218
        r = seqLimits[i]
Martin@866
   219
        out = i, str(r[0]), str(r[1])
Martin@866
   220
        warn("\t".join(out))
Martin@866
   221
    warn("")
Martin@851
   222
    if sortOpt == 2:
Martin@851
   223
        seqRecords = sorted(zip(seqSizes, seqNames), reverse=True)
Martin@851
   224
        seqSizes = [i[0] for i in seqRecords]
Martin@851
   225
        seqNames = [i[1] for i in seqRecords]
Martin@898
   226
    seqRanges = [(i, seqLimits[i][0], seqLimits[i][1]) for i in seqNames]
Martin@899
   227
    labelData = list(rangeLabels(seqRanges, labelOpt,
Martin@899
   228
                                 font, fontsize, image_mode, textRot))
Martin@899
   229
    margin = max(i[2] for i in labelData)
Martin@878
   230
    # xxx the margin may be too big, because some labels may get omitted
Martin@899
   231
    return seqNames, seqSizes, labelData, margin
Martin@1
   232
Martin@1
   233
def div_ceil(x, y):
Martin@1
   234
    '''Return x / y rounded up.'''
Martin@1
   235
    q, r = divmod(x, y)
Martin@1
   236
    return q + (r != 0)
Martin@1
   237
Martin@896
   238
def get_bp_per_pix(rangeSizes, pixTweenRanges, maxPixels):
Martin@1
   239
    '''Get the minimum bp-per-pixel that fits in the size limit.'''
Martin@904
   240
    warn("choosing bp per pixel...")
Martin@896
   241
    numOfRanges = len(rangeSizes)
Martin@896
   242
    maxPixelsInRanges = maxPixels - pixTweenRanges * (numOfRanges - 1)
Martin@896
   243
    if maxPixelsInRanges < numOfRanges:
Martin@649
   244
        raise Exception("can't fit the image: too many sequences?")
Martin@896
   245
    negLimit = -maxPixelsInRanges
Martin@896
   246
    negBpPerPix = sum(rangeSizes) // negLimit
Martin@863
   247
    while True:
Martin@896
   248
        if sum(i // negBpPerPix for i in rangeSizes) >= negLimit:
Martin@863
   249
            return -negBpPerPix
Martin@863
   250
        negBpPerPix -= 1
Martin@1
   251
Martin@900
   252
def getRangePixBegs(rangePixLens, pixTweenRanges, margin):
Martin@900
   253
    '''Get the start pixel for each range.'''
Martin@900
   254
    rangePixBegs = []
Martin@896
   255
    pix_tot = margin - pixTweenRanges
Martin@900
   256
    for i in rangePixLens:
Martin@896
   257
        pix_tot += pixTweenRanges
Martin@900
   258
        rangePixBegs.append(pix_tot)
Martin@1
   259
        pix_tot += i
Martin@900
   260
    return rangePixBegs
Martin@1
   261
Martin@896
   262
def pixelData(rangeSizes, bp_per_pix, pixTweenRanges, margin):
Martin@900
   263
    '''Return pixel information about the ranges.'''
Martin@900
   264
    rangePixLens = [div_ceil(i, bp_per_pix) for i in rangeSizes]
Martin@900
   265
    rangePixBegs = getRangePixBegs(rangePixLens, pixTweenRanges, margin)
Martin@900
   266
    tot_pix = rangePixBegs[-1] + rangePixLens[-1]
Martin@900
   267
    return rangePixBegs, rangePixLens, tot_pix
Martin@1
   268
Martin@835
   269
def drawLineForward(hits, width, bp_per_pix, beg1, beg2, size):
Martin@639
   270
    while True:
Martin@639
   271
        q1, r1 = divmod(beg1, bp_per_pix)
Martin@639
   272
        q2, r2 = divmod(beg2, bp_per_pix)
Martin@835
   273
        hits[q2 * width + q1] |= 1
Martin@639
   274
        next_pix = min(bp_per_pix - r1, bp_per_pix - r2)
Martin@639
   275
        if next_pix >= size: break
Martin@639
   276
        beg1 += next_pix
Martin@639
   277
        beg2 += next_pix
Martin@639
   278
        size -= next_pix
Martin@639
   279
Martin@835
   280
def drawLineReverse(hits, width, bp_per_pix, beg1, beg2, size):
Martin@639
   281
    beg2 = -1 - beg2
Martin@639
   282
    while True:
Martin@639
   283
        q1, r1 = divmod(beg1, bp_per_pix)
Martin@639
   284
        q2, r2 = divmod(beg2, bp_per_pix)
Martin@835
   285
        hits[q2 * width + q1] |= 2
Martin@639
   286
        next_pix = min(bp_per_pix - r1, r2 + 1)
Martin@639
   287
        if next_pix >= size: break
Martin@639
   288
        beg1 += next_pix
Martin@639
   289
        beg2 -= next_pix
Martin@639
   290
        size -= next_pix
Martin@639
   291
Martin@836
   292
def alignmentPixels(width, height, alignments, bp_per_pix, origins1, origins2):
Martin@640
   293
    hits = [0] * (width * height)  # the image data
Martin@640
   294
    for seq1, seq2, blocks in alignments:
Martin@836
   295
        ori1 = origins1[seq1]
Martin@836
   296
        ori2 = origins2[seq2]
Martin@640
   297
        for beg1, beg2, size in blocks:
Martin@640
   298
            if beg1 < 0:
Martin@640
   299
                beg1 = -(beg1 + size)
Martin@640
   300
                beg2 = -(beg2 + size)
Martin@640
   301
            if beg2 >= 0:
Martin@835
   302
                drawLineForward(hits, width, bp_per_pix,
Martin@835
   303
                                beg1 + ori1, beg2 + ori2, size)
Martin@640
   304
            else:
Martin@835
   305
                drawLineReverse(hits, width, bp_per_pix,
Martin@835
   306
                                beg1 + ori1, beg2 - ori2, size)
Martin@640
   307
    return hits
Martin@1
   308
Martin@650
   309
def expandedSeqDict(seqDict):
Martin@650
   310
    '''Allow lookup by short sequence names, e.g. chr7 as well as hg19.chr7.'''
Martin@861
   311
    newDict = seqDict.copy()
Martin@650
   312
    for name, x in seqDict.items():
Martin@861
   313
        if "." in name:
Martin@861
   314
            base = name.split(".")[-1]
Martin@861
   315
            if base in newDict:  # an ambiguous case was found:
Martin@861
   316
                return seqDict   # so give up completely
Martin@861
   317
            newDict[base] = x
Martin@650
   318
    return newDict
Martin@650
   319
Martin@845
   320
def readBed(fileName, seqLimits):
Martin@845
   321
    for line in myOpen(fileName):
Martin@845
   322
        w = line.split()
Martin@847
   323
        if not w: continue
Martin@845
   324
        seqName = w[0]
Martin@845
   325
        if seqName not in seqLimits: continue
Martin@845
   326
        beg = int(w[1])
Martin@845
   327
        end = int(w[2])
Martin@857
   328
        layer = 900
Martin@895
   329
        color = "#fbf"
Martin@858
   330
        if len(w) > 4:
Martin@858
   331
            if w[4] != ".":
Martin@858
   332
                layer = float(w[4])
Martin@858
   333
            if len(w) > 5:
Martin@858
   334
                if len(w) > 8 and w[8].count(",") == 2:
Martin@858
   335
                    color = "rgb(" + w[8] + ")"
Martin@858
   336
                elif w[5] == "+":
Martin@895
   337
                    color = "#ffe8e8"
Martin@858
   338
                elif w[5] == "-":
Martin@895
   339
                    color = "#e8e8ff"
Martin@859
   340
        yield layer, color, seqName, beg, end
Martin@845
   341
Martin@860
   342
def commaSeparatedInts(text):
Martin@860
   343
    return map(int, text.rstrip(",").split(","))
Martin@860
   344
Martin@860
   345
def readGenePred(opts, fileName, seqLimits):
Martin@860
   346
    for line in myOpen(fileName):
Martin@860
   347
        fields = line.split()
Martin@860
   348
        if not fields: continue
Martin@860
   349
        if fields[2] not in "+-": fields = fields[1:]
Martin@860
   350
        seqName = fields[1]
Martin@860
   351
        if seqName not in seqLimits: continue
Martin@860
   352
        #strand = fields[2]
Martin@860
   353
        cdsBeg = int(fields[5])
Martin@860
   354
        cdsEnd = int(fields[6])
Martin@860
   355
        exonBegs = commaSeparatedInts(fields[8])
Martin@860
   356
        exonEnds = commaSeparatedInts(fields[9])
Martin@860
   357
        for beg, end in zip(exonBegs, exonEnds):
Martin@860
   358
            yield 300, opts.exon_color, seqName, beg, end
Martin@860
   359
            b = max(beg, cdsBeg)
Martin@860
   360
            e = min(end, cdsEnd)
Martin@860
   361
            if b < e: yield 400, opts.cds_color, seqName, b, e
Martin@860
   362
Martin@860
   363
def readRmsk(fileName, seqLimits):
Martin@860
   364
    for line in myOpen(fileName):
Martin@860
   365
        fields = line.split()
Martin@860
   366
        if len(fields) == 17:  # rmsk.txt
Martin@860
   367
            seqName = fields[5]
Martin@860
   368
            if seqName not in seqLimits: continue  # do this ASAP for speed
Martin@860
   369
            beg = int(fields[6])
Martin@860
   370
            end = int(fields[7])
Martin@860
   371
            strand = fields[9]
Martin@860
   372
            repeatClass = fields[11]
Martin@860
   373
        elif len(fields) == 15:  # .out
Martin@860
   374
            seqName = fields[4]
Martin@860
   375
            if seqName not in seqLimits: continue
Martin@860
   376
            beg = int(fields[5]) - 1
Martin@860
   377
            end = int(fields[6])
Martin@860
   378
            strand = fields[8]
Martin@860
   379
            repeatClass = fields[10]
Martin@860
   380
        else:
Martin@860
   381
            continue
Martin@860
   382
        if repeatClass in ("Low_complexity", "Simple_repeat"):
Martin@895
   383
            yield 200, "#fbf", seqName, beg, end
Martin@860
   384
        elif strand == "+":
Martin@895
   385
            yield 100, "#ffe8e8", seqName, beg, end
Martin@860
   386
        else:
Martin@895
   387
            yield 100, "#e8e8ff", seqName, beg, end
Martin@860
   388
Martin@650
   389
def isExtraFirstGapField(fields):
Martin@650
   390
    return fields[4].isdigit()
Martin@650
   391
Martin@857
   392
def readGaps(opts, fileName, seqLimits):
Martin@650
   393
    '''Read locations of unsequenced gaps, from an agp or gap file.'''
Martin@844
   394
    for line in myOpen(fileName):
Martin@650
   395
        w = line.split()
Martin@650
   396
        if not w or w[0][0] == "#": continue
Martin@650
   397
        if isExtraFirstGapField(w): w = w[1:]
Martin@650
   398
        if w[4] not in "NU": continue
Martin@650
   399
        seqName = w[0]
Martin@839
   400
        if seqName not in seqLimits: continue
Martin@650
   401
        end = int(w[2])
Martin@650
   402
        beg = end - int(w[5])  # zero-based coordinate
Martin@857
   403
        if w[7] == "yes":
Martin@859
   404
            yield 3000, opts.bridged_color, seqName, beg, end
Martin@857
   405
        else:
Martin@859
   406
            yield 2000, opts.unbridged_color, seqName, beg, end
Martin@650
   407
Martin@859
   408
def bedBoxes(beds, seqLimits, origins, margin, edge, isTop, bpPerPix):
Martin@897
   409
    for layer, color, seqName, bedBeg, bedEnd in beds:
Martin@859
   410
        cropBeg, cropEnd = seqLimits[seqName]
Martin@897
   411
        beg = max(bedBeg, cropBeg)
Martin@897
   412
        end = min(bedEnd, cropEnd)
Martin@859
   413
        if beg >= end: continue
Martin@845
   414
        ori = origins[seqName]
Martin@857
   415
        if layer <= 1000:
Martin@857
   416
            # include partly-covered pixels
Martin@857
   417
            b = (ori + beg) // bpPerPix
Martin@857
   418
            e = div_ceil(ori + end, bpPerPix)
Martin@857
   419
        else:
Martin@857
   420
            # exclude partly-covered pixels
Martin@857
   421
            b = div_ceil(ori + beg, bpPerPix)
Martin@857
   422
            e = (ori + end) // bpPerPix
Martin@857
   423
            if e <= b: continue
Martin@857
   424
        if isTop:
Martin@857
   425
            box = b, margin, e, edge
Martin@857
   426
        else:
Martin@857
   427
            box = margin, b, edge, e
Martin@857
   428
        yield layer, color, box
Martin@845
   429
Martin@857
   430
def drawAnnotations(im, boxes):
Martin@857
   431
    # xxx use partial transparency for different-color overlaps?
Martin@857
   432
    for layer, color, box in boxes:
Martin@650
   433
        im.paste(color, box)
Martin@650
   434
Martin@901
   435
def placedLabels(labels, rangePixBegs, rangePixLens, beg, end):
Martin@901
   436
    '''Return axis labels with endpoint & sort-order information.'''
Martin@901
   437
    maxWidth = end - beg
Martin@901
   438
    for i, j, k in zip(labels, rangePixBegs, rangePixLens):
Martin@901
   439
        text, textWidth, textHeight = i
Martin@901
   440
        if textWidth > maxWidth:
Martin@901
   441
            continue
Martin@901
   442
        labelBeg = j + (k - textWidth) // 2
Martin@901
   443
        labelEnd = labelBeg + textWidth
Martin@901
   444
        sortKey = textWidth - k
Martin@901
   445
        if labelBeg < beg:
Martin@904
   446
            sortKey += maxWidth * (beg - labelBeg)
Martin@901
   447
            labelBeg = beg
Martin@901
   448
            labelEnd = beg + textWidth
Martin@901
   449
        if labelEnd > end:
Martin@904
   450
            sortKey += maxWidth * (labelEnd - end)
Martin@901
   451
            labelEnd = end
Martin@901
   452
            labelBeg = end - textWidth
Martin@901
   453
        yield sortKey, labelBeg, labelEnd, text, textHeight
Martin@1
   454
Martin@897
   455
def nonoverlappingLabels(labels, minPixTweenLabels):
Martin@1
   456
    '''Get a subset of non-overlapping axis labels, greedily.'''
Martin@897
   457
    out = []
Martin@1
   458
    for i in labels:
Martin@897
   459
        beg = i[1] - minPixTweenLabels
Martin@897
   460
        end = i[2] + minPixTweenLabels
Martin@897
   461
        if all(j[2] <= beg or j[1] >= end for j in out):
Martin@897
   462
            out.append(i)
Martin@897
   463
    return out
Martin@1
   464
Martin@901
   465
def axisImage(labels, rangePixBegs, rangePixLens, textRot,
Martin@895
   466
              textAln, font, image_mode, opts):
Martin@1
   467
    '''Make an image of axis labels.'''
Martin@900
   468
    beg = rangePixBegs[0]
Martin@900
   469
    end = rangePixBegs[-1] + rangePixLens[-1]
Martin@901
   470
    margin = max(i[2] for i in labels)
Martin@901
   471
    labels = sorted(placedLabels(labels, rangePixBegs, rangePixLens, beg, end))
Martin@878
   472
    minPixTweenLabels = 0 if textRot else opts.label_space
Martin@897
   473
    labels = nonoverlappingLabels(labels, minPixTweenLabels)
Martin@897
   474
    image_size = (margin, end) if textRot else (end, margin)
Martin@895
   475
    im = Image.new(image_mode, image_size, opts.margin_color)
Martin@1
   476
    draw = ImageDraw.Draw(im)
Martin@1
   477
    for i in labels:
Martin@878
   478
        base = margin - i[4] if textAln else 0
Martin@878
   479
        position = (base, i[1]) if textRot else (i[1], base)
Martin@646
   480
        draw.text(position, i[3], font=font, fill=opts.text_color)
Martin@1
   481
    return im
Martin@1
   482
Martin@900
   483
def seqOrigins(seqNames, rangePixBegs, seqLimits, bp_per_pix):
Martin@900
   484
    for i, j in zip(seqNames, rangePixBegs):
Martin@839
   485
        yield i, bp_per_pix * j - seqLimits[i][0]
Martin@836
   486
Martin@903
   487
def getFont(opts):
Martin@903
   488
    if opts.fontfile:
Martin@903
   489
        return ImageFont.truetype(opts.fontfile, opts.fontsize)
Martin@903
   490
    fileNames = []
Martin@903
   491
    try:
Martin@903
   492
        x = ["fc-match", "-f%{file}", "arial"]
Martin@903
   493
        p = subprocess.Popen(x, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Martin@903
   494
        out, err = p.communicate()
Martin@903
   495
        fileNames.append(out)
Martin@903
   496
    except OSError as e:
Martin@903
   497
        warn("fc-match error: " + str(e))
Martin@903
   498
    fileNames.append("/Library/Fonts/Arial.ttf")  # for Mac
Martin@903
   499
    for i in fileNames:
Martin@903
   500
        try:
Martin@903
   501
            font = ImageFont.truetype(i, opts.fontsize)
Martin@903
   502
            warn("font: " + i)
Martin@903
   503
            return font
Martin@903
   504
        except IOError as e:
Martin@903
   505
            warn("font load error: " + str(e))
Martin@903
   506
    return ImageFont.load_default()
Martin@903
   507
Martin@648
   508
def lastDotplot(opts, args):
Martin@903
   509
    font = getFont(opts)
Martin@643
   510
    image_mode = 'RGB'
Martin@643
   511
    forward_color = ImageColor.getcolor(opts.forwardcolor, image_mode)
Martin@643
   512
    reverse_color = ImageColor.getcolor(opts.reversecolor, image_mode)
Martin@643
   513
    zipped_colors = zip(forward_color, reverse_color)
Martin@643
   514
    overlap_color = tuple([(i + j) // 2 for i, j in zipped_colors])
Martin@641
   515
Martin@644
   516
    warn("reading alignments...")
Martin@904
   517
    alnData = readAlignments(args[0], opts)
Martin@904
   518
    alignments, seqNames1, seqNames2, seqLimits1, seqLimits2 = alnData
Martin@644
   519
    warn("done")
Martin@649
   520
    if not alignments: raise Exception("there are no alignments")
Martin@641
   521
Martin@878
   522
    textRot1 = "vertical".startswith(opts.rot1)
Martin@851
   523
    i1 = getSeqInfo(opts.sort1, seqNames1, seqLimits1,
Martin@898
   524
                    font, opts.fontsize, image_mode, opts.labels1, textRot1)
Martin@899
   525
    seqNames1, rangeSizes1, labelData1, tMargin = i1
Martin@846
   526
Martin@878
   527
    textRot2 = "horizontal".startswith(opts.rot2)
Martin@851
   528
    i2 = getSeqInfo(opts.sort2, seqNames2, seqLimits2,
Martin@898
   529
                    font, opts.fontsize, image_mode, opts.labels2, textRot2)
Martin@899
   530
    seqNames2, rangeSizes2, labelData2, lMargin = i2
Martin@641
   531
Martin@896
   532
    maxPixels1 = opts.width  - lMargin
Martin@896
   533
    maxPixels2 = opts.height - tMargin
Martin@897
   534
    bpPerPix1 = get_bp_per_pix(rangeSizes1, opts.border_pixels, maxPixels1)
Martin@897
   535
    bpPerPix2 = get_bp_per_pix(rangeSizes2, opts.border_pixels, maxPixels2)
Martin@855
   536
    bpPerPix = max(bpPerPix1, bpPerPix2)
Martin@855
   537
    warn("bp per pixel = " + str(bpPerPix))
Martin@641
   538
Martin@900
   539
    p1 = pixelData(rangeSizes1, bpPerPix, opts.border_pixels, lMargin)
Martin@900
   540
    rangePixBegs1, rangePixLens1, width = p1
Martin@900
   541
Martin@900
   542
    p2 = pixelData(rangeSizes2, bpPerPix, opts.border_pixels, tMargin)
Martin@900
   543
    rangePixBegs2, rangePixLens2, height = p2
Martin@900
   544
Martin@847
   545
    warn("width:  " + str(width))
Martin@847
   546
    warn("height: " + str(height))
Martin@839
   547
Martin@900
   548
    origins1 = dict(seqOrigins(seqNames1, rangePixBegs1, seqLimits1, bpPerPix))
Martin@900
   549
    origins2 = dict(seqOrigins(seqNames2, rangePixBegs2, seqLimits2, bpPerPix))
Martin@641
   550
Martin@644
   551
    warn("processing alignments...")
Martin@855
   552
    hits = alignmentPixels(width, height, alignments, bpPerPix,
Martin@836
   553
                           origins1, origins2)
Martin@641
   554
Martin@904
   555
    warn("reading annotations...")
Martin@134
   556
Martin@845
   557
    seqLimits1 = expandedSeqDict(seqLimits1)
Martin@845
   558
    seqLimits2 = expandedSeqDict(seqLimits2)
Martin@836
   559
    origins1 = expandedSeqDict(origins1)
Martin@836
   560
    origins2 = expandedSeqDict(origins2)
Martin@845
   561
Martin@857
   562
    beds1 = itertools.chain(readBed(opts.bed1, seqLimits1),
Martin@860
   563
                            readRmsk(opts.rmsk1, seqLimits1),
Martin@860
   564
                            readGenePred(opts, opts.genePred1, seqLimits1),
Martin@857
   565
                            readGaps(opts, opts.gap1, seqLimits1))
Martin@877
   566
    b1 = bedBoxes(beds1, seqLimits1, origins1, tMargin, height, True, bpPerPix)
Martin@845
   567
Martin@857
   568
    beds2 = itertools.chain(readBed(opts.bed2, seqLimits2),
Martin@860
   569
                            readRmsk(opts.rmsk2, seqLimits2),
Martin@860
   570
                            readGenePred(opts, opts.genePred2, seqLimits2),
Martin@857
   571
                            readGaps(opts, opts.gap2, seqLimits2))
Martin@877
   572
    b2 = bedBoxes(beds2, seqLimits2, origins2, lMargin, width, False, bpPerPix)
Martin@857
   573
Martin@857
   574
    boxes = sorted(itertools.chain(b1, b2))
Martin@904
   575
Martin@904
   576
    warn("drawing...")
Martin@904
   577
Martin@904
   578
    image_size = width, height
Martin@904
   579
    im = Image.new(image_mode, image_size, opts.background_color)
Martin@904
   580
Martin@857
   581
    drawAnnotations(im, boxes)
Martin@650
   582
Martin@643
   583
    for i in range(height):
Martin@643
   584
        for j in range(width):
Martin@643
   585
            store_value = hits[i * width + j]
Martin@643
   586
            xy = j, i
Martin@643
   587
            if   store_value == 1: im.putpixel(xy, forward_color)
Martin@643
   588
            elif store_value == 2: im.putpixel(xy, reverse_color)
Martin@643
   589
            elif store_value == 3: im.putpixel(xy, overlap_color)
Martin@95
   590
Martin@643
   591
    if opts.fontsize != 0:
Martin@900
   592
        axis1 = axisImage(labelData1, rangePixBegs1, rangePixLens1,
Martin@895
   593
                          textRot1, False, font, image_mode, opts)
Martin@878
   594
        if textRot1:
Martin@878
   595
            axis1 = axis1.transpose(Image.ROTATE_90)
Martin@900
   596
        axis2 = axisImage(labelData2, rangePixBegs2, rangePixLens2,
Martin@895
   597
                          textRot2, textRot2, font, image_mode, opts)
Martin@878
   598
        if not textRot2:
Martin@878
   599
            axis2 = axis2.transpose(Image.ROTATE_270)
Martin@643
   600
        im.paste(axis1, (0, 0))
Martin@643
   601
        im.paste(axis2, (0, 0))
Martin@1
   602
Martin@900
   603
    for i in rangePixBegs1[1:]:
Martin@877
   604
        box = i - opts.border_pixels, tMargin, i, height
Martin@852
   605
        im.paste(opts.border_color, box)
Martin@1
   606
Martin@900
   607
    for i in rangePixBegs2[1:]:
Martin@877
   608
        box = lMargin, i - opts.border_pixels, width, i
Martin@852
   609
        im.paste(opts.border_color, box)
Martin@1
   610
Martin@643
   611
    im.save(args[1])
Martin@648
   612
Martin@648
   613
if __name__ == "__main__":
Martin@649
   614
    usage = """%prog --help
Martin@649
   615
   or: %prog [options] maf-or-tab-alignments dotplot.png
Martin@649
   616
   or: %prog [options] maf-or-tab-alignments dotplot.gif
Martin@649
   617
   or: ..."""
Martin@649
   618
    description = "Draw a dotplot of pair-wise sequence alignments in MAF or tabular format."
Martin@649
   619
    op = optparse.OptionParser(usage=usage, description=description)
Martin@866
   620
    op.add_option("-v", "--verbose", action="count",
Martin@866
   621
                  help="show progress messages & data about the plot")
Martin@651
   622
    op.add_option("-1", "--seq1", metavar="PATTERN", action="append",
Martin@840
   623
                  default=[],
Martin@651
   624
                  help="which sequences to show from the 1st genome")
Martin@651
   625
    op.add_option("-2", "--seq2", metavar="PATTERN", action="append",
Martin@840
   626
                  default=[],
Martin@651
   627
                  help="which sequences to show from the 2nd genome")
Martin@648
   628
    # Replace "width" & "height" with a single "length" option?
Martin@648
   629
    op.add_option("-x", "--width", type="int", default=1000,
Martin@648
   630
                  help="maximum width in pixels (default: %default)")
Martin@648
   631
    op.add_option("-y", "--height", type="int", default=1000,
Martin@648
   632
                  help="maximum height in pixels (default: %default)")
Martin@649
   633
    op.add_option("-c", "--forwardcolor", metavar="COLOR", default="red",
Martin@649
   634
                  help="color for forward alignments (default: %default)")
Martin@649
   635
    op.add_option("-r", "--reversecolor", metavar="COLOR", default="blue",
Martin@649
   636
                  help="color for reverse alignments (default: %default)")
Martin@851
   637
    op.add_option("--sort1", type="int", default=1, metavar="N",
Martin@851
   638
                  help="genome1 sequence order: 0=input order, 1=name order, "
Martin@851
   639
                  "2=length order (default=%default)")
Martin@851
   640
    op.add_option("--sort2", type="int", default=1, metavar="N",
Martin@851
   641
                  help="genome2 sequence order: 0=input order, 1=name order, "
Martin@851
   642
                  "2=length order (default=%default)")
Martin@839
   643
    op.add_option("--trim1", action="store_true",
Martin@839
   644
                  help="trim unaligned sequence flanks from the 1st genome")
Martin@839
   645
    op.add_option("--trim2", action="store_true",
Martin@839
   646
                  help="trim unaligned sequence flanks from the 2nd genome")
Martin@852
   647
    op.add_option("--border-pixels", metavar="INT", type="int", default=1,
Martin@852
   648
                  help="number of pixels between sequences (default=%default)")
Martin@895
   649
    op.add_option("--border-color", metavar="COLOR", default="black",
Martin@852
   650
                  help="color for pixels between sequences (default=%default)")
Martin@895
   651
    op.add_option("--margin-color", metavar="COLOR", default="#dcdcdc",
Martin@895
   652
                  help="margin color")
Martin@846
   653
Martin@850
   654
    og = optparse.OptionGroup(op, "Text options")
Martin@850
   655
    og.add_option("-f", "--fontfile", metavar="FILE",
Martin@850
   656
                  help="TrueType or OpenType font file")
Martin@903
   657
    og.add_option("-s", "--fontsize", metavar="SIZE", type="int", default=14,
Martin@850
   658
                  help="TrueType or OpenType font size (default: %default)")
Martin@898
   659
    og.add_option("--labels1", type="int", default=0, metavar="N", help=
Martin@898
   660
                  "genome1 labels: 0=name, 1=name:length, "
Martin@898
   661
                  "2=name:start:length, 3=name:start-end (default=%default)")
Martin@898
   662
    og.add_option("--labels2", type="int", default=0, metavar="N", help=
Martin@898
   663
                  "genome2 labels: 0=name, 1=name:length, "
Martin@898
   664
                  "2=name:start:length, 3=name:start-end (default=%default)")
Martin@878
   665
    og.add_option("--rot1", metavar="ROT", default="h",
Martin@878
   666
                  help="text rotation for the 1st genome (default=%default)")
Martin@878
   667
    og.add_option("--rot2", metavar="ROT", default="v",
Martin@878
   668
                  help="text rotation for the 2nd genome (default=%default)")
Martin@850
   669
    op.add_option_group(og)
Martin@850
   670
Martin@860
   671
    og = optparse.OptionGroup(op, "Annotation options")
Martin@860
   672
    og.add_option("--bed1", metavar="FILE",
Martin@860
   673
                  help="read genome1 annotations from BED file")
Martin@860
   674
    og.add_option("--bed2", metavar="FILE",
Martin@860
   675
                  help="read genome2 annotations from BED file")
Martin@860
   676
    og.add_option("--rmsk1", metavar="FILE", help="read genome1 repeats from "
Martin@860
   677
                  "RepeatMasker .out or rmsk.txt file")
Martin@860
   678
    og.add_option("--rmsk2", metavar="FILE", help="read genome2 repeats from "
Martin@860
   679
                  "RepeatMasker .out or rmsk.txt file")
Martin@860
   680
    op.add_option_group(og)
Martin@860
   681
Martin@860
   682
    og = optparse.OptionGroup(op, "Gene options")
Martin@860
   683
    og.add_option("--genePred1", metavar="FILE",
Martin@860
   684
                  help="read genome1 genes from genePred file")
Martin@860
   685
    og.add_option("--genePred2", metavar="FILE",
Martin@860
   686
                  help="read genome2 genes from genePred file")
Martin@895
   687
    og.add_option("--exon-color", metavar="COLOR", default="PaleGreen",
Martin@860
   688
                  help="color for exons (default=%default)")
Martin@895
   689
    og.add_option("--cds-color", metavar="COLOR", default="LimeGreen",
Martin@860
   690
                  help="color for protein-coding regions (default=%default)")
Martin@860
   691
    op.add_option_group(og)
Martin@860
   692
Martin@650
   693
    og = optparse.OptionGroup(op, "Unsequenced gap options")
Martin@650
   694
    og.add_option("--gap1", metavar="FILE",
Martin@650
   695
                  help="read genome1 unsequenced gaps from agp or gap file")
Martin@650
   696
    og.add_option("--gap2", metavar="FILE",
Martin@650
   697
                  help="read genome2 unsequenced gaps from agp or gap file")
Martin@650
   698
    og.add_option("--bridged-color", metavar="COLOR", default="yellow",
Martin@650
   699
                  help="color for bridged gaps (default: %default)")
Martin@895
   700
    og.add_option("--unbridged-color", metavar="COLOR", default="orange",
Martin@650
   701
                  help="color for unbridged gaps (default: %default)")
Martin@650
   702
    op.add_option_group(og)
Martin@648
   703
    (opts, args) = op.parse_args()
Martin@648
   704
    if len(args) != 2: op.error("2 arguments needed")
Martin@648
   705
Martin@648
   706
    opts.text_color = "black"
Martin@648
   707
    opts.background_color = "white"
Martin@648
   708
    opts.label_space = 5     # minimum number of pixels between axis labels
Martin@648
   709
Martin@649
   710
    try: lastDotplot(opts, args)
Martin@649
   711
    except KeyboardInterrupt: pass  # avoid silly error message
Martin@903
   712
    except Exception as e:
Martin@649
   713
        prog = os.path.basename(sys.argv[0])
Martin@649
   714
        sys.exit(prog + ": error: " + str(e))