cairo_draw.py 95.6 KB
Newer Older
Tiago Peixoto's avatar
Tiago Peixoto committed
1
2
3
4
5
#! /usr/bin/env python
# -*- coding: utf-8 -*-
#
# graph_tool -- a general graph manipulation python module
#
Tiago Peixoto's avatar
Tiago Peixoto committed
6
# Copyright (C) 2006-2016 Tiago de Paula Peixoto <tiago@skewed.de>
Tiago Peixoto's avatar
Tiago Peixoto committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

21
from __future__ import division, absolute_import, print_function
22
23
24
import sys
if sys.version_info < (3,):
    range = xrange
25
26
else:
    unicode = str
27

Tiago Peixoto's avatar
Tiago Peixoto committed
28
29
import os
import warnings
30
import numpy
Tiago Peixoto's avatar
Tiago Peixoto committed
31

32
from .. topology import shortest_distance, is_bipartite
33
from .. import _check_prop_scalar
34

Tiago Peixoto's avatar
Tiago Peixoto committed
35
36
37
try:
    import cairo
except ImportError:
38
    msg = "Error importing cairo. Graph drawing will not work."
39
    warnings.warn(msg, RuntimeWarning)
40
    raise
Tiago Peixoto's avatar
Tiago Peixoto committed
41

Tiago Peixoto's avatar
Tiago Peixoto committed
42
default_cm = None
Tiago Peixoto's avatar
Tiago Peixoto committed
43
try:
44
45
    import matplotlib.artist
    import matplotlib.backends.backend_cairo
46
47
    import matplotlib.cm
    import matplotlib.colors
48
    from matplotlib.cbook import flatten
49
50
51
52
53
54
55
56
57
58
59
60
61
62
    default_clrs = [(0.5529411764705883, 0.8274509803921568, 0.7803921568627451, 1.0),
                    #(1.0, 1.0, 0.7019607843137254, 1.0),
                    (0.7450980392156863, 0.7294117647058823, 0.8549019607843137, 1.0),
                    (0.984313725490196, 0.5019607843137255, 0.4470588235294118, 1.0),
                    (0.5019607843137255, 0.6941176470588235, 0.8274509803921568, 1.0),
                    (0.9921568627450981, 0.7058823529411765, 0.3843137254901961, 1.0),
                    (0.7019607843137254, 0.8705882352941177, 0.4117647058823529, 1.0),
                    (0.9882352941176471, 0.803921568627451, 0.8980392156862745, 1.0),
                    (0.8509803921568627, 0.8509803921568627, 0.8509803921568627, 1.0),
                    (0.7372549019607844, 0.5019607843137255, 0.7411764705882353, 1.0),
                    (0.8, 0.9215686274509803, 0.7725490196078432, 1.0),
                    (1.0, 0.9294117647058824, 0.43529411764705883, 1.0)]
    default_cm = matplotlib.colors.LinearSegmentedColormap.from_list("Set3",
                                                                     default_clrs)
63
    is_draw_inline = 'inline' in matplotlib.get_backend()
64
    color_converter = matplotlib.colors.ColorConverter()
Tiago Peixoto's avatar
Tiago Peixoto committed
65
except ImportError:
66
    msg = "Error importing matplotlib module. Graph drawing will not work."
67
    warnings.warn(msg, RuntimeWarning)
68
    raise
Tiago Peixoto's avatar
Tiago Peixoto committed
69

70
71
try:
    import IPython.display
Tiago Peixoto's avatar
Tiago Peixoto committed
72
except ImportError:
73
74
    pass

Tiago Peixoto's avatar
Tiago Peixoto committed
75
76
77
78
import numpy as np
import gzip
import bz2
import zipfile
79
import copy
80
import io
Tiago Peixoto's avatar
Tiago Peixoto committed
81
82
from collections import defaultdict

83
from .. import Graph, GraphView, PropertyMap, ungroup_vector_property,\
84
     group_vector_property, _prop, _check_prop_vector, map_property_values
85

Tiago Peixoto's avatar
Tiago Peixoto committed
86
87
88
from .. stats import label_parallel_edges, label_self_loops

from .. dl_import import dl_import
89
dl_import("from . import libgraph_tool_draw")
Tiago Peixoto's avatar
Tiago Peixoto committed
90
try:
91
    from .libgraph_tool_draw import vertex_attrs, edge_attrs, vertex_shape,\
Tiago Peixoto's avatar
Tiago Peixoto committed
92
93
        edge_marker
except ImportError:
94
95
    msg = "Error importing cairo-based drawing library. " + \
        "Was graph-tool compiled with cairomm support?"
96
    warnings.warn(msg, RuntimeWarning)
Tiago Peixoto's avatar
Tiago Peixoto committed
97
98

from .. draw import sfdp_layout, random_layout, _avg_edge_distance, \
99
100
101
102
    coarse_graphs, radial_tree_layout, prop_to_size

from .. generation import graph_union
from .. topology import shortest_path
Tiago Peixoto's avatar
Tiago Peixoto committed
103
104
105

_vdefaults = {
    "shape": "circle",
106
107
    "color": (0.6, 0.6, 0.6, 0.8),
    "fill_color": (0.6470588235294118, 0.058823529411764705, 0.08235294117647059, 0.8),
Tiago Peixoto's avatar
Tiago Peixoto committed
108
    "size": 5,
109
    "aspect": 1.,
110
    "rotation": 0.,
111
    "anchor": 1,
Tiago Peixoto's avatar
Tiago Peixoto committed
112
113
114
    "pen_width": 0.8,
    "halo": 0,
    "halo_color": [0., 0., 1., 0.5],
115
    "halo_size": 1.5,
Tiago Peixoto's avatar
Tiago Peixoto committed
116
117
118
    "text": "",
    "text_color": [0., 0., 0., 1.],
    "text_position": -1.,
119
120
    "text_rotation": 0.,
    "text_offset": [0., 0.],
Tiago Peixoto's avatar
Tiago Peixoto committed
121
122
123
    "font_family": "serif",
    "font_slant": cairo.FONT_SLANT_NORMAL,
    "font_weight": cairo.FONT_WEIGHT_NORMAL,
124
    "font_size": 12.,
125
126
    "surface": None,
    "pie_fractions": [0.75, 0.25],
127
    "pie_colors": default_clrs # ('b', 'g', 'r', 'c', 'm', 'y', 'k')
Tiago Peixoto's avatar
Tiago Peixoto committed
128
129
130
    }

_edefaults = {
131
    "color": (0.1796875, 0.203125, 0.2109375, 0.8),
Tiago Peixoto's avatar
Tiago Peixoto committed
132
133
134
135
136
    "pen_width": 1,
    "start_marker": "none",
    "mid_marker": "none",
    "end_marker": "none",
    "marker_size": 4.,
137
    "mid_marker_pos": .5,
Tiago Peixoto's avatar
Tiago Peixoto committed
138
    "control_points": [],
Tiago Peixoto's avatar
Tiago Peixoto committed
139
    "gradient": [],
140
    "dash_style": [],
141
    "text": "",
142
    "text_color": (0., 0., 0., 1.),
143
144
145
146
147
148
    "text_distance": 5,
    "text_parallel": True,
    "font_family": "serif",
    "font_slant": cairo.FONT_SLANT_NORMAL,
    "font_weight": cairo.FONT_WEIGHT_NORMAL,
    "font_size": 12.,
149
150
    "sloppy": False,
    "seamless": False
Tiago Peixoto's avatar
Tiago Peixoto committed
151
152
    }

153
154
155
156
157
158
_vtypes = {
    "shape": "int",
    "color": "vector<double>",
    "fill_color": "vector<double>",
    "size": "double",
    "aspect": "double",
159
    "rotation": "double",
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    "anchor": "double",
    "pen_width": "double",
    "halo": "bool",
    "halo_color": "vector<double>",
    "halo_size": "double",
    "text": "string",
    "text_color": "vector<double>",
    "text_position": "double",
    "text_rotation": "double",
    "text_offset": "vector<double>",
    "font_family": "string",
    "font_slant": "int",
    "font_weight": "int",
    "font_size": "float",
    "surface": "object",
    "pie_fractions": "vector<double>",
    "pie_colors": "vector<double>"
    }

_etypes = {
    "color": "vector<double>",
    "pen_width": "double",
    "start_marker": "int",
    "mid_marker": "int",
    "end_marker": "int",
    "marker_size": "double",
    "mid_marker_pos": "double",
    "control_points": "vector<double>",
    "gradient": "vector<double>",
    "dash_style": "vector<double>",
    "text": "string",
    "text_color": "vector<double>",
    "text_distance": "double",
    "text_parallel": "bool",
    "font_family": "string",
    "font_slant": "int",
    "font_weight": "int",
    "font_size": "double",
    "sloppy": "bool",
    "seamless": "bool"
    }

for k in list(_vtypes.keys()):
    _vtypes[getattr(vertex_attrs, k)] = _vtypes[k]

for k in list(_etypes.keys()):
    _etypes[getattr(edge_attrs, k)] = _etypes[k]

Tiago Peixoto's avatar
Tiago Peixoto committed
208
209
210

def shape_from_prop(shape, enum):
    if isinstance(shape, PropertyMap):
211
        g = shape.get_graph()
Tiago Peixoto's avatar
Tiago Peixoto committed
212
        if shape.key_type() == "v":
213
214
            prop = g.new_vertex_property("int")
            descs = g.vertices()
Tiago Peixoto's avatar
Tiago Peixoto committed
215
        else:
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
            descs = g.edges()
            prop = g.new_edge_property("int")
        if shape.value_type() == "string":
            def conv(x):
                return int(getattr(enum, x))
            map_property_values(shape, prop, conv)
        else:
            rg = (min(enum.values.keys()),
                  max(enum.values.keys()))
            g.copy_property(shape, prop)
            if prop.fa.min() < rg[0]:
                prop.fa += rg[0]
            prop.fa -= rg[0]
            prop.fa %= rg[1] - rg[0] + 1
            prop.fa += rg[0]
Tiago Peixoto's avatar
Tiago Peixoto committed
231
        return prop
232
    if isinstance(shape, (str, unicode)):
233
        return int(getattr(enum, shape))
Tiago Peixoto's avatar
Tiago Peixoto committed
234
235
236
237
238
239
    else:
        return shape

    raise ValueError("Invalid value for attribute %s: %s" %
                     (repr(enum), repr(shape)))

240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
def open_file(name, mode="r"):
    name = os.path.expanduser(name)
    base, ext = os.path.splitext(name)
    if ext == ".gz":
        out = gzip.GzipFile(name, mode)
        name = base
    elif ext == ".bz2":
        out = bz2.BZ2File(name, mode)
        name = base
    elif ext == ".zip":
        out = zipfile.ZipFile(name, mode)
        name = base
    else:
        out = open(name, mode)
    fmt = os.path.splitext(name)[1].replace(".", "")
255
    return out, fmt
256

257
258
259
260
261
262
263
264
265
266
267
268
def get_file_fmt(name):
    name = os.path.expanduser(name)
    base, ext = os.path.splitext(name)
    if ext == ".gz":
        name = base
    elif ext == ".bz2":
        name = base
    elif ext == ".zip":
        name = base
    fmt = os.path.splitext(name)[1].replace(".", "")
    return fmt

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

def surface_from_prop(surface):
    if isinstance(surface, PropertyMap):
        if surface.key_type() == "v":
            prop = surface.get_graph().new_vertex_property("object")
            descs = surface.get_graph().vertices()
        else:
            descs = surface.get_graph().edges()
            prop = surface.get_graph().new_edge_property("object")
        surface_map = {}
        for v in descs:
            if surface.value_type() == "string":
                if surface[v] not in surface_map:
                    sfc = gen_surface(surface[v])
                    surface_map[surface[v]] = sfc
284
                prop[v] = surface_map[surface[v]]
285
286
287
            elif surface.value_type() == "python::object":
                if isinstance(surface[v], cairo.Surface):
                    prop[v] = surface[v]
288
                elif surface[v] is not None:
289
290
291
292
293
294
295
                    raise ValueError("Invalid value type for surface property: " +
                                     str(type(surface[v])))
            else:
                raise ValueError("Invalid value type for surface property: " +
                                 surface.value_type())
        return prop

296
    if isinstance(surface, (str, unicode)):
297
298
299
300
301
302
        return gen_surface(surface)
    elif isinstance(surface, cairo.Surface) or surface is None:
        return surface

    raise ValueError("Invalid value for attribute surface: " + repr(surface))

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def centered_rotation(g, pos, text_pos=True):
    x, y = ungroup_vector_property(pos, [0, 1])
    cm = (x.fa.mean(), y.fa.mean())
    dx = x.fa - cm[0]
    dy = y.fa - cm[0]
    angle = g.new_vertex_property("double")
    angle.fa = numpy.arctan2(dy, dx)
    pi = numpy.pi
    angle.fa += 2 * pi
    angle.fa %= 2 * pi
    if text_pos:
        idx = (angle.a > pi / 2 ) * (angle.a < 3 * pi / 2)
        tpos = g.new_vertex_property("double")
        angle.a[idx] += pi
        tpos.a[idx] = pi
        return angle, tpos
    return angle
Tiago Peixoto's avatar
Tiago Peixoto committed
320

321
def _convert(attr, val, cmap, pmap_default=False, g=None, k=None):
Tiago Peixoto's avatar
Tiago Peixoto committed
322
    if attr == vertex_attrs.shape:
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
        new_val = shape_from_prop(val, vertex_shape)
        if pmap_default and not isinstance(val, PropertyMap):
            new_val = g.new_vertex_property("int", new_val)
        return new_val
    elif attr == vertex_attrs.surface:
        new_val = surface_from_prop(val)
        if pmap_default and not isinstance(val, PropertyMap):
            new_val = g.new_vertex_property("python::object", new_val)
        return new_val
    elif attr in [edge_attrs.start_marker, edge_attrs.mid_marker,
                  edge_attrs.end_marker]:
        new_val = shape_from_prop(val, edge_marker)
        if pmap_default and not isinstance(val, PropertyMap):
            new_val = g.new_edge_property("int", new_val)
        return new_val
    elif attr in [vertex_attrs.pie_colors]:
339
340
341
        if isinstance(val, PropertyMap):
            if val.value_type() in ["vector<double>", "vector<long double>"]:
                return val
342
            if val.value_type() in ["vector<int32_t>", "vector<int64_t>", "vector<bool>"]:
343
344
                g = val.get_graph()
                new_val = g.new_vertex_property("vector<double>")
345
                rg = [numpy.inf, -numpy.inf]
346
347
                for v in g.vertices():
                    for x in val[v]:
348
349
                        rg[0] = min(x, rg[0])
                        rg[1] = max(x, rg[1])
350
351
                if rg[0] == rg[1]:
                    rg[1] = 1
352
353
                map_property_values(val, new_val,
                                    lambda y: flatten([cmap((x - rg[0]) / (rg[1] - rg[0])) for x in y]))
354
                return new_val
355
356
357
            if val.value_type() == "vector<string>":
                g = val.get_graph()
                new_val = g.new_vertex_property("vector<double>")
358
359
                map_property_values(val, new_val,
                                    lambda y: flatten([color_converter.to_rgba(x) for x in y]))
360
361
362
363
364
                return new_val
            if val.value_type() == "python::object":
                try:
                    g = val.get_graph()
                    new_val = g.new_vertex_property("vector<double>")
365
                    def conv(y):
366
                        try:
367
                            new_val[v] = [float(x) for x in flatten(y)]
368
                        except ValueError:
369
370
                            new_val[v] = flatten([color_converter.to_rgba(x) for x in y])
                    map_property_values(val, new_val, conv)
371
372
373
374
375
                    return new_val
                except ValueError:
                    pass
        else:
            try:
376
                new_val = [float(x) for x in flatten(val)]
377
378
            except ValueError:
                try:
379
380
                    new_val = flatten(color_convert.to_rgba(x) for x in val)
                    new_val = list(new_val)
381
382
                except ValueError:
                    pass
383
384
385
386
387
388
389
390
391
392
            if pmap_default:
                val_a = numpy.zeros((g.num_vertices(), len(new_val)))
                for i in range(len(new_val)):
                    val_a[:, i] = new_val[i]
                return g.new_vertex_property("vector<double>", val_a)
            else:
                return new_val
    elif attr in [vertex_attrs.color, vertex_attrs.fill_color,
                  vertex_attrs.text_color, vertex_attrs.halo_color,
                  edge_attrs.color, edge_attrs.text_color]:
Tiago Peixoto's avatar
Tiago Peixoto committed
393
        if isinstance(val, list):
394
395
396
            new_val = val
        elif isinstance(val, (tuple, np.ndarray)):
            new_val = list(val)
397
        elif isinstance(val, (str, unicode)):
398
399
            new_val = list(color_converter.to_rgba(val))
        elif isinstance(val, PropertyMap):
Tiago Peixoto's avatar
Tiago Peixoto committed
400
            if val.value_type() in ["vector<double>", "vector<long double>"]:
401
402
                new_val = val
            elif val.value_type() in ["int32_t", "int64_t", "double",
403
404
                                      "long double", "unsigned long",
                                      "unsigned int", "bool"]:
405
                g = val.get_graph()
Tiago Peixoto's avatar
Tiago Peixoto committed
406
407
408
                try:
                    vrange = [val.fa.min(), val.fa.max()]
                except ValueError:
409
410
411
412
                    #vertex index
                    vrange = [int(g.vertex(0, use_index=False)),
                              int(g.vertex(g.num_vertices() - 1,
                                           use_index=False))]
413
                cnorm = matplotlib.colors.Normalize(vmin=vrange[0],
Tiago Peixoto's avatar
Tiago Peixoto committed
414
                                                    vmax=vrange[1])
415
                g = val.get_graph()
Tiago Peixoto's avatar
Tiago Peixoto committed
416
                if val.key_type() == "v":
417
                    prop = g.new_vertex_property("vector<double>")
Tiago Peixoto's avatar
Tiago Peixoto committed
418
                else:
419
420
421
422
423
                    prop = g.new_edge_property("vector<double>")
                map_property_values(val, prop, lambda x: cmap(cnorm(x)))
                new_val = prop
            elif val.value_type() == "string":
                g = val.get_graph()
Tiago Peixoto's avatar
Tiago Peixoto committed
424
                if val.key_type() == "v":
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
                    prop = g.new_vertex_property("vector<double>")
                else:
                    prop = g.new_edge_property("vector<double>")
                map_property_values(val, prop,
                                    lambda x: color_converter.to_rgba(x))
                new_val = prop
            else:
                raise ValueError("Invalid value for attribute %s: %s" %
                                 (repr(attr), repr(val)))
        if pmap_default and not isinstance(val, PropertyMap):
            if attr in [vertex_attrs.color, vertex_attrs.fill_color,
                        vertex_attrs.text_color, vertex_attrs.halo_color]:
                val_a = numpy.zeros((g.num_vertices(),len(new_val)))
                for i in range(len(new_val)):
                    val_a[:, i] = new_val[i]
                return g.new_vertex_property("vector<double>", val_a)
            else:
                val_a = numpy.zeros((g.num_edges(), len(new_val)))
                for i in range(len(new_val)):
                    val_a[:,i] = new_val[i]
                return g.new_edge_property("vector<double>", val_a)
        else:
            return new_val

    if pmap_default and not isinstance(val, PropertyMap):
450
451
        if k == "v":
            new_val = g.new_vertex_property(_vtypes[attr], val=val)
452
        else:
453
            new_val = g.new_edge_property(_etypes[attr], val=val)
454
        return new_val
455

Tiago Peixoto's avatar
Tiago Peixoto committed
456
457
458
459
460
461
    return val


def _attrs(attrs, d, g, cmap):
    nattrs = {}
    defaults = {}
462
    for k, v in attrs.items():
Tiago Peixoto's avatar
Tiago Peixoto committed
463
464
        try:
            if d == "v":
465
                attr = getattr(vertex_attrs, k)
Tiago Peixoto's avatar
Tiago Peixoto committed
466
            else:
467
468
                attr = getattr(edge_attrs, k)
        except AttributeError:
469
            warnings.warn("Unknown attribute: " + str(k), UserWarning)
Tiago Peixoto's avatar
Tiago Peixoto committed
470
471
472
473
474
475
476
            continue
        if isinstance(v, PropertyMap):
            nattrs[int(attr)] = _prop(d, g, _convert(attr, v, cmap))
        else:
            defaults[int(attr)] = _convert(attr, v, cmap)
    return nattrs, defaults

477
478
479
480
481
def _convert_props(props, d, g, cmap, pmap_default=False):
    nprops = {}
    for k, v in props.items():
        try:
            if d == "v":
482
                attr = getattr(vertex_attrs, k)
483
            else:
484
                attr = getattr(edge_attrs, k)
485
486
            nprops[k] = _convert(attr, v, cmap, pmap_default=pmap_default,
                                 g=g, k=d)
487
        except AttributeError:
488
489
490
491
            warnings.warn("Unknown attribute: " + str(k), UserWarning)
            continue
    return nprops

Tiago Peixoto's avatar
Tiago Peixoto committed
492
493
494
495
496
497
498
499
500
501
502
503

def get_attr(attr, d, attrs, defaults):
    if attr in attrs:
        p = attrs[attr]
    else:
        p = defaults[attr]
    if isinstance(p, PropertyMap):
        return p[d]
    else:
        return p


504
505
def position_parallel_edges(g, pos, loop_angle=float("nan"),
                            parallel_distance=1):
Tiago Peixoto's avatar
Tiago Peixoto committed
506
507
    lp = label_parallel_edges(GraphView(g, directed=False))
    ll = label_self_loops(g)
508
509
510
    if isinstance(loop_angle, PropertyMap):
        angle = loop_angle
    else:
511
        angle = g.new_vertex_property("double", float(loop_angle))
512

Tiago Peixoto's avatar
Tiago Peixoto committed
513
    g = GraphView(g, directed=True)
514
515
    if ((len(lp.fa) == 0 or lp.fa.max() == 0) and
        (len(ll.fa) == 0 or ll.fa.max() == 0)):
Tiago Peixoto's avatar
Tiago Peixoto committed
516
517
518
519
        return []
    else:
        spline = g.new_edge_property("vector<double>")
        libgraph_tool_draw.put_parallel_splines(g._Graph__graph,
520
                                                _prop("v", g, pos),
Tiago Peixoto's avatar
Tiago Peixoto committed
521
                                                _prop("e", g, lp),
522
                                                _prop("e", g, spline),
523
                                                _prop("v", g, angle),
524
                                                parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
525
526
527
528
529
530
        return spline


def parse_props(prefix, args):
    props = {}
    others = {}
531
    for k, v in list(args.items()):
Tiago Peixoto's avatar
Tiago Peixoto committed
532
533
534
535
536
537
538
539
        if k.startswith(prefix + "_"):
            props[k.replace(prefix + "_", "")] = v
        else:
            others[k] = v
    return props, others


def cairo_draw(g, pos, cr, vprops=None, eprops=None, vorder=None, eorder=None,
540
               nodesfirst=False, vcmap=default_cm, ecmap=default_cm,
541
               loop_angle=numpy.nan, parallel_distance=None, fit_view=False,
542
               res=0, render_offset=0, max_render_time=-1, **kwargs):
Tiago Peixoto's avatar
Tiago Peixoto committed
543
    r"""
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
    Draw a graph to a :mod:`cairo` context.

    Parameters
    ----------
    g : :class:`~graph_tool.Graph`
        Graph to be drawn.
    pos : :class:`~graph_tool.PropertyMap`
        Vector-valued vertex property map containing the x and y coordinates of
        the vertices.
    cr : :class:`~cairo.Context`
        A :class:`~cairo.Context` instance.
    vprops : dict (optional, default: ``None``)
        Dictionary with the vertex properties. Individual properties may also be
        given via the ``vertex_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    eprops : dict (optional, default: ``None``)
560
        Dictionary with the edge properties. Individual properties may also be
561
562
563
564
565
566
567
568
        given via the ``edge_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    vorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the vertices are drawn.
    eorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the edges are drawn.
    nodesfirst : bool (optional, default: ``False``)
        If ``True``, the vertices are drawn first, otherwise the edges are.
569
    vcmap : :class:`matplotlib.colors.Colormap` (optional, default: :class:`default_cm`)
570
        Vertex color map.
571
    ecmap : :class:`matplotlib.colors.Colormap` (optional, default: :class:`default_cm`)
572
        Edge color map.
573
    loop_angle : float or :class:`~graph_tool.PropertyMap` (optional, default: ``nan``)
574
575
576
577
578
        Angle used to draw self-loops. If ``nan`` is given, they will be placed
        radially from the center of the layout.
    parallel_distance : float (optional, default: ``None``)
        Distance used between parallel edges. If not provided, it will be
        determined automatically.
579
    fit_view : bool or float or tuple (optional, default: ``True``)
580
        If ``True``, the layout will be scaled to fit the entire clip region.
581
        If a float value is given, it will be interpreted as ``True``, and in
582
583
584
        addition the viewport will be scaled out by that factor. If a tuple
        value is given, it should have four values ``(x, y, w, h)`` that
        specify the view in user coordinates.
585
586
    bg_color : str or sequence (optional, default: ``None``)
        Background color. The default is transparent.
587
588
589
590
591
592
593
594
595
    res : float (optional, default: ``0.``):
        If shape sizes fall below this value, simplified drawing is used.
    render_offset : int (optional, default: ``0``):
        If supplied, the rendering will skip the specified initial amount of
        vertices / edges.
    max_render_time : int (optional, default: ``-1``):
        Maximum allowed time (in milliseconds) for rendering. If exceeded, the
        rendering will return unfinished. If negative values are given, the
        rendering will always complete.
596
597
598
599
600
601
602
603
    vertex_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``vertex_<prop-name>`` specify the
        vertex property with name ``<prop-name>``, as an alternative to the
        ``vprops`` parameter.
    edge_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``edge_<prop-name>`` specify the edge
        property with name ``<prop-name>``, as an alternative to the ``eprops``
        parameter.
Tiago Peixoto's avatar
Tiago Peixoto committed
604

605
606
607
608
609
    Returns
    -------
    offset : int
        The offset into the completed rendering. If this value is zero, the
        rendering was complete.
Tiago Peixoto's avatar
Tiago Peixoto committed
610
611
    """

612
613
614
    if vorder is not None:
        _check_prop_scalar(vorder, name="vorder")

615
616
    vprops = {} if vprops is None else copy.copy(vprops)
    eprops = {} if eprops is None else copy.copy(eprops)
Tiago Peixoto's avatar
Tiago Peixoto committed
617
618
619
620
621
622
623
624

    props, kwargs = parse_props("vertex", kwargs)
    vprops.update(props)
    props, kwargs = parse_props("edge", kwargs)
    eprops.update(props)
    for k in kwargs:
        warnings.warn("Unknown parameter: " + k, UserWarning)

625
    cr.save()
626
    if fit_view != False:
627
628
        extents = cr.clip_extents()
        output_size = (extents[2] - extents[0], extents[3] - extents[1])
629
630
631
632
633
        try:
            x, y, w, h = fit_view
            cr.scale(output_size[0] / w, output_size[1] / h)
            cr.translate(-x, -y)
        except TypeError:
634
            pad = fit_view if fit_view != True else 0.95
635
636
637
638
639
640
641
642
            offset, zoom = fit_to_view(g, pos, output_size,
                                       vprops.get("size", _vdefaults["size"]),
                                       vprops.get("pen_width", _vdefaults["pen_width"]),
                                       None, vprops.get("text", None),
                                       vprops.get("font_family",
                                                  _vdefaults["font_family"]),
                                       vprops.get("font_size",
                                                  _vdefaults["font_size"]),
643
                                       pad, cr)
644
645
646
647
            cr.translate(offset[0], offset[1])
            if not isinstance(fit_view, bool):
                zoom /= fit_view
            cr.scale(zoom, zoom)
648

Tiago Peixoto's avatar
Tiago Peixoto committed
649
    if "control_points" not in eprops:
650
651
652
653
654
655
656
657
658
659
        if parallel_distance is None:
            parallel_distance = vprops.get("size", _vdefaults["size"])
            if isinstance(parallel_distance, PropertyMap):
                parallel_distance = parallel_distance.fa.mean()
            parallel_distance /= 1.5
            M = cr.get_matrix()
            scale = transform_scale(M, 1,)
            parallel_distance /= scale
        eprops["control_points"] = position_parallel_edges(g, pos, loop_angle,
                                                           parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
660
661
    if g.is_directed() and "end_marker" not in eprops:
        eprops["end_marker"] = "arrow"
662

663
664
665
666
667
    if vprops.get("text_position", None) == "centered":
        angle, tpos = centered_rotation(g, pos, text_pos=True)
        vprops["text_position"] = tpos
        vprops["text_rotation"] = angle

Tiago Peixoto's avatar
Tiago Peixoto committed
668
669
670
671
672
673
    vattrs, vdefaults = _attrs(vprops, "v", g, vcmap)
    eattrs, edefaults = _attrs(eprops, "e", g, ecmap)
    vdefs = _attrs(_vdefaults, "v", g, vcmap)[1]
    vdefs.update(vdefaults)
    edefs = _attrs(_edefaults, "e", g, ecmap)[1]
    edefs.update(edefaults)
674
675
676
677
678
679

    if "control_points" not in eprops:
        if parallel_distance is None:
            parallel_distance = _defaults
        eprops["control_points"] = position_parallel_edges(g, pos, loop_angle,
                                                           parallel_distance)
Tiago Peixoto's avatar
Tiago Peixoto committed
680
    g = GraphView(g, directed=True)
681
682
683
684
    count = libgraph_tool_draw.cairo_draw(g._Graph__graph, _prop("v", g, pos),
                                          _prop("v", g, vorder), _prop("e", g, eorder),
                                          nodesfirst, vattrs, eattrs, vdefs, edefs, res,
                                          render_offset, max_render_time, cr)
685
    cr.restore()
686
    return count
Tiago Peixoto's avatar
Tiago Peixoto committed
687

688
689
def color_contrast(color):
    c = np.asarray(color)
690
691
    y = c[0] * .299 + c[1] * .587 + c[2] * .114
    if y < .5:
692
693
694
695
696
697
698
        c[:3] = 1
    else:
        c[:3] = 0
    return c


def auto_colors(g, bg, pos, back):
699
    if not isinstance(bg, PropertyMap):
700
        if isinstance(bg, (str, unicode)):
701
            bg = color_converter.to_rgba(bg)
702
        bg = g.new_vertex_property("vector<double>", val=bg)
703
704
705
706
707
708
709
710
711
712
713
714
715
    if not isinstance(pos, PropertyMap):
        if pos == "centered":
            pos = 0
        pos = g.new_vertex_property("double", pos)
    bg_a = bg.get_2d_array(range(4))
    bgc_pos = numpy.zeros((g.num_vertices(), 5))
    for i in range(4):
        bgc_pos[:, i] = bg_a[i, :]
    bgc_pos[:, 4] = pos.fa
    bgc_pos = g.new_vertex_property("vector<double>", bgc_pos)
    def conv(x):
        bgc = x[:4]
        p = x[4]
716
        if p < 0:
717
            return color_contrast(bgc)
718
        else:
719
720
721
            return color_contrast(back)
    c = g.new_vertex_property("vector<double>")
    map_property_values(bgc_pos, c, conv)
722
723
    return c

Tiago Peixoto's avatar
Tiago Peixoto committed
724
725
def graph_draw(g, pos=None, vprops=None, eprops=None, vorder=None, eorder=None,
               nodesfirst=False, output_size=(600, 600), fit_view=True,
726
727
               inline=is_draw_inline, mplfig=None, output=None, fmt="auto",
               **kwargs):
728
729
730
731
732
733
734
735
736
737
738
739
740
741
    r"""Draw a graph to screen or to a file using :mod:`cairo`.

    Parameters
    ----------
    g : :class:`~graph_tool.Graph`
        Graph to be drawn.
    pos : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        Vector-valued vertex property map containing the x and y coordinates of
        the vertices. If not given, it will be computed using :func:`sfdp_layout`.
    vprops : dict (optional, default: ``None``)
        Dictionary with the vertex properties. Individual properties may also be
        given via the ``vertex_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    eprops : dict (optional, default: ``None``)
742
        Dictionary with the edge properties. Individual properties may also be
743
744
745
746
747
748
749
750
751
752
753
        given via the ``edge_<prop-name>`` parameters, where ``<prop-name>`` is
        the name of the property.
    vorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the vertices are drawn.
    eorder : :class:`~graph_tool.PropertyMap` (optional, default: ``None``)
        If provided, defines the relative order in which the edges are drawn.
    nodesfirst : bool (optional, default: ``False``)
        If ``True``, the vertices are drawn first, otherwise the edges are.
    output_size : tuple of scalars (optional, default: ``(600,600)``)
        Size of the drawing canvas. The units will depend on the output format
        (pixels for the screen, points for PDF, etc).
754
755
756
757
758
759
    fit_view : bool, float or tuple (optional, default: ``True``)
        If ``True``, the layout will be scaled to fit the entire clip region.
        If a float value is given, it will be interpreted as ``True``, and in
        addition the viewport will be scaled out by that factor. If a tuple
        value is given, it should have four values ``(x, y, w, h)`` that
        specify the view in user coordinates.
760
761
762
    inline : bool (optional, default: ``False``)
        If ``True`` and an `IPython notebook <http://ipython.org/notebook>`_  is
        being used, an inline version of the drawing will be returned.
763
764
765
766
767
    mplfig : :mod:`matplotlib` container object (optional, default: ``None``)
        The ``mplfig`` object needs to have an ``artists`` attribute. This can
        for example be a :class:`matplotlib.figure.Figure` or
        :class:`matplotlib.axes.Axes`. Only the cairo backend is supported; use
        ``switch_backend('cairo')``.
768
769
    output : string or file object (optional, default: ``None``)
        Output file name (or object). If not given, the graph will be displayed via
770
771
772
773
774
        :func:`interactive_window`.
    fmt : string (default: ``"auto"``)
        Output file format. Possible values are ``"auto"``, ``"ps"``, ``"pdf"``,
        ``"svg"``, and ``"png"``. If the value is ``"auto"``, the format is
        guessed from the ``output`` parameter.
775
776
    bg_color : str or sequence (optional, default: ``None``)
        Background color. The default is transparent.
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
    vertex_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``vertex_<prop-name>`` specify the
        vertex property with name ``<prop-name>``, as an alternative to the
        ``vprops`` parameter.
    edge_* : :class:`~graph_tool.PropertyMap` or arbitrary types (optional, default: ``None``)
        Parameters following the pattern ``edge_<prop-name>`` specify the edge
        property with name ``<prop-name>``, as an alternative to the ``eprops``
        parameter.
    **kwargs
        Any extra parameters are passed to :func:`~graph_tool.draw.interactive_window`,
        :class:`~graph_tool.draw.GraphWindow`, :class:`~graph_tool.draw.GraphWidget`
        and :func:`~graph_tool.draw.cairo_draw`.

    Returns
    -------
    pos : :class:`~graph_tool.PropertyMap`
        Vector vertex property map with the x and y coordinates of the vertices.
    selected : :class:`~graph_tool.PropertyMap` (optional, only if ``output is None``)
        Boolean-valued vertex property map marking the vertices which were
        selected interactively.

    Notes
    -----


    .. table:: **List of vertex properties**

        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | Name          | Description                                       | Accepted types         | Default Value                    |
        +===============+===================================================+========================+==================================+
        | shape         | The vertex shape. Can be one of the following     | ``str`` or ``int``     | ``"circle"``                     |
        |               | strings: "circle", "triangle", "square",          |                        |                                  |
        |               | "pentagon", "hexagon", "heptagon", "octagon"      |                        |                                  |
        |               | "double_circle", "double_triangle",               |                        |                                  |
        |               | "double_square", "double_pentagon",               |                        |                                  |
        |               | "double_hexagon", "double_heptagon",              |                        |                                  |
813
        |               | "double_octagon", "pie".                          |                        |                                  |
814
815
816
817
818
819
820
821
822
823
824
825
826
        |               | Optionally, this might take a numeric value       |                        |                                  |
        |               | corresponding to position in the list above.      |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | color         | Color used to stroke the lines of the vertex.     | ``str`` or list of     | ``[0., 0., 0., 1]``              |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | fill_color    | Color used to fill the interior of the vertex.    | ``str`` or list of     | ``[0.640625, 0, 0, 0.9]``        |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | size          | The size of the vertex, in the default units of   | ``float`` or ``int``   | ``5``                            |
        |               | the output format (normally either pixels or      |                        |                                  |
        |               | points).                                          |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
827
828
        | aspect        | The aspect ratio of the vertex.                   | ``float`` or ``int``   | ``1.0``                          |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
829
        | rotation      | Angle (in radians) to rotate the vertex.          | ``float``              | ``0.``                           |
830
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
831
832
833
834
        | anchor        | Specifies how the edges anchor to the vertices.   |  ``int``               | ``1``                            |
        |               | If `0`, the anchor is at the center of the vertex,|                        |                                  |
        |               | otherwise it is at the border.                    |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
835
836
837
838
839
840
841
842
843
844
        | pen_width     | Width of the lines used to draw the vertex, in    | ``float`` or ``int``   | ``0.8``                          |
        |               | the default units of the output format (normally  |                        |                                  |
        |               | either pixels or points).                         |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | halo          | Whether to draw a circular halo around the        | ``bool``               | ``False``                        |
        |               | vertex.                                           |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | halo_color    | Color used to draw the halo.                      | ``str`` or list of     | ``[0., 0., 1., 0.5]``            |
        |               |                                                   | ``floats``             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
845
846
847
        | halo_size     | Relative size of the halo.                        | ``float``              | ``1.5``                          |
        |               |                                                   |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
848
849
        | text          | Text to draw together with the vertex.            | ``str``                | ``""``                           |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
850
851
852
        | text_color    | Color used to draw the text. If the value is      | ``str`` or list of     | ``"auto"``                       |
        |               | ``"auto"``, it will be computed based on          | ``floats``             |                                  |
        |               | fill_color to maximize contrast.                  |                        |                                  |
853
854
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_position | Position of the text relative to the vertex.      | ``float`` or ``int``   | ``-1``                           |
855
        |               | If the passed value is positive, it will          |  or ``"centered"``     |                                  |
856
857
858
        |               | correspond to an angle in radians, which will     |                        |                                  |
        |               | determine where the text will be placed outside   |                        |                                  |
        |               | the vertex. If the value is negative, the text    |                        |                                  |
859
860
        |               | will be placed inside the vertex. If the value is |                        |                                  |
        |               | ``-1``, the vertex size will be automatically     |                        |                                  |
861
862
863
        |               | increased to accommodate the text. The special    |                        |                                  |
        |               | value ``"centered"`` positions the texts rotated  |                        |                                  |
        |               | radially around the center of mass.               |                        |                                  |
864
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
865
866
867
868
869
870
        | text_offset   | Text position offset.                             | list of ``float``      | ``[0.0, 0.0]``                   |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_rotation | Angle of rotation (in radians) for the text.      | ``float``              | ``0.0``                          |
        |               | The center of rotation is the position of the     |                        |                                  |
        |               | vertex.                                           |                        |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
871
872
873
874
875
876
877
878
        | font_family   | Font family used to draw the text.                | ``str``                | ``"serif"``                      |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_slant    | Font slant used to draw the text.                 | ``cairo.FONT_SLANT_*`` | :data:`cairo.FONT_SLANT_NORMAL`  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_weight   | Font weight used to draw the text.                | ``cairo.FONT_WEIGHT_*``| :data:`cairo.FONT_WEIGHT_NORMAL` |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_size     | Font size used to draw the text.                  | ``float`` or ``int``   | ``12``                           |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
879
880
        | surface       | The cairo surface used to draw the vertex. If     | :class:`cairo.Surface` | ``None``                         |
        |               | the value passed is a string, it is interpreted   | or ``str``             |                                  |
Tiago Peixoto's avatar
Tiago Peixoto committed
881
        |               | as an image file name to be loaded.               |                        |                                  |
882
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
883
884
885
886
887
888
        | pie_fractions | Fractions of the pie sections for the vertices if | list of ``int`` or     | ``[0.75, 0.25]``                 |
        |               | ``shape=="pie"``.                                 | ``float``              |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
        | pie_colors    | Colors used in the pie sections if                | list of strings or     | ``('b','g','r','c','m','y','k')``|
        |               | ``shape=="pie"``.                                 | ``float``.             |                                  |
        +---------------+---------------------------------------------------+------------------------+----------------------------------+
889
890
891
892
893
894
895
896
897
898
899
900
901
902


    .. table:: **List of edge properties**

        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | Name           | Description                                       | Accepted types         | Default Value                    |
        +================+===================================================+========================+==================================+
        | color          | Color used to stroke the edge lines.              | ``str`` or list of     | ``[0.179, 0.203,0.210, 0.8]``    |
        |                |                                                   | floats                 |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | pen_width      | Width of the line used to draw the edge, in       | ``float`` or ``int``   | ``1.0``                          |
        |                | the default units of the output format (normally  |                        |                                  |
        |                | either pixels or points).                         |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
903
        | start_marker,  | Edge markers. Can be one of "none", "arrow",      | ``str`` or ``int``     | ``none``                         |
904
905
906
907
        | mid_marker,    | "circle", "square", "diamond", or "bar".          |                        |                                  |
        | end_marker     | Optionally, this might take a numeric value       |                        |                                  |
        |                | corresponding to position in the list above.      |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
908
909
        | mid_marker_pos | Relative position of the middle marker.           | ``float``              | ``0.5``                          |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
910
911
912
913
        | marker_size    | Size of edge markers, in units appropriate to the | ``float`` or ``int``   | ``4``                            |
        |                | output format (normally either pixels or points). |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | control_points | Control points of a Bézier spline used to draw    | sequence of ``floats`` | ``[]``                           |
Tiago Peixoto's avatar
Tiago Peixoto committed
914
915
916
917
918
919
920
921
922
        |                | the edge. Each spline segment requires 6 values   |                        |                                  |
        |                | corresponding to the (x,y) coordinates of the two |                        |                                  |
        |                | intermediary control points and the final point.  |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | gradient       | Stop points of a linear gradient used to stroke   | sequence of ``floats`` | ``[]``                           |
        |                | the edge. Each group of 5 elements is interpreted |                        |                                  |
        |                | as ``[o, r, g, b, a]`` where ``o`` is the offset  |                        |                                  |
        |                | in the range [0, 1] and the remaining values      |                        |                                  |
        |                | specify the colors.                               |                        |                                  |
923
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
924
925
926
927
928
929
        | dash_style     | Dash pattern is specified by an array of positive | sequence of ``floats`` | ``[]``                           |
        |                | values. Each value provides the length of         |                        |                                  |
        |                | alternate "on" and "off" portions of the stroke.  |                        |                                  |
        |                | The last value specifies an offset into the       |                        |                                  |
        |                | pattern at which the stroke begins.               |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
        | text           | Text to draw next to the edges.                   | ``str``                | ``""``                           |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_color     | Color used to draw the text.                      | ``str`` or list of     | ``[0., 0., 0., 1.]``             |
        |                |                                                   | ``floats``             |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_distance  | Distance from the edge and its text.              | ``float`` or ``int``   | ``4``                            |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | text_parallel  | If ``True`` the text will be drawn parallel to    | ``bool``               | ``True``                         |
        |                | the edges.                                        |                        |                                  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_family    | Font family used to draw the text.                | ``str``                | ``"serif"``                      |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_slant     | Font slant used to draw the text.                 | ``cairo.FONT_SLANT_*`` | :data:`cairo.FONT_SLANT_NORMAL`  |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_weight    | Font weight used to draw the text.                | ``cairo.FONT_WEIGHT_*``| :data:`cairo.FONT_WEIGHT_NORMAL` |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
        | font_size      | Font size used to draw the text.                  | ``float`` or ``int``   | ``12``                           |
        +----------------+---------------------------------------------------+------------------------+----------------------------------+
948
949
950

    Examples
    --------
951
952
953
954
955
956
957
    .. testcode::
       :hide:

       np.random.seed(42)
       gt.seed_rng(42)
       from numpy import sqrt

958
959
960
    >>> g = gt.price_network(1500)
    >>> deg = g.degree_property_map("in")
    >>> deg.a = 4 * (sqrt(deg.a) * 0.5 + 0.4)
961
962
    >>> ebet = gt.betweenness(g)[1]
    >>> ebet.a /= ebet.a.max() / 10.
963
964
965
966
967
968
969
970
971
972
    >>> eorder = ebet.copy()
    >>> eorder.a *= -1
    >>> pos = gt.sfdp_layout(g)
    >>> control = g.new_edge_property("vector<double>")
    >>> for e in g.edges():
    ...     d = sqrt(sum((pos[e.source()].a - pos[e.target()].a) ** 2)) / 5
    ...     control[e] = [0.3, d, 0.7, d]
    >>> gt.graph_draw(g, pos=pos, vertex_size=deg, vertex_fill_color=deg, vorder=deg,
    ...               edge_color=ebet, eorder=eorder, edge_pen_width=ebet,
    ...               edge_control_points=control, # some curvy edges
973
974
975
    ...               output="graph-draw.pdf")
    <...>

976
977
978
979
980
981
982
983
984
    .. testcode::
       :hide:

       gt.graph_draw(g, pos=pos, vertex_size=deg, vertex_fill_color=deg, vorder=deg,
                     edge_color=ebet, eorder=eorder, edge_pen_width=ebet,
                     edge_control_points=control,
                     output="graph-draw.png")


985
986
987
    .. figure:: graph-draw.*
        :align: center

988
989
        SFDP force-directed layout of a Price network with 1500 nodes. The
        vertex size and color indicate the degree, and the edge color and width
990
        the edge betweenness centrality.
991
992
993

    """

Tiago Peixoto's avatar
Tiago Peixoto committed
994
995
996
997
    vprops = vprops.copy() if vprops is not None else {}
    eprops = eprops.copy() if eprops is not None else {}

    props, kwargs = parse_props("vertex", kwargs)
998
    props = _convert_props(props, "v", g, kwargs.get("vcmap", default_cm))
Tiago Peixoto's avatar
Tiago Peixoto committed
999
1000
    vprops.update(props)
    props, kwargs = parse_props("edge", kwargs)
1001
    props = _convert_props(props, "e", g, kwargs.get("ecmap", default_cm))
Tiago Peixoto's avatar
Tiago Peixoto committed
1002
1003
1004
    eprops.update(props)

    if pos is None:
1005
        if (g.num_vertices() > 2 and output is None and
1006
            not inline and kwargs.get("update_layout", True)):
Tiago Peixoto's avatar
Tiago Peixoto committed
1007
1008
1009
1010
1011
1012
1013
1014
1015
            L = np.sqrt(g.num_vertices())
            pos = random_layout(g, [L, L])
            if g.num_vertices() > 1000:
                if "multilevel" not in kwargs:
                    kwargs["multilevel"] = True
            if "layout_K" not in kwargs:
                kwargs["layout_K"] = _avg_edge_distance(g, pos) / 10
        else:
            pos = sfdp_layout(g)
1016
1017
    else:
        _check_prop_vector(pos, name="pos", floating=True)
1018
        if output is None and not inline:
1019
1020
1021
1022
            if "layout_K" not in kwargs:
                kwargs["layout_K"] = _avg_edge_distance(g, pos)
            if "update_layout" not in kwargs:
                kwargs["update_layout"] = False
Tiago Peixoto's avatar
Tiago Peixoto committed
1023

1024
1025
1026
    if "pen_width" in eprops and "marker_size" not in eprops:
        pw = eprops["pen_width"]
        if isinstance(pw, PropertyMap):
1027
            pw = pw.copy("double")
1028
            pw.fa *= 2.75
1029
1030
1031
            eprops["marker_size"] = pw
        else:
            eprops["marker_size"] = pw * 2.75
1032

1033
1034
1035
    if "text" in eprops and "text_distance" not in eprops and "pen_width" in eprops:
        pw = eprops["pen_width"]
        if isinstance(pw, PropertyMap):
1036
            pw = pw.copy("double")
1037
            pw.fa *= 2
1038
1039
1040
1041
            eprops["text_distance"] = pw
        else:
            eprops["text_distance"] = pw * 2

1042
    if "text" in vprops and ("text_color" not in vprops or vprops["text_color"] == "auto"):
1043
        vcmap = kwargs.get("vcmap", matplotlib.cm.jet)
1044
1045
1046
1047
        bg = _convert(vertex_attrs.fill_color,
                      vprops.get("fill_color", _vdefaults["fill_color"]),
                      vcmap)
        bg_color = kwargs.get("bg_color", [1., 1., 1., 1.])
1048
1049
1050
1051
1052
        vprops["text_color"] = auto_colors(g, bg,
                                           vprops.get("text_position",
                                                      _vdefaults["text_position"]),
                                           bg_color)

1053
    if mplfig:
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
        ax = None
        if isinstance(mplfig, matplotlib.figure.Figure):
            ctr = ax = mplfig.gca()
        elif isinstance(mplfig, matplotlib.axes.Axes):
            ctr = ax = mplfig
        else:
            ctr = mplfig

        artist = GraphArtist(g, pos, vprops, eprops, vorder, eorder, nodesfirst,
                             ax, **kwargs)
        ctr.artists.append(artist)

1066
1067
1068
1069
1070
1071
1072
1073
1074
        if fit_view != False and ax is not None:
            try:
                x, y, w, h = fit_view
            except TypeError:
                x, y = ungroup_vector_property(pos, [0, 1])
                l, r = x.a.min(), x.a.max()
                b, t = y.a.min(), y.a.max()
                w = r - l
                h = t - b
1075
1076
1077
            if fit_view != True:
                w *= float(fit_view)
                h *= float(fit_view)
1078
1079
1080
1081
            ax.set_xlim(l - w * .1, r + w * .1)
            ax.set_ylim(b - h * .1, t + h * .1)

        return pos
1082

1083
1084
    if inline:
        if fmt == "auto":
1085
1086
1087
1088
1089
            if output is None:
                fmt = "png"
            else:
                fmt = get_file_fmt(output)
        output_file = output
1090
1091
        output = io.BytesIO()

1092
    if output is None:
1093
        fit_area = fit_view if fit_view != True else 0.95
Tiago Peixoto's avatar
Tiago Peixoto committed
1094
        return interactive_window(g, pos, vprops, eprops, vorder, eorder,
1095
1096
                                  nodesfirst, geometry=output_size,
                                  fit_area=fit_area, **kwargs)
Tiago Peixoto's avatar
Tiago Peixoto committed
1097
    else:
1098
        if isinstance(output, (str, unicode)):
1099
1100
1101
1102
1103
            out, auto_fmt = open_file(output, mode="wb")
        else:
            out = output
            if fmt == "auto":
                raise ValueError("File format must be specified.")
Tiago Peixoto's avatar
Tiago Peixoto committed
1104
1105

        if fmt == "auto":
1106
            fmt = auto_fmt
Tiago Peixoto's avatar
Tiago Peixoto committed
1107
1108
1109
1110
        if fmt == "pdf":
            srf = cairo.PDFSurface(out, output_size[0], output_size[1])
        elif fmt == "ps":
            srf = cairo.PSSurface(out, output_size[0], output_size[1])
Tiago Peixoto's avatar
Tiago Peixoto committed
1111
1112
1113
        elif fmt == "eps":
            srf = cairo.PSSurface(out, output_size[0], output_size[1])
            srf.set_eps(True)
Tiago Peixoto's avatar
Tiago Peixoto committed
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
        elif fmt == "svg":
            srf = cairo.SVGSurface(out, output_size[0], output_size[1])
        elif fmt == "png":
            srf = cairo.ImageSurface(cairo.FORMAT_ARGB32, output_size[0],
                                     output_size[1])
        else:
            raise ValueError("Invalid format type: " + fmt)

        cr = cairo.Context(srf)

        adjust_default_sizes(g, output_size, vprops, eprops)
1125
1126
1127
1128
1129
        if fit_view != False:
            try:
                x, y, w, h = fit_view
                offset, zoom = [0, 0], 1
            except TypeError:
1130
                pad = fit_view if fit_view != True else 0.95
1131
1132
1133
1134
1135
1136
1137
                offset, zoom = fit_to_view(g, pos, output_size, vprops["size"],
                                           vprops["pen_width"], None,
                                           vprops.get("text", None),
                                           vprops.get("font_family",
                                                      _vdefaults["font_family"]),
                                           vprops.get("font_size",
                                                      _vdefaults["font_size"]),
1138
                                           pad, cr)
1139
                fit_view = False
Tiago Peixoto's avatar
Tiago Peixoto committed
1140
1141
1142
1143
1144
1145
1146
1147
1148
        else:
            offset, zoom = [0, 0], 1

        if "bg_color" in kwargs:
            bg_color = kwargs["bg_color"]
            del  kwargs["bg_color"]
            cr.set_source_rgba(bg_color[0], bg_color[1],
                               bg_color[2], bg_color[3])
            cr.paint()
1149

Tiago Peixoto's avatar
Tiago Peixoto committed
1150
1151
1152
1153
        cr.translate(offset[0], offset[1])
        cr.scale(zoom, zoom)

        cairo_draw(g, pos, cr, vprops, eprops, vorder, eorder,
1154
                   nodesfirst, fit_view=fit_view, **kwargs)
1155

1156
        if fmt == "png":
Tiago Peixoto's avatar
Tiago Peixoto committed
1157
            srf.write_to_png(out)
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167

        del cr

        if inline:
            img = None
            if fmt == "png":
                img = IPython.display.Image(data=out.getvalue())
            if fmt == "svg":
                img = IPython.display.SVG(data=out.getvalue())
            if img is None:
1168
1169
                inl_out = io.BytesIO()
                inl_srf = cairo.ImageSurface(cairo.FORMAT_ARGB32,
Pietro Battiston's avatar
Pietro Battiston committed
1170
1171
                                             output_size[0],
                                             output_size[1])
1172
1173
1174
1175
1176
1177
                inl_cr = cairo.Context(inl_srf)
                inl_cr.set_source_surface(srf, 0, 0)
                inl_cr.paint()
                inl_srf.write_to_png(inl_out)
                del inl_srf
                img = IPython.display.Image(data=inl_out.getvalue())
1178
            srf.finish()
1179
            if output_file is not None:
1180
                if isinstance(output_file, (str, unicode)):
1181
1182
1183
1184
                    ofile, auto_fmt = open_file(output_file, mode="wb")
                else:
                    ofile = output_file
                ofile.write(out.getvalue())
1185
                if isinstance(output_file, (str, unicode)):
1186
                    ofile.close()
1187
            IPython.display.display(img)
1188
        del srf
Tiago Peixoto's avatar
Tiago Peixoto committed
1189
        return pos
1190
1191
1192
1193
1194


def adjust_default_sizes(g, geometry, vprops, eprops, force=False):
    if "size" not in vprops or force:
        A = geometry[0] * geometry[1]
Tiago Peixoto's avatar
Tiago Peixoto committed
1195
1196
        N = max(g.num_vertices(), 1)
        vprops["size"] = np.sqrt(A / N) / 3.5
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219

    if "pen_width" not in vprops or force:
        size = vprops["size"]
        if isinstance(vprops["size"], PropertyMap):
            size = vprops["size"].fa.mean()
        vprops["pen_width"] = size / 10
        if "pen_width" not in eprops or force: