Getdatasource: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Bob No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
===Purpose=== | ===Purpose=== | ||
Extract summary information about a DataSet. | Extract summary information about a DataSet. | ||
===Synopsis=== | ===Synopsis=== | ||
:[out1, out2,...] = getdatasource(dataset1, ''dataset2'',...) | :[out1, out2,...] = getdatasource(dataset1, ''dataset2'',...) | ||
===Description=== | ===Description=== | ||
The input(s) dataset1,'' dataset2'',... are dataset objects. GETDATASOURCE returns structures containing useful summary information about each | |||
The input(s) dataset1,'' dataset2'',... are dataset objects. GETDATASOURCE returns structures containing useful summary information about each dataset object including the contents of the dataset fields: name, author, date, and moddate. Also returned in the structure is the size of the data field. | |||
====Inputs==== | |||
* '''dataset1''' = first input dataset object | |||
====Optional Inputs==== | |||
* '''dataset2, ...''' = second (and so on) dataset objects | |||
====Outputs==== | |||
* '''out1''' = structure containing information corresponding to <tt>dataset1</tt> (and so on for <tt>out2</tt> . . .) | |||
===Examples=== | |||
<pre> | |||
>> getdatasource(arch) | |||
ans = | |||
name: 'arch' | |||
type: 'data' | |||
author: 'archeologist' | |||
date: [2001 5 11 11 19 45.250000000000000] | |||
moddate: [2002 5 17 8 52 58.170000000000002] | |||
size: [75 10] | |||
include_size: [75 10] | |||
description: [4x60 char] | |||
</pre> | |||
===See Also=== | ===See Also=== | ||
[[dataset/dataset]], [[dataset/subsref]], [[modelstruct]] | [[dataset/dataset]], [[dataset/subsref]], [[modelstruct]] | ||
Latest revision as of 18:49, 9 October 2008
Purpose
Extract summary information about a DataSet.
Synopsis
- [out1, out2,...] = getdatasource(dataset1, dataset2,...)
Description
The input(s) dataset1, dataset2,... are dataset objects. GETDATASOURCE returns structures containing useful summary information about each dataset object including the contents of the dataset fields: name, author, date, and moddate. Also returned in the structure is the size of the data field.
Inputs
- dataset1 = first input dataset object
Optional Inputs
- dataset2, ... = second (and so on) dataset objects
Outputs
- out1 = structure containing information corresponding to dataset1 (and so on for out2 . . .)
Examples
>> getdatasource(arch)
ans =
name: 'arch'
type: 'data'
author: 'archeologist'
date: [2001 5 11 11 19 45.250000000000000]
moddate: [2002 5 17 8 52 58.170000000000002]
size: [75 10]
include_size: [75 10]
description: [4x60 char]