forked from episodes-platform/shared-snippets
Update docs by adding link to catalog format documentation
This commit is contained in:
parent
221d8ba37a
commit
5b65058b89
@ -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'}
|
||||
|
@ -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)
|
||||
|
@ -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.
|
||||
%
|
||||
|
@ -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];
|
||||
|
Loading…
Reference in New Issue
Block a user