diff --git a/matlab/catalog/eliminateEmptyValues.m b/matlab/catalog/eliminateEmptyValues.m index fe24199..99c5e86 100644 --- a/matlab/catalog/eliminateEmptyValues.m +++ b/matlab/catalog/eliminateEmptyValues.m @@ -15,6 +15,10 @@ function varargout = eliminateEmptyValues(varargin) % arrays, and the function will remove entries that are empty in any of % the input columns. % +% This function is designed to work with catalog objects. For more +% information about the catalog format, refer to the documentation: +% https://docs.cyfronet.pl/display/ISDOC/Catalog+-+description +% % Example: % [a, b] = eliminateEmptyValues([1, NaN, 3], {'A', '', 'C'}); % % Result: a = [1, 3], b = {'A', 'C'} diff --git a/matlab/catalog/extractColumns.m b/matlab/catalog/extractColumns.m index 8bc90ec..1d1907c 100644 --- a/matlab/catalog/extractColumns.m +++ b/matlab/catalog/extractColumns.m @@ -14,6 +14,9 @@ function [varargout] = extractColumns(catalog, varargin) % each structure has fields 'field' and 'val'. The function returns the % values of the requested columns. % +% For more details on the catalog format, see: +% https://docs.cyfronet.pl/display/ISDOC/Catalog+-+description +% % Example: % catalog(1).field = 'ID'; catalog(1).val = [1, 2, 3]; % catalog(2).field = 'Time'; catalog(2).val = [100, 200, 300]; @@ -34,6 +37,9 @@ function column = findColumn(catalog, colName) % column = FINDCOLUMN(catalog, colName) searches the catalog structure % for the specified column name and returns its values. If the column % does not exist, an error is thrown. +% +% Refer to the catalog documentation for further information: +% https://docs.cyfronet.pl/display/ISDOC/Catalog+-+description for c = 1:length(catalog) if strcmp(catalog(c).field, colName) diff --git a/matlab/catalog/findCatalogColumn.m b/matlab/catalog/findCatalogColumn.m index 00926d3..c7daf88 100644 --- a/matlab/catalog/findCatalogColumn.m +++ b/matlab/catalog/findCatalogColumn.m @@ -16,6 +16,9 @@ function columnIdx = findCatalogColumn(catalog, colName) % idx = findCatalogColumn(catalog, 'Time'); % % Result: idx = 2 % +% For more details on the catalog format, refer to the documentation: +% https://docs.cyfronet.pl/display/ISDOC/Catalog+-+description +% % Note: This function is intended to be used in conjunction with other % catalog processing functions. % diff --git a/matlab/catalog/sortByTime.m b/matlab/catalog/sortByTime.m index c077538..41e11be 100644 --- a/matlab/catalog/sortByTime.m +++ b/matlab/catalog/sortByTime.m @@ -4,7 +4,7 @@ % ----------------- % function [sortedCatalog] = sortByTime(catalog) -% SORTBYTIME Sorts a catalog structure by the 'Time' column +% SORTBYTIME Sorts a seismic catalog structure by the 'Time' column % % sortedCatalog = SORTBYTIME(catalog) sorts the given catalog structure % based on the values in the 'Time' column. The catalog is expected to be @@ -12,6 +12,10 @@ function [sortedCatalog] = sortByTime(catalog) % 'val'. The function rearranges the catalog entries in ascending order % of time. % +% This function is specific to seismic catalogs. For more general +% information on catalogs, refer to: +% https://docs.cyfronet.pl/display/ISDOC/Catalog+-+description +% % Example: % catalog(1).field = 'ID'; catalog(1).val = [3, 2, 1]; % catalog(2).field = 'Time'; catalog(2).val = [300, 200, 100];