File: faq.rst

package info (click to toggle)
python-nixio 1.5.4%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,888 kB
  • sloc: python: 12,527; cpp: 832; makefile: 25
file content (56 lines) | stat: -rw-r--r-- 2,358 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.. toctree::
   :maxdepth: 1

FAQ
===

Q: Why sampling interval in the sampled dimension, not sampling rate?
---------------------------------------------------------------------

Because the interval is the more **general** term. It can also be
applied to dimensions that do not extend in time but for example space.

Q: What does this error mean? “Cannot open a nonexistent file in ReadOnly mode”
-------------------------------------------------------------------------------

Arises when the provided file path is invalid and you try to open it
with the nixio.FileMode.ReadOnly mode. Solution: provide the path to an
existing file to be opened in ``nixio.FileMode.ReadOnly`` mode or use the
``nixio.FileMode.ReadWrite`` or ``nixio.FileMode.Overwrite`` flag to
create a new one.

Q: Is it ok to use non-SI units?
--------------------------------

Well, let’s say it is tolerated but not advised. When using SI and
compounds of SI units we can try to scale according to the provided
units which is not supported/not necessarily possible for non-SI units.
It is largely safe to use non-SI units when providing metadata or
specifying the unit of the data stored in a *DataArray*. It may become
problematic in the context of *Dimensions*. Some functions support
reading data with the positions provided by the *Tags*, in these cases we
rely on scalability of the units.

If you feel this is unjustified, feel free to improve our unit-handling
system.

Q: Can I use unicode?
---------------------

Unfortunately, unicode is so far not supported. In order to specify
microseconds you can, and have to, write “us”.

Q: Why does a *DataArray* not automatically load the data from file?
--------------------------------------------------------------------

This would be very convenient, indeed. Otoh, the *NIX* entities, such as
the *DataArray*, are designed to be lightweight objects that can be
created quickly and do not eat up the RAM. At opening time we have no
idea about the actual data size. In our use-cases a single
*DataArray* can contain GB of data. Reading these would take some time
and increase memory demand.

It further allows for partial loading of data. A *DataArray* that
contains multiple long signals can be very large and it would be
inefficient loading the entire data when you need only a
single signal, or a few data segments.