Loading README.md +114 −15 Original line number Diff line number Diff line Loading @@ -72,21 +72,22 @@ outputs: ``` projs(4) = struct with fields: id: 9 name: 'BEPICRUISE' description: 'BepiColombo Cruise Phase' id: 10 name: 'BEPI' description: 'Test' ``` ### MatMust_getDataFromName ### MatMust_searchTMparFromName Search a parameter into the requested **dataprovider** (es. 'BEPICRUISE') Search a parameter into the requested **dataprovider** (es. 'BEPI') `results = MatMust_searchTMparFromName(M, namequery, dataproviders, options)` `results = MatMust_searchTMparFromName(M, namequery, dataproviders, [options])` inputs: - `M` -> A MutMust Class, succesfully logged in - `namequery` -> The query to perform (ex. '*HGA' ) - `dataproviders` -> dataprovider IdName. Can be more than one passed as a cell `{'BEPICRUISE','...'}` - `dataproviders` -> dataprovider IdName. Can be more than one passed as a cell `{'BEPI','...'}` - aggregationValue = <numeric> (es. 10) - `options` -> You can specify several options: - 'dump' -> print to screen the parameters found - 'Description' -> Extend search in Parameters Descriptions Loading @@ -98,32 +99,130 @@ outputs: ``` r = struct with fields: type: 'BEPICRUISE params' type: 'BEPI params' typeId: 'params' children: [2×1 struct] ``` es: `r = MatMust_searchTMparFromName(M, 'APMH processed ', 'BEPICRUISE','dump','Description','title')` `r = MatMust_searchTMparFromName(M, 'APMH processed ', 'BEPI','dump','Description','title')` ### MatMust_getTMparStatistics Get back statistics of specified parameters in the time span `results = MatMust_getTMparStatistics(obj, ds, parname, dateStart, dateStop, [options] )` inputs: - `M` -> A MutMust Class, succesfully logged in - `ds` -> 'string' -> name of the dataprovider i.e.'BEPI' - `parname` -> 'string' -> a parameter name i.e. 'NCAD7EB7' or a struct of strings {'NCAD7EB7', 'NCAD7EB8' ...} - `dateStart` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `dateStop` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `options` -> You can specify several options: - 'dump' -> print to screen the parameters found output: - `results` -> a Nx1 struct array of the N parameters requested example: results = M.MatMust_getTMparStatistics('BEPI', {'NCAD09A1', 'NCAD7DD1'}, '2022-11-12 02:00:00', '2022-11-12 06:00:00','dump'); ``` results = 2×1 struct array with fields: dataProvider parameter from to aggregation aggregationValue aggregationFunction count sum min max minDate maxDate avg stddev orbit ``` ### MatMust_getDataFromName MatMust_getDataFromName get the data name parameter from the project name `ds` in the time interval `dateStart`, `dateStop`. `data = MatMust_getDataFromName(M, ds, parname, dateStart, dateStop, options )` `data = MatMust_getDataFromName(M, ds, parname, dateStart, dateStop,[aggregation], [options] )` inputs: - `M` -> A MutMust Class, succesfully logged in - `ds` -> 'string' -> name of the dataprovider i.e.'BEPICRUISE' - `ds` -> 'string' -> name of the dataprovider i.e.'BEPI' - `parname` -> 'string' -> a parameter name i.e. 'NCAD7EB7' or a struct of strings {'NCAD7EB7', 'NCAD7EB8' ...} - `dateStart` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `dateStop` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `aggregation`-> (optional) You can specify aggregation function and parameters - You can add aggration funcition - aggregation = [days | hours | minutes ] - aggregationFunction = [ FIRST | LAST | MAX | MIN | AVERAGE] - `options` -> You can specify several options: - `'dump'` will print on screen all the results - `'plot'` optional parameter to dump and plot the data - `'calibrated'` optional parameter that specify that you want calibrated data output: A Nx1 cell array of structs containing the data for the N parameters requested. Each parameter is contained in a struct: ``` data{1} = struct with fields: unit: 'none' data: [115200×1 struct] date value calibratedValue dateMAT dataType: 'DOUBLE' name: 'NCAD09A1' description: 'Est sc ang rate x' subsystem: 'TM' id: '18334' type: 'TM' complete: 'true' ``` example: `data = M.MatMust_getDataFromName(['BEPI'], {'NCAD09A1','NCAD09A2','NCAD09A3'}, dataStartOM , dataStopOM);` ``` data = 3×1 cell array {1×1 struct} {1×1 struct} {1×1 struct} ``` ``` data{1} = struct with fields: unit: 'none' data: [115200×1 struct] date value calibratedValue dateMAT dataType: 'DOUBLE' name: 'NCAD09A1' description: 'Est sc ang rate x' subsystem: 'TM' id: '18334' type: 'TM' complete: 'true' ``` No newline at end of file Loading
README.md +114 −15 Original line number Diff line number Diff line Loading @@ -72,21 +72,22 @@ outputs: ``` projs(4) = struct with fields: id: 9 name: 'BEPICRUISE' description: 'BepiColombo Cruise Phase' id: 10 name: 'BEPI' description: 'Test' ``` ### MatMust_getDataFromName ### MatMust_searchTMparFromName Search a parameter into the requested **dataprovider** (es. 'BEPICRUISE') Search a parameter into the requested **dataprovider** (es. 'BEPI') `results = MatMust_searchTMparFromName(M, namequery, dataproviders, options)` `results = MatMust_searchTMparFromName(M, namequery, dataproviders, [options])` inputs: - `M` -> A MutMust Class, succesfully logged in - `namequery` -> The query to perform (ex. '*HGA' ) - `dataproviders` -> dataprovider IdName. Can be more than one passed as a cell `{'BEPICRUISE','...'}` - `dataproviders` -> dataprovider IdName. Can be more than one passed as a cell `{'BEPI','...'}` - aggregationValue = <numeric> (es. 10) - `options` -> You can specify several options: - 'dump' -> print to screen the parameters found - 'Description' -> Extend search in Parameters Descriptions Loading @@ -98,32 +99,130 @@ outputs: ``` r = struct with fields: type: 'BEPICRUISE params' type: 'BEPI params' typeId: 'params' children: [2×1 struct] ``` es: `r = MatMust_searchTMparFromName(M, 'APMH processed ', 'BEPICRUISE','dump','Description','title')` `r = MatMust_searchTMparFromName(M, 'APMH processed ', 'BEPI','dump','Description','title')` ### MatMust_getTMparStatistics Get back statistics of specified parameters in the time span `results = MatMust_getTMparStatistics(obj, ds, parname, dateStart, dateStop, [options] )` inputs: - `M` -> A MutMust Class, succesfully logged in - `ds` -> 'string' -> name of the dataprovider i.e.'BEPI' - `parname` -> 'string' -> a parameter name i.e. 'NCAD7EB7' or a struct of strings {'NCAD7EB7', 'NCAD7EB8' ...} - `dateStart` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `dateStop` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `options` -> You can specify several options: - 'dump' -> print to screen the parameters found output: - `results` -> a Nx1 struct array of the N parameters requested example: results = M.MatMust_getTMparStatistics('BEPI', {'NCAD09A1', 'NCAD7DD1'}, '2022-11-12 02:00:00', '2022-11-12 06:00:00','dump'); ``` results = 2×1 struct array with fields: dataProvider parameter from to aggregation aggregationValue aggregationFunction count sum min max minDate maxDate avg stddev orbit ``` ### MatMust_getDataFromName MatMust_getDataFromName get the data name parameter from the project name `ds` in the time interval `dateStart`, `dateStop`. `data = MatMust_getDataFromName(M, ds, parname, dateStart, dateStop, options )` `data = MatMust_getDataFromName(M, ds, parname, dateStart, dateStop,[aggregation], [options] )` inputs: - `M` -> A MutMust Class, succesfully logged in - `ds` -> 'string' -> name of the dataprovider i.e.'BEPICRUISE' - `ds` -> 'string' -> name of the dataprovider i.e.'BEPI' - `parname` -> 'string' -> a parameter name i.e. 'NCAD7EB7' or a struct of strings {'NCAD7EB7', 'NCAD7EB8' ...} - `dateStart` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `dateStop` -> 'yyyy-mm-dd HH:MM:SS' format date UTC time - `aggregation`-> (optional) You can specify aggregation function and parameters - You can add aggration funcition - aggregation = [days | hours | minutes ] - aggregationFunction = [ FIRST | LAST | MAX | MIN | AVERAGE] - `options` -> You can specify several options: - `'dump'` will print on screen all the results - `'plot'` optional parameter to dump and plot the data - `'calibrated'` optional parameter that specify that you want calibrated data output: A Nx1 cell array of structs containing the data for the N parameters requested. Each parameter is contained in a struct: ``` data{1} = struct with fields: unit: 'none' data: [115200×1 struct] date value calibratedValue dateMAT dataType: 'DOUBLE' name: 'NCAD09A1' description: 'Est sc ang rate x' subsystem: 'TM' id: '18334' type: 'TM' complete: 'true' ``` example: `data = M.MatMust_getDataFromName(['BEPI'], {'NCAD09A1','NCAD09A2','NCAD09A3'}, dataStartOM , dataStopOM);` ``` data = 3×1 cell array {1×1 struct} {1×1 struct} {1×1 struct} ``` ``` data{1} = struct with fields: unit: 'none' data: [115200×1 struct] date value calibratedValue dateMAT dataType: 'DOUBLE' name: 'NCAD09A1' description: 'Est sc ang rate x' subsystem: 'TM' id: '18334' type: 'TM' complete: 'true' ``` No newline at end of file