added plot_comet3 to itacoordinates

ExternalPackages/PlotComet_3D/PlotComet_3D.m

+function varargout = PlotComet_3D(x_data, y_data, z_data, varargin)
+
+%function creates a moving comet plot in 3 dimensions using the specificed
+%x, y, and z line data
+%
+%PlotComet_3D(x_data, y_data, z_data)
+%
+%Optional Input Arguements:
+%cFigure, handle to the current figure or axes to create the plot in (will
+%   add the line data to the plot regardless of whether hold is on
+%
+%Frequency, playback frequency, if not provided assumed to be 10 Hz
+%
+%blockSize, number of points in the comet tail, assumed to be 1/20 of
+%   length(x_data) if not provided
+%
+%PlotComet_3D(x_data, y_data, z_data, 'cFigure',FigureHandle,...
+%     'Frequency',freq, 'blockSize',num_points)
+%
+%tailFormat, a structured variable containing the fomrating requirements of
+%   the tail (if different than the default red solid line)
+%   ex: Tail = struct('LineWidth',2,'Color','g','LineStyle','*');
+%   PlotComet_3D(x_data,y_data,z_data,'tailFormat',Tail);
+%
+%headFormat, a structued vairable containing the formating requirements of
+%   the head (if different than the default blue circle)
+%   ex: Head = struct('LineStyle','none','MarkerSize',8,'Marker','^','Color','k');
+%   PlotComet_3D(x_data,y_data,z_data,'headFormat',head);
+%   Note: 'LineSytle','none' is required since the head is plotted as a
+%   single point!
+%
+%Optional Output Arguements
+%hFigure = figure handle to the comet plot
+%
+%Example: Create a surface plot and construct a moving line plot through it
+%with connected cyan stars and dashed line on a 50 points long tail
+%and large green square for a head.
+%
+%%create some data for the surface
+%[X, Y] = meshgrid(linspace(-1, 1, 25), linspace(-1, 1, 25));
+%Z = X .* exp(-X.^2 - Y.^2);
+%%open a new figure and plot the surface
+%surf(X, Y, Z);
+%fig = gcf;
+%%create the line data
+%t = -pi:pi/500:pi;
+%x = sin(5*t);
+%y = cos(3*t);
+%z = t;
+%%define the tail formated structure
+%Tail = struct('LineStyle','--','Marker','*','Color','c',...
+%   'LineWidth',2,'MarkerSize',4);
+%%define the head formated structure
+%Head = struct('LineStyle','none','Marker','s','Color','g','MarkerSize',10);
+%
+%%Invoke the comet plot with 50 Hz playback, and a tail length of 50 pts
+%PlotComet_3D(x,y,z,'cFigure',fig,'blockSize',50,'Frequency',50,...
+%   'headFormat',Head,'tailFormat',Tail);
+%
+%Nick Hansford
+%09/26/2013
+
+%initialize the inputs
+freq = 10;
+blockSize = floor(1/20*length(x_data));
+tailFormat = struct('LineWidth',1,'Color','r','LineStyle','-');
+headFormat = struct('LineStyle','none','Marker','o','MarkerSize',6,...
+    'Color','b');
+
+
+
+
+%parse out the inputs
+argCount = nargin - 3;
+
+for i = 1:2:argCount
+    %         caseVar = varargin{i}
+    switch varargin{i}
+        case 'cFigure'
+            cFigure = varargin{i+1};
+            %get the original size:
+            cAxes = get(cFigure,'CurrentAxes');
+            xLim = get(cAxes,'XLim');
+            yLim = get(cAxes,'YLim');
+            zLim = get(cAxes,'ZLim');
+            
+            %resize if the new plot will exceed them
+            if xLim(1) > min(x_data)
+                xLim(1) = min(x_data);
+            end
+            
+            if xLim(2) < max(x_data)
+                xLim(2) = max(x_data);
+            end
+            
+            if yLim(1) > min(y_data)
+                yLim(1) = min(y_data);
+            end
+            
+            if yLim(2) < max(y_data)
+                yLim(2) = max(y_data);
+            end
+            
+            if zLim(1) > min(z_data)
+                zLim(1) = min(z_data);
+            end
+            
+            if zLim(2) < max(z_data)
+                zLim(2) = max(z_data);
+            end
+            
+            axis([xLim, yLim, zLim]);
+            
+        case 'blockSize'
+            blockSize = varargin{i+1};
+        case 'Frequency'
+            freq = varargin{i+1};
+            
+        case 'tailFormat'
+            tailFormat = varargin{i+1};
+            
+        case 'headFormat'
+            headFormat = varargin{i+1};
+    end
+end
+    
+    
+%make sure the figure exists, if not, create it
+if ~exist('cFigure')
+    cFigure = figure;
+    view(3);
+    axis([min(x_data), max(x_data),...
+        min(y_data), max(y_data),...
+        min(z_data), max(z_data)]);
+end
+
+    
+%user can pass in current axes, if so, get the parent for the figure window
+%and use that instead...should make this compatible with GUIs?
+if strcmp(get(cFigure,'Type'),'axes')
+    cFigure = get(cFigure,'Parent');
+end
+
+%activate the figure window
+figure(cFigure);
+cAxes = get(cFigure,'CurrentAxes');
+
+oldNextPlot = get(cAxes,'NextPlot');
+set(cAxes,'NextPlot','add');
+
+pauseTime = 1./freq;
+
+n_start = 1;
+n_stop = 1;
+%put on the starting point
+plot3(x_data(n_start:n_stop),...
+    y_data(n_start:n_stop),...
+    z_data(n_start:n_stop),tailFormat);
+plot3(x_data(n_stop), y_data(n_stop), z_data(n_stop),headFormat);
+
+%playback!
+for n = 1:1:length(x_data)
+    a = tic;
+    %delete the previous plot
+    hChild = get(cAxes,'Children');
+    delete(hChild(1:2));
+       
+    
+    if n <= blockSize
+        n_start = 1;
+        n_stop = n;
+    else
+        n_start = n_start + 1;
+        n_stop = n_stop + 1;
+    end
+    
+    %new plot
+    plot3(x_data(n_start:n_stop),...
+        y_data(n_start:n_stop),...
+        z_data(n_start:n_stop),tailFormat);
+    plot3(x_data(n_stop), y_data(n_stop), z_data(n_stop),headFormat);
+    drawnow;
+    
+    %update playback refresh rate
+    b = toc(a);
+    pause(pauseTime-b);
+end
+
+set(cAxes,'NextPlot',oldNextPlot);
+% fprintf('Finished\n');
+
+if nargout == 1
+    varargout{1} = cFigure;
+end

ExternalPackages/PlotComet_3D/license.txt

+Copyright (c) 2013, Nick Hansford
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in
+      the documentation and/or other materials provided with the distribution
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

kernel/ClassStuff/@itaCoordinates/comet3.m

+function [ varargout ] = comet3(this,varargin )
+
+% <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>
+
+hFig = PlotComet_3D(this.x, this.y, this.z, varargin{:});
+xlabel('X');
+ylabel('Y');
+zlabel('Z');
+axis equal vis3d
+if nargout
+   varargout = {hFig};
+else
+    varargout = {};
+end
+
+end
+