Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabian Prasser committed Jul 9, 2014
1 parent 7cb5cf6 commit a43b3fb
Show file tree
Hide file tree
Showing 292 changed files with 39,875 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .classpath
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="src" path="src/main"/>
<classpathentry kind="src" path="src/swt"/>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
<classpathentry kind="lib" path="lib/swt-4.2.1-gtk-linux-x86_64.jar"/>
<classpathentry kind="output" path="bin"/>
</classpath>
17 changes: 17 additions & 0 deletions .project
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>JHeatMapControl</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.jdt.core.javanature</nature>
</natures>
</projectDescription>
9 changes: 9 additions & 0 deletions .settings/net.sf.jautodoc.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
add_header=true
add_todo=false
eclipse.preferences.version=1
header_text=/*\n* JHC - Java Heatmap Control\n* Copyright (C) 2014 Fabian Prasser\n*\n* This program is free software\: you can redistribute it and/or modify\n* it under the terms of the GNU General Public License as published by\n* the Free Software Foundation, either version 3 of the License, or\n* (at your option) any later version.\n*\n* This program is distributed in the hope that it will be useful,\n* but WITHOUT ANY WARRANTY; without even the implied warranty of\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n* GNU General Public License for more details.\n*\n* You should have received a copy of the GNU General Public License\n* along with this program. If not, see <http\://www.gnu.org/licenses/>.\n*/
mode=mode_replace
multi_header=true
project_specific_settings=true
replace_header=true
replacements=<?xml version\="1.0" standalone\="yes"?>\n\n<replacements>\n<replacement key\="get" scope\="1" mode\="0">Returns the</replacement>\n<replacement key\="set" scope\="1" mode\="0">Sets the</replacement>\n<replacement key\="add" scope\="1" mode\="0">Adds the</replacement>\n<replacement key\="edit" scope\="1" mode\="0">Edits the</replacement>\n<replacement key\="remove" scope\="1" mode\="0">Removes the</replacement>\n<replacement key\="init" scope\="1" mode\="0">Inits the</replacement>\n<replacement key\="parse" scope\="1" mode\="0">Parses the</replacement>\n<replacement key\="create" scope\="1" mode\="0">Creates the</replacement>\n<replacement key\="build" scope\="1" mode\="0">Builds the</replacement>\n<replacement key\="is" scope\="1" mode\="0">Checks if is</replacement>\n<replacement key\="print" scope\="1" mode\="0">Prints the</replacement>\n<replacement key\="has" scope\="1" mode\="0">Checks for</replacement>\n</replacements>\n\n
291 changes: 291 additions & 0 deletions .settings/org.eclipse.jdt.core.prefs

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions .settings/org.eclipse.jdt.ui.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
eclipse.preferences.version=1
formatter_profile=_eclipse-cs FLASH
formatter_settings_version=12
2 changes: 2 additions & 0 deletions .settings/org.jboss.ide.eclipse.as.core.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
eclipse.preferences.version=1
org.jboss.ide.eclipse.as.core.singledeployable.deployableList=\n
165 changes: 165 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
JHC - Java Heatmap Control
====

This project implements a widget/control that displays [heat maps](https://en.wikipedia.org/wiki/Heat_map).
JHMC is available for all major Java toolkits, the Standard Widget Toolkit (SWT), Swing and the Abstract Window Toolkit (AWT). For rendering,
the native interfaces of the toolkits are used (avoiding the infamous SWT_AWT bridge). The main feature of JHC is that it is able
to display very large heat maps efficiently.

[![Screenshot-1](https://raw.github.com/prasser/jhc/master/img/screenshot1.png)](https://raw.github.com/prasser/jhc/master/img/screenshot1.png)

Introduction
------

In JHC heat maps are not represented as two-dimensional arrays but as sets of points. This allows to only sparsely populate the space
defined by the domains of the attributes involved. Moreover, heat maps are computed on-demand for the current size of the widget,
respecting a pre-defined maximal size. In case of very large heat maps, the data itself is scaled down instead of a rendered image.
Computations are performed in a background thread, allowing time-consuming processes, e.g. extensive disk access, when rendering a heat map.

When scaling heat maps down, JHC currently uses the arithmetic mean to aggregate values and dynamically
adjusts the minimum and maximum of the scale to these aggregates. In future releases, it is planned to
make this process configurable (e.g. using static minima and maxima or different aggregate functions).

There are multiple ways in which data can be provided to JHC. Firstly, different variants of the static method JHCData.create(...)
allow handling two-dimensional arrays of primitive Java data types. Secondly, the interface JHCDataProvider can be implemented
to provide arbitrary two-dimensional data, e.g. from disk, via JHCData.create(...). Finally, the abstract class
JHCData can itself be extended to implement a custom process for computing heat maps. To this end, the following classes must be implemented:

[![Classes](https://raw.github.com/prasser/jhc/master/img/classes.png)](https://raw.github.com/prasser/jhc/master/img/classes.png)

JHC will repeatedly call JHCData.getHeatmap(...) to retrieve an instance of the heat map for a specific
size. This call will be performed from a background thread. As a result, an instance of JHCHeatmap must be returned
that provides data points via an iterator over instances of the interface JHCHeatmap.Point. Each data point
associates a value with an x-coordinate and a y-coordinate. Each coordinate represents one tick on the according
axis. Associated labels must be returned from calls to JHCHeatmap.getXLabel(x) and getYLabel(y), respectively.

Customization
------

JHC currently supports a customizable layout as well as different gradients for the heat map. Gradients are
inspired by [plotly](https://plot.ly/). See [here](http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s5_heatmaps/s5_heatmaps.ipynb#Plotly%27s-pre-defined-color-scales)
for a description of the color scales currently implemented.

The class JHCLayout allows defining the following offsets and lengths:
* Offsets: from left, right, top, bottom, between heat map and scale and between labels
* Length: length of small and large ticks
* Rotation: labels for ticks can be rotated and drawn within given maximal bounds

Compatibility
------
JHC has been tested on all major platforms, MS Windows, Linux and OS X (with and without Retina-Displays), and all major toolkits,
SWT, AWT and Swing.

Example (SWT)
------

```Java
// Define scales
JHCScale<String> xScale = new JHCScale.String(new String[] { "X1", "X2", "X3" });
JHCScale<String> yScale = new JHCScale.String(new String[] { "Y1", "Y2", "Y3" });

// Configure
JHCLayout layout = new JHCLayout(true, 20, true, 20);
JHCConfiguration config = new JHCConfiguration("x-label", "y-label", JHCGradient.GRADIENT_HEAT, layout);

// Create array
int[][] array = {{0,1,0}, {1,0,1}, {0,1,0}};

// Create data object
JHCData data = JHCData.create(array, xScale, yScale);

// Create JHC widget
JHC jhc = new JHC(shell, SWT.NONE);
jhc.setData(data, config);
```

Download
------
A binary version for AWT is available for download [here](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-awt.jar)
([Javadoc](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-awt-doc.jar)).
A binary version for Swing is available for download [here](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-swing.jar)
([Javadoc](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-swing-doc.jar)).
A binary version for SWT is available for download [here](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-swt.jar)
([Javadoc](https://rawgithub.com/prasser/jhc/master/jars/jhc-1.0.0-swt-doc.jar)).

Documentation
------
Online Javadoc for AWT can be found [here](https://rawgithub.com/prasser/jhc/master/doc/awt/index.html).
Online Javadoc for Swing can be found [here](https://rawgithub.com/prasser/jhc/master/doc/swing/index.html).
Online Javadoc for SWT can be found [here](https://rawgithub.com/prasser/jhc/master/doc/swt/index.html).
Binary file added bin/de/linearbits/examples/ExampleData.class
Binary file not shown.
Binary file added bin/de/linearbits/examples/Examples.class
Binary file not shown.
Binary file added bin/de/linearbits/examples/ExamplesSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/examples/Window.class
Binary file not shown.
Binary file added bin/de/linearbits/examples/WindowSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Canvas$CanvasListener.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Canvas.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$1.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$2.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$3$1.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$3.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$4.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$5.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT$6.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/CanvasSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Dimension.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Graphics.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/GraphicsSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHC.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCConfiguration.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCData.class
Binary file not shown.
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCDataProvider.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCGradient.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCHeatmap$Point.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCHeatmap.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCLayout.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCScale$Date.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCScale$Decimal.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCScale$Integer.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCScale$String.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/JHCScale.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Painter.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/PainterSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Pixels.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/PixelsSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderCharArray.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderData$1.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderData$2.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderData$3.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderData$4.class
Binary file not shown.
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderData.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderDoubleArray.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderFloatArray.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderIntegerArray.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ProviderLongArray.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Rectangle.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/RenderedHeatmap.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/RenderedLayout.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Renderer$1.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Renderer$Job.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/Renderer.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/RendererSWT.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/ToolTip.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/_JHC$1.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/_JHC.class
Binary file not shown.
Binary file added bin/de/linearbits/jhc/package-info.class
Binary file not shown.
Loading

0 comments on commit a43b3fb

Please sign in to comment.