Taking v1 as the first release (#92)

- file reading
- decoding master file
This commit is contained in:
Erik Fröjdh
2024-11-07 10:14:20 +01:00
committed by GitHub
parent ae71e23dd2
commit d8d1f0c517
87 changed files with 9860 additions and 0 deletions

View File

@ -0,0 +1,7 @@
ClusterFinder
=============
.. doxygenclass:: aare::ClusterFinder
:members:
:undoc-members:

7
docs/src/Dtype.rst Normal file
View File

@ -0,0 +1,7 @@
Dtype
=============
.. doxygenclass:: aare::Dtype
:members:
:undoc-members:

8
docs/src/File.rst Normal file
View File

@ -0,0 +1,8 @@
File
=============
.. doxygenclass:: aare::File
:members:
:undoc-members:
:private-members:

8
docs/src/Frame.rst Normal file
View File

@ -0,0 +1,8 @@
Frame
=============
.. doxygenclass:: aare::Frame
:members:
:undoc-members:
:private-members:

7
docs/src/NDArray.rst Normal file
View File

@ -0,0 +1,7 @@
NDArray
=============
.. doxygenclass:: aare::NDArray
:members:
:undoc-members:

7
docs/src/NDView.rst Normal file
View File

@ -0,0 +1,7 @@
NDView
=============
.. doxygenclass:: aare::NDView
:members:
:undoc-members:

8
docs/src/Pedestal.rst Normal file
View File

@ -0,0 +1,8 @@
Pedestal
=============
.. doxygenclass:: aare::Pedestal
:members:
:undoc-members:
:private-members:

8
docs/src/RawFile.rst Normal file
View File

@ -0,0 +1,8 @@
RawFile
===============
.. doxygenclass:: aare::RawFile
:members:
:undoc-members:
:private-members:

View File

@ -0,0 +1,14 @@
RawMasterFile
===============
.. doxygenclass:: aare::RawMasterFile
:members:
:undoc-members:
:private-members:
.. doxygenclass:: aare::RawFileNameComponents
:members:
:undoc-members:
:private-members:

View File

@ -0,0 +1,7 @@
VarClusterFinder
====================
.. doxygenclass:: aare::VarClusterFinder
:members:
:undoc-members:

31
docs/src/index.rst Normal file
View File

@ -0,0 +1,31 @@
AARE
==============================================
.. note ::
Hello
.. toctree::
:caption: C++ API
:maxdepth: 1
NDArray
NDView
Frame
File
Dtype
ClusterFinder
Pedestal
RawFile
RawMasterFile
VarClusterFinder
.. toctree::
:caption: Python API
:maxdepth: 1
pyFile
pyCtbRawFile
pyRawMasterFile
pyVarClusterFinder

11
docs/src/pyCtbRawFile.rst Normal file
View File

@ -0,0 +1,11 @@
CtbRawFile
============
.. py:currentmodule:: aare
.. autoclass:: CtbRawFile
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

11
docs/src/pyFile.rst Normal file
View File

@ -0,0 +1,11 @@
File
========
.. py:currentmodule:: aare
.. autoclass:: File
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

View File

@ -0,0 +1,10 @@
RawMasterFile
===================
.. py:currentmodule:: aare
.. autoclass:: RawMasterFile
:members:
:undoc-members:
:show-inheritance:
:inherited-members:

View File

@ -0,0 +1,10 @@
VarClusterFinder
===================
.. py:currentmodule:: aare
.. autoclass:: VarClusterFinder
:members:
:undoc-members:
:show-inheritance:
:inherited-members: