update operators (#1117)

Co-authored-by: rlagha <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>

Author: 3 people

docs/source/_static/dpf_operators.html

@@ -7,6 +7,7 @@
 from .field_low_pass_fc import field_low_pass_fc 
 from .field_signed_high_pass import field_signed_high_pass 
 from .field_signed_high_pass_fc import field_signed_high_pass_fc 
+from .filtering_max_over_time import filtering_max_over_time 
 from .scoping_band_pass import scoping_band_pass 
 from .scoping_high_pass import scoping_high_pass 
 from .scoping_low_pass import scoping_low_pass 

src/ansys/dpf/core/operators/filter/__init__.py

@@ -22,6 +22,11 @@ class abc_weightings(Operator):
         computed, 1 the b-weigting is
         computed and 2 the c-weightings is
         computed.
+    shape_by_tf_scoping : bool
+        If this pin is set to true, each field of the
+        input fields container is defined by
+        time freq scoping and not by ids.
+        default is false
 
 
     Examples
@@ -36,19 +41,27 @@ class abc_weightings(Operator):
     >>> op.inputs.fields_container.connect(my_fields_container)
     >>> my_weighting_type = int()
     >>> op.inputs.weighting_type.connect(my_weighting_type)
+    >>> my_shape_by_tf_scoping = bool()
+    >>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.filter.abc_weightings(
     ...     fields_container=my_fields_container,
     ...     weighting_type=my_weighting_type,
+    ...     shape_by_tf_scoping=my_shape_by_tf_scoping,
     ... )
 
     >>> # Get output data
     >>> result_weightings = op.outputs.weightings()
     """
 
     def __init__(
-        self, fields_container=None, weighting_type=None, config=None, server=None
+        self,
+        fields_container=None,
+        weighting_type=None,
+        shape_by_tf_scoping=None,
+        config=None,
+        server=None,
     ):
         super().__init__(name="abc_weightings", config=config, server=server)
         self._inputs = InputsAbcWeightings(self)
@@ -57,6 +70,8 @@ def __init__(
             self.inputs.fields_container.connect(fields_container)
         if weighting_type is not None:
             self.inputs.weighting_type.connect(weighting_type)
+        if shape_by_tf_scoping is not None:
+            self.inputs.shape_by_tf_scoping.connect(shape_by_tf_scoping)
 
     @staticmethod
     def _spec():
@@ -81,6 +96,15 @@ def _spec():
         computed and 2 the c-weightings is
         computed.""",
                 ),
+                2: PinSpecification(
+                    name="shape_by_tf_scoping",
+                    type_names=["bool"],
+                    optional=False,
+                    document="""If this pin is set to true, each field of the
+        input fields container is defined by
+        time freq scoping and not by ids.
+        default is false""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -142,6 +166,8 @@ class InputsAbcWeightings(_Inputs):
     >>> op.inputs.fields_container.connect(my_fields_container)
     >>> my_weighting_type = int()
     >>> op.inputs.weighting_type.connect(my_weighting_type)
+    >>> my_shape_by_tf_scoping = bool()
+    >>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
     """
 
     def __init__(self, op: Operator):
@@ -150,6 +176,10 @@ def __init__(self, op: Operator):
         self._inputs.append(self._fields_container)
         self._weighting_type = Input(abc_weightings._spec().input_pin(1), 1, op, -1)
         self._inputs.append(self._weighting_type)
+        self._shape_by_tf_scoping = Input(
+            abc_weightings._spec().input_pin(2), 2, op, -1
+        )
+        self._inputs.append(self._shape_by_tf_scoping)
 
     @property
     def fields_container(self):
@@ -194,6 +224,29 @@ def weighting_type(self):
         """
         return self._weighting_type
 
+    @property
+    def shape_by_tf_scoping(self):
+        """Allows to connect shape_by_tf_scoping input to the operator.
+
+        If this pin is set to true, each field of the
+        input fields container is defined by
+        time freq scoping and not by ids.
+        default is false
+
+        Parameters
+        ----------
+        my_shape_by_tf_scoping : bool
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.filter.abc_weightings()
+        >>> op.inputs.shape_by_tf_scoping.connect(my_shape_by_tf_scoping)
+        >>> # or
+        >>> op.inputs.shape_by_tf_scoping(my_shape_by_tf_scoping)
+        """
+        return self._shape_by_tf_scoping
+
 
 class OutputsAbcWeightings(_Outputs):
     """Intermediate class used to get outputs from