appstate.py

Summary

This file is intended to initialize a few internal global variables that will mainly be used in the UI interface. In addition, it can also initialize a few variables that may have not been initialized in the configuration file.

Globals initialized

It should be noted that all of these global variables are intended to be used internally by the User interface. Setting these global variables generally do not change the attributes. Instead, their respective functions should be called.

isLogScale: Determines whether the UI indicates that the current layout is a log scale or not. Changing this variable d directly will not change the Log Scale. To actually change the Log Scale, call the enableLogScale() function in FireflyUi. However, this variable is intended to be updated whenever the enableLogScale() function in fireflyUi is called, so it should always reflect the logscale status if not otherwise tampered with

dataMode: An Integer indicating which dataMode the UI should display as the current Datamode. Do not set this variable directly, instead call the setDataMode() function in the loader file. The value of the integer corresponds to the index of the dataMode in the global dataModes, initialized in the loader file.

filterMode, filterMin, and filterMax: Used to determine whether a filter setting is active. A filter setting hides all particles outside of a particular range for a certain attribute. For example, if you only want to display particles of a mass between 0 and 5, you can set filterMode to "Mass", filterMin to 0.0 and filterMax to 5.0.

colormapperEnabled, colormapMin and colormapMax: a boolean that determines whether the UI believes the colormap options are on and the bounds displayed.

currentColorMapIndex: An integer that determines which colormap the UI should siaplay as the current Colormap. The integer reflects the index of the global array colorMapLabels initialized in colormapConfig.py.

pivotSelectionMode: a boolean that active when the user is in pivotselectionmode, activated by pressing "Ctrl" by default.

isLogArray = [False] * 10

kernelModes: An array holding all kernel mode rendering options which will be displayed on the UI. Kernels affect how each individual point is rendered.

kernelModeInd: Integer indicating the index of the kernel mode of the UI display. The options are intialized in fireflyUi.py. To set the kernelMode directly, you can use the function setKernelMode: initialized in fireflyUi.py.

renderModes: An array holding all render mode options which will be displayed on the UI.

renderModeInd: renderMode controls how the full image is rendered on screen. The options are specified with the global variable renderModes initialized in fireflyUi.py. To change the renderModes, please use the setRenderMode function in fireflyUi.py.

Globals used

scale: set in the config file, determines the initial pointscale of the particles (how big each individual particle appears in the layout)