# Pipeline API Docs

## `pipeline`

```{eval-rst}

.. autoclass:: pyearthtools.pipeline.Sampler
    :members:
.. autoclass:: pyearthtools.pipeline.Pipeline
    :members:
.. autoclass:: pyearthtools.pipeline.Operation
    :members:
.. autoclass:: pyearthtools.pipeline.ReversedPipeline
    :members:
.. autoclass:: pyearthtools.pipeline.PipelineException
    :members:
.. autoclass:: pyearthtools.pipeline.PipelineFilterException
    :members:
.. autoclass:: pyearthtools.pipeline.PipelineRuntimeError
    :members:
.. autoclass:: pyearthtools.pipeline.PipelineTypeError
    :members:
```

## `pipeline.branching`
```{eval-rst}

.. autoclass:: pyearthtools.pipeline.branching.PipelineBranchPoint
    :members:
.. autoclass:: pyearthtools.pipeline.branching.Unifier
    :members:
.. autoclass:: pyearthtools.pipeline.branching.Joiner
    :members:
.. autoclass:: pyearthtools.pipeline.branching.Spliter
    :members:
```


## `pipeline.filters`
```{eval-rst}

.. autoclass:: pyearthtools.pipeline.filters.Filter
    :members:
.. autoclass:: pyearthtools.pipeline.filters.FilterCheck
    :members:
.. autoclass:: pyearthtools.pipeline.filters.FilterWarningContext
    :members:
.. autoclass:: pyearthtools.pipeline.filters.TypeFilter
    :members:
```

## `pipeline.iterators`
```{eval-rst}

.. autoclass:: pyearthtools.pipeline.iterators.Iterator
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.Range
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.Predefined
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.File
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.DateRange
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.DateRangeLimit
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.Randomise
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.SuperIterator
    :members:
.. autoclass:: pyearthtools.pipeline.iterators.IterateResults
    :members:
```

## `pipeline.modifications`

```{eval-rst}
.. autoclass:: pyearthtools.pipeline.modifications.Cache
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.StaticCache
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.MemCache
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.IdxModifier
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.IdxOverride
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.TimeIdxModifier
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.SequenceRetrieval
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.TemporalRetrieval
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.TemporalWindow
    :members:
.. autoclass:: pyearthtools.pipeline.modifications.idx_modification
    :members:
```

## `pipeline.operations`

```{eval-rst}
.. autoclass:: pyearthtools.pipeline.operations.Transforms
    :members:
```

### `pipeline.operations.xarray`

```{eval-rst}
.. autoclass:: pyearthtools.pipeline.operations.xarray.Compute
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.Merge
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.Concatenate
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.Sort
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.Chunk
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.RecodeCalendar
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.AlignDates
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.conversion.ToNumpy
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.conversion.ToDask
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.filters.XarrayFilter
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.filters.DropAnyNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.filters.DropAllNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.filters.DropValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.filters.Shape
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.reshape.Dimensions
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.reshape.CoordinateFlatten
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.select.SelectDataset
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.select.DropDataset
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.select.SliceDataset
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.split.OnVariables
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.split.OnCoordinate
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.values.FillNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.values.MaskValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.values.Clip
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.values.Derive
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.metadata.Rename
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.metadata.Encoding
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.metadata.MaintainEncoding
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.metadata.Attributes
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.metadata.MaintainAttributes
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.normalisation.xarrayNormalisation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.normalisation.Anomaly
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.normalisation.Deviation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.normalisation.Division
    :members:
.. autoclass:: pyearthtools.pipeline.operations.xarray.normalisation.Evaluated
    :members:

.. autoclass:: pyearthtools.pipeline.operations.xarray.remapping.HEALPix
    :members:
```

### `pipeline.operations.dask`

```{eval-rst}
.. autoclass:: pyearthtools.pipeline.operations.dask.Stack
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.Concatenate
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.VStack
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.HStack
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.Compute
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.augment.Rotate
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.augment.Flip
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.augment.FlipAndRotate
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.filters.daskFilter
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.filters.DropAnyNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.filters.DropAllNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.filters.DropValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.filters.Shape
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.reshape.Rearrange
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.reshape.Squeeze
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.reshape.Flattener
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.reshape.Flatten
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.reshape.SwapAxis
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.select.Select
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.select.Slice
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.split.OnAxis
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.split.OnSlice
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.values.FillNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.values.MaskValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.values.Clip
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.normalisation.daskNormalisation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.normalisation.Anomaly
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.normalisation.Deviation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.normalisation.Division
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.normalisation.Evaluated
    :members:

.. autoclass:: pyearthtools.pipeline.operations.dask.conversion.ToXarray
    :members:
.. autoclass:: pyearthtools.pipeline.operations.dask.conversion.ToNumpy
    :members:

```


### `pipeline.operations.numpy`
```{eval-rst}
.. autoclass:: pyearthtools.pipeline.operations.numpy.Stack
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.Concatenate
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.augment.Rotate
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.augment.Flip
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.augment.FlipAndRotate
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.filters.NumpyFilter
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.filters.DropAnyNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.filters.DropAllNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.filters.DropValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.filters.Shape
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.Rearrange
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.Squeeze
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.Expand
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.Flattener
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.Flatten
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.reshape.SwapAxis
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.select.Select
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.select.Slice
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.split.OnAxis
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.split.OnSlice
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.split.VSplit
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.split.HSplit
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.values.FillNan
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.values.MaskValue
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.values.Clip
    :members:

.. autoclass:: pyearthtools.pipeline.operations.numpy.normalisation.numpyNormalisation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.normalisation.Anomaly
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.normalisation.Deviation
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.normalisation.Division
    :members:
.. autoclass:: pyearthtools.pipeline.operations.numpy.normalisation.Evaluated
    :members:

```

### `pipeline.operations.transform`
```{eval-rst}
.. autoclass:: pyearthtools.pipeline.operations.transform.TimeOfYear
    :members:
.. autoclass:: pyearthtools.pipeline.operations.transform.AddCoordinates
    :members:
```

## `pipeline.samplers`
```{eval-rst}

.. autoclass:: pyearthtools.pipeline.samplers.EmptyObject
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.Sampler
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.Default
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.SuperSampler
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.Random
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.DropOut
    :members:
.. autoclass:: pyearthtools.pipeline.samplers.RandomDropOut
    :members:
```