Formatting

Author: paloma-martinez

geos-mesh/src/geos/mesh/model/QualityMetricSummary.py

@@ -60,34 +60,34 @@ def getIndex( self: Self ) -> int:
         """Get stat index.
 
         Returns:
-            int: index
+            int: Index
         """
         return self.value[ 0 ]
 
     def getString( self: Self ) -> str:
         """Get stat name.
 
         Returns:
-            str: name
+            str: Name
         """
         return self.value[ 1 ]
 
     def getType( self: Self ) -> object:
         """Get stat type.
 
         Returns:
-            object: type
+            object: Type
         """
         return self.value[ 2 ]
 
     def compute( self: Self, array: Iterable[ float ] ) -> int | float:
         """Compute statistics using function.
 
         Args:
-            array (Iterable[float]): input array
+            array (Iterable[float]): Input array
 
         Returns:
-            int | float: output stat
+            int | float: Output stat
         """
         return self.value[ 3 ]( array )
 
@@ -96,10 +96,10 @@ def getNameFromIndex( index: int ) -> str:
         """Get stat name from index.
 
         Args:
-            index (int): index
+            index (int): Index
 
         Returns:
-            str: name
+            str: Name
         """
         return list( StatTypes )[ index ].getString()
 
@@ -108,10 +108,10 @@ def getIndexFromName( name: str ) -> int:
         """Get stat index from name.
 
         Args:
-            name (str): name
+            name (str): Name
 
         Returns:
-            int: index
+            int: Index
         """
         for stat in list( StatTypes ):
             if stat.getString() == name:
@@ -123,10 +123,10 @@ def getTypeFromIndex( index: int ) -> object:
         """Get stat type from index.
 
         Args:
-            index (int): index
+            index (int): Index
 
         Returns:
-            object: type
+            object: Type
         """
         return list( StatTypes )[ index ].getType()
 
@@ -184,15 +184,15 @@ def getCellTypeCountsObject( self: Self ) -> int:
         """Get cell type counts.
 
         Returns:
-            int: number of cell
+            int: Number of cell
         """
         return self._counts
 
     def getCellTypeCountsOfCellType( self: Self, cellType: int ) -> int:
         """Get cell type counts.
 
         Returns:
-            int: number of cell
+            int: Number of cell
         """
         return self._counts.getTypeCount( cellType )
 
@@ -204,8 +204,8 @@ def isCellStatsValidForMetricAndCellType(
         """Returns True if input quality metric applies to input cell type.
 
         Args:
-            metricIndex (int): metric index
-            cellType (int): cell type index
+            metricIndex (int): Metric index
+            cellType (int): Cell type index
 
         Returns:
             bool: True if input quality metric applies
@@ -216,23 +216,23 @@ def getAllCellStats( self: Self ) -> pd.DataFrame:
         """Get all cell stats including nan values.
 
         Returns:
-            pd.DataFrame: stats
+            pd.DataFrame: Stats
         """
         return self._cellStats
 
     def getAllValidCellStats( self: Self ) -> pd.DataFrame:
         """Get all valid cell stats.
 
         Returns:
-            pd.DataFrame: stats
+            pd.DataFrame: Stats
         """
         return self._cellStats.dropna( axis=1 )
 
     def getAllValidOtherMetricStats( self: Self ) -> pd.DataFrame:
         """Get all valid other metric stats.
 
         Returns:
-            pd.DataFrame: stats
+            pd.DataFrame: Stats
         """
         print( self._meshOtherStats.head() )
         return self._meshOtherStats.dropna( axis=1 )
@@ -246,12 +246,12 @@ def getCellStatValueFromStatMetricAndCellType(
         """Get cell stat value for the given metric and cell types.
 
         Args:
-            metricIndex (int): metric index
-            cellType (int): cell type index
-            statType (StatTypes): stat number
+            metricIndex (int): Metric index
+            cellType (int): Cell type index
+            statType (StatTypes): Stat number
 
         Returns:
-            float: stats value
+            float: Stats value
         """
         if ( metricIndex, cellType ) not in self._cellStats.columns:
             raise IndexError( f"Index ({metricIndex}, {cellType}) not in QualityMetricSummary stats" )
@@ -261,11 +261,11 @@ def getStatsFromMetricAndCellType( self: Self, metricIndex: int, cellType: int )
         """Get stats for the given metric and cell types.
 
         Args:
-            metricIndex (int): metric index
-            cellType (int): cell type index
+            metricIndex (int): Metric index
+            cellType (int): Cell type index
 
         Returns:
-            pd.Series: stats
+            pd.Series: Stats
         """
         if ( metricIndex, cellType ) not in self._cellStats.columns:
             raise IndexError( f"Index ({metricIndex}, {cellType}) not in QualityMetricSummary stats" )
@@ -278,10 +278,10 @@ def getStatsFromMetric(
         """Get stats for the given metric index.
 
         Args:
-            metricIndex (int): metric index
+            metricIndex (int): Metric index
 
         Returns:
-            pd.DataFrame: stats
+            pd.DataFrame: Stats
         """
         if metricIndex < QUALITY_METRIC_OTHER_START_INDEX:
             return self._cellStats.xs( metricIndex, level=self._LEVELS[ 0 ], axis=1 )
@@ -292,9 +292,9 @@ def setOtherStatValueFromMetric( self: Self, metricIndex: int, statType: StatTyp
         """Set other stat value for the given metric.
 
         Args:
-            metricIndex (int): metric index
-            statType (StatTypes): stat number
-            value (int | float): value
+            metricIndex (int): Metric index
+            statType (StatTypes): Stat number
+            value (int | float): Value
         """
         if metricIndex not in self._meshOtherStats.columns:
             raise IndexError( f"Index {metricIndex} not in QualityMetricSummary meshOtherStats" )
@@ -307,10 +307,10 @@ def getCellStatsFromCellType(
         """Get cell stats for the given cell type.
 
         Args:
-            cellType (int): cell type index
+            cellType (int): Cell type index
 
         Returns:
-            pd.DataFrame: stats
+            pd.DataFrame: Stats
         """
         return self._cellStats.xs( cellType, level=self._LEVELS[ 1 ], axis=1 )
 
@@ -319,10 +319,10 @@ def setCellStatValueFromStatMetricAndCellType( self: Self, metricIndex: int, cel
         """Set cell stats for the given metric and cell types.
 
         Args:
-            metricIndex (int): metric index
-            cellType (int): cell type index
-            statType (StatTypes): stat number
-            value (int | float): value
+            metricIndex (int): Metric index
+            cellType (int): Cell type index
+            statType (StatTypes): Stat number
+            value (int | float): Value
         """
         if ( metricIndex, cellType ) not in self._cellStats.columns:
             raise IndexError( f"Index ({metricIndex}, {cellType}) not in QualityMetricSummary stats" )
@@ -332,7 +332,7 @@ def getComputedCellMetricIndexes( self: Self ) -> list[ Any ]:
         """Get the list of index of computed cell quality metrics.
 
         Returns:
-            tuple[int]: list of metrics index
+            tuple[int]: List of metrics index
         """
         validCellStats: pd.DataFrame = self.getAllValidCellStats()
         columns: list[ int ] = validCellStats.columns.get_level_values( 0 ).to_list()
@@ -342,7 +342,7 @@ def getComputedOtherMetricIndexes( self: Self ) -> list[ Any ]:
         """Get the list of index of computed other quality metrics.
 
         Returns:
-            tuple[int]: list of metrics index
+            tuple[int]: List of metrics index
         """
         validOtherStats: pd.DataFrame = self.getAllValidOtherMetricStats()
         columns: list[ int ] = [ validOtherStats.columns.to_list() ]
@@ -352,15 +352,15 @@ def getAllComputedMetricIndexes( self: Self ) -> list[ Any ]:
         """Get the list of index of all computed metrics.
 
         Returns:
-            tuple[int]: list of metrics index
+            tuple[int]: List of metrics index
         """
         return self.getComputedCellMetricIndexes() + self.getComputedOtherMetricIndexes()
 
     def plotSummaryFigure( self: Self ) -> Figure:
         """Plot quality metric summary figure.
 
         Returns:
-            plt.figure: output Figure
+            plt.figure: Output Figure
         """
         computedCellMetrics: list[ int ] = self.getComputedCellMetricIndexes()
         computedOtherMetrics: list[ int ] = self.getComputedOtherMetricIndexes()
@@ -423,7 +423,7 @@ def _plotOtherMetricStats( self: Self, ax0: Axes ) -> None:
 
         Args:
             ax0 (Axes): Axes object
-            metricIndex (int): metric index
+            metricIndex (int): Metric index
         """
         # order of cell types in each axes
         computedMetrics: list[ int ] = self.getComputedOtherMetricIndexes()
@@ -470,7 +470,7 @@ def _plotCellMetricStats( self: Self, ax: Axes, metricIndex: int ) -> None:
 
         Args:
             ax (Axes): Axes object
-            metricIndex (int): metric index
+            metricIndex (int): Metric index
         """
         # get data to plot
         maxs: pd.Series = self._cellStats.loc[ StatTypes.MAX.getIndex(), metricIndex ]
@@ -515,16 +515,16 @@ def _plotRangePatch( self: Self, ax: Axes, metricIndex: int, cellType: int, ylim
         """Plot quality metric ranges.
 
         Args:
-            ax (Axes): axes object
-            metricIndex (int): metric index
-            cellType (int): cell type index
-            ylim0 (float): min y
-            ylim1 (float): max y
-            xtick (float): abscissa
-            rangeRecWidth (float): patch width
+            ax (Axes): Axes object
+            metricIndex (int): Metric index
+            cellType (int): Cell type index
+            ylim0 (float): Min y
+            ylim1 (float): Max y
+            xtick (float): Abscissa
+            rangeRecWidth (float): Patch width
 
         Returns:
-            tuple[float, float]: tuple containing miny and max y
+            tuple[float, float]: Tuple containing min y and max y
         """
         try:
             metric: MeshQualityMetricEnum = getQualityMetricFromIndex( metricIndex )
@@ -553,14 +553,14 @@ def _plotQualityRange( self: Self, ax: Axes, qualityRange: QualityRange, x: floa
         """Plot quality range patches.
 
         Args:
-            ax (Axes): axes object
-            qualityRange (QualityRange): quality ranges to plot
-            x (float): origin abscissa of the patches
-            ylim (tuple[float, float]): y limits for updates
-            rangeRecWidth (float): patch width
+            ax (Axes): Axes object
+            qualityRange (QualityRange): Quality ranges to plot
+            x (float): Origin abscissa of the patches
+            ylim (tuple[float, float]): Y limits for updates
+            rangeRecWidth (float): Patch width
 
         Returns:
-            tuple[float, float]: y limits for updates
+            tuple[float, float]: Y limits for updates
         """
         ylim0: float = ylim[ 0 ]
         ylim1: float = ylim[ 1 ]