ISL-4832 Adjusted description in find_catalog_column.py, sort_by_time.py and sort_by_time_standalone.py

This commit is contained in:
plgmlesniak 2025-01-13 12:44:44 +01:00
parent 60e52884f4
commit 9fa094a2dc
3 changed files with 6 additions and 6 deletions

View File

@ -20,8 +20,8 @@ def find_catalog_column(catalog, field_name):
Finds the index of a column in the catalog based on its field name. Finds the index of a column in the catalog based on its field name.
Parameters: Parameters:
catalog (np.ndarray): A structured NumPy array representing the catalog, where each row catalog (np.ndarray): A structured NumPy array representing the catalog.
corresponds to a field with attributes like 'field', 'val', etc. https://docs.cyfronet.pl/display/ISDOC/Seismic+catalog
field_name (str): The field name of the entry to search for. field_name (str): The field name of the entry to search for.
Returns: Returns:

View File

@ -23,8 +23,8 @@ def sort_by_time(catalog):
Sorts the given catalog based on the 'Time' column. Sorts the given catalog based on the 'Time' column.
Parameters: Parameters:
catalog (np.ndarray): A structured NumPy array representing the catalog, where each row catalog (np.ndarray): A structured NumPy array representing the catalog.
contains fields like 'Time', 'ID', and others. https://docs.cyfronet.pl/display/ISDOC/Seismic+catalog
Returns: Returns:
np.ndarray: The sorted catalog, where rows in 'val' fields are ordered by ascending 'Time' values. np.ndarray: The sorted catalog, where rows in 'val' fields are ordered by ascending 'Time' values.

View File

@ -22,8 +22,8 @@ def sort_by_time(catalog):
Sorts the given catalog based on the 'Time' column. Sorts the given catalog based on the 'Time' column.
Parameters: Parameters:
catalog (np.ndarray): A structured NumPy array representing the catalog, where each row catalog (np.ndarray): A structured NumPy array representing the catalog.
contains fields like 'Time', 'ID', and others. https://docs.cyfronet.pl/display/ISDOC/Seismic+catalog
Returns: Returns:
np.ndarray: The sorted catalog, where rows in 'val' fields are ordered by ascending 'Time' values. np.ndarray: The sorted catalog, where rows in 'val' fields are ordered by ascending 'Time' values.