ALL Metrics
-
Views
-
Downloads
Get PDF
Get XML
Cite
Export
Track
Software Tool Article

CyAnimator: Simple Animations of Cytoscape Networks

[version 1; peer review: 1 approved, 1 approved with reservations]
PUBLISHED 05 Aug 2015
Author details Author details
OPEN PEER REVIEW
REVIEWER STATUS

This article is included in the Bioinformatics gateway.

This article is included in the Cytoscape gateway.

Abstract

CyAnimator (http://apps.cytoscape.org/apps/cyanimator) is a Cytoscape app that provides a tool for simple animations of Cytoscape networks. The tool allows you to take a series of snapshots (CyAnimator calls them frames) of Cytoscape networks. For example, the first frame might be of a network shown from a ”zoomed out” viewpoint and the second frame might focus on a specific group of nodes. Once these two frames are captured by the tool, it can animate between them by interpolating the changes in location, zoom, node color, node size, edge thickness, presence or absence of annotations, etc. The animations may be saved as a series of individual frames, animated GIFs, MP4 movies, or H.264/MOV
movies. CyAnimator is available from within the Cytoscape App Manager or from the Cytoscape app store.

Keywords

Cytoscape, CyAnimator, network, animation

Introduction

Biological networks are typically represented as nodes and edges (node-link diagrams) that might represent the pathways, signaling cascades, interactions between proteins, and other relationships between biological entities. The problem with this representation is that it makes it seem like these relationships are static, but it is well known that biological networks are dynamic, adapting and changing in response to the cell cycle, environmental conditions, development, and, over longer periods of time, evolution. One of the best methods to represent these changes is to take advantage of motion, showing changes by interpolating between the two states. This use of motion is one way to address “change blindness”1, which makes it difficult to detect the difference between two images when they are shown in succession. This is important both for presentation of results to collaborators and the broader scientific community and for the exploration of data by individual researchers.

Cytoscape2 is one of the most common tools used to visualize and analyze biological networks. It provides very powerful visualization tools to map a variety of categorical and numeric data into visual attributes associated with the nodes and edges of node-link diagrams. Unfortunately, Cytoscape does not provide any inherent animation capabilities, making it difficult to use interpolation to detect changes between two states, however, Cytoscape does provide a rich infrastructure for extending its core functionality through “apps”3. Several Cytoscape apps provide some animation capabilities. For example, VistaClara4, 3DScape5, and clusterMaker6 provide support to animate through the columns of a heat map. DynNetwork (http://apps.cytoscape.org/apps/dynnetwork) reads specially constructed input files that specifically encodes changes to the network over time. Of these, only clusterMaker2 and DynNetwork are available in Cytoscape 3, and offer relatively limited restrictive animation capabilities (in the case of clusterMaker2) or require construction of special input files in advance (in the case of DynNetwork). None of the available tools allows for the animation of arbitrary changes to the network topology or visualization.

CyAnimator attempts to fill this gap by providing a tool that supports animation by allowing the user to designate particular network views as “key frames”. These frames represent the state of the network at particular moments in time including the current list of nodes and edges and the visual attributes of those nodes and edges. The user may then arrange those frames in a desired sequence and CyAnimator will interpolate between the frames resulting in a smooth animation between the states of the network. The resulting animation may be saved as a movie.

Methods

Implementation

The main object in CyAnimator is a CyFrame, which contains all of the information about the visual attributes of the network background, annotations, nodes, and edges. This information is stored in a series of maps indexed either by the internal unique identifier (SUID) of the node or edge or by a hashCode of the annotation object, if the stored object is an annotation. CyAnimator makes heavy use of the visual property system in Cytoscape and the pseudocode for the general loop for populating a CyFrame is:

getNetworkVisualProperties();
foreach Node:
    getNodeVisualProperties();
foreach Edge:
    getEdgeVisualProperties();
foreach Annotation:
    getAnnotationVisualProperties();
getImage();

The captured image is used to show thumbnails to the user in the CyAnimator dialog (see below). In general, getting the visual properties results in a series of maps, one map for each property. These maps are used to restore the state of the network or to form the basis for the interpolations. In hindsight, this was an unfortunate way to implement the storage of the individual visual properties. In the current implementation, when we want to add support for a new visual property, we must create a new map for it, add code to populate the map, add code to explicitly set that visual property on a network view, and finally add the appropriate code to interpolate between two values of that visual property. This would have been much easier if we had instead stored a map of the form:

Map<Long, Map<VisualProperty, Object>>

where the Long key would be the SUID of the object. We could then maintain a list of VisualProperties, or even a map linking VisualProperty to Interpolator. This would greatly facilitate adding new visual properties to the system. We plan on refactoring CyAnimator in a future release to implement this new approach.

When the user clicks on a frame in the CyAnimator dialog or during the animation, the stored visual properties must be mapped onto the current network. This is a straightforward mapping except in circumstances where the current network does not have the node, edge, or annotation that the stored CyFrame had or the CyFrame did not have a node, edge, or annotation that the current network has. In the first case, the missing object is added to the network and styled using the stored information. This approach depends on the fact that deleted nodes and edges are not removed from the CyRootNetwork, so the topology of the network at the time the CyFrame was stored may be recreated. In the second case, the CyFrame sets the visibility of the object to false, resulting in a network view that is consistent with the saved visual properties.

Interpolation between CyFrames is handled by the Interpolator, which maintains lists of interpolators for node visual attributes, edge visual attributes, annotation visual attributes, and network visual attributes. The Interpolator makeFrames() method takes as input the list of CyFrames, the user saved (key frames) and returns an array of frames that includes interpolations between each pair of key frames. So, if the user has requested 30 frames between each key frame, and created 5 key frames, makeFrames(), will return 121 frames, which is the number of key frames to interpolate between (key frames - 1), multiplied by the number of interpolations between each key frame, plus the initial key frame ( (keyframes - 1)*interpolations + 1).

CyAnimator currently supports 5 different interpolation types:

Linear:Values are linearly interpolated between
the two key frames
Bezier:Used for transparency to fade in slowly
and fade out slowly
Instant:No real interpolation – switch between
values 1/2 way through the set of frames
Fade-in/Fade-out:Linearly fade out then fade in. Essentially
this is as close as we can get to a crossfade
effect.
None:This visual attribute is not interpolated.

Table 1 shows the interpolated visual attributes and the type of interpolation. In the current version of Cytoscape, there is no mechanism to get the list of node custom graphics for a particular node, so charts, gradients, and other custom graphics can not be interpolated. CyAnimator also doesn’t currently support interpolation of arrow colors. This is an oversight that will be rectified in a future version.

Table 1. Visual Property Interpolations.

Object TypeVisual AttributesInterpolation
NetworkBackground Paint, Scale Factor, Size, Center X Location, Center Y Location
Title
Linear
None
NodePosition, Border Width, Label Font Size, Size, Fill Color, Border Color, Label Color
Transparency, Border Transparency
Label
Font Face, Shape, Border Line Type
Label Position, Custom Paint
Linear
Bezier
Fade-out/Fade-in
Instant
None
EdgeStroke Color (Unselected), Label Color, Label Font Size, Width
Transparency
Line Type, Source Arrow Shape, Target Arrow Shape
Label
Source Arrow Unselected Paint, Target Arrow Unselected Paint
Linear
Bezier
Instant
Fade-in/Fade-out
None
AnnotationsPosition, Size, Color,
Text
Linear
Instant

To implement the creation of a movie, three different mechanisms are used. In each case, an image file is created for each interpolated frame. One option the user has is to just write out the individual frames and allow them to use whatever movie making tool they desire. We have also implemented an animated GIF writer using the native Java ImageIO library. Finally, for creating MP4 or H.264 movies, we utilize the Xuggler (http://www.xuggle.com/xuggler/) Java library, which includes the necessary video codecs.

Operation

To bring up CyAnimator select Apps→CyAnimator. This will bring up an empty CyAnimator dialog (Figure 1). Note that CyAnimator is only able to animate between networks in the same network collection. Starting CyAnimator on a new network collection will create a new, empty, CyAnimator dialog. Once a CyAnimator dialog is open, the general workflow would be to manipulate the network to what you want it to look like at the start of your movie, then select Add Frame to add the frame to CyAnimator. Once the frame has been added, you can modify your network to what you want it to look like in the next frame of your movie and then again select Add Frame. Note that CyAnimator will do all of the interpolation to get from one frame to another, so the manipulations of the network can include a variety of changes, including changes in color, position, zoom, annotations, etc. Repeat this process until you are happy with your movie, then simply press the record (f7e9e483-a882-4433-893e-abfc727040c2_table6.gif) button. If you want more time between any two frames, use the context menu to change the Interpolations value.

f7e9e483-a882-4433-893e-abfc727040c2_figure1.gif

Figure 1. The CyAnimator Dialog showing two key frames.

CyAnimator dialog

The CyAnimator dialog provides the main interface to CyAnimator, including the following controls:

Add FrameAdd the current network view as a frame to the
animation.
f7e9e483-a882-4433-893e-abfc727040c2_table1.gif Play the animation by interpolating through each
frame.
f7e9e483-a882-4433-893e-abfc727040c2_table2.gif Pause the currently playing animation.
f7e9e483-a882-4433-893e-abfc727040c2_table3.gif Stop the currently playing animation.
f7e9e483-a882-4433-893e-abfc727040c2_table4.gif Step backwards to the previous interpolated
frame.
f7e9e483-a882-4433-893e-abfc727040c2_table5.gif Step forwards to the next interpolated frame.
f7e9e483-a882-4433-893e-abfc727040c2_table6.gif Bring up the Output Options dialog and record a
movie or (optionally) save each of the interpolated
frames.
Speed sliderThe speed slider controls the speed of the animation
(but is ignored for the recorded movies, which uses
it’s own Frames Per Second option.

Frame context menu

In addition to the menu bar controls discussed above, each frame provides a context menu that’s available through a Right-click (or Control-click on Mac). These menu items are:

InterpolateSelect the number of frames to interpolate between
this frame and the previous frame. This allows you
to control the duration of the interpolation—to
increase the speed between this frame and the
previous frame, select fewer interpolation frames;
more interpolation frames will result in a longer
animation.
DeleteDelete the current frame.
Move RightMove this frame right (later in the animation).
Move LeftMove this frame left (earlier in the animation).

Output options

The Output Options Dialog (see Figure 2) provides the controls to choose the type of video you want to produce, options about the resolution and speed of the video, and the location of the video output.

f7e9e483-a882-4433-893e-abfc727040c2_figure2.gif

Figure 2. The Output Options Dialog showing the production of an H.264 video file at three times the screen resolution and 50 frames/second.

Video types

Frames. This is the simplest of the video types. This will output each frame as a ".png" file at the requested resolution (see ’Resolution’ below) into the Video location directory specified. To make a movie, you could use any of the standard video packages that accept individual frames (e.g. iMovie on Mac). Note that the Frames Per Second option doesn’t make sense for this output type since we’re only writing individual frames (no time encoding), so this option is disabled (grayed out) in the interface.

GIF. This will output an animated GIF of the interpolated frames. Animated GIF files are easy to show on web sites, but are not the currently accepted standard format. On the other hand, animated GIF files are computationally very easy to produce.

MP4. This will output a raw MPEG4 file of the interpolated frames. Producing an MP4 (and a MOV/H264) can be computationally expensive, and will require more time and memory to complete.

MOV/H264. This will output an MPEG4-encoded video of the interpolated frames. The MPEG4 video is then encapsulated in an H.264 container. This is considered the current standard for web deployment of video content. Producing an MOV/H264 can be computationally expensive, and will require more time and memory to complete.

Frame options

Frames Per Second. This controls the speed of the movie in terms of the number of frames per second. Smooth animations should be set to at least 30 frames per second.

Resolution. This controls the resolution of the output frames. The units are % expansion, so a Resolution of 300 would result in a 300% (or 3X) expansion of the output image. This is extremely important for high-quality videos. We recommend at least a 3X (Resolution of 300) expansion for any published video.

Example movie

A sample movie is provided (see Supplementary_File_1.mov) that was created with CyAnimator and Cytoscape 3.3. This movie used galFiltered.cys, which may be located in the sampleData subdirectory of the Cytoscape installation directory (e.g. /Applications/Cytoscape_v3.2.1/sampleData on a Mac). The movie consisted of 4 key frames:

  • 1. the full network

  • 2. a view focused on MCM1

  • 3. the same view, but peripheral nodes were moved out of the way, and five annotations were added: three text annotations, a shape annotation around the three text strings, and an arrow pointing to MCM1

  • 4. another capture frame of the same view

Conclusions

CyAnimator is an important addition to the suite of Cytoscape apps. It provides an easy tool to interpolate between different states of a network and may be used to animate changes over time, condition, or treatment. One missing feature of CyAnimator is the ability to save the key frames of an animation as part of a session. We will be adding support for this in a future release.

Software availability

Archived source code as at the time of publication

http://dx.doi.org/10.5281/zenodo.206847

License: Lesser GNU Public License 3.0

https://www.gnu.org/licenses/lgpl.html

Comments on this article Comments (0)

Version 2
VERSION 2 PUBLISHED 05 Aug 2015
Comment
Author details Author details
Competing interests
Grant information
Copyright
Download
 
Export To
metrics
Views Downloads
F1000Research - -
PubMed Central
Data from PMC are received and updated monthly.
- -
Citations
CITE
how to cite this article
Morris JH, Vijay D, Federowicz S et al. CyAnimator: Simple Animations of Cytoscape Networks [version 1; peer review: 1 approved, 1 approved with reservations]. F1000Research 2015, 4:482 (https://doi.org/10.12688/f1000research.6852.1)
NOTE: If applicable, it is important to ensure the information in square brackets after the title is included in all citations of this article.
track
receive updates on this article
Track an article to receive email alerts on any updates to this article.

Open Peer Review

Current Reviewer Status: ?
Key to Reviewer Statuses VIEW
ApprovedThe paper is scientifically sound in its current form and only minor, if any, improvements are suggested
Approved with reservations A number of small changes, sometimes more significant revisions are required to address specific details and improve the papers academic merit.
Not approvedFundamental flaws in the paper seriously undermine the findings and conclusions
Version 1
VERSION 1
PUBLISHED 05 Aug 2015
Views
27
Cite
Reviewer Report 02 Sep 2015
Nathan Salomonis, Cincinnati Children's Hospital Medical Center Research Foundation, Cincinnati, OH, USA 
Approved with Reservations
VIEWS 27
The authors present a useful Cytoscape app that fills in an important void not provided by the parent application: dynamically transitioning between distinct network states or associated visualized datasets. The application is thus novel and provides an important function in ... Continue reading
CITE
CITE
HOW TO CITE THIS REPORT
Salomonis N. Reviewer Report For: CyAnimator: Simple Animations of Cytoscape Networks [version 1; peer review: 1 approved, 1 approved with reservations]. F1000Research 2015, 4:482 (https://doi.org/10.5256/f1000research.7370.r10174)
NOTE: it is important to ensure the information in square brackets after the title is included in all citations of this article.
  • Author Response 30 Dec 2015
    Scooter Morris, Resource for Biocomputing, Visualization and Informatics,, University of California, San Francisco, 94143, USA
    30 Dec 2015
    Author Response
    Thank you for your review.  I have just submitted version 2 of the CyAnimator paper, which corresponds to the latest release of the App on the Cytoscape App store.  The ... Continue reading
COMMENTS ON THIS REPORT
  • Author Response 30 Dec 2015
    Scooter Morris, Resource for Biocomputing, Visualization and Informatics,, University of California, San Francisco, 94143, USA
    30 Dec 2015
    Author Response
    Thank you for your review.  I have just submitted version 2 of the CyAnimator paper, which corresponds to the latest release of the App on the Cytoscape App store.  The ... Continue reading
Views
23
Cite
Reviewer Report 18 Aug 2015
Giovanni Scardoni, Center for BioMedical Computing, University of Verona, Verona, Italy 
Approved
VIEWS 23
The App is very useful and easy to use. As the article highlights It is very important to have a tool allowing the user to create animations from static frames of a network, and there are no other Cytoscape apps ... Continue reading
CITE
CITE
HOW TO CITE THIS REPORT
Scardoni G. Reviewer Report For: CyAnimator: Simple Animations of Cytoscape Networks [version 1; peer review: 1 approved, 1 approved with reservations]. F1000Research 2015, 4:482 (https://doi.org/10.5256/f1000research.7370.r9880)
NOTE: it is important to ensure the information in square brackets after the title is included in all citations of this article.

Comments on this article Comments (0)

Version 2
VERSION 2 PUBLISHED 05 Aug 2015
Comment
Alongside their report, reviewers assign a status to the article:
Approved - the paper is scientifically sound in its current form and only minor, if any, improvements are suggested
Approved with reservations - A number of small changes, sometimes more significant revisions are required to address specific details and improve the papers academic merit.
Not approved - fundamental flaws in the paper seriously undermine the findings and conclusions
Sign In
If you've forgotten your password, please enter your email address below and we'll send you instructions on how to reset your password.

The email address should be the one you originally registered with F1000.

Email address not valid, please try again

You registered with F1000 via Google, so we cannot reset your password.

To sign in, please click here.

If you still need help with your Google account password, please click here.

You registered with F1000 via Facebook, so we cannot reset your password.

To sign in, please click here.

If you still need help with your Facebook account password, please click here.

Code not correct, please try again
Email us for further assistance.
Server error, please try again.