# -*- coding: utf-8 -*-
"""
Authors
-------
- Novimir A. Pablant <npblant@pppl.gov>
"""
import numpy as np
from xicsrt.tools.xicsrt_doc import dochelper
from xicsrt.objects._ConfigObject import ConfigObject
from xicsrt.objects._GeometryObject import GeometryObject
[docs]
@dochelper
class XicsrtBundleFilter(GeometryObject):
"""
A base class for bundle filters.
"""
[docs]
def default_config(self):
config = super().default_config()
return config
[docs]
def filter(self, bundle_input):
"""
This is the main filtering method that must be reimplemented
for specific filter objects.
"""
return bundle_input