timepix

Documentation

Overview

Package timepix implements a command to view and edit a time pixelation model.

Index

• Variables

Variables

var Command = &command.Command{
	Usage: "timepix [--key <key-file>] <time-pix-file>",
	Short: "view and edit a time pixelation model",
	Long: `
Command timepix reads a time pixelation model from a file and displays it using
a plate carrée projection.

The argument of the command is the name of the file that contains the time
pixelation model.
	
In the display, all pixels with a given value will have the same color
(selected at random). With the flag --key, a key file can be used to define
the color used in the display. A key file is a tab-delimited file with the
following required columns:
	
	key    the value used as an identifier.
	color  an RBA value separated by commas, for example "125,132,148".
	
All other columns will be ignored. Here is an example of a key file:
	
	key	color	gray	comment
	0	54, 75, 154	255	deep ocean
	1	74, 123, 183	235	oceanic plateaus
	2	152, 202, 225	225	continental shelf
	3	254, 218, 139	195	lowlands
	4	246, 126, 75	185	highlands
	5	231, 231, 231	245	ice sheets

In this case, the gray and comment columns will be ignored.

At the bottom of the display, a status bar will show information about the
model. In the first field, a star "[*]" will be displayed if the model has
been modified. The second field is the time for the current stage, in million
years. The third field is the geographic location. The fourth field is the
pixel identifier. The fifth field is the value of the current pixel. The last
field, Set, shows the value used to set a pixel.

The following keys can be used:

	"N"  go to next time stage
	"P"  go to previous time stage
	"+"  zoom in
	"-"  zoom out
	"S"  changes the set value for a pixel
	"M"  shows a mask for all the pixels with the same value as 
	     the current pixel
	"W"  writes any change to the time pixelation model

To set a pixel, click the mouse over a pixel while holding the <shift> key.

Use a mouse drag to change the location of the map in the display.
	`,
	SetFlags: setFlags,
	Run:      run,
}