vtkMatplotlibMathTextUtilities.cxx 33.2 KB
Newer Older
David C. Lonie's avatar
David C. Lonie committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkMatplotlibMathTextUtilities.cxx

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15
#include "vtkPython.h" // must be the first thing that's included.
16
#include "vtkPythonCompatibility.h"
David C. Lonie's avatar
David C. Lonie committed
17
18
#include "vtkMatplotlibMathTextUtilities.h"

19
#include "vtkCommand.h"
David C. Lonie's avatar
David C. Lonie committed
20
#include "vtkImageData.h"
21
22
23
#include "vtkImageReslice.h"
#include "vtkMath.h"
#include "vtkNew.h"
David C. Lonie's avatar
David C. Lonie committed
24
25
26
#include "vtkObjectFactory.h"
#include "vtkPath.h"
#include "vtkPoints.h"
27
#include "vtkPythonInterpreter.h"
28
#include "vtkStdString.h"
29
#include "vtkSmartPyObject.h"
David C. Lonie's avatar
David C. Lonie committed
30
#include "vtkTextProperty.h"
31
#include "vtkTransform.h"
David C. Lonie's avatar
David C. Lonie committed
32

33
34
#include <vtksys/SystemTools.hxx>

David C. Lonie's avatar
David C. Lonie committed
35
36
#include <vector>

37
38
39
40
// We need to define Py_ssize_t for older python API version
#if PYTHON_API_VERSION < 1013
// Taken from pyport.h
#  ifdef HAVE_SSIZE_T
41
typedef ssize_t         Py_ssize_t;
42
#  elif SIZEOF_VOID_P == SIZEOF_SIZE_T
43
typedef Py_intptr_t     Py_ssize_t;
44
45
46
47
48
#  else
#    error "Python needs a typedef for Py_ssize_t."
#  endif
#endif

David C. Lonie's avatar
David C. Lonie committed
49
//----------------------------------------------------------------------------
50
vtkMatplotlibMathTextUtilities::Availability
51
vtkMatplotlibMathTextUtilities::MPLMathTextAvailable =
52
vtkMatplotlibMathTextUtilities::NOT_TESTED;
53

54
// A macro that is used in New() to print warnings if VTK_MATPLOTLIB_DEBUG
55
56
57
// is defined in the environment. Use vtkGenericWarningMacro to allow this to
// work in release mode builds.
#define vtkMplStartUpDebugMacro(x) if(debug){vtkGenericWarningMacro(x);}
58

59
60
vtkObjectFactoryNewMacro(vtkMatplotlibMathTextUtilities)

61
//----------------------------------------------------------------------------
62
63
vtkMatplotlibMathTextUtilities::Availability
vtkMatplotlibMathTextUtilities::CheckMPLAvailability()
64
{
65
66
67
  if (vtkMatplotlibMathTextUtilities::MPLMathTextAvailable != NOT_TESTED)
    {
    // Already tested. Nothing to do now.
68
    return vtkMatplotlibMathTextUtilities::MPLMathTextAvailable;
69
70
    }

71
72
  // Enable startup debugging output. This will be set to true when
  // VTK_MATPLOTLIB_DEBUG is defined in the process environment.
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
  bool debug = (vtksys::SystemTools::GetEnv("VTK_MATPLOTLIB_DEBUG") != NULL);

  // Initialize the python interpretor if needed
  vtkMplStartUpDebugMacro("Initializing Python, if not already.");
  vtkPythonInterpreter::Initialize();
  vtkMplStartUpDebugMacro("Attempting to import matplotlib.");
  if (PyErr_Occurred() || !PyImport_ImportModule("matplotlib") || PyErr_Occurred())
    {
    // FIXME: Check if we need this. Wouldn't pipe-ing the stdout/stderr make
    // this unnecessary?

    // Fetch the exception info. Note that value and traceback may still be
    // NULL after the call to PyErr_Fetch().
    PyObject *type = NULL;
    PyObject *value = NULL;
    PyObject *traceback = NULL;
    PyErr_Fetch(&type, &value, &traceback);
90
91
92
    vtkSmartPyObject typeStr(PyObject_Str(type));
    vtkSmartPyObject valueStr(PyObject_Str(value));
    vtkSmartPyObject tracebackStr(PyObject_Str(traceback));
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
    vtkMplStartUpDebugMacro(
      "Error during matplotlib import:\n"
      << "\nStack:\n"
      << (tracebackStr.GetPointer() == NULL
        ? "(none)"
        : const_cast<char*>(
          PyString_AsString(tracebackStr.GetPointer())))
      << "\nValue:\n"
      << (valueStr.GetPointer() == NULL
        ? "(none)"
        : const_cast<char*>(
          PyString_AsString(valueStr.GetPointer())))
      << "\nType:\n"
      << (typeStr.GetPointer() == NULL
        ? "(none)"
        : const_cast<char*>(
          PyString_AsString(typeStr.GetPointer()))));
    PyErr_Clear();
    vtkMatplotlibMathTextUtilities::MPLMathTextAvailable = UNAVAILABLE;
    }
  else
    {
    vtkMplStartUpDebugMacro("Successfully imported matplotlib.");
    vtkMatplotlibMathTextUtilities::MPLMathTextAvailable = AVAILABLE;
    }
118
119

  return vtkMatplotlibMathTextUtilities::MPLMathTextAvailable;
120
121
122
}

//----------------------------------------------------------------------------
123
bool vtkMatplotlibMathTextUtilities::IsAvailable()
124
{
125
  return this->CheckMPLAvailability() == AVAILABLE;
126
}
David C. Lonie's avatar
David C. Lonie committed
127
128
129

//----------------------------------------------------------------------------
vtkMatplotlibMathTextUtilities::vtkMatplotlibMathTextUtilities()
130
131
  : Superclass(), MaskParser(NULL), PathParser(NULL), FontPropertiesClass(NULL),
    ScaleToPowerOfTwo(true)
David C. Lonie's avatar
David C. Lonie committed
132
{
133
134
135
  this->Interpreter = vtkPythonInterpreter::New();
  this->Interpreter->AddObserver(vtkCommand::ExitEvent,
    this, &vtkMatplotlibMathTextUtilities::CleanupPythonObjects);
David C. Lonie's avatar
David C. Lonie committed
136
137
138
139
}

//----------------------------------------------------------------------------
vtkMatplotlibMathTextUtilities::~vtkMatplotlibMathTextUtilities()
140
141
142
143
144
145
146
{
  this->CleanupPythonObjects();
  this->Interpreter->Delete();
}

//----------------------------------------------------------------------------
void vtkMatplotlibMathTextUtilities::CleanupPythonObjects()
David C. Lonie's avatar
David C. Lonie committed
147
148
149
150
{
  Py_XDECREF(this->MaskParser);
  Py_XDECREF(this->PathParser);
  Py_XDECREF(this->FontPropertiesClass);
151

152
153
154
  this->MaskParser = NULL;
  this->PathParser = NULL;
  this->FontPropertiesClass = NULL;
David C. Lonie's avatar
David C. Lonie committed
155
156
157
158
159
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::InitializeMaskParser()
{
160
161
162
  // ensure that Python is initialized.
  vtkPythonInterpreter::Initialize();

163
  vtkSmartPyObject mplMathTextLib(PyImport_ImportModule("matplotlib.mathtext"));
David C. Lonie's avatar
David C. Lonie committed
164
165
166
167
168
  if (this->CheckForError(mplMathTextLib.GetPointer()))
    {
    return false;
    }

169
  vtkSmartPyObject mathTextParserClass(
David C. Lonie's avatar
David C. Lonie committed
170
        PyObject_GetAttrString(mplMathTextLib.GetPointer(), "MathTextParser"));
David C. Lonie's avatar
David C. Lonie committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
  if (this->CheckForError(mathTextParserClass.GetPointer()))
    {
    return false;
    }

  this->MaskParser =
      PyObject_CallFunction(mathTextParserClass.GetPointer(),
                            const_cast<char*>("s"), "bitmap");
  if (this->CheckForError(this->MaskParser))
    {
    Py_CLEAR(this->MaskParser);
    return false;
    }

  return true;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::InitializePathParser()
{
191
192
193
  // ensure that Python is initialized.
  vtkPythonInterpreter::Initialize();

194
  vtkSmartPyObject mplTextPathLib(PyImport_ImportModule("matplotlib.textpath"));
David C. Lonie's avatar
David C. Lonie committed
195
196
197
198
199
  if (this->CheckForError(mplTextPathLib.GetPointer()))
    {
    return false;
    }

200
  vtkSmartPyObject textToPathClass(
David C. Lonie's avatar
David C. Lonie committed
201
        PyObject_GetAttrString(mplTextPathLib.GetPointer(), "TextToPath"));
David C. Lonie's avatar
David C. Lonie committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  if (this->CheckForError(textToPathClass.GetPointer()))
    {
    return false;
    }

  this->PathParser = PyObject_CallFunction(textToPathClass.GetPointer(), NULL);
  if (this->CheckForError(this->PathParser))
    {
    Py_CLEAR(this->PathParser);
    return false;
    }

  return true;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::InitializeFontPropertiesClass()
{
220
221
222
  // ensure that Python is initialized.
  vtkPythonInterpreter::Initialize();

223
  vtkSmartPyObject mplFontManagerLib(
David C. Lonie's avatar
David C. Lonie committed
224
        PyImport_ImportModule("matplotlib.font_manager"));
David C. Lonie's avatar
David C. Lonie committed
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
  if (this->CheckForError(mplFontManagerLib.GetPointer()))
    {
    return false;
    }

  this->FontPropertiesClass = PyObject_GetAttrString(
        mplFontManagerLib.GetPointer(), "FontProperties");
  if (this->CheckForError(this->FontPropertiesClass))
    {
    Py_CLEAR(this->FontPropertiesClass);
    return false;
    }

  return true;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::CheckForError()
{
  PyObject *exception = PyErr_Occurred();
  if (exception)
    {
247
248
    if (this->Debug)
      {
249
250
251
252
253
254
      // Fetch the exception info. Note that value and traceback may still be
      // NULL after the call to PyErr_Fetch().
      PyObject *type = NULL;
      PyObject *value = NULL;
      PyObject *traceback = NULL;
      PyErr_Fetch(&type, &value, &traceback);
255
256
257
      vtkSmartPyObject typeStr(PyObject_Str(type));
      vtkSmartPyObject valueStr(PyObject_Str(value));
      vtkSmartPyObject tracebackStr(PyObject_Str(traceback));
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
      vtkWarningMacro(<< "Python exception raised:\n"
                      << "\nStack:\n"
                      << (tracebackStr.GetPointer() == NULL
                          ? "(none)"
                          : const_cast<char*>(
                            PyString_AsString(tracebackStr.GetPointer())))
                      << "\nValue:\n"
                      << (valueStr.GetPointer() == NULL
                          ? "(none)"
                          : const_cast<char*>(
                            PyString_AsString(valueStr.GetPointer())))
                      << "\nType:\n"
                      << (typeStr.GetPointer() == NULL
                          ? "(none)"
                          : const_cast<char*>(
                            PyString_AsString(typeStr.GetPointer()))));
274
      }
275
    PyErr_Clear();
David C. Lonie's avatar
David C. Lonie committed
276
277
278
279
280
281
282
283
284
285
286
287
288
    return true;
    }
  return false;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::CheckForError(PyObject *object)
{
  // Print any exceptions
  bool result = this->CheckForError();

  if (object == NULL)
    {
289
    vtkDebugMacro(<< "Object is NULL!");
David C. Lonie's avatar
David C. Lonie committed
290
291
292
293
294
295
296
297
298
    return true;
    }
  return result;
}

//----------------------------------------------------------------------------
PyObject *
vtkMatplotlibMathTextUtilities::GetFontProperties(vtkTextProperty *tprop)
{
299
300
301
302
303
304
  if (!this->IsAvailable())
    {
    vtkErrorMacro(<<"Matplotlib rendering is unavailable.");
    return NULL;
    }

David C. Lonie's avatar
David C. Lonie committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
  if (!this->FontPropertiesClass)
    {
    if (!this->InitializeFontPropertiesClass())
      {
      vtkErrorMacro(<<"FontPropertiesClass is not initialized!");
      return NULL;
      }
    }

  char tpropFamily[16];
  char tpropStyle[16];
  char tpropVariant[16] = "normal";
  char tpropWeight[16];
  long tpropFontSize;

  switch (tprop->GetFontFamily())
    {
    default:
    case VTK_ARIAL:
      strcpy(tpropFamily, "sans-serif");
      break;
    case VTK_COURIER:
      strcpy(tpropFamily, "monospace");
      break;
    case VTK_TIMES:
      strcpy(tpropFamily, "serif");
      break;
    }

  if (tprop->GetItalic())
    {
    strcpy(tpropStyle, "italic");
    }
  else
    {
    strcpy(tpropStyle, "normal");
    }

  if (tprop->GetBold())
    {
    strcpy(tpropWeight, "bold");
    }
  else
    {
    strcpy(tpropWeight, "normal");
    }

  tpropFontSize = tprop->GetFontSize();

  return PyObject_CallFunction(this->FontPropertiesClass,
                               const_cast<char*>("sssssi"), tpropFamily,
                               tpropStyle, tpropVariant, tpropStyle,
                               tpropWeight, tpropFontSize);
}

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
//----------------------------------------------------------------------------
void vtkMatplotlibMathTextUtilities::GetJustifiedBBox(int rows, int cols,
                                                      vtkTextProperty *tprop,
                                                      int bbox[])
{
  bbox[0] = 0;
  bbox[1] = cols - 1;
  bbox[2] = 0;
  bbox[3] = rows - 1;

  int justifyOffset[2];
  switch (tprop->GetJustification())
    {
    default:
    case VTK_TEXT_LEFT:
      justifyOffset[0] = 0;
      break;
    case VTK_TEXT_CENTERED:
      justifyOffset[0] = bbox[1] / 2;
      break;
    case VTK_TEXT_RIGHT:
      justifyOffset[0] = bbox[1];
      break;
    }
  switch (tprop->GetVerticalJustification())
    {
    default:
    case VTK_TEXT_BOTTOM:
      justifyOffset[1] = 0;
      break;
    case VTK_TEXT_CENTERED:
      justifyOffset[1] = bbox[3] / 2;
      break;
    case VTK_TEXT_TOP:
      justifyOffset[1] = bbox[3];
      break;
    }

  bbox[0] -= justifyOffset[0];
  bbox[1] -= justifyOffset[0];
  bbox[2] -= justifyOffset[1];
  bbox[3] -= justifyOffset[1];
}

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
//----------------------------------------------------------------------------
void vtkMatplotlibMathTextUtilities::RotateCorners(double angleDeg,
                                                   double corners[4][2],
                                                   double bbox[4])
{
  double angleRad = vtkMath::RadiansFromDegrees(angleDeg);
  double c = cos(angleRad);
  double s = sin(angleRad);
  // Rotate corners
  for (int i = 0; i < 4; ++i)
    {
    int newpt[2];
    newpt[0] = c * corners[i][0] - s * corners[i][1];
    newpt[1] = s * corners[i][0] + c * corners[i][1];
    corners[i][0] = newpt[0];
    corners[i][1] = newpt[1];
    }
  // Find new bounds
  bbox[0] = VTK_INT_MAX;
  bbox[1] = VTK_INT_MIN;
  bbox[2] = VTK_INT_MAX;
  bbox[3] = VTK_INT_MIN;
  for (int i = 0; i < 4; ++i)
    {
    if (corners[i][0] < bbox[0])
      {
      bbox[0] = corners[i][0];
      }
    if (corners[i][0] > bbox[1])
      {
      bbox[1] = corners[i][0];
      }
    if (corners[i][1] < bbox[2])
      {
      bbox[2] = corners[i][1];
      }
    if (corners[i][1] > bbox[3])
      {
      bbox[3] = corners[i][1];
      }
    }
}

447
448
449
//----------------------------------------------------------------------------
// This is more or less ported from vtkFreeTypeTools.
bool vtkMatplotlibMathTextUtilities::PrepareImageData(vtkImageData *data,
450
                                                      int textBbox[4])
451
{
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
  // Calculate the bbox's dimensions
  int textDims[2];
  textDims[0] = (textBbox[1] - textBbox[0] + 1);
  textDims[1] = (textBbox[3] - textBbox[2] + 1);

  // Calculate the size the image needs to be.
  int targetDims[3];
  targetDims[0] = textDims[0];
  targetDims[1] = textDims[1];
  targetDims[2] = 1;
  // Scale to the next highest power of 2 if required.
  if (this->ScaleToPowerOfTwo)
    {
    targetDims[0] = vtkMath::NearestPowerOfTwo(targetDims[0]);
    targetDims[1] = vtkMath::NearestPowerOfTwo(targetDims[1]);
    }

  // Calculate the target extent of the image.
  int targetExtent[6];
  targetExtent[0] = textBbox[0];
  targetExtent[1] = textBbox[0] + targetDims[0] - 1;
  targetExtent[2] = textBbox[2];
  targetExtent[3] = textBbox[2] + targetDims[1] - 1;
  targetExtent[4] = 0;
  targetExtent[5] = 0;

  // Get the actual image extents and increments
  int imageExtent[6];
  double imageSpacing[3];
  data->GetExtent(imageExtent);
  data->GetSpacing(imageSpacing);

  // Do we need to reallocate the image memory?
485
486
  if (data->GetScalarType() != VTK_UNSIGNED_CHAR ||
      data->GetNumberOfScalarComponents() != 4 ||
487
488
489
490
491
492
493
494
495
      imageExtent[0] != targetExtent[0] ||
      imageExtent[1] != targetExtent[1] ||
      imageExtent[2] != targetExtent[2] ||
      imageExtent[3] != targetExtent[3] ||
      imageExtent[4] != targetExtent[4] ||
      imageExtent[5] != targetExtent[5] ||
      fabs(imageSpacing[0] - 1.0) > 1e-10 ||
      fabs(imageSpacing[1] - 1.0) > 1e-10 ||
      fabs(imageSpacing[2] - 1.0) > 1e-10 )
496
    {
497
498
499
    data->SetSpacing(1.0, 1.0, 1.0);
    data->SetExtent(targetExtent);
    data->AllocateScalars(VTK_UNSIGNED_CHAR, 4);
500
501
502
503
504
    }

  // Clear the image
  memset(data->GetScalarPointer(), 0,
         (data->GetNumberOfPoints() * data->GetNumberOfScalarComponents()));
David C. Lonie's avatar
David C. Lonie committed
505
506

  return true;
507
508
}

509
510
//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::GetBoundingBox(
511
    vtkTextProperty *tprop, const char *str, int dpi, int bbox[4])
512
513
514
515
516
517
518
519
520
521
522
523
524
{
  vtkTextRenderer::Metrics metrics;
  if (!this->GetMetrics(tprop, str, dpi, metrics))
    {
    return false;
    }
  std::copy(metrics.BoundingBox.GetData(), metrics.BoundingBox.GetData() + 4,
            bbox);
  return true;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::GetMetrics(
525
    vtkTextProperty *tprop, const char *str, int dpi,
526
    vtkTextRenderer::Metrics &metrics)
527
{
528
529
530
531
532
533
  if (!this->IsAvailable())
    {
    vtkErrorMacro(<<"Matplotlib rendering is unavailable.");
    return false;
    }

534
535
536
537
538
539
540
541
542
  if (!this->MaskParser)
    {
    if (!this->InitializeMaskParser())
      {
      vtkErrorMacro(<<"MaskParser is not initialized!");
      return false;
      }
    }

543
  vtkDebugMacro(<<"Calculating metrics for '" << str << "'");
544
545
546
547

  long int rows = 0;
  long int cols = 0;

548
  vtkSmartPyObject resultTuple(PyObject_CallMethod(this->MaskParser,
549
550
551
                                                   const_cast<char*>("to_mask"),
                                                   const_cast<char*>("sii"),
                                                   const_cast<char*>(str),
552
553
                                                   tprop->GetFontSize(),
                                                   dpi));
554
555
556
557
558
559
560
561
562
563
564
565
  if (this->CheckForError(resultTuple.GetPointer()))
    {
    return false;
    }

  // numpyArray is a borrowed reference, no smart wrapper needed:
  PyObject *numpyArray = PyTuple_GetItem(resultTuple.GetPointer(), 0);
  if (this->CheckForError(numpyArray))
    {
    return false;
    }

566
  vtkSmartPyObject dimTuple(PyObject_GetAttrString(numpyArray,
David C. Lonie's avatar
David C. Lonie committed
567
                                                const_cast<char*>("shape")));
568
569
570
571
572
573
574
575
576
577
578
  if (this->CheckForError(dimTuple.GetPointer()))
    {
    return false;
    }

  PyArg_ParseTuple(dimTuple.GetPointer(), "ii", &rows, &cols);
  if (this->CheckForError())
    {
    return false;
    }

579
580
  int extent[4];
  this->GetJustifiedBBox(rows, cols, tprop, extent);
581
582
583
584

  // Determine the dimensions of the rotated image
  double angleDeg = tprop->GetOrientation();
  // Corners of original image
585
  double corners[4][2] = {
586
587
588
589
    {static_cast<double>(extent[0]), static_cast<double>(extent[2])},   // TL
    {static_cast<double>(extent[1]), static_cast<double>(extent[2])},   // TR
    {static_cast<double>(extent[0]), static_cast<double>(extent[3])},   // BL
    {static_cast<double>(extent[1]), static_cast<double>(extent[3])} }; // BR
590
591
592

  double bboxd[4];
  this->RotateCorners(angleDeg, corners, bboxd);
593
594
595
596
597
598
599
600
601
602
603
604
605
606

  metrics.BoundingBox[0] = vtkMath::Floor(bboxd[0]);
  metrics.BoundingBox[1] = vtkMath::Ceil(bboxd[1]);
  metrics.BoundingBox[2] = vtkMath::Floor(bboxd[2]);
  metrics.BoundingBox[3] = vtkMath::Ceil(bboxd[3]);

  metrics.TopLeft[0]     = vtkMath::Round(corners[0][0]);
  metrics.TopLeft[1]     = vtkMath::Round(corners[0][1]);
  metrics.TopRight[0]    = vtkMath::Round(corners[1][0]);
  metrics.TopRight[1]    = vtkMath::Round(corners[1][1]);
  metrics.BottomLeft[0]  = vtkMath::Round(corners[2][0]);
  metrics.BottomLeft[1]  = vtkMath::Round(corners[2][1]);
  metrics.BottomRight[0] = vtkMath::Round(corners[3][0]);
  metrics.BottomRight[1] = vtkMath::Round(corners[3][1]);
607
608
609
610

  return true;
}

David C. Lonie's avatar
David C. Lonie committed
611
612
613
614
//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::RenderString(const char *str,
                                                  vtkImageData *image,
                                                  vtkTextProperty *tprop,
615
                                                  int dpi,
616
                                                  int textDims[2])
David C. Lonie's avatar
David C. Lonie committed
617
{
618
619
620
621
622
623
  if (!this->IsAvailable())
    {
    vtkErrorMacro(<<"Matplotlib rendering is unavailable.");
    return false;
    }

David C. Lonie's avatar
David C. Lonie committed
624
625
626
627
628
629
630
631
632
633
634
635
636
637
  if (!this->MaskParser)
    {
    if (!this->InitializeMaskParser())
      {
      vtkErrorMacro(<<"MaskParser is not initialized!");
      return false;
      }
    }

  vtkDebugMacro(<<"Converting '" << str << "' into MathText image...");

  long int rows = 0;
  long int cols = 0;
  long int ind = 0;
638
639
640
641
642

  double *fgColor = tprop->GetColor();
  unsigned char fgR = static_cast<unsigned char>(fgColor[0] * 255);
  unsigned char fgG = static_cast<unsigned char>(fgColor[1] * 255);
  unsigned char fgB = static_cast<unsigned char>(fgColor[2] * 255);
643
  double fgA = tprop->GetOpacity();
644
645
646
647
648

  double *bgColor = tprop->GetBackgroundColor();
  unsigned char bgR = static_cast<unsigned char>(bgColor[0] * 255);
  unsigned char bgG = static_cast<unsigned char>(bgColor[1] * 255);
  unsigned char bgB = static_cast<unsigned char>(bgColor[2] * 255);
649
650
  double bgA = tprop->GetBackgroundOpacity();
  bool hasBackground = (static_cast<unsigned char>(bgA * 255) != 0);
David C. Lonie's avatar
David C. Lonie committed
651

652
  vtkSmartPyObject resultTuple(PyObject_CallMethod(this->MaskParser,
653
654
655
656
                                                   const_cast<char*>("to_mask"),
                                                   const_cast<char*>("sii"),
                                                   const_cast<char*>(str),
                                                   tprop->GetFontSize(), dpi));
David C. Lonie's avatar
David C. Lonie committed
657
658
659
660
661
662
663
664
665
666
667
668
  if (this->CheckForError(resultTuple.GetPointer()))
    {
    return false;
    }

  // numpyArray is a borrowed reference, no smart wrapper needed:
  PyObject *numpyArray = PyTuple_GetItem(resultTuple.GetPointer(), 0);
  if (this->CheckForError(numpyArray))
    {
    return false;
    }

669
  vtkSmartPyObject flatArray(PyObject_CallMethod(numpyArray,
David C. Lonie's avatar
David C. Lonie committed
670
671
                                              const_cast<char*>("flatten"),
                                              const_cast<char*>("")));
David C. Lonie's avatar
David C. Lonie committed
672
673
674
675
676
  if (this->CheckForError(flatArray.GetPointer()))
    {
    return false;
    }

677
  vtkSmartPyObject list(PyObject_CallMethod(flatArray.GetPointer(),
David C. Lonie's avatar
David C. Lonie committed
678
679
                                         const_cast<char*>("tolist"),
                                         const_cast<char*>("")));
David C. Lonie's avatar
David C. Lonie committed
680
681
682
683
684
  if (this->CheckForError(list.GetPointer()))
    {
    return false;
    }

685
  vtkSmartPyObject dimTuple(PyObject_GetAttrString(numpyArray,
David C. Lonie's avatar
David C. Lonie committed
686
                                                const_cast<char*>("shape")));
David C. Lonie's avatar
David C. Lonie committed
687
688
689
690
691
692
693
694
695
696
697
  if (this->CheckForError(dimTuple.GetPointer()))
    {
    return false;
    }

  PyArg_ParseTuple(dimTuple.GetPointer(), "ii", &rows, &cols);
  if (this->CheckForError())
    {
    return false;
    }

Dave DeMarle's avatar
Dave DeMarle committed
698
  //numPixels = PyObject_Length(list.GetPointer());
David C. Lonie's avatar
David C. Lonie committed
699
700
701
702
703
  if (this->CheckForError())
    {
    return false;
    }

704
705
706
707
708
709
  if (textDims)
    {
    textDims[0] = cols;
    textDims[1] = rows;
    }

710
711
712
713
  // Create justified bounding box.
  int bbox[4];
  this->GetJustifiedBBox(rows, cols, tprop, bbox);

714
  this->PrepareImageData(image, bbox);
715

716
  for (long int row = bbox[3]; row >= bbox[2]; --row)
David C. Lonie's avatar
David C. Lonie committed
717
    {
718
    for (long int col = bbox[0]; col <= bbox[1]; ++col)
David C. Lonie's avatar
David C. Lonie committed
719
720
721
722
723
724
725
      {
      // item is borrowed, no need for a smart wrapper
      PyObject *item = PyList_GetItem(list.GetPointer(), ind++);
      if (this->CheckForError(item))
        {
        return false;
        }
726
      const unsigned char val = static_cast<unsigned char>(PyInt_AsLong(item));
David C. Lonie's avatar
David C. Lonie committed
727
728
729
730
731
732
      if (this->CheckForError())
        {
        return false;
        }
      unsigned char *ptr =
          static_cast<unsigned char*>(image->GetScalarPointer(col, row, 0));
733

734
735
736
737
      if (hasBackground)
        {
        const float fg_blend = fgA * (val / 255.f);
        const float bg_blend = 1.f - fg_blend;
738

739
740
741
742
743
744
745
746
747
748
749
750
        ptr[0] = static_cast<unsigned char>(bg_blend * bgR + fg_blend * fgR);
        ptr[1] = static_cast<unsigned char>(bg_blend * bgG + fg_blend * fgG);
        ptr[2] = static_cast<unsigned char>(bg_blend * bgB + fg_blend * fgB);
        ptr[3] = static_cast<unsigned char>(255 * (fg_blend + bgA * bg_blend));
        }
      else
        {
        ptr[0] = fgR;
        ptr[1] = fgG;
        ptr[2] = fgB;
        ptr[3] = static_cast<unsigned char>(val * fgA);
        }
David C. Lonie's avatar
David C. Lonie committed
751
752
753
      }
    }

754
755
756
757
758
  // Mark the image data as modified, as it is possible that only
  // vtkImageData::Get*Pointer methods will be called, which do not update the
  // MTime.
  image->Modified();

759
760
761
762
763
764
765
766
767
  // Determine the dimensions of the rotated image
  double angleDeg = tprop->GetOrientation();
  // Save some time if no rotation needed
  if (fabs(angleDeg) < 0.01)
    {
    return true;
    }

  // Corners of original image
768
769
770
771
772
773
774
775
  double corners[4][2] = { {static_cast<double>(bbox[0]),
                            static_cast<double>(bbox[2])},
                           {static_cast<double>(bbox[1]),
                            static_cast<double>(bbox[2])},
                           {static_cast<double>(bbox[0]),
                            static_cast<double>(bbox[3])},
                           {static_cast<double>(bbox[1]),
                            static_cast<double>(bbox[3])} };
776
  double bboxd[4];
777
778

  // Rotate the corners of the image and determine the bounding box
779
  this->RotateCorners(angleDeg, corners, bboxd);
780

781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
  // Also rotate the text dimensions.
  if (textDims)
    {
    double text_bbox[4];
    corners[0][0] = static_cast<double>(0);
    corners[0][1] = static_cast<double>(0);
    corners[1][0] = static_cast<double>(0);
    corners[1][1] = static_cast<double>(textDims[1]);
    corners[2][0] = static_cast<double>(textDims[0]);
    corners[2][1] = static_cast<double>(textDims[1]);
    corners[3][0] = static_cast<double>(textDims[0]) ;
    corners[3][1] = static_cast<double>(0);
    this->RotateCorners(angleDeg, corners, text_bbox);
    textDims[0] = std::ceil(text_bbox[1] - text_bbox[0]);
    textDims[1] = std::ceil(text_bbox[3] - text_bbox[2]);
    }

798
799
800
801
  bbox[0] = vtkMath::Floor(bboxd[0]);
  bbox[1] = vtkMath::Ceil(bboxd[1]);
  bbox[2] = vtkMath::Floor(bboxd[2]);
  bbox[3] = vtkMath::Ceil(bboxd[3]);
802

803
804
805
806
807
  // Rotate the temporary image into the returned image:
  vtkNew<vtkTransform> rotation;
  rotation->RotateWXYZ(-angleDeg, 0, 0, 1);
  // Dummy image with the output dimensions
  vtkNew<vtkImageData> dummyImage;
808
  this->PrepareImageData(dummyImage.GetPointer(), bbox);
809
810
811
812
813
814
815
816
  vtkNew<vtkImageReslice> rotator;
  rotator->SetInputData(image);
  rotator->SetInformationInput(dummyImage.GetPointer());
  rotator->SetResliceTransform(rotation.GetPointer());
  rotator->SetInterpolationModeToLinear();
  rotator->Update();
  image->ShallowCopy(rotator->GetOutput());

David C. Lonie's avatar
David C. Lonie committed
817
818
819
820
821
822
  return true;
}

//----------------------------------------------------------------------------
bool vtkMatplotlibMathTextUtilities::StringToPath(const char *str,
                                                  vtkPath *path,
823
824
                                                  vtkTextProperty *tprop,
                                                  int dpi)
David C. Lonie's avatar
David C. Lonie committed
825
{
826
827
828
829
830
831
  if (!this->IsAvailable())
    {
    vtkErrorMacro(<<"Matplotlib rendering is unavailable.");
    return false;
    }

David C. Lonie's avatar
David C. Lonie committed
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
  if (!this->PathParser)
    {
    if (!this->InitializePathParser())
      {
      vtkErrorMacro(<<"PathParser is not initialized!");
      return false;
      }
    }

  vtkDebugMacro(<<"Converting '" << str << "' into a vtkPath...");

  // Matplotlib path codes:
  const int pathStop = 0;
  const int pathMoveTo = 1;
  const int pathLineTo = 2;
  const int pathCurve3 = 3;
  const int pathCurve4 = 4;
  const int pathClosePoly = 0x4f;

  // List sizes:
  Py_ssize_t numCodes;
  Py_ssize_t numVerts;

  // Temp vars:
856
  float origin[2] = {0.0, 0.0};
David C. Lonie's avatar
David C. Lonie committed
857
858
859
  float vert[2];
  float delta[2] = {0.0, 0.0};
  int code;
860
  bool hasOrigin = false;
David C. Lonie's avatar
David C. Lonie committed
861
862
863
864

  // Bounding box for all control points, used for justification
  float cbox[4] = {VTK_FLOAT_MAX, VTK_FLOAT_MAX, VTK_FLOAT_MIN, VTK_FLOAT_MIN};

865
  // The path is always generated using a 100pt font @72 dpi. Use this factor to
David C. Lonie's avatar
David C. Lonie committed
866
  // recover the font.
867
868
  const float fontScale = (tprop->GetFontSize() / 100.f) * (dpi / 72.f) ;

David C. Lonie's avatar
David C. Lonie committed
869
870
871
  path->Reset();

  // Create the font property
872
  vtkSmartPyObject pyFontProp(this->GetFontProperties(tprop));
David C. Lonie's avatar
David C. Lonie committed
873
874
875
876
877
  if (this->CheckForError(pyFontProp.GetPointer()))
    {
    return false;
    }

878
  vtkSmartPyObject pyResultTuple(
David C. Lonie's avatar
David C. Lonie committed
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
        PyObject_CallMethod(this->PathParser,
                            const_cast<char*>("get_text_path"),
                            const_cast<char*>("Osi"),
                            pyFontProp.GetPointer(),// prop
                            const_cast<char*>(str), // texstring
                            1,                      // boolean, ismath
                            0));                    // boolean, usetex
  if (this->CheckForError(pyResultTuple.GetPointer()))
    {
    return false;
    }

  // pyVerts and pyCodes are borrowed references -- no need for smart wrappers
  PyObject *pyVerts = PyTuple_GetItem(pyResultTuple.GetPointer(), 0);
  PyObject *pyCodes = PyTuple_GetItem(pyResultTuple.GetPointer(), 1);
  if (this->CheckForError(pyVerts)  ||
      this->CheckForError(pyCodes))
    {
    return false;
    }

  // Both verts and codes are lists?
  if (!PySequence_Check(pyVerts) || !PySequence_Check(pyCodes))
    {
    return false;
    }

  numVerts = PySequence_Size(pyVerts);
  numCodes = PySequence_Size(pyCodes);
  if (numVerts != numCodes)
    {
    return false;
    }

  path->Allocate(numVerts);

  for (Py_ssize_t i = 0; i < numVerts; ++i)
    {
917
918
    vtkSmartPyObject pyVert(PySequence_GetItem(pyVerts, i));
    vtkSmartPyObject pyCode(PySequence_GetItem(pyCodes, i));
David C. Lonie's avatar
David C. Lonie committed
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
    if (this->CheckForError(pyVert.GetPointer()) ||
        this->CheckForError(pyCode.GetPointer()))
      {
      return false;
      }

    // pyVert is sometimes a numpy array, sometimes it's a tuple.
    // Initialize the following objects in the following conditional, then
    // convert to smart pointers afterwards.
    PyObject *pyVertXObj = NULL;
    PyObject *pyVertYObj = NULL;
    if (pyVert->ob_type == &PyTuple_Type)
      {
      pyVertXObj = PyTuple_GetItem(pyVert.GetPointer(), 0);
      pyVertYObj = PyTuple_GetItem(pyVert.GetPointer(), 1);
      // Increase reference count -- the other branch returns a new reference,
      // this keeps cleanup consistent
      if (pyVertXObj)
        {
        Py_INCREF(pyVertXObj);
        }
      if (pyVertYObj)
        {
        Py_INCREF(pyVertYObj);
        }
      }
    else // Assume numpy array. Convert to list and extract elements.
      {
947
      vtkSmartPyObject pyVertList(PyObject_CallMethod(pyVert.GetPointer(),
David C. Lonie's avatar
David C. Lonie committed
948
949
                                                   const_cast<char*>("tolist"),
                                                   NULL));
David C. Lonie's avatar
David C. Lonie committed
950
951
952
953
954
955
956
957
958
959
      if (this->CheckForError(pyVertList.GetPointer()) ||
          PySequence_Size(pyVertList.GetPointer()) < 2)
        {
        return false;
        }

      pyVertXObj = PySequence_GetItem(pyVertList.GetPointer(), 0);
      pyVertYObj = PySequence_GetItem(pyVertList.GetPointer(), 1);
      }

960
961
    vtkSmartPyObject pyVertX(pyVertXObj);
    vtkSmartPyObject pyVertY(pyVertYObj);
David C. Lonie's avatar
David C. Lonie committed
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
    if (this->CheckForError(pyVertX.GetPointer()) ||
        this->CheckForError(pyVertY.GetPointer()))
      {
      return false;
      }

    vert[0] = PyFloat_AsDouble(pyVertX.GetPointer()) * fontScale;
    vert[1] = PyFloat_AsDouble(pyVertY.GetPointer()) * fontScale;
    if (this->CheckForError())
      {
      return false;
      }

    if (vert[0] < cbox[0])
      {
      cbox[0] = vert[0];
      }
    if (vert[1] < cbox[1])
      {
      cbox[1] = vert[1];
      }
    if (vert[0] > cbox[2])
      {
      cbox[2] = vert[0];
      }
    if (vert[1] > cbox[3])
      {
      cbox[3] = vert[1];
      }

    code = PyInt_AsLong(pyCode.GetPointer());
    if (this->CheckForError())
      {
      return false;
      }

    switch (code)
      {
      case pathStop:
        hasOrigin = false;
        break;
      case pathMoveTo:
        path->InsertNextPoint(vert[0], vert[1], 0, vtkPath::MOVE_TO);
        origin[0] = vert[0];
        origin[1] = vert[1];
        hasOrigin = true;
        break;
      case pathLineTo:
        path->InsertNextPoint(vert[0], vert[1], 0, vtkPath::LINE_TO);
        break;
      case pathCurve3:
        path->InsertNextPoint(vert[0], vert[1], 0, vtkPath::CONIC_CURVE);
        break;
      case pathCurve4:
        path->InsertNextPoint(vert[0], vert[1], 0, vtkPath::CUBIC_CURVE);
        break;
      case pathClosePoly:
        if (hasOrigin)
          path->InsertNextPoint(origin[0], origin[1], 0, vtkPath::LINE_TO);
        hasOrigin = false;
        break;
      default:
        vtkWarningMacro(<<"Unrecognized code: " << code);
        break;
      }
    }

  // Apply justification:
  switch (tprop->GetJustification())
    {
    default:
    case VTK_TEXT_LEFT:
      delta[0] = -cbox[0];
      break;
    case VTK_TEXT_CENTERED:
      delta[0] = -(cbox[2] - cbox[0]) * 0.5;
      break;
    case VTK_TEXT_RIGHT:
      delta[0] = -cbox[2];
      break;
    }
  switch (tprop->GetVerticalJustification())
    {
    default:
    case VTK_TEXT_BOTTOM:
      delta[1] = -cbox[1];
      break;
    case VTK_TEXT_CENTERED:
      delta[1] = -(cbox[3] - cbox[1]) * 0.5;
      break;
    case VTK_TEXT_TOP:
      delta[1] = -cbox[3];
    }

1056
1057
1058
  const double theta = vtkMath::RadiansFromDegrees(tprop->GetOrientation());
  const double sinTheta = sin(theta);
  const double cosTheta = cos(theta);
David C. Lonie's avatar
David C. Lonie committed
1059
  vtkPoints *points = path->GetPoints();
1060
1061
  double point[3];
  double newPoint[3];
David C. Lonie's avatar
David C. Lonie committed
1062
1063
  for (vtkIdType i = 0; i < points->GetNumberOfPoints(); ++i)
    {
1064
    points->GetPoint(i, point);
David C. Lonie's avatar
David C. Lonie committed
1065
1066
    point[0] += delta[0];
    point[1] += delta[1];
1067
1068
1069
1070
    newPoint[0] = (point[0] * cosTheta) - (point[1] * sinTheta);
    newPoint[1] = (point[0] * sinTheta) + (point[1] * cosTheta);
    newPoint[2] = point[2];
    points->SetPoint(i, newPoint);
David C. Lonie's avatar
David C. Lonie committed
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
    }


  return true;
}

//----------------------------------------------------------------------------
void vtkMatplotlibMathTextUtilities::PrintSelf(ostream &os, vtkIndent indent)
{
  this->Superclass::PrintSelf(os, indent);

1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
  os << indent << "MPLMathTextAvailable: ";
  switch (this->MPLMathTextAvailable)
    {
    case vtkMatplotlibMathTextUtilities::NOT_TESTED:
      os << "Not tested\n";
      break;
    case vtkMatplotlibMathTextUtilities::AVAILABLE:
      os << "Available\n";
      break;
    default:
    case vtkMatplotlibMathTextUtilities::UNAVAILABLE:
      os << "Unavailable\n";
      break;
    }

David C. Lonie's avatar
David C. Lonie committed
1097
1098
1099
1100
  os << indent << "MaskParser: " << this->MaskParser << endl;
  os << indent << "PathParser: " << this->PathParser << endl;
  os << indent << "FontPropertiesClass: " << this->FontPropertiesClass << endl;
}