itaSuper.m

classdef itaSuper < itaMeta
    
    
    %ITASUPER - Mother of all ita data-object classes (itaAudio/itaResult)
    %   Detailed explanation goes here
    %
    %   Reference page in Help browser
    %   <a href="matlab:doc itaSuper">doc itaSuper</a>
    
    % <ITA-Toolbox>
    % This file is part of the ITA-Toolbox. Some rights reserved.
    % You can find the license for this m-file in the license.txt file in the ITA-Toolbox folder.
    % </ITA-Toolbox>
    
    properties(Access = private, Hidden = true)
        % Internal fields, no access from outside the class
        mData = [];
        mDimensions = 0;
        mDomain = 'time';                % 'time' / 'freq'
        mChannelNames = {};
        mChannelUnits = {};
        mChannelCoordinates = itaCoordinates();
        mChannelOrientation = itaCoordinates();
        mChannelSensors = {};
        mChannelUserData = {};
        mAllowDBPlot = true;
        
        % up and view vector for hrtf data
        mObjectCoordinates = itaCoordinates();
        mObjectViewVector = itaCoordinates();
        mObjectUpVector = itaCoordinates();
        
        mDataType = 'double';           % Type for internal data
        mDataTypeOutput = 'double';     % Type used for output
        mDataTypeEqual = true;          % On/Off Switch for data type casts (speed reason)
        mDataFactor = 1;                % Factor for scaling if using int
    end
    
    properties(Constant, Hidden = true)
        % display options
        LINE_LENGTH  = 90;
    end
    
    %     properties(Abstract)
    %         % Properties that all sub-classes have but are not used in this class
    %         %freqVector
    %         %timeVector
    %     end
    
    properties(Dependent = true, Hidden = false)
        
        time %time domain data (get/set) - full dimensions
        timeData %time domain data in 2D
        
        freq %frequency domain data (get/set) - full dimensions
        freqData %frequency domain data in 2D
        
        
        nBins %number of frequency samples called bins
        nSamples % number of time samples
        
        domain % domain of data ('time'/'freq')
        dimensions % dimensions of the data field
        
        dataType %raw data type, data is stored in... (single/double)
        dataTypeOutput %data type when you access data (single/double), conversion
        
        channelNames %Names for each channel (cell string)
        channelUnits %Units for each channel (cell string)
        channelCoordinates %Coordinates for each channel (have to be itaCoordinates)