SISOFilter for all

Author: jafranc

geos-pv/src/geos/pv/plugins/PVClipToMainFrame.py

@@ -4,24 +4,16 @@
 # ruff: noqa: E402 # disable Module level import not at top of file
 import sys
 from pathlib import Path
-from typing import Union
 
 from paraview.util.vtkAlgorithm import (  # type: ignore[import-not-found]
-    VTKPythonAlgorithmBase, smdomain, smhint, smproperty, smproxy,
+    VTKPythonAlgorithmBase,
 )  # source: https://github.com/Kitware/ParaView/blob/master/Wrapping/Python/paraview/util/vtkAlgorithm.py
 from paraview.detail.loghandler import (  # type: ignore[import-not-found]
     VTKHandler,
 )  # source: https://github.com/Kitware/ParaView/blob/master/Wrapping/Python/paraview/detail/loghandler.py
 
 from vtkmodules.vtkCommonDataModel import (
-    vtkMultiBlockDataSet,
-    vtkUnstructuredGrid,
-)
-
-from vtkmodules.vtkCommonCore import (
-    vtkInformation,
-    vtkInformationVector,
-)
+    vtkMultiBlockDataSet, )
 
 # update sys.path to load all GEOS Python Package dependencies
 geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
@@ -30,6 +22,7 @@
 
 update_paths()
 
+from geos.pv.utils.details import SISOFilter, FilterCategory
 from geos.mesh.processing.ClipToMainFrame import ClipToMainFrame
 
 __doc__ = """
@@ -43,67 +36,26 @@
 """
 
 
-@smproxy.filter( name="PVClipToMainFrame", label="Clip to the main frame" )
-@smhint.xml( '<ShowInMenu category="4- Geos Utils"/>' )
-@smproperty.input( name="Input", port_index=0 )
-@smdomain.datatype(
-    dataTypes=[ "vtkMultiBlockDataSet", "vtkUnstructuredGrid" ],
-    composite_data_supported=True,
-)
+@SISOFilter( category=FilterCategory.GEOS_UTILS,
+             decorated_label="Clip to the main frame",
+             decorated_type=[ "vtkMultiBlockDataSet", "vtkDataSet" ] )
 class PVClipToMainFrame( VTKPythonAlgorithmBase ):
 
     def __init__( self ) -> None:
         """Init motherclass, filter and logger."""
-        VTKPythonAlgorithmBase.__init__( self,
-                                         nInputPorts=1,
-                                         nOutputPorts=1,
-                                         inputType="vtkDataObject",
-                                         outputType="vtkDataObject" )
-
         self._realFilter = ClipToMainFrame( speHandler=True )
         if not self._realFilter.logger.hasHandlers():
             self._realFilter.SetLoggerHandler( VTKHandler() )
 
-    #ensure I/O consistency
-    def RequestDataObject( self, request: vtkInformation, inInfoVec: list[ vtkInformationVector ],
-                           outInfoVec: vtkInformationVector ) -> int:
-        """Inherited from VTKPythonAlgorithmBase::RequestDataObject.
-
-        Args:
-            request (vtkInformation): request
-            inInfoVec (list[vtkInformationVector]): input objects
-            outInfoVec (vtkInformationVector): output objects
-
-        Returns:
-            int: 1 if calculation successfully ended, 0 otherwise.
-        """
-        inData = self.GetInputData( inInfoVec, 0, 0 )
-        outData = self.GetOutputData( outInfoVec, 0 )
-        assert inData is not None
-        if outData is None or ( not outData.IsA( inData.GetClassName() ) ):
-            outData = inData.NewInstance()
-            outInfoVec.GetInformationObject( 0 ).Set( outData.DATA_OBJECT(), outData )
-        return super().RequestDataObject( request, inInfoVec, outInfoVec )  # type: ignore[no-any-return]
-
-    def RequestData( self, request: vtkInformation, inInfo: list[ vtkInformationVector ],
-                     outInfo: vtkInformationVector ) -> int:
-        """Inherited from VTKPythonAlgorithmBase::RequestData. Apply ClipToMainFrame filter.
+    def Filter( self, inputMesh: vtkMultiBlockDataSet, outputMesh: vtkMultiBlockDataSet ) -> None:
+        """Is applying CreateConstantAttributePerRegion filter.
 
         Args:
-            request (vtkInformation): Request
-            inInfo (list[vtkInformationVector]): Input objects
-            outInfo (vtkInformationVector): Output objects
-
-        Returns:
-            int: 1 if calculation successfully ended, 0 otherwise.
+            inputMesh : a mesh to transform
+            outputMesh : a mesh transformed
         """
-        inputMesh: Union[ vtkMultiBlockDataSet, vtkUnstructuredGrid ] = self.GetInputData( inInfo, 0, 0 )
-        outputMesh: Union[ vtkMultiBlockDataSet, vtkUnstructuredGrid ] = self.GetOutputData( outInfo, 0 )
-
         # struct
         self._realFilter.SetInputData( inputMesh )
         self._realFilter.ComputeTransform()
         self._realFilter.Update()
         outputMesh.ShallowCopy( self._realFilter.GetOutputDataObject( 0 ) )
-
-        return 1