Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -162,4 +162,8 @@ cython_debug/
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
#.idea/

# AI agents
CLAUDE.md
.claude
44 changes: 41 additions & 3 deletions docs/api/atoms.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Attributes
Atom.initialized
```


Methods

```{eval-rst}
Expand All @@ -34,19 +33,57 @@ Methods
Atom.initialize_from_state
Atom.call
Atom.reset
Atom.save_state
Atom.set_state
Atom.load_state
```

## Core atoms
## Core atoms

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

Sequential
Partial
State
```

### Partial

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

Partial
```

Attributes

```{eval-rst}
.. autosummary::

Partial.stateful
```

Methods

```{eval-rst}
.. autosummary::

Partial.call
Partial.from_state
Partial.get_state
```

## Decorators

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

atomized
```

## Signal processing

```{eval-rst}
Expand All @@ -57,6 +94,7 @@ Methods
FIRFilter
IIRFilter
LFilter
MLPicker
ResamplePoly
SOSFilter
Trigger
Expand Down
50 changes: 50 additions & 0 deletions docs/api/processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,66 @@

# xdas.processing

## Functions

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

process
```

## Loaders

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

DataArrayLoader
RealTimeLoader
```

### DataArrayLoader

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

DataArrayLoader.nbytes
```

## Writers

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

DataArrayWriter
DataFrameWriter
StreamWriter
ZMQPublisher
ZMQSubscriber
```

### DataArrayWriter

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

DataArrayWriter.submit
DataArrayWriter.write
DataArrayWriter.shutdown
DataArrayWriter.result
```

### ZMQPublisher

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

ZMQPublisher.submit
ZMQPublisher.write
ZMQPublisher.result
```
2 changes: 1 addition & 1 deletion docs/api/signal.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
medfilt
```

## Spectral analysisi
## Spectral analysis

```{eval-rst}
.. autosummary::
Expand Down
1 change: 1 addition & 0 deletions docs/api/synthetics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@

wavelet_wavefronts
randn_wavefronts
dummy
```
112 changes: 100 additions & 12 deletions docs/api/virtual.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,130 @@

## VirtualArray

Base class for all virtual array types.

Attributes

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualArray.shape
VirtualArray.dtype
VirtualArray.to_dataset
VirtualArray.ndim
VirtualArray.size
VirtualArray.empty
VirtualArray.nbytes
VirtualArray.empty
```

Methods

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualArray.to_dataset
```

## VirtualSource

A lazy pointer to a single dataset inside an HDF5/NetCDF4 file.

Constructor

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualSource
```

Attributes

```{eval-rst}
.. autosummary::

VirtualSource.vsource
VirtualSource.shape
VirtualSource.dtype
VirtualSource.ndim
VirtualSource.size
VirtualSource.nbytes
VirtualSource.empty
```

Methods

```{eval-rst}
.. autosummary::

VirtualSource.to_dataset
```

## VirtualStack

A lazy concatenation of multiple {py:class}`VirtualSource` objects along one axis.

Constructor

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualStack
```

Attributes

```{eval-rst}
.. autosummary::

VirtualStack.sources
VirtualStack.axis
VirtualStack.shape
VirtualStack.dtype
VirtualStack.ndim
VirtualStack.size
VirtualStack.nbytes
VirtualStack.empty
```

Methods

```{eval-rst}
.. autosummary::

VirtualStack.append
VirtualStack.extend
VirtualStack.to_dataset
VirtualStack._to_layout
```

## VirtualLayout

Internal HDF5 virtual dataset layout object.

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualLayout
```

Attributes

```{eval-rst}
.. autosummary::

VirtualLayout.shape
VirtualLayout.dtype
VirtualLayout.to_dataset
```

## VirtualSource
Methods

```{eval-rst}
.. autosummary::
:toctree: ../_autosummary

VirtualSource.vsource
VirtualSource.shape
VirtualSource.dtype
VirtualSource.to_dataset
VirtualSource._to_layout
VirtualLayout.to_dataset
```

## Selection
Expand All @@ -65,7 +138,22 @@
.. autosummary::
:toctree: ../_autosummary

Selection
```

Attributes

```{eval-rst}
.. autosummary::

Selection.shape
Selection.ndim
```

Methods

```{eval-rst}
.. autosummary::

Selection.get_indexer
```
```
Loading
Loading