DataSet Object Methods: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
No edit summary
imported>Scott
No edit summary
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
In addition to the specific methods listed below, a number of standard MATLAB functions are overloaded for [[DataSet_Object|DataSet objects]] but otherwise work as documented for standard data types. The following methods operate on the underlying data field of a DataSet object only and have no effect on any other fields:


'''Methods overloaded for DataSet objects'''
<div style="width:350px;column-count:3;-moz-column-count:3;-webkit-column-count:3">
:minus (-)
:plus (+)
:times (.*)
:rdivide (./)
:ldivide (.\)
:double
:single
</div>


:[[dataset/cat]]
To get help on any DataSet object method, use the command: <tt>help dataset/method</tt>  where <tt>method</tt> is the name of the method for which you want help.
:[[dataset/delsamps]]
 
:[[dataset/disp]]
===Methods Defined or Overloaded for DataSet Objects===
:[[dataset/explode]]
 
:[[dataset/get]]  
:[[dataset_augment|augment]] - Concatenation of DataSet objects and add class.
:[[dataset/horzcat]]
:[[dataset_anyexcluded|anyexcluded]] - Reports if any element is excluded in a DSO.
:[[dataset/isempty]]
:[[dataset_cat|cat]] - Generic concatenation of DataSet objects.
:[[dataset/length]]  
:[[dataset_delsamps|delsamps]] - Deletes or excludes the specified samples, rows, or other dimension from a DataSet object.
:[[dataset/ndims]]  
:[[dataset_disp|disp]] - Display summary of DataSet object contents.
:[[dataset/numel]]  
:[[dataset_explode|explode]] - Extract all variables from a DataSet object.
:[[dataset/permute]]
:[[dataset_findset|findset]] - Locate a set within a label field (axisscale,label,class) in a DataSet.
:[[dataset/repmat]]  
:[[dataset_get|get]] - Get field/property values from a DataSet object. 
:[[dataset/set]]    
:[[dataset_horzcat|horzcat]] - Horizontal concatenation of DataSet objects.
:[[dataset/size]]    
:[[dataset_isempty|isempty]] - Returns Boolean true if the DataSet object data field is empty.
:[[dataset/sortrows]]  
:[[dataset_length|length]] - Returns the length of the data field in a DataSet object.
:[[dataset/squeeze]]
:[[dataset_length|listsets]] - For a given field and mode list the sets available.
:[[dataset/subsasgn]]  
:[[dataset_ndims|ndims]] - Returns the number of dimensions of the data field in a DataSet object.
:[[dataset/subsref]]
:[[dataset_numel|numel]] - Returns a value of 1 for any dataset object.
:[[dataset/transpose]]
:[[dataset_permute|permute]] - Permute array dimensions of a DataSet object.
:[[dataset/unique]]  
:[[dataset_repmat|repmat]] - Replicate and tile a DataSet object.
:[[dataset/vertcat]]
:[[dataset_reshape|reshape]] - Change size of a DataSet object.
:[[dataset_rmset|rmset]] - Removes a specific set from a DSO field.
:[[dataset_search|search]] - Search for given term in a dso field, mode, and set.
:[[dataset_set|set]] - Set field/property values for a DataSet object.
:[[dataset_size|size]] - Returns the size of the data field in a DataSet object.
:[[dataset_sortby|sortby]] - Sort a DataSet by given field, dim, and set. 
:[[dataset_sortcols|sortcols]] - Sort columns of a DataSet. 
:[[dataset_sortrows|sortrows]] - Sort rows of a DataSet. 
:[[dataset_squeeze|squeeze]] - Removes singleton dimensions of a DataSet object.
:[[dataset_subsasgn|subsasgn]] - Assign for DataSet objects using Structure and index notation. 
:[[dataset_subsref|subsref]] - Subindex for DataSet objects using Structure and index notation.
:[[dataset_transpose|transpose]] - Performs a transpose (rows become columns and columns become rows) on a two-way DataSet object.
:[[dataset_unique|unique]] - Returns a DataSet object containing all the unique values from the input.
:[[dataset_updateset|updateset]] - Add/update a label field (axisscale,label,class) in a DataSet.
:[[dataset_vertcat|vertcat]] - Returns a DataSet object containing all the unique values from the input

Latest revision as of 16:28, 9 June 2014

In addition to the specific methods listed below, a number of standard MATLAB functions are overloaded for DataSet objects but otherwise work as documented for standard data types. The following methods operate on the underlying data field of a DataSet object only and have no effect on any other fields:

minus (-)
plus (+)
times (.*)
rdivide (./)
ldivide (.\)
double
single

To get help on any DataSet object method, use the command: help dataset/method where method is the name of the method for which you want help.

Methods Defined or Overloaded for DataSet Objects

augment - Concatenation of DataSet objects and add class.
anyexcluded - Reports if any element is excluded in a DSO.
cat - Generic concatenation of DataSet objects.
delsamps - Deletes or excludes the specified samples, rows, or other dimension from a DataSet object.
disp - Display summary of DataSet object contents.
explode - Extract all variables from a DataSet object.
findset - Locate a set within a label field (axisscale,label,class) in a DataSet.
get - Get field/property values from a DataSet object.
horzcat - Horizontal concatenation of DataSet objects.
isempty - Returns Boolean true if the DataSet object data field is empty.
length - Returns the length of the data field in a DataSet object.
listsets - For a given field and mode list the sets available.
ndims - Returns the number of dimensions of the data field in a DataSet object.
numel - Returns a value of 1 for any dataset object.
permute - Permute array dimensions of a DataSet object.
repmat - Replicate and tile a DataSet object.
reshape - Change size of a DataSet object.
rmset - Removes a specific set from a DSO field.
search - Search for given term in a dso field, mode, and set.
set - Set field/property values for a DataSet object.
size - Returns the size of the data field in a DataSet object.
sortby - Sort a DataSet by given field, dim, and set.
sortcols - Sort columns of a DataSet.
sortrows - Sort rows of a DataSet.
squeeze - Removes singleton dimensions of a DataSet object.
subsasgn - Assign for DataSet objects using Structure and index notation.
subsref - Subindex for DataSet objects using Structure and index notation.
transpose - Performs a transpose (rows become columns and columns become rows) on a two-way DataSet object.
unique - Returns a DataSet object containing all the unique values from the input.
updateset - Add/update a label field (axisscale,label,class) in a DataSet.
vertcat - Returns a DataSet object containing all the unique values from the input