Coder Social home page Coder Social logo

chronsemble's Introduction

chronsemble

Team Members

Summary

The goal of this project is to design a visualization tool to help investigators discover evidence associated with human trafficking through spatio-temporal analysis. While the project has its roots in combating trafficking, the visualization should have application to many analytic problems.

Our hypothesis is that the trafficking trade applies mechanisms of social, financial, and transportation networks and that the patterns associated with this criminal activity may be distinct and observable when looked for.

Chronsemble is a visualization tool that is designed to allow analysts to interactively examine data in three modes: (1) temporally using timelines, (2) spatially using maps, and (3) contextually by changing the temporal focus to view the data. A mock-up of the temporal visualization is shown in figure 1. In this mock-up, data on the timeline can be viewed with greater detail in info-flow panes.

Figure 1. Mock-up of the info-flow and timeline visualization mode.

Figure 1. Mock-up of the info-flow and timeline visualization mode.

Goals

Visualization should:

  • be a web application for maximum reach;
  • expose properties and relationships between entities/events at any point in space and time;
  • sequence entities/events in absolute and relative terms (e.g. before, during, after, near, around, inside, outside, etc.);
  • expose entity/event relationships by context/ontology/semantics;
  • support interactivity with animation;
  • support data entry.

Status as of December 2018

The visualization supports rendering and interacting with a limited number of entities/events as long as the following restrictions are observed:

  • Entities/events must be temporally tagged.
  • Each rendered entity/event must include a label and a start field.
  • For entities/events to be rendered on an interval, the input data must also include an end field.
  • Entities/events that include only a start field will be rendered as instantaneous items.
  • Temporal data should be formatted according to a js parsable date format.
  • Spatial coordinates are optional.
  • Spatial granularity is currently limited to highlighting entities/events by country.
  • Spatial coordinates should be labeled with the loc field and conform to country code trigraphs defined by ISO 3166 trigraphs.
  • Input entities/events are rendered in browser memory and should therefore be limited in number to prevent browser crashes.

Installation

  1. Clone repository
  2. Install js dependencies
    • cd to top project directory with the index.html and package.json file
    • npm install
  3. Install a light weight webserver (e.g. browsersync)
  4. Start your webserver from top level directory where index.html resides (uses chrome):
    • /usr/local/bin/browser-sync start --server --browser "Google Chrome" --files "*.html, css/*.css, src/*.js"

Operation

To visualize a dataset with Chronsemble, you will need a local data file that conforms to the restrictions noted in the Status section of this document. Chronsemble can process csv or json formatted data files.

When you launch the application, you will see the Chronsemble masthead with a pull-down menu labeled Input Source. Use this menu to choose and upload your local data file. Once data has been loaded, the Settings tab will become active. Choose the Settings tab to configure the visualization. Figure 2 shows the components of the Settings tab.

Settings tab

Figure 2. Settings components.

Figure 2. Settings tab components.

The Settings tab is designed to allow you to configure the visualization before rendering. It consists of a menu bar and a configuration table. The intent of the Settings tab is threefold: (1) to allow you to choose which metadata to render on info cards, (2) to provide a mechanism to map arbitrary data files to the Chronsemble data schema, and (3) to provide a mechanism to select the context for rendering visualized data. Currently, only the assignment of metadata to info cards is fully operational; there is also a very rudimentary bit of code that supports changing the temporal context from the default context of rendering by entity/event label to rendering by entity/event location. This is at proof-of-concept stage only.

The menu bar contains controls that allow you to filter table data, add/remove data elements to/from info cards, re-order info card data elements, and build/refresh the configured visualization. There is also a control designed to allow saving configured settings but this is not yet implemented.

The configuration table exposes the names of the data fields from your uploaded data file as well as two samples of data from the file. There are also columns in the table to indicate placement of a data field on the info card display, and as yet implemented features to display data kind and accuracy/precision of time and location kinds of data. Finally, there is a mechanism to allow assigning event types and context to data - this as yet implemented feature will provide a means to map arbitrary data files to Chronsemble's data schema. For now, you must manually adjust your field names to match the expected names for valid temporal and location data fields. These are: label representing the name of the entity/event, start and end for the beginning and ending of an entity/event, and loc for the country trigraph corresponding to the entity/event location.

The data populating the Data Fields column in column 1 of the table are typically the column labels of a csv file. To choose metadata from your file to render on info cards, use the selection boxes to the left of the Data Fields column to choose up to sixteen fields to render on an info card. The order (from top to bottom) with which the fields will appear on each card are the same as the order of selection. Assignments are not final until the +Info Card button is pressed. The order of placement on cards is shown in the column to the right of the Data Fields column. The order of one or more items can be shifted by selecting the desired items to move and using the up or down arrows in the menu bar to move them in the desired direction. The placement order follows the ordinal value with least to greatest rendering from top to bottom on each card. For an example of how info cards are rendered on the visualization, see the info-flow pane in figure 3.

If no fields are added to the info card, then the visualization will render without an info-flow pane. To render the visualization, click on the Build/Refresh button in the menu bar. Once the visualization renders, the Spatio-temporal Visualization tab will become active. Select this tab to view and interact with the visualization.

Figure 3 shows a fully rendered data set from the test data supplied with this project.

Spatio-temporal visualization tab

Figure 3. Visualization components.

Figure 3. Components of the spatio-temporal visualization.

Once the visualization is selected, the status bar will reveal the name of the uploaded file and which of the three flow panes (info-flow, temporal flow, spatio flow) have been rendered. There will always be a temporal flow pane but the info-flow and spatio flow panes will only render if the uploaded file contains location data and at least one data field was assigned to an info card in the Settings tab.

To interact with the visualization, move the cursor to the bird's-eye-view area and drag-click anywhere on the bird's-eye-view. As you drag-click, a scrubber window will be created over the area traversed by the cursor. Once a scrubber window has been created, the temporal flow pane will render the items windowed by the scrubber pane. The scrubber control can be dragged left or right along the bird's-eye-view to move the visualization backward or forward in time.

The visualization consists of the following main components: Status bar, Info-flow, Temporal flow, and Spatio flow. Each of the three main components is explained in greater detail.

Status bar

The status bar reveals the name of the file being visualized and which of the three flows are included in the visualization.

Info-flow pane

The info-flow pane contains the sequence of info cards highlighted by the vertical cursor and central to the reference time. The data appearing on each info card is defined by the assignments made on the Settings tab. Info cards move in unison with the items on the temporal flow pane as controlled by the time scrubber; however, time on the info-flow pane is piecewise linear with each entity/event duration scaled to the width of its respective info card. Info card width is fixed at the time that the visualization is created and is based on the default of four cards per flow (software configurable) fit equally to the width of the browser window. The movement of cards on the info-flow pane then follows the flow of time as determined by the movement of the time scrubber.

Temporal flow pane

As previously mentioned, the temporal flow is the only required visualization pane and is the means by which users interact with rendered data. This pane consists chiefly of a timeline of the entities/events rendered from the input data and a bird's-eye-view rendering of the entire timeline. Entities/events are rendered on the timeline as either intervals or instants. An entity/event with a start and end time will render as an interval; items with only a start time will render as instants. Intervals are rendered as light blue rectangles; instants are rendered as pink circles.

The temporal flow is created based on the label associated with each item (this is the default temporal context). During creation of the temporal flow, layout of items on the timeline proceeds from top to bottom on a first come, first served basis. Items that overlap an item already placed on the timeline will begin a new row. The item label will be placed to the right of the of the start of the item interval or instant.

Bisecting the temporal flow pane is a dashed vertical line that marks the reference time. The reference time denotes the moment used to compute the cards to render on the info-flow and the events to map on the spatio flow. Items displayed on the info-flow are a detailed view of the timeline items in the row highlighted by the vertical cursor and central to the reference time. The vertical cursor automatically focuses on the timeline row with the entity/event nearest to or with the tightest bound of the reference time. Support for manual control of the vertical cursor is planned in a future release.

The reference time is also used to compute the locations to render on the spatio flow. The locations of the entities/events within the timeline interval window as determined by the scrubber bounds are each rendered on the spatio flow as a color gradient. The intensity of the color used to highlight a location is proportional to the proximity of that entity/event to the reference time. Therefore, the locations with the darkest colors indicate entities/events that either contain the reference time or are nearest to the reference time. Lighter locations indicate those items that are furthest from the reference time.

The numeric value in the upper left corner of the temporal flow pane indicates the interval duration as defined by the width of the scrubber window. The values at the bottom of the temporal flow pane in blue, red, and blue as seen from left to right indicate the beginning time, the duration, and the ending time of the visualization respectively.

The height of the timeline is determined by the total number of rows needed to represent all items without overlapping intervals. The maximum height limit is currently set to 17 rows but this value is configurable with a minor change to the software. If additional rows are needed to render timeline items, they will be rendered below the 17th row off-pane. A vertical scrollbar will be instanced on the right side of the temporal flow pane to allow shifting the view as needed to see all items. This row limitation also governs the height of the bird's-eye-view component and the vertical scroll control simultaneously scrolls both the temporal flow and bird's-eye-view when operated.

The bird's-eye-view portion of the timeline is the area of the visualization that supports user interactivity and animation control.

Bird's-eye-view

The bird's-eye-view component shows a zoomed out version of the entire temporal flow. When hovered over the bird's-eye-view, the mouse pointer will change to a cross-hair. The bird's-eye-view supports user interactivity through a scrubber control that can be created by clicking and dragging the cross-hair anywhere along the bird's-eye-view. This action will create a scrubber window along an interval matching the location and duration of the drag event. Once the scrubber window is instanced, the temporal flow pane will zoom in on just the items determined by the duration of the scrubber window interval. To interact with and simultaneously animate the flows, drag the scrubber to the left or right to examine former or latter items on the info, temporal, and/or spatio flows. The duration of the scrubber window can be adjusted by selecting either end of the window and dragging to reduce or extend the window size. The scrubber window can also be dismissed by clicking the bird's-eye-view anywhere outside of the window.

Spatio flow

The spatio flow pane will render locations of entities/events using a choropleth map. Future upgrades will support a broad range of mapping functions. If the input data contains trigraph country codes associated with entities/events, the countries associated with the entities/events rendered in the temporal flow pane will also be painted in the spatio flow pane. As previously described, the colors used for rendering locations are based on a gradient proportional to the item's proximity to the reference time with dark colors being closest to the reference time. The color gradient is the same for future and past events. The default color of the map is grey.

Log tab

The log tab is currently used to output debugging information. Future updates will include logging user activity.

Future development

UXD

Schema mapping

The Settings tab is intended to enable mapping an arbitray data schema to Chronsemble's visualization schema. As of December 2018, this feature is partially implemented with the ability to select data fields from the input source and assign them to event types in Chronsemble's schema using the data table widget. However, the assignments are not currently interrogated or used by the underlying software. One difficulty in building out this capability is in defining the atomic components for each field and then providing code to build the composite data type. In addition, parsing and validating the atomic and composite fields is along with error handling. For instance, a date field may come as a complete composite entry with year, month, day, hour, minute, and second fields. Or it may be provided in pieces such as a date field and time field or further divided into separate year, month, and day fields and so forth. Similarly for location fields. Errors may appear in some or all of the fields and a process for dealing with errors needs to be defined.

Context assignment

The Settings tab also contains a mechanism for assigning the context for temporal events. The default context for laying out items on temporal flow timelines are by entity/event labels. The current layout technique assumes all labels are unique, however, this may not always be true. A rudimentary proof-of-concept (poc) implementation of the context assignment feature has been implemented. This can be demonstrated against the Correlates of War test file by using the Event Assignment menu to set the loc field as the Temporal Context. As implemented, this demonstration will change the temporal flow context to group items by location. The poc algorithm will sort the data by location and layout entities/events on the timeline with the location containing the largest number of entities/events. The poc implementation does not visualize the remaining data items as of yet. This could be done by a variety of techniques including rendering timelines for each location without focus in bird's-eye-view form or in full as separate timeline swim lanes. The latter approach would grow quite large for some contexts.

Temporal flow scaling

The mock-up show in figure 1 shows two temporal flows in the same visualization. This idea is intended to support visualizing multiple data sets at the same time or to allow instancing a new timeline from an entity/event on an existing timeline. The latter concept would be implemented by means of right-clicking an info card in the info-flow and choosing to instance a new timeline from this entry. As shown in the mock-up, a right-click on the George Washington info card brings up a menu to instance a new timeline for a variety of the relevant contexts for this historical figure. An astute observer will realize that presenting relevant contexts for a given entity/event is non-trivial and might require a trained ML algorithm or underlying knowledge graph. The intent of this work has been to support this type of complex analytic visualization elegantly.

Visualization tabs

Support for multiple visualization tabs was also envisioned. In its simplest form, this would allow opening up multiple visualization tabs in the same session that will operate independently. This feature might be better addressed by running multiple instances of Chronsemble in separate browser windows. However, it might be valuable to support this feature internally to allow separating muli-temporal flows into separate tabs or, conversely, combining separate tabs into a single temporal flow. This needs further thought.

Vertical cursor control

The vertical cursor on the temporal flow pane should allow for manual control by way of the up/down arrow keys.

Transport controls

Transport controls will allow the means to animate the visualization by way of a familiar video transport control UI. This will include buttons for play, fast-forward, reverse, fast-reverse, and jump-to-start/end.

Use of color

The temporal flow uses a single color to shade intervals and a single color to shade instants. A better use of color will permit assigning distinct colors to distinct temporal entities/events and retaining consistency of color between the three flows (e.g. use the same spatio flow and info-flow color/shade as used on the temporal flow for a given entity/event.)

Software design

Info card data

Info cards should be able to render multiple media types on a card. The intent of this feature is to provide a detailed summary of the entity/event in a form similar to a wikipedia info box. As shown in figure 1, support for images is high on the list of media types to support.

Temporal flow rendering

As of Dec. 2018, the temporal flow does not provide a visual representation of relationships between entities/events. A goal is to, at a minimum, provide an indication of direct causality by grouping causally related entities/events on adjacent rows and connecting them with a vertical line at the beginning moment of the dependent item. For instance, a parent/child relationship will show a connection between the parent interval and the child interval at the moment of the child's birth. This feature could be implemented as a threshold along a continuum where the relationships are continuous values (i.e. weighted values) where the weights are adjusted based on the visualization context. Think of this as visualizing a knowledge graph where the context is the root node of the graph and the relationships between children of that root and children of those children, etc. are weakened or strengthened by the depth of their connection to the root. For example, if the context were the United States of America and a rendered entity is Thomas Jefferson, there should be a dependent link between that interval and the beginning interval for the Declaration of Independence (as Jefferson is accepted to have penned the first draft.) We would not perhaps expect Jefferson's children to be rendered inthis context (although a very low threshold might allow for many more items to be rendered.)

Spatio flow rendering

The spatio flow rendering is (as of Dec. 2018) very inefficient. For each update to the map, the entire map is redrawn over the previous map and then the previous map is discarded. To improve the performance of the visualization, this should be made to update only the areas that are changed between scenes. In addition, the gradients used to denote approaching/receding events should be made to be smooth and follow an exponential function based on the temporal velocity and granularity for the view.

Path rendering

Location data should be analyzed for rendering either as part of a path or as a stationary point. Paths and points should be rendered by modulating the intensity as an exponential function based on temporal velocity (e.g. intensity begins low and increases as the entity/event epoch approaches; the converse as the epoch decreases). Path interpolation may be desirable based on resolution of view. Path uncertainty can be conveyed by path thickness. Stationary locations should be rendered by anticipating the location's moment using a circle with a radius of uncertainty that where the radius decreases and the intensity increases as the moment approaches; as the moment recedes, the reverse animation should be used.

Network database support

Chronsemble should support ingest from network databases in addition to local file uploading. This will require careful thought and research of best practices for web application architecture design when supporting these two use cases. Refactoring the current design is expected.

Module design

Refactoring Chronsemble should include adoption and implementation of a leading javascript module format. The leading candidates are ES6 and CommonJS.

Node-link display

Part of the initial vision for this visualization was the inclusion of a node-link display (an additional "flow" pane). This was in keeping with the idea that this will be a tool capable of visualizing temporal knowledge graphs and examining data by context. A key idea in support of a node-link visualization is to serve as a guide to analysts for selection of context. When introduced to new data, it may not be clear to analysts how the data is organized, what words are used to describe the data, and the relationships that expose the language, or contexts, for the data set. A node-link display is thought to be a useful way to elucidate these ideas and relationships. Inspiration for the implementation of this component can be found by looking at the WebVOWL project.

Use cases

One of the desired use cases for this tool is to be able to ingest forum data and render it on a timeline. For instance, some forums (e.g. ars TECHNICA), do not thread comments which can make it difficult to navigate conversations that often arise on commented articles. A timeline can be a useful representation of a conversation thread. Consider viewing forum data "by root comment rating". Scores might be grouped by some distribution and rendered on the timeline with replies to a root comment or branch comment represented by vertical dependence from the root. Similarly, a context of "by moniker", might render root comments by an entity moniker with an interval length corresponding to the comment submission time and ending on the submission time of the last direct reply to that comment. To simplify layout and reduce connective clutter, replies to a root comment should render in the root's swim lane. Replies will render again in the moniker's swim lane with no connection to a root comment (i.e. duplicate the comment for the moniker's timeline).

Testing

In order to test the app, a server must be used to supply resources to the browser. The app has been successfully tested with two light-weight client side servers: (1) browser-sync, and (2) wepack-dev-server. For a local install of browser-sync, the following command can be run from the top level folder (where index.html) to launch the server:

./node_modules/.bin/browser-sync start --server --browser "Google Chrome" --files "src/*.js, css/*.css, *.html"

Data

Several test files can be found in the "data" folder. Four of these files have been altered by hand to match the Chronsemble schema (i.e. they contain the field headings: "label", "start", "end", and "loc") which makes them suitable for testing:

  1. Intra-StateWarData_v4.1.3.csv is data from The Correlates of War Project. Component date fields which were originally disjoint in the original file have been combined for more granular timelines.
  2. philosophers.csv is data from the original timeline example.
  3. philosophers3.json was converted to json from the csv file; one record was given an additional field called "description".
  4. Inter-StateWarData_v4.0.1.csv is also from The Correlates of War Project but the date fields remain disjoint so the visualization renders timeline events with year granularity. Locations were not translated into trigraphs so no spatio flow will be generated.
  5. Inter-StateWarData_v4.0.csv is an original file from The Correlates of War Project. This file will not render.
  6. Intra-StateWarData_v4.1.2.csv is data from The Correlates of War Project. This file includes locations but date fields have not been combined.
  7. Intra-StateWarData_v4.1.csv is an original file from The Correlates of War Project. This file will not render.
  8. philosophers.json was converted to json from the csv file; the json format is hierarchical rather than flat which fails to render.

chronsemble's People

Contributors

johnnyncsu avatar aarivan avatar

Stargazers

 avatar

Watchers

James Cloos avatar John Slankas avatar  avatar  avatar  avatar

chronsemble's Issues

Spatio-flow zoom bug ...

If you zoom in on the patio-flow and then resize the range on the temporal-flow, there is no way to unzoom the spatio-flow.

Empty end date fields containing a delimiter in the input css file fail.

When indicating 'instant' entities by not including an end date in the 'end' date field, if the end field contains a delimiter such as a space or tab between the commas of your css, the field is parsed as an undefined date which causes the file to fail to render. Temporary workaround is to eliminate any delimiting characters in an empty field within an input css file.

Working example:

start,end,label
2019-04-25,,No Bug
2019-04-26,,No Bug

Failing example:

start,end,label
2019-04-25, ,Bug
2019-04-26, ,Bug

Blank spatio-flow on file load ...

The spatio-flow pane is blank on loading a new file until the cursor selects the bird's-eye-view in the temporal-flow pane (probably initiates a redraw).

Single element input files fail.

An input file with a single input element causes Chronsemble to fail. This appears to be a result of not having enough elements to construct a valid array(s) on input processing. This results in js error when array methods are called on an improperly constructed array variable.

PatternFly masthead clips bottom of brand image on some mobile browsers.

The version of PatternFly being used with Chronsemble is far out of date at this point so this issue is likely not relevant in latest PatternFly release; however, integrating with the latest PatternFly release will probably take a significant effort so it may be best to address using a local patch as previously done. This issue has been seen with mobile Safari on iPhone and iPad.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.