nixview-python/docs/treeview.md
2021-01-10 00:04:13 +01:00

2.7 KiB

TreeView

The file content is initially displayed in a TreeView. The items in the Tree have symbols that refelct the type of item. Using the dropdown menu above the TreeView allows to to change the tree layout.

Symbols

alt text

Blocks Are the top-level grouping items in a nix file. In many cases they represent something like an experimental session.

alt text

DataArray: The core entity for storing n-dimensional data. All entries are of the same data type. For each of the n dimensions there must be a Dimension descriptor.

alt text

Dimension: describes one dimension of the stored data. There are three types of dimensions. SampledDimension for data that is sampled in regular intervals (e.g. time), SetDimension for dimensions that do not have a natural order but represent categories, and RangeDimension for data that is sampled in irregular intervals.

alt text

DataFrame: a tabular structure for storing data. All entries along a column have the same data type. Each column has an header holding the column's name and dtype.

alt text

Tag/MultiTag: Entities that can tag regions in DataArrays to give these regions a specific meaning. For example, the time interval in which a stimulus was applied, or a region of interest in the data. The region is defined by the tag's position and extent. A tag can tag multiple DataArrays and may contain several Features.

alt text

Feature: entities are children of a Tag and are used to provide additional features of the tagged segments or regions. There are three types of features, tagged (position and extent have to be applied to the feature's data), untagged (position and extent do not apply), and indexed (for each tagged region there is an entry in the 1st dimension of the feature's data that matches).

alt text

Group: Simple grouing elements for grouping within a Block.

alt text

Source: used to provide information about the origin of the data. Sources can create a tree-like structure.

alt text

Section: Grouping element within the metadata tree. Sections build a tree and may contain Properties that carry the actual metadata. Most other entities can link to a section which then holds the metadata about the respective entity.

alt text

Property: An extended key-value pair for storing metadata.