We use cookies to ensure you get the best experience on our website
Strona główna Odkrywaj Pomoc News
Zarejestruj się Zaloguj się

Scheduled service maintenance on November 22

On Friday, November 22, 2024, between 06:00 CET and 18:00 CET, GIN services will undergo planned maintenance. Extended service interruptions should be expected. We will try to keep downtimes to a minimum, but recommend that users avoid critical tasks, large data uploads, or DOI requests during this time.

We apologize for any inconvenience.

INT
/
multielectrode_grasp
DOI
10.12751/g-node.f83565
11
3
Forkuj 7
Pliki Problemy 0 Oczekujące zmiany 0
Drzewo: 78f9810227
Gałęzie Tagi
multielectro...
/
code
/
python-odml
/
doc
/
base-classes.rst

base-classes.rst 1.2 KB
Historia Download

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. .. _class-reference:
    2. 

  2. 

  3. odML-Base Classes
    4. 

  4. =================
    5. 

  5. 

  6. These classes are the core data-structures of odML.
    7. 

  7. To sum things up, an odML-Document consists of several Sections.
    8. 

  8. Each Section may contain other Sections and Properties.
    9. 

  9. Again each Property can have multiple Values.
    10. 

  10. 

  11. The odml Module contains wrappers, that are shortcuts for creating the main objects::
    12. 

  12. 

  13.     >>> from odml import Document, Section, Property, Value
    14. 

  14.     >>> Document(version=0.9, author="Kermit")
    15. 

  15.     <Doc 0.9 by Kermit (0 sections)>
    16. 

  16. 

  17. Several modules exist to extend the implementation.
    18. 

  18. The ones included in the library are those:
    19. 

  19. 

  20. * :py:mod:`odml.tools.event` provides event capabilities, allowing to add change-listeners to objects
    21. 

  21. * :py:mod:`odml.tools.nodes` provides a tree-interface used by the gui with functions like next() and position()
    22. 

  22. 

  23. Document
    24. 

  24. --------
    25. 

  25. .. autoclass:: odml.doc.BaseDocument
    26. 

  26.    :members:
    27. 

  27.    :inherited-members:
    28. 

  28.    :undoc-members:
    29. 

  29. 

  30. Section
    31. 

  31. -------
    32. 

  32. .. autoclass:: odml.section.BaseSection
    33. 

  33.    :members:
    34. 

  34.    :inherited-members:
    35. 

  35.    :undoc-members:
    36. 

  36. 

  37. Property
    38. 

  38. --------
    39. 

  39. .. autoclass:: odml.property.BaseProperty
    40. 

  40.    :members:
    41. 

  41.    :inherited-members:
    42. 

  42.    :undoc-members:
    43. 

  43. 

  44. Value
    45. 

  45. -----
    46. 

  46. .. autoclass:: odml.value.BaseValue
    47. 

  47.    :members:
    48. 

  48.    :inherited-members:
    49. 

  49.    :undoc-members:
    50. 

  50.