Mayavi

=============

Enhancements
------------

30 Oct 2012 (PR)
- NEW: Adding a Qt version of the gradient editor. With this, all of
Mayavi's UI should be usable on Qt.

Fixes
------

11 Mar 2013 (Aestrivex)
- Fixed bug with incorrectly tiled snapshots while using savefig.

30 Oct 2012 (PR)
- BUG: Qt: fix crashing full-screen-mode. Fixed segfault when you click on
full-screen and press escape/q/e.

=============

Enhancements
------------

9 August 2012 (GV)
- ENH: Add null engine to mlab.pipeline.open.

===========================

Enhancements
------------

22 July 2010 (GV)
- ENH: Add error management for extents in mlab: some module cannot be
scaled [25683].

16 July 2010 (GV)

- ENH: Enable LUT defined by tables to have their number of colors
adjusted [25663].

Fixes
------


2 August 2010 (GV)
- BUG: Fix a segfault when updating lines on a MLineSource using 'reset'
and reducing the number of points [25700].

1 August 2010 (GV)
- BUG: Fix updating scalar scatters using mlab_source.set: a race condition
under Qt prevented the scalar range to be updated in time [25699].

25 July 2010 (GV)
- BUG: Fix corner cases in the pipeline browser: objects for which the
number of inputs is misreported, and iterable objects to do not contain
TVTKBase entries [25685,25686].

14 July 2010 (GV)
- BUG: Fix a bug in the poll_file example. Thanks to Jonathan Guyer for
pointing out the solution [25660].

===============================

Enhancements
------------

DOCs: many docs and example improvements (GV).

13 April 2010 (GV)
- API: Enforces wx >= 2.8 [25465,25471,25529]

11 April 2010 (GV)
- ENH: Add figure management to mlab.roll [25464].

6 March 2010 (GV)
- MISC: Change the default in iso_surface to compute normals, as with
recent VTK versions colors look ugly when normals are not computed
[25400].

Fixes
------

17 May 2010 (PR)
- BUG: Fixing wrapping for VTK-5.6 and above where one of the string
traits default to a value with a special character like "\n" "\r"
[25546].

17 April 2010 (GV)
- BUG: Fix integer casting in magnification for mlab.savefig [25483]

5 April 2010 (GV)
- BUG: A slight modification to enable inserting graph objects
in the Mayavi pipeline: the polydata created by the GraphToPolyData
filter had some 'None' arrays in their point_data [25434].

3 April 2010 (GV)
- BUG: Make the 'use_lookup_table' traits of the image_plane_widget
work. [25430]

===========================

Enhancements
------------

20 Dec, 2009 (GV):
- ENH: Merge in Scott Wart's patch to add an 'ImageChangeInformation
filter to ArraySource, with additional work to get the tests to pass
[25036], [25043]

14 Dec, 2009 (GV)
- ENH: Add helper functions to interact with object via callbacks by
clicking on them. The core function is the scene.on_mouse_pick, that is
demoed in the new example 'on_mouse_pick' [25016], [25019]

13 Dec, 2009 (GV):
- ENH: Make array_handler more robust to buffer protocole [25013]
- ENH: Add support for assigning numbers to MGlyphSource x, y, z, and u, v,
w [25015]

27 Nov 2009 (GV):
- ENH: Add an auto mode for mlab.view, for distance and focal point
[24971]

26 Nov, 2009 (GV):
- ENH: Add a probe_data to retrieve data from Mayavi or VTK objects [24966]

25 Nov, 2009 (GV):
- ENH: Usability: change the label of the '*.*' extension in th
decorated scene save snapshot dialog [24963]

12 Oct, 2009 (GV):
- ENH: Add script recording to the widget position for the DataSetClipper
filter [24826]

17 Sep, 2009 (PR):
- ENH: Making the widgets recordable [24738]

02 Sept 2009 (GV):
- ENH: Add a new glyph source: a cross, that can be used as a cursor, or a
axes [24678]

02 Sep, 2009 (GV):
- ENH: Add a figure argument to mlab.view and try to lift the figure on
screenshot [24676]
- DOC: Add a detailed example of using 'UserDefined' contributed b
Emmanuelle Gouillart [24677]

20 Aug, 2009 (PR):
- ENH: Don't persist mlab_source [24567]

14 Aug, 2009 (GV):
- ENH: Stop gap solution to limit the cost of auto-scaling the glyph
size with large arrays in barchart, when the positionning is
implicite, and thus distance calculation is pointless [24526]
- ENH: Do not update the rendering of the scene when using mlab
helper functions that build one object after another [24529]
- ENH: Add an argument to barchart to avoid expensive scaling computation
[24531]
- ENH: Make the scalars argument of mlab.pipeline.vector_field work with
lists too [24532]

13 Aug, 2009 (GV):
- ENH: Force an update of the data when using the set_active_attribute
filter, so that the names of all defined arrays are displayed [24464]
[24466], [24520], [24521], [24520]

04 Aug, 2009 (GV)
- ENH: Add a screenshot function to mlab for easy capture of the pixmap to
[24445]
- ENH: Add a patch contributed by Chris Colbert for control of the array
type in mlab.screenshot (rgb vs rgba) [24453]

03 Aug, 2009 (GV):
- MISC: Fix long-standing usability complain: OK button on adder nodes
not creating object [24443]

03 Aug, 2009 (PR):
- ENH: Adding to/from_array to the Matrix4x4 class for convenience
[24437]
- ENH: Thanks to a suggestion from Gary Ruben, mlab.plot3d now uses
tvtk.Stripper in the pipeline to produce smooth tubes [24438] [24442]
[24439]

01 Aug, 2009 (GV):
- DOC: Merge in Ondrej's more precise instructions on installing SVN on an
already-installed system [24428]

15 Jul, 2009 (GV):
- ENH: Open the possibility to have image plane widget working with
RGBA data [24169]

10 Jul, 2009 (GV):
- ENH: Allows for use of lists as a scalar argument in mlab function
[24094]

09 Jul 2009 (PR):
- ENH/API: Checking in patch from Erik Tollerud which adds a `move`, `yaw
and `pitch` to the mlab camera. Many thanks to Erik for this patch
[24083], [24084]

08 Jul, 2009 (GV):
- ENH: Capture any errors while building docs and fail gracefully
during the build [24067]

08 Jul, 2009 (GV):
- ENH: Try to force the use of wx2.8, or else do not display the logger
[24064], [24060]

07 Jul, 2009 (GV):
- ENH: Add a button and a menu entry to display the VTK documentation
browser [25058]

22 Jul, 2009 (Dave Peterson):
- Updated all __init__.py files with modulefinder code so that
py2app/py2exe can correctly determine what to include when packaging a
distribution. This is necessary due to the use of namespace packages
[24339]


Fixes
-----

21 Feb, 2010 (GV)
- BUG: Make the threshold filter better behaved when there are nans in
the data [25280]
- BUG: Remove callbacks on OrientationAxis that where triggering
useless redraws [25279]

15 Feb, 2010 (PR):
- BUG: Fix issue when an automatically generated trait name was actually
Python keyword. In these cases the trait name is simply appended with a
underscore (_). This should hopefully fix problems with building TVTK
with VTK from CVS [25236]

12 Feb, 2010 (Scott Warts):
- Reset the current scene if it is removed [ 25219]

08 Jan, 2010 (GV):
- BUG: Radius and length of a cylinder had upper bounds to 100, where
they should really be confined only to positive numbers. Fix with
kludge. Thanks to Michele Mattioni for pointing out the bug, and
providing the patch [25097]

20 Dec, 2009 (GV):
- BUG: Correct bug with visibility of OrientationAxes reported by Uche
Mennel [25037]
- BUG: Patch by Varun Hiremath to make build docs more robust [25039]
- BUG: Fix scalarbar positionning for VTK >= 5. [25040]
- BUG: Avoid a segfault when enabling the OrientationAxes without an
interactor [25044]
- MISC: Disable the use of IPython by default, there are right now too many
bugs with it [25041]

14 Dec, 2009 (GV):
- BUG: Fix test on pick dispatcher [25020]
- BUG: Fix a bug in tvtk.py, in the loading of tvtk classes generated code
when the path is not in the sys.path
Thank you to Ram Rachum for finding this problem, and the fix [25021]

26 Nov, 2009 (GV):
- BUG: Add forgotten file. Thanks to Darren Dale for reporting [24967]
- BUG: Fix mlab.pipeline.get_vtk_src for VTK dataset [24968]

25 Nov, 2009 (GV):
- BUG: Fix a bug in barchart [24962]

18 Nov, 2009 (Scott Warts):
- Don't reset the zoom level if there are volumes or actors. Before we
were just checking for actors [24932]

04 Nov, 2009 (GV):
- BUG: mlab.clf() was renabling rendering on figures, had it been
disabled [24874]

22 Oct, 2009 (Scott Warts):
- BUG: Fixed memory leak. Switched to using tvtk.messenger when adding
observers to keep from creating uncollectable cycles [24856], [24857]

14 Sep, 2009 (GV):
- BUG: Fix trivial bug when size in savefig was not specified, and
magnification was set to auto [24733]

19 Aug, 2009 (GV):
- BUG: Fix 'feature' of mlab.colorbar which would show up on objects with
scalar representation not enabled [24559]

19 Aug, 2009 (PR):
- BUG: Fixing some of the issues with colorbar and VTK versions greater
than 5.2 [24558]

18 Aug, 2009 (GV):
- BUG: The figure magnification was not working correctly. Fix [24569]
- BUG: Fix a traceback in mlab.show_pipeline if no scene was open [24553]

17 Aug, 2009 (PR):
- BUG: TVTK was not correctly wrapping newer versions of VTK
Specifically the vtkArray class was causing a traceback. This patch
appears to fix the problem. Thanks to Kyle Mandli for helping with
debugging this issue and testing the fix

14 Aug, 2009 (GV):
- BUG: Fix a bug when reseting the MlabTriangularMeshSource: when growing
the number of points, triangles were created before the corresponding
points. Thanks to Ondrej Certik for reporting this one

08 Aug, 2009 (GV):
- BUG: Fix a bug for with the notebook in wx example for which objects were
not added to the right scene [24492]

07 Aug, 2009 (Scott Warts):
- Added two more exceptions to state methods from ImageReslice:
SetOutputOriginToDefault and SetOutputExtentToDefault [24480]

06 Aug, 2009 (PR):
- BUG: vtkImageReslice's SetOutputSpacingToDefault does not make
OutputSpacing a state method. Thanks to Scott Swarts for pointing this
out [24476]

01 Aug, 2009 (Robert Kern):
- BUG: With a vtkWin32OpenGLRenderWindow, set the parent widget info
before resizing in order to avoid an offset bug [24427]

23 Jul, 2009 (Evan Patterson):
- BUG: Replacing deprecated calls to wx.Yield() [24379]

============================

Enhancements
------------

06 Jul, 2009 (PR):
- ENH/API: No longer save to a file (with a popup when a user unchecks the
record icon). Also added `start_recording` and `stop_recording`
functions to mlab to make it easier to do this via scripts [24048]

08 Jul, 2009 (GV):
- ENH: Make the MlabSceneModel manage the mlab current scene so that in
plots to the embedded scene, but does not upset the current
mlab figure [24040], [24065]

05 Jul 2009 (GV):
- ENH: Add the possibility to specify figures to mlab.figure by instance
rather than name [24039]
- ENH: Add an example of using multiple mlab scene models [24041]
- ENH: Add a figure keyword argument to mlab.pipeline factories to
control which figure objects are added on [2403]

02 July, 2009 (PR):
- ENH: The record icon on the engine view is smarter now and will
automatically be checked on and off if the engine's recorder trait in
set. This paves the way for a convenient mlab one liner to start
recording [24025]

01 Jul, 2009 (PR):
- NEW: Adding a new filter that clips an input dataset. Also added an
`ImplicitWidgets` component that abstracts a box, plane, sphere and
implicit plane widget into one reusable component. An initial patch was
contributed by Suyog and them modified by PR. Many thanks to Suyog for
this patch [24017]

01 Jul, 2009 (GV):
- ENH: Add an mlab.close function to close figures controled by mlab
[24006]

30 Jun, 2009 (PR):
- ENH/API: Checking in improved patch sent by Suyog along with fixes from me.
This adds a can_read_test metadata attribute for sources which can be
optionally specified, the function should return True if the reader can
read a given file. The patch also adds a volume reader and a chaco
reader and also supports the .xyz format reader provided in VTK. A test
for the new registry functionality is also added. The API has only
changed for the manner in which the registry is queried for a reader
using the file itself rather than the file extension. Many thanks to
Suyog for this work [24002]

29 Jun, 2009 (GV):
- ENH: Add an option to show_engine to show the rich view [23981]

14 Jun, 2009 (GV):
- BUG: mlab.set_engine was not registering engines, causing testing to
be difficult [23819]
- ENH: expose text3d in mlab [23820]
- ENH/TEST: rewamp the mlab testing infrastructure [23822]

13 Jun, 2009 (GV):
- ENH: Adapt mlab.savefig code to make it easier to save figures with size
larger than window size [23813]
- ENH: Add a text3d module, for displaying text located in the 3D scene
scaling and hiding as the other 3D actors [23809], [23810].
- ENH: Add a helper function to mlab to syncronize cameras on two
scenes [23814]

10 Jun, 2009 (PR):
- API: The name of the scene created on the mayavi2 app now defaults to
"Mayavi Scene %d" rather than "TVTK Scene %d". This is to make this
consistent with what `mlab.figure()` does and to avoid user confusion
[23787]

2 Jun, 2009 (PR):
- ENH: Ensuring that the scene editor's name is synced with the scene'
name. Also making the scene itself "renamable" [23710]

29 May, 2009 (PR):
- ENH: Also pickle the name of the scene -- it shouldn't hurt [23691]

18 May, 2009 (GV):
- ENH: cleaner exception capture for sensible error message [23660]

10 May, 2009 (GV):
- ENH: Use pickle rather than numpy npz for lookup table [23618]
[23619]
- API: Add PipelineBase to mayavi.core.api as it is needed for
the interactive example [23617]

9 May, 2009 (PR):
- ENH/API: Adding to the API of the lut manager with a show_legend boo
which is an alias for show_scalar_bar. This makes the UI a littl
clearer [23608]
- ENH: Adding ID's to the various pop-up editors for the lut manager s
their sizing etc. is persisted [23609]
- ENH/API: Exposing the scalar_bar_widget's representation in the UI an
API and recording it so changes to the scalar bar's position ar
recorded and editable on the UI [23610]


20 Apr, 2009 (GV):
ENH [23545]:
- Add an example gallery to the documentation

- Rewamp the documentation-generation code, and its packaging. Th
generation code was made more robust, and as a result n
generated test files are checked in svn. The images for th
mlab documentation and the mlab examples are generated by th
render_images.py script
- Space has been optimized by removing duplicated artwork an
moving outside of the source distribution files no
required for distribution

19 Apr, 2009 (GV)
- ENH: Use numpy's npz format for storing LUT information. This saves ~1Mo
from the source and binary distributions[23544]

11 Apr, 2009 (GV):
- ENH/API: add an API module to core, to give a central place for
important core import [23520]


Fixes
-----

15 Jul, 2009 (PR):
- BUG: Fix what I think is a long standing bug. You couldn't use the
envisage backend with mlab because of a problem with envisage'.
workbench application. I've worked around the problem in mayavi'
workbench subclass and added a test to ensure that this is now fixed
This basically adds a new trait to the Mayavi app and the mayavi
workbench application called `start_gui_event_loop` that is disabled
when used from mlab [24171]

6 Jul, 2009 (Dave Martin):
- BUG: If the scene being closed has None for scene.scene, call
registry.find_scene_engine(scene) instead of "scene.scene" [24052]
[24055]

05 Jul, 2009 (GV):
- BUG: small fix for successive builds of the tvtk code generation, by
Rakesh Pandit [24038]
- BUG: Do not create application directories on import of mayavi
preferences. [24036]

29 Jun, 2009 (GV):
- BUG: Make sure that the vertical vector source used for barchart is
well-behaved with regards to mlab_source.update [23983]

28 Jun, 2009 (PR):
- BUG: Mlab's barchart uses the scale_by_vector_components which was not
exposed by the glyph component leading to update problems reported by
Christian Vollmer. This is now fixed along with a simple test case.
There are deeper problems with barchart that do need attention though -
if a user changes the data inplace and calls the mlab_source.update()
nothing updates correctly since the data is really copied over to the
vector components. This can be fixed with a callback and will be done
later. [23980]

25 Jun, 2009 (PR):
- BUG: Was checking for attribute in editor assuming they were all scene
editors which is clearly wrong. This bug fixes problems with using
mayavi and a text editor say [23933]

2, Jun 2009 (PR):
- BUG: With recent versions of VTK when a VTK array is exported to a numpy
array, the numpy array is already a view so resetting the VTK array back
to the numpy array for some reason triggers a segfault. This is now
fixed [23711]
- BUG: The Engine's open method did not work with a null engine. Tested
and fixed [23713]

30 May, 2009 (PR):
- [TVTK] BUG: Working around problem with parser for
vtkRenderedGraphRepresentation which has non-standard arguments for some
of its SetIvarToState methods [23696]

26 Lay, 2009 (GV):
- BUG: Fix scaling bug for surf with warp_scale='auto'. Thanks to Jakob
Rohrhirsch for reporting it [23682]

6 May, 2009 (PR):
- BUG: The implicit plane widget was not recordable [23595]
- BUG: [mlab] mlab.pipeline.contour_grid_plane was broken [23596]

27 Apr, 2009 (GV):
- API: add an API module for core.ui [23562]
- DOC: Put up to date information on the engine [23560]

23 Apr, 2009 (GV):
- DOC: Add an example to show how you can have different engines in an
application [23558]

13 April, 2009 (PR):
- BUG: The trailing '|' in the wildcard breaks the file dialog's filterin
for user defined readers. Thanks to B. P. Thrane for reporting the bug

27 March, 2009 (GV):
- BUG: Fixed bug with importing customization contributions. Added a test
case for this. Thanks to Mario Ceresa for reporting the bug [23438]

23 March, 2009 (GV):
- BUG: Fix TVTK possible build failure, reported by Andrew Straw
https://bugs.launchpad.net/bugs/34693 [23371]



20 March, 2009 (PR):
- TEST/BUG: Adding a new test for the `tvtk.util.ctf` utility
functions. Also fixed a bug that affects VTK-5.2 and above where the
range of the CTF must be set [23267]
- BUG/CLEAN: Fixing a 5.2 specific bug in the volume module mlab function
Also cleaned up the mlab code for this a little [23268]