Merge pull request 'feature/ISL-4832-przepisac-catalogeditor-do-pythona' (#2) from ymlesni/shared-snippets:feature/ISL-4832-przepisac-catalogeditor-do-pythona into main

Reviewed-on: episodes-platform/shared-snippets#2
Reviewed-by: asia <asia@noreply.example.org>

matlab/logging/base_logger.m

@@ -10,6 +10,9 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
+% The log file is specified by the environment variable 'APP_LOG_FILE'. If
+% the variable is not set, a default file 'base-logger-log.log' is used.
+%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -17,20 +20,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(message) - Logs a message with TRACE level.
-%     @param message The message to log.
+%   trace(varargin) - Logs one or more messages with TRACE level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   debug(message) - Logs a message with DEBUG level.
-%     @param message The message to log.
+%   debug(varargin) - Logs one or more messages with DEBUG level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   info(message) - Logs a message with INFO level.
-%     @param message The message to log.
+%   info(varargin) - Logs one or more messages with INFO level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   warning(message) - Logs a message with WARNING level.
-%     @param message The message to log.
+%   warning(varargin) - Logs one or more messages with WARNING level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   error(message) - Logs a message with ERROR level.
-%     @param message The message to log.
+%   error(varargin) - Logs one or more messages with ERROR level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %

octave/logging/base_logger.m

@@ -10,6 +10,9 @@
 % It follows the Singleton pattern to ensure that only one instance of the logger
 % exists throughout the application.
 %
+% The log file is specified by the environment variable 'APP_LOG_FILE'. If
+% the variable is not set, a default file 'base-logger-log.log' is used.
+%
 % Properties:
 %   fid - (private) The file identifier for the log file. This is used to write logs.
 %
@@ -17,20 +20,20 @@
 %
 %   getInstance() - Retrieves the singleton instance of the logger.
 %
-%   trace(message) - Logs a message with TRACE level.
-%     @param message The message to log.
+%   trace(varargin) - Logs one or more messages with TRACE level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   debug(message) - Logs a message with DEBUG level.
-%     @param message The message to log.
+%   debug(varargin) - Logs one or more messages with DEBUG level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   info(message) - Logs a message with INFO level.
-%     @param message The message to log.
+%   info(varargin) - Logs one or more messages with INFO level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   warning(message) - Logs a message with WARNING level.
-%     @param message The message to log.
+%   warning(varargin) - Logs one or more messages with WARNING level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
-%   error(message) - Logs a message with ERROR level.
-%     @param message The message to log.
+%   error(varargin) - Logs one or more messages with ERROR level.
+%     @param varargin The messages to log. Can be strings, numbers, or MException objects.
 %
 %   delete() - Destructor method that closes the file identifier when the logger is deleted.
 %

python/catalog/find_catalog_column.py

@@ -0,0 +1,36 @@
+# -----------------
+# Copyright © 2024 ACK Cyfronet AGH, Poland.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This work was partially funded by DT-GEO Project.
+# -----------------
+def find_catalog_column(catalog, field_name):
+    """
+    Finds the index of a column in the catalog based on its field name.
+
+    Parameters:
+        catalog (np.ndarray): A structured NumPy array representing a catalog in EPISODES Platform format:
+                              https://docs.cyfronet.pl/display/ISDOC/Catalogs
+        field_name (str): The field name of the entry to search for.
+
+    Returns:
+        int: The index of the entry matching the given field name.
+
+    Raises:
+        ValueError: If the specified field name is not found in the catalog.
+    """
+    for idx, col in enumerate(catalog):
+        if col['field'] == field_name:
+            return idx
+    raise ValueError(f'No {field_name} field found in the catalog.')

python/catalog/sort_by_time.py

@@ -0,0 +1,44 @@
+# -----------------
+# Copyright © 2024 ACK Cyfronet AGH, Poland.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# This work was partially funded by DT-GEO Project.
+# -----------------
+import numpy as np
+from find_catalog_column import find_catalog_column
+
+def sort_by_time(catalog):
+    """
+    Sorts the given catalog based on the 'Time' column. Requires find_catalog_column script to work.
+
+    Parameters:
+        catalog (np.ndarray): A structured NumPy array representing a seismic catalog in EPISODES Platform format:
+                              https://docs.cyfronet.pl/display/ISDOC/Seismic+catalog
+
+    Returns:
+        np.ndarray: The sorted catalog, where rows in 'val' fields are ordered by ascending 'Time' values.
+
+    Raises:
+        ValueError: If the 'Time' column is not found in the catalog.
+    """
+    time_col_index = find_catalog_column(catalog, 'Time')
+
+    time_values = catalog[time_col_index]['val'].flatten()
+    sorted_indexes = np.argsort(time_values)
+
+    sorted_catalog = catalog.copy()
+    for field in sorted_catalog:
+        field['val'] = field['val'][sorted_indexes]
+
+    return sorted_catalog