package Chart::Gnuplot; use strict; use vars qw($VERSION); use Carp; use File::Copy; use File::Temp qw(tempdir); use Chart::Gnuplot::Util qw(_lineType); $VERSION = 0.03; # Constructor sub new { my ($class, %hash) = @_; # Default terminal: postscript terminal with color drawing elements $hash{terminal} = "postscript enhanced color" if (!defined $hash{terminal} && !defined $hash{term}); # Default setting if (defined $hash{output}) { my @a = split(/\./, $hash{output}); my $ext = $a[-1]; $hash{terminal} .= " eps" if ($hash{terminal} =~ /^post/ && $ext eq 'eps'); } my $self = \%hash; return bless($self, $class); } # Generic attribute methods sub AUTOLOAD { my ($self, $key) = @_; my $attr = our $AUTOLOAD; $attr =~ s/.*:://; return if ($attr eq 'DESTROY'); # ignore destructor $self->{$attr} = $key if (defined $key); return($self->{$attr}); } # General set method sub set { my ($self, %opts) = @_; foreach my $opt (keys %opts) { $self->$opt($opts{$opt}); } return($self); } # Add a 2D data set to the chart object # - used with multiplot sub add2d { my ($self, @dataSet) = @_; push(@{$self->{_dataSets2D}}, @dataSet); } # Add a 3D data set to the chart object # - used with multiplot sub add3d { my ($self, @dataSet) = @_; push(@{$self->{_dataSets3D}}, @dataSet); } # Add a 2D data set to the chart object # - redirect to &add2d # - for backward compatibility sub add { &add2d(@_); } # Plot 2D graphs # - call _setChart() # # TODO: # - Consider using pipe instead of system call # - support MS time format: %{yyyy}-%{mmm}-%{dd} %{HH}:%{MM} sub plot2d { my ($self, @dataSet) = @_; &_setChart($self) if (!defined $self->{_script}); &_setTimeFmt($self, @dataSet); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "\nplot "; print PLT join(', ', map {$_->_thaw} @dataSet), "\n"; close(PLT); # Generate image file &_execute($self); return($self); } # Plot 3D graphs # - call _setChart() # # TODO: # - Consider using pipe instead of system call # - support MS time format: %{yyyy}-%{mmm}-%{dd} %{HH}:%{MM} sub plot3d { my ($self, @dataSet) = @_; &_setChart($self) if (!defined $self->{_script}); &_setTimeFmt($self, @dataSet); open(GPH, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print GPH "\nsplot "; print GPH join(', ', map {$_->_thaw} @dataSet), "\n"; close(GPH); # Generate image file &_execute($self); return($self); } # Plot multiple plots in one single chart sub multiplot { my ($self, @charts) = @_; if (!defined $self->{_script}) { my $set = &_setChart($self); &_unset($self, $set); } open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); # Emulate the title when there is background color fill if (defined $self->{title} && defined $self->{bg}) { print PLT "set label \"$self->{title}\" at screen 0.5, screen 1 ". "center offset 0,-1\n"; } if (scalar(@charts) == 1 && ref($charts[0]) eq 'ARRAY') { my $nrows = scalar(@{$charts[0]}); my $ncols = scalar(@{$charts[0][0]}); &_setMultiplot($self, $nrows, $ncols); for (my $r = 0; $r < $nrows; $r++) { for (my $c = 0; $c < $ncols; $c++) { my $chart = $charts[0][$r][$c]; $chart->_script($self->{_script}); my $set = &_setChart($chart); if (defined $chart->{_dataSets2D}) { my @dataSet = @{$chart->{_dataSets2D}}; &_setTimeFmt($chart, @dataSet); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "\nplot "; print PLT join(', ', map {$_->_thaw} @dataSet), "\n"; close(PLT); } elsif (defined $chart->{_dataSets3D}) { my @dataSet = @{$chart->{_dataSets3D}}; &_setTimeFmt($chart, @dataSet); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "\nsplot "; print PLT join(', ', map {$_->_thaw} @dataSet), "\n"; close(PLT); } &_unset($chart, $set); } } } else { # Start multi-plot &_setMultiplot($self); foreach my $chart (@charts) { $chart->_script($self->{_script}); my $set = &_setChart($chart); if (defined $chart->{_dataSets2D}) { my @dataSet = @{$chart->{_dataSets2D}}; &_setTimeFmt($chart, @dataSet); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "\nplot "; print PLT join(', ', map {$_->_thaw} @dataSet), "\n"; close(PLT); } elsif (defined $chart->{_dataSets3D}) { my @dataSet = @{$chart->{_dataSets3D}}; &_setTimeFmt($chart, @dataSet); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "\nsplot "; print PLT join(', ', map {$_->_thaw} @dataSet), "\n"; close(PLT); } &_unset($chart, $set); } } close(PLT); # Generate image file &_execute($self); return($self); } # Pass generic commands sub command { my ($self, $cmd) = @_; &_setChart($self) if (!defined $self->{_script}); open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "$cmd\n"; close(PLT); return($self); } # Set how the chart looks like # - call _setTitle(), _setAxisLabel(), _setTics(), _setGrid(), _setBorder() # - called by plot2d() and plot3d() sub _setChart { my ($self) = @_; my @sets = (); # Orientation $self->{terminal} .= " $self->{orient}" if (defined $self->{orient}); # Set canvas size if (defined $self->{imagesize}) { my ($ws, $hs) = split(/,\s?/, $self->{imagesize}); $ws *= 10 if ($ws =~ /\D/); # for post terminal $hs *= 7 if ($hs =~ /\D/); # for post terminal $self->{terminal} .= " size $ws,$hs"; } # Create temporary file to store Gnuplot instructions if (!defined $self->{_script}) { my $dirTmp = tempdir(CLEANUP => 1, DIR => '/tmp'); $self->_script("$dirTmp/plot"); } else { delete $self->{terminal}; } my $pltTmp = $self->{_script}; open(PLT, ">>$pltTmp") || confess("Can't write gnuplot script $pltTmp"); # Chart background color if (defined $self->{bg}) { my $bg = $self->{bg}; if (ref($bg) eq 'HASH') { print PLT "set object rect from screen 0, screen 0 to ". "screen 1, screen 1 fillcolor rgb \"$$bg{color}\""; print PLT " fillstyle solid $$bg{density}" if (defined $$bg{density}); print PLT " behind\n"; } else { print PLT "set object rect from screen 0, screen 0 to ". "screen 1, screen 1 fillcolor rgb \"$bg\" behind\n"; } } # Plot area background color if (defined $self->{plotbg}) { my $bg = $self->{plotbg}; if (ref($bg) eq 'HASH') { print PLT "set object rect from graph 0, graph 0 to ". "graph 1, graph 1 fillcolor rgb \"$$bg{color}\""; print PLT " fillstyle solid $$bg{density}" if (defined $$bg{density}); print PLT " behind\n"; } else { print PLT "set object rect from graph 0, graph 0 to ". "graph 1, graph 1 fillcolor rgb \"$bg\" behind\n"; } } # Loop and process other chart options foreach my $attr (keys %$self) { if ($attr eq 'output') { print PLT "set output \"$self->{output}\"\n"; } elsif ($attr eq 'title') { print PLT "set title ".&_setTitle($self->{title})."\n"; push(@sets, 'title') } elsif ($attr =~ /^((x|y)2?|z)label$/) { print PLT "set $attr ".&_setAxisLabel($self->{$attr})."\n"; push(@sets, $attr); } elsif ($attr =~ /^((x|y)2?|z)range$/) { if (ref($self->{$attr}) eq 'ARRAY') { # Deal with ranges from array reference print PLT "set $attr [". join(':', @{$self->{$attr}}) . "]\n"; } elsif ($self->{$attr} eq 'reverse') { print PLT "set $attr [*:*] reverse\n"; } else { print PLT "set $attr $self->{$attr}\n"; } push(@sets, $attr); } elsif ($attr =~ /^(x|y)2?tics$/) { my ($axis) = ($attr =~ /^(.+)tics$/); print PLT "set $attr".&_setTics($self->{$attr})."\n"; if (ref($self->{$attr}) eq 'HASH') { if (defined ${$self->{$attr}}{labelfmt}) { print PLT "set format $axis ". "\"${$self->{$attr}}{labelfmt}\"\n"; } if (defined ${$self->{$attr}}{minor}) { my $nTics = ${$self->{$attr}}{minor}+1; print PLT "set m$axis"."tics $nTics\n"; } } push(@sets, $attr); } elsif ($attr eq 'border') { print PLT "set border".&_setBorder($self->{border})."\n"; push(@sets, 'border'); } elsif ($attr eq 'grid') { print PLT "set grid".&_setGrid($self->{grid})."\n"; push(@sets, 'grid'); } elsif ($attr eq 'timeaxis') { my @axis = split(/,\s?/, $self->{timeaxis}); foreach my $axis (@axis) { print PLT "set $axis"."data time\n"; push(@sets, $axis."data"); } } elsif ($attr eq 'terminal') { print PLT "set $attr $self->{$attr}\n"; } elsif ($attr !~ /^(gnuplot|imagesize|orient|bg|plotbg)$/ && $attr !~ /^_/) { (defined $self->{$attr} && $self->{$attr} ne '')? (print PLT "set $attr $self->{$attr}\n"): (print PLT "set $attr\n"); push(@sets, $attr); } } close(PLT); return(\@sets); } # Set the input time format # - must be called after _setChart() is called # - called by plot2d() and plot3d() sub _setTimeFmt { my ($self, @dataSet) = @_; # Setting due to DataSet object attributes open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); foreach my $ds (@dataSet) { # Set the format of the time data if (defined $ds->{timefmt}) # input time format { print PLT "set timefmt \"$ds->{timefmt}\"\n"; last; } } close(PLT); } # Set the details of the title # - called by _setChart() # # Usage example: # my $chart = Chart::Gnuplot->new( # title => { # text => "My title", # font => "arial, 14", # color => "brown", # offset => "0, -1", # }, # ... # ); sub _setTitle { my ($title) = @_; if (ref($title)) { my $out = "\"$$title{text}\""; $out .= " offset $$title{offset}" if (defined $$title{offset}); # Font and size my $font; $font = $$title{font} if (defined $$title{font}); $font .= ",$$title{fontsize}" if (defined $$title{fontsize}); $out .= " font \"$font\"" if (defined $font); # Color $out .= " textcolor rgb \"$$title{color}\"" if (defined $$title{color}); # Switch of the enhanced mode. Default: off $out .= " noenhanced" if (!defined $$title{enhanced} || $$title{enhanced} ne 'on'); return($out); } else { return("\"$title\" noenhanced"); } } # Set the details of the axis labels # - called by _setChart() # # Usage example: # my $chart = Chart::Gnuplot->new( # xlabel => { # text => "My x-axis label", # font => "arial, 14", # color => "brown", # offset => "0, -1", # rotate => 45, # }, # ... # ); # # TODO # - support radian and pi in "rotate" sub _setAxisLabel { my ($label) = @_; if (ref($label)) { my $out = "\"$$label{text}\""; # Location offset $out .= " offset $$label{offset}" if (defined $$label{offset}); # Font and size my $font; $font = $$label{font} if (defined $$label{font}); $font .= ",$$label{fontsize}" if (defined $$label{fontsize}); $out .= " font \"$font\"" if (defined $font); # Color $out .= " textcolor rgb \"$$label{color}\"" if (defined $$label{color}); # Switch of the enhanced mode. Default: off $out .= " noenhanced" if (!defined $$label{enhanced} || $$label{enhanced} ne 'on'); # Text rotation $out .= " rotate by $$label{rotate}" if (defined $$label{rotate}); return($out); } else { return("\"$label\" noenhanced"); } } # Set the details of the tics and tic labels # - called by _setChart() # # Usage example: # my $chart = Chart::Gnuplot->new( # xtics => { # labels => [-10, 15, 20, 25], # labelfmt => "%3f", # font => "arial", # fontsize => 14, # fontcolor => "brown", # offset => "0, -1", # rotate => 45, # length => "2,1", # along => 'axis', # x2tics => 'off', # minor => 3, # }, # ... # ); # # TODO # - able to replace the label for specified text # - implement "add" option to add addition tics other than default # - support radian and pi in "rotate" sub _setTics { my ($tic) = @_; my $out = ''; if (ref($tic) eq 'HASH') { $out .= " $$tic{along}" if (defined $$tic{along}); $out .= " nomirror" if ( defined $$tic{mirror} && $$tic{mirror} eq 'off' ); $out .= " scale $$tic{length}" if (defined $$tic{length}); $out .= " rotate by $$tic{rotate}" if (defined $$tic{rotate}); $out .= " offset $$tic{offset}" if (defined $$tic{offset}); $out .= " (". join(',', @{$$tic{labels}}) . ")" if (defined $$tic{labels}); # Font, font size and font color if (defined $$tic{font}) { my $font = $$tic{font}; $font = "$$tic{font},$$tic{fontsize}" if ($font !~ /\,/ && defined $$tic{fontsize}); $out .= " font \"$font\""; } $out .= " textcolor rgb \"$$tic{fontcolor}\"" if (defined $$tic{fontcolor}); } elsif (ref($tic) eq 'ARRAY') { $out = " (". join(',', @$tic) . ")"; } elsif ($tic ne 'on') { $out = "\"$tic\""; } return($out); } # Set the details of the grid lines # - called by _setChart() # # Usage example: # my $chart = Chart::Gnuplot->new( # grid => { # type => 'dash, dot', # default: dot # width => '2, 1', # default: 0 # color => 'blue, gray', # default: black # xlines => 'on, on', # default: 'on, off' # ylines => 'on, on', # default: 'on, off' # }, # ... # ); # # # OR # # my $chart = Chart::Gnuplot->new( # grid => 'on', # ... # ); # # TODO: # - support polar grid # - suppiort ztics # - support layer sub _setGrid { my ($grid) = @_; my $out = ''; if (ref($grid) eq 'HASH') { # Set whether the major and minor grid lines are drawn (defined $$grid{xlines} && $$grid{xlines} =~ /^off/)? ($out .= " noxtics"): ($out .= " xtics"); (defined $$grid{ylines} && $$grid{ylines} =~ /^off/)? ($out .= " noytics"): ($out .= " ytics"); (defined $$grid{xlines} && $$grid{xlines} =~ /,\s?on$/)? ($out .= " mxtics"): ($out .= " nomxtics"); (defined $$grid{ylines} && $$grid{ylines} =~ /,\s?on$/)? ($out .= " mytics"): ($out .= " nomytics"); # Set the line type of the grid lines my $major = my $minor = ''; if (defined $$grid{linetype}) { my $majorType = my $minorType = $$grid{linetype}; ($majorType, $minorType) = split(/\,\s?/, $$grid{linetype}) if ($$grid{linetype} =~ /\,/); $major .= " linetype ".&_lineType($majorType); $minor .= " linetype ".&_lineType($minorType); } if (defined $$grid{width}) { my $majorWidth = my $minorWidth = $$grid{width}; ($majorWidth, $minorWidth) = split(/\,\s?/, $$grid{width}) if ($$grid{width} =~ /\,/); $major .= " linewidth $majorWidth"; $minor .= " linewidth $minorWidth"; } my $majorColor = my $minorColor = 'black'; if (defined $$grid{color}) { $majorColor = $minorColor = $$grid{color}; ($majorColor, $minorColor) = split(/\,\s?/, $$grid{color}) if ($$grid{color} =~ /\,/); } $major .= " linecolor rgb \"$majorColor\""; $minor .= " linecolor rgb \"$minorColor\""; $out .= "$major" if ($major ne ''); $out .= ",$minor" if ($minor ne ''); } return($out); } # Set the details of the graph border # - called by _setChart() # # Usage example: # my $chart = Chart::Gnuplot->new( # border => { # linetype => 3, # default: solid # width => 2, # default: 0 # color => '#ff00ff', # default: system defined # }, # ... # ); # # Remark: # - By default, the color of the axis tics would follow the border unless # specified otherwise. # # TODO: # - support layer sub _setBorder { my ($border) = @_; my $out = ''; $out .= " linetype ".&_lineType($$border{linetype}) if (defined $$border{linetype}); $out .= " linewidth $$border{width}" if (defined $$border{width}); $out .= " linecolor rgb \"$$border{color}\"" if (defined $$border{color}); return($out); } # Generate the image file sub _execute { my ($self) = @_; # Execute gnuplot my $gnuplot = 'gnuplot'; $gnuplot = $self->{gnuplot} if (defined $self->{gnuplot}); system("$gnuplot $self->{_script}"); # Convert the image to the user-specified format if (defined $self->{output} && $self->{output} =~ /\./) { my @a = split(/\./, $self->{output}); my $ext = $a[-1]; if ( $self->{terminal} !~ /^$ext/ && ($self->{terminal} !~ /^post/ || $ext !~ /^e?ps$/) ) { &convert($self, $ext); } } } # Set title and layout of the multiplot sub _setMultiplot { my ($self, $nrows, $ncols) = @_; open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); print PLT "set multiplot"; print PLT " title \"$self->{title}\"" if (defined $self->{title}); print PLT " layout $nrows, $ncols" if (defined $nrows); print PLT "\n"; close(PLT); } # Unset the chart properties # - called by multiplot() sub _unset { my ($self, $set) = @_; open(PLT, ">>$self->{_script}") || confess("Can't write $self->{_script}"); foreach my $opt (@$set) { print PLT "unset $opt\n"; } close(PLT); } # Output a test image for the terminal # # Usage example: # $chart = Chart::Gnuplot->new(output => "test.png"); # $chart->test; sub test { my ($self) = @_; # Create temporary file to store Gnuplot instructions my $dirTmp = tempdir(CLEANUP => 1, DIR => '/tmp'); my $pltTmp = "$dirTmp/plot"; open(PLT, ">$pltTmp") || confess("Can't write gnuplot script $pltTmp"); print PLT "set terminal $self->{terminal}\n"; print PLT "set output \"$self->{output}\"\n"; print PLT "test\n"; close(PLT); # Execute gnuplot my $gnuplot = 'gnuplot'; $gnuplot = $self->{gnuplot} if (defined $self->{gnuplot}); system("$gnuplot $pltTmp"); return($self); } sub histogram { } # Change the image format # - called by plot2d() # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data); # $chart->convert('gif'); sub convert { my ($self, $imgfmt) = @_; return($self) if (!-e $self->{output}); # Generate temp file my $temp = "$self->{_script}.tmp"; move($self->{output}, $temp); if ($self->{terminal} =~ /^post/ && $imgfmt eq 'pdf') { system("ps2pdf $temp $temp".".$imgfmt"); } elsif ($self->{terminal} =~ /^pdf/ && $imgfmt eq 'ps') { system("pdf2ps $temp $temp".".$imgfmt"); } else { # Rotate 90 deg for landscape image if (defined $self->{orient} && $self->{orient} eq 'portrait') { system("convert $temp $temp".".$imgfmt"); } else { system("convert -rotate 90 $temp $temp".".$imgfmt"); } } # Remove the temp file move("$temp".".$imgfmt", $self->{output}); unlink($temp); return($self); } # Change the image format to PNG # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data)->png; sub png { my ($self); &convert($self, 'png'); return($self) } # Change the image format to GIF # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data)->gif; sub gif { my ($self); &convert($self, 'gif'); return($self) } # Change the image format to JPG # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data)->jpg; sub jpg { my ($self); &convert($self, 'jpg'); return($self) } # Change the image format to PS # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data)->ps; sub ps { my ($self); &convert($self, 'ps'); return($self) } # Change the image format to PDF # # Usage example: # my $chart = Chart::Gnuplot->new(...); # my $data = Chart::Gnuplot::DataSet->new(...); # $chart->plot2d($data)->pdf; sub pdf { my ($self); &convert($self, 'pdf'); return($self) } ################## Chart::Gnuplot::DataSet object ################## package Chart::Gnuplot::DataSet; use strict; use Carp; use File::Temp qw(tempdir); use Chart::Gnuplot::Util qw(_lineType _pointType); # Constructor sub new { my ($class, %hash) = @_; my $self = \%hash; return bless($self, $class); } # Generic attribute methods sub AUTOLOAD { my ($self, $key) = @_; my $attr = our $AUTOLOAD; $attr =~ s/.*:://; return if ($attr eq 'DESTROY'); # ignore destructor $self->{$attr} = $key if (defined $key); return($self->{$attr}); } # Thaw the data set object to string # - call _fillStyle() # # TODO: # - "using" feature for "file" dataset # - data file delimiter # - data labels # - zdata sub _thaw { my ($self) = @_; my $string; # Data points stored in arrays # - in any case, ydata need to be defined if (defined $self->{ydata}) { my $ydata = $self->{ydata}; # Create temporary file to store Perl data my $dirTmp = tempdir(CLEANUP => 1, DIR => '/tmp'); my $fileTmp = "$dirTmp/data"; open(DATA, ">$fileTmp") || confess("Can't write data to temp file"); # Process 3D data set # - zdata is defined if (defined $self->{zdata}) { my $zdata = $self->{zdata}; my $xdata = $self->{xdata}; croak("x-data and y-data have unequal length") if (scalar(@$ydata) ne scalar(@$xdata)); croak("y-data and z-data have unequal length") if (scalar(@$ydata) ne scalar(@$zdata)); for (my $i = 0; $i < @$xdata; $i++) { print DATA "$$xdata[$i] $$ydata[$i] $$zdata[$i]\n"; print DATA "\n" if ($i > 0 && $$xdata[$i] != $$xdata[$i-1]); } $string = "\"$fileTmp\""; # Construst using statement for date-time data if (defined $self->{timefmt}) { my @a = split(/\s+/, $$xdata[0]); my $yCol = scalar(@a) + 1; $string .= " using 1:$yCol"; my @b = split(/\s+/, $$ydata[0]); my $zCol = scalar(@b) + $yCol; $string .= ":$zCol"; } } # Treatment for financebars and candlesticks styles # - Both xdata and ydata are defined elsif (defined $self->{xdata} && defined $self->{style} && $self->{style} =~ /^(financebars|candlesticks)$/) { my $xdata = $self->{xdata}; croak("x-data and y-data have unequal length") if (scalar(@{$$ydata[0]}) ne scalar(@$xdata)); for (my $i = 0; $i < @$xdata; $i++) { print DATA "$$xdata[$i] $$ydata[0][$i] $$ydata[1][$i] ". "$$ydata[2][$i] $$ydata[3][$i]\n"; } $string = "\"$fileTmp\""; # Construst using statement for date-time data if (defined $self->{timefmt}) { my @a = split(/\s+/, $$xdata[0]); my $yCol = scalar(@a) + 1; $string .= " using 1:$yCol"; } } # Treatment for errorbars and errorlines styles # - Both xdata and ydata are defined # - Style is defined and contain "error" elsif (defined $self->{xdata} && defined $self->{style} && $self->{style} =~ /error/) { my $xdata = $self->{xdata}; # Error bars along x-axis if ($self->{style} =~ /^xerror/) { croak("x-data and y-data have unequal length") if (scalar(@{$$xdata[0]}) ne scalar(@$ydata)); for (my $i = 0; $i < @$ydata; $i++) { print DATA "$$xdata[0][$i] $$ydata[$i]"; for(my $j = 1; $j < @$xdata; $j++) { print DATA " $$xdata[$j][$i]"; } print DATA "\n"; } } # Error bars along y-axis elsif ($self->{style} =~ /^(y|box)error/) { croak("x-data and y-data have unequal length") if (scalar(@{$$ydata[0]}) ne scalar(@$xdata)); for (my $i = 0; $i < @$xdata; $i++) { print DATA "$$xdata[$i] $$ydata[0][$i]"; for(my $j = 1; $j < @$ydata; $j++) { print DATA " $$ydata[$j][$i]"; } print DATA "\n"; } } # Error bars along both x and y-axis elsif ($self->{style} =~ /^(box)?xyerror/) { if (scalar(@$xdata) == scalar(@$ydata)) { for (my $i = 0; $i < @{$$xdata[0]}; $i++) { print DATA "$$xdata[0][$i] $$ydata[0][$i]"; for(my $j = 1; $j < @$ydata; $j++) { print DATA " $$xdata[$j][$i] $$ydata[$j][$i]"; } print DATA "\n"; } } else { for (my $i = 0; $i < @{$$xdata[0]}; $i++) { print DATA "$$xdata[0][$i] $$ydata[0][$i]"; if (scalar(@$xdata) == 2) { my $ltmp = $$xdata[0][$i] - $$xdata[1][$i]*0.5; my $htmp = $$xdata[0][$i] + $$xdata[1][$i]*0.5; print DATA " $ltmp $htmp ". "$$ydata[1][$i] $$ydata[2][$i]\n"; } else { my $ltmp = $$ydata[0][$i] - $$ydata[1][$i]*0.5; my $htmp = $$ydata[0][$i] - $$ydata[1][$i]*0.5; print DATA " $$xdata[1][$i] $$xdata[2][$i] ". "$ltmp $htmp\n"; } } } } $string = "\"$fileTmp\""; # Construst using statement for date-time data if (defined $self->{timefmt}) { my ($xTmp) = (ref($$xdata[0]) eq 'ARRAY')? ($$xdata[0][0]): ($$xdata[0]); my @a = split(/\s+/, $xTmp); my $yCol = scalar(@a) + 1; $string .= " using 1:$yCol"; } } # Normal x-y plot # - Both xdata and ydata are defined elsif (defined $self->{xdata}) { my $xdata = $self->{xdata}; croak("x-data and y-data have unequal length") if (scalar(@$ydata) ne scalar(@$xdata)); for (my $i = 0; $i < @$xdata; $i++) { print DATA "$$xdata[$i] $$ydata[$i]\n"; } $string = "\"$fileTmp\""; # Construst using statement for date-time data if (defined $self->{timefmt}) { my @a = split(/\s+/, $$xdata[0]); my $yCol = scalar(@a) + 1; $string .= " using 1:$yCol"; } } # Only ydata is defined else { # Treatment for financebars and candlesticks styles if (defined $self->{style} && $self->{style} =~ /^(financebars|candlesticks)$/) { for (my $i = 0; $i < @{$$ydata[0]}; $i++) { print DATA "$i $$ydata[0][$i] $$ydata[1][$i] ". "$$ydata[2][$i] $$ydata[3][$i]\n"; } } # Treatment for errorbars and errorlines styles # - Style is defined and contain "error" elsif (defined $self->{style} && $self->{style} =~ /^yerror/) { for (my $i = 0; $i < @{$$ydata[0]}; $i++) { print DATA "$i $$ydata[0][$i]"; for(my $j = 1; $j < @$ydata; $j++) { print DATA " $$ydata[$j][$i]"; } print DATA "\n"; } } # ydata vs index else { for (my $i = 0; $i < @$ydata; $i++) { print DATA "$i $$ydata[$i]\n"; } } $string = "\"$fileTmp\""; $string .= " using 1:2" if (defined $self->{timefmt}); } close(DATA); } # Data in points elsif (defined $self->{points}) { my $pt = $self->{points}; my $dirTmp = tempdir(CLEANUP => 1, DIR => '/tmp'); my $fileTmp = "$dirTmp/data"; open(DATA, ">$fileTmp") || confess("Can't write data to temp file"); # 2D data points if (scalar(@{$$pt[0]}) == 2 || (defined $self->{style} && $self->{style} =~ /error/)) { for(my $i = 0; $i < @$pt; $i++) { print DATA join(" ", @{$$pt[$i]}), "\n"; } } # 3D data points elsif (scalar(@{$$pt[0]}) == 3) { my $xLast; for(my $i = 0; $i < @$pt; $i++) { print DATA join(" ", @{$$pt[$i]}), "\n"; print DATA "\n" if (defined $xLast && $$pt[$i][0] != $xLast); $xLast = $$pt[$i][0]; } } close(DATA); $string = "\"$fileTmp\""; # Construst using statement for date-time data if (defined $self->{timefmt}) { my @a = split(/\s+/, $$pt[0][0]); my $yCol = scalar(@a) + 1; $string .= " using 1:$yCol"; if (scalar(@{$$pt[0]}) == 3) { my @a = split(/\s+/, $$pt[0][1]); my $zCol = scalar(@a) + $yCol; $string .= ":$zCol"; } } } # File elsif (defined $self->{datafile}) { $string = "\"$self->{datafile}\""; } # Function elsif (defined $self->{func}) { $string = "$self->{func}"; } # Add title for the data sets (defined $self->{title})? ($string .= " title \"$self->{title}\""): ($string .= " title \"\""); # Change plotting style, color, width and point size $string .= " smooth $self->{smooth}" if (defined $self->{smooth}); $string .= " axes $self->{axes}" if (defined $self->{axes}); $string .= " with $self->{style}" if (defined $self->{style}); $string .= " linetype ".&_lineType($self->{linetype}) if (defined $self->{linetype}); $string .= " linecolor rgb \"$self->{color}\"" if (defined $self->{color}); $string .= " linewidth $self->{width}" if (defined $self->{width}); $string .= " pointtype ".&_pointType($self->{pointtype}) if (defined $self->{pointtype}); $string .= " pointsize $self->{pointsize}" if (defined $self->{pointsize}); $string .= " fill".&_fillStyle($self->{fill}) if (defined $self->{fill}); return($string); } # Generate box filling style string # - called by _thaw() sub _fillStyle { my ($fill) = @_; if (ref($fill) eq 'HASH') { my $style = " solid $$fill{density}"; $style .= " noborder" if (defined $$fill{border} && $$fill{border} =~ /^(off|no)$/); return($style); } return(" solid $fill"); } 1; __END__ =head1 NAME Chart::Gnuplot - Plot graph using Gnuplot on the fly =head1 SYNOPSIS use Chart::Gnuplot; # Data my @x = (-10 .. 10); my @y = (0 .. 20); # Create chart object and specify the properties of the chart my $chart = Chart::Gnuplot->new( output => "fig/simple.png", title => "Simple testing", xlabel => "My x-axis label", ylabel => "My y-axis label", .... ); # Create dataset object and specify the properties of the dataset my $dataSet = Chart::Gnuplot::DataSet->new( xdata => \@x, ydata => \@y, title => "Plotting a line from Perl arrays", style => "linespoints", .... ); # Plot the data set on the chart $chart->plot2d($dataSet); ################################################## # Plot many data sets on a single chart $chart->plot2d($dataSet1, $dataSet2, ...); =head1 DESCRIPTION This module is to plot graphs uning GNUPLOT on the fly. In order to use this module, gnuplot need to be installed. If image format other than PS, PDF and EPS is required to generate, the convert program of ImageMagick is also needed. To plot chart using Chart::Gnuplot, a chart object and at least one dataset object are needed to be created. Information about the chart such as output file, chart title, axes labels and so on is specified in the chart object. Dataset object contains information about the dataset to be plotted, including source of the data points, dataset label, color used to plot and more. After chart object and dataset object(s) are created, the chart can be plotted using the plot2d, plot3d or multiplot method of the chart object, e.g. # $chart is the chart object $chart->plot2d($dataSet1, $dataSet2, ...); To illustate the feature of Chart::Gnuplot, the best way is to show by examples. =head1 CHART OBJECT The chart object can be initiated by the c method. Properties of the chart may be specified optionally when the object is initiated: my $chart = Chart::Gnuplot->new(%options); =head2 Chart Options =head3 output Output file of the graph. By default, the image format is detected automatically by the extension of the filename. However, it can also be changed manually by using the format conversion methods such as C and C (see sessions below). The supported image formats are: bmp : Microsoft Windows bitmap epdf : Encapsulated Portable Document Format epi : Encapsulated PostScript Interchange format eps : Encapsulated PostScript gif : Graphics Interchange Format jpg : Joint Photographic Experts Group JFIF format pdf : Portable Document Format png : Portable Network Graphics ppm : Portable Pixmap Format ps : PostScript file psd : Adobe Photoshop bitmap file xpm : X Windows system pixmap If the filename has no extension, postscipt will be used. =head3 title Title of the chart. E.g., title => "Chart title" Properties of the chart title can be specified in hash. E.g., title => { text => "Chart title", font => "arial, 20", ..... } Supported properties are: text : title in plain text font : font face (and optionally font size) color : font color offset : offset relative to the default position enhanced : title contains subscript/superscipt/greek? (on/off) Default values would be used for properties not specified. These properties has no effect on the main title of the multi-chart (see L). =head3 xlabel Label of the x-axis. E.g. xlabel => "Bottom axis label" Properties of the chart title can be specified in hash, similar to the chart title. Supported properties are: text : title in plain text font : font face (and optionally font size) color : font color offset : offset relative to the default position rotate : rotation by degrees enhanced : title contains subscript/superscipt/greek? (on/off) =head3 ylabel Label of the y-axis. See L. =head3 x2label Label of the secondary x-axis (displayed on the top of the graph). See L. =head3 y2label Label of the secondary y-axis (displayed on the right of the graph). See L. =head3 zlabel Label of the z-axis in 3D plots. See L. =head3 xrange Range of the x-axis in the plot, e.g. xrange => [0, "pi"]; =head3 yrange Range of the y-axis in the plot. =head3 x2range Range of the secondary x-axis in the plot. =head3 y2range Range of the secondary y-axis in the plot. =head3 zrange Range of the z-axis in the 3D plot. =head3 xtics The tics and tic label of the x-axis. =head3 ytics The tics and tic label of the y-axis. =head3 x2tics The tics and tic label of the x2-axis. =head3 y2tics The tics and tic label of the y2-axis. =head3 timeaxis Specify the axes of which the tic labels are date/time string. Possible values are combinations of "x", "y", "x2", and "y2" joined by ",". E.g. timeaxis => "x, y2" means that the x-axis and y2-axis are data/time axes. =head3 border Border of the graph. Properties supported are "linetype", "width", and "color". E.g. border => { linetype => 3, width => 2, color => '#ff00ff', } =head3 grid Grid lines. =head3 bmargin Bottom margin (in character height). This option has no effect in 3D plots. =head3 lmargin Left margin (in character width) =head3 rmargin Right margin (in character width). This option has no effect in 3D plots. =head3 tmargin Top margin (in character height). This option has no effect in 3D plots. =head3 orient Orientation of the image. Possible values are "lanscape" and "portrait". =head3 imagesize Size (length and height) of the image relative to the default. =head3 size Size of the chart relative to the chart size. This is useful in some multi-plot such as inset chart. =head3 origin Origin of the chart. This is useful in some multi-plot such as inset chart. =head3 bg (experimental) Background color of the chart. This option is experimental. =head3 plotbg (experimental) Background color of the plot area. This option has no effect in 3D plots and is experimental. =head3 gnuplot The path of Gnuplot installed. This option is useful if you have multiple versions of Gnuplot installed. =head3 terminal The terminal that Gnuplot use. The default terminal is "postscript". This attribute is not recommended to be changed unless you are familiar with the Gnuplot syntax. Please test carefully before using this in production code. Terminal is not necessarily related to the output image format. You may convert the image format by the C method. =head2 Chart Methods =head3 new my $chart = Chart::Gnuplot->new(%options); Constructor of the chart object. If no option is specified, default values would be used. See L for available options. =head3 set General set methods for arbitrary number of options. $chart->set(%options); =head3 plot2d $chart->plot2d(@dataSets); Plot the data sets in a 2D chart. Each dataset is represented by a dataset object. =head3 plot3d $chert->plot3d(@dataSets); Plot the data sets in a 3D chart. Each dataset is represented by a dataset object. It is not yet completed. Only basic features are supported. =head3 multiplot $chert->multiplot(@charts); Plot multiple charts in the same image. =head3 add2d Add a 2D dataset to a chart without plotting it out immediately. Used with C. =head3 add3d Add a 3D dataset to a chart without plotting it out immediately. Used with C. =head3 convert $chart->convert($imageFmt); Convert the image format to C<$imageFmt>. See L for supported image formats. =head3 png $chart->png; Change the image format to PNG. =head3 gif $chart->gif; Change the image format to GIF. =head3 jpg $chart->jpg; Change the image format to JPEG. =head3 ps $chart->ps; Change the image format to postscript. =head3 pdf $chart->pdf Change the image format to PDF. =head3 command $chart->command($gnuplotCommand); Add a gnuplot command. This method is useful for the Gnuplot features that have not yet implemented. =head1 DATASET OBJECT The dataset object can be initiated by the C method. Properties of the dataset may be specified optionally when the object is initiated: my $dataset = Chart::Gnuplot::DataSet->new(%options); =head2 Dataset Options =head3 xdata The x values of the data points. xdata => \@x If C is omitted but C is defined, the integer index starting from 0 would be used for C. =head3 ydata The y values of the data points. ydata => \@y =head3 points Data point matrix of the format [[x1,y1], [x2,y2], [x3,y3], ...] points => \@points =head3 datafile Input data file datafile => $file The data files are assumed to be space-separated, with each row corresponding to one data point. Lines beginning with "#" are considered as comments and would be ignored. Other formats are not supported at this moment. =head3 func Mathematical function to be plotted. E.g. func => "sin(x)*x**3" Supported functions: abs(x) : absolute value acos(x) : inverse cosine acosh(x) : inverse hyperbolic cosine arg(x) : complex argument asin(x) : inverse sine asinh(x) : inverse hyperbolic sine atan(x) : inverse tangent atanh(x) : inverse hyperbolic tangent besj0(x) : zeroth order Bessel function of the first kind besj1(x) : first order Bessel function of the first kind besy0(x) : zeroth order Bessel function of the second kind besy1(x) : first order Bessel function of the second kind ceil(x) : ceiling function cos(x) : cosine cosh(x) : hyperbolic cosine erf(x) : error function erfc(x) : complementary error function exp(x) : expontial function floor(x) : floor function gamma(x) : gamma function ibeta(a,b,x) : incomplete beta function inverf(x) : inverse error function igamma(a,x) : incomplete gamma function imag(x) : imaginary part invnorm(x) : inverse normal distribution function int(x) : integer part lambertw(x) : Lambert W function lgamma(x) : log gamma function log(x) : natural logarithm log10(x) : common logarithm norm(x) : normal distribution function rand(x) : pseudo random number real(x) : real part sgn(x) : sign function sin(x) : sine sinh(x) : hyperbolic sine sqrt(x) : square root tan(x) : tangent tanh(x) : hyperbolic tangent Please see the Gnuplot manual for updated information. Supported mathematical constants: pi : the circular constant 3.14159... Supported arithmetic operators: addition : + division : / exponentiation : ** factorial : ! modulo : % multiplication : * subtraction : -, e.g., 1-2 unary minus : -, e.g., -1 Supported logical operations: and : && complement : ~ equality : == greater than : > greater than or equal to : >= inequality : != less than : < less than or equal to : <= negation : ! or : || if ... than else ... : ?:, e.g., a ? b : c =head3 title Title of the dataset (shown in the legend). =head3 style The plotting style for the dataset, including lines : join adjacent points by straight lines points : mark each points by a symbol linespoints : both "lines" and "points" dots : dot each points. Useful for large datasets impluses : draw a vertical line from the x-axis to each point steps : join adjacent points by steps boxes : draw a centered box from the x-axis to each point xerrorbars : "dots" with horizontal error bars yerrorbars : "dots" with vertical error bars xyerrorbars : both "xerrorbars" and "yerrorbars" xerrorlines : "linespoints" with horizontal error bars yerrorlines : "linespoints" with vertical error bars xyerrorlines : both "xerrorlines" and "yerrorlines" boxerrorbars : "boxes" with "yerrorbars" boxxyerrorbars : use rectangles to represent the data with errors financebars : finance bars for open, high, low and close price candlesticks : candle sticks for open, high, low and close price =head3 color Color of the dataset in the plot. Can be a named color ot RBG (#RRGGBB) value. The supported color names can be found in the file F in the distribution. E.g. color => "#99ccff" # or color => "dark-red" =head3 width Line width used in the plot. =head3 linetype Line type. =head3 pointtype Point type. =head3 pointsize Point size of the plot. =head3 fill Filling string. Has effect only on plotting styles "boxes", "boxxyerrorbars" and "financebars". =head3 axes Axes used in the plot. Possible values are "x1y1", "x1y2", "x2y1" and "x2y2". =head3 timefmt Time format of the input data. =head3 smooth The smooth method used in plotting data points. Supported methods include cubic splines (csplines), Bezier curve (bezier) and other. Please see Gnuplot manual for details. =head2 Dataset Methods =head3 new my $dataset = Chart::Gnuplot::DataSet->new(%options); Constructor of the dataset object. If no option is specified, default values would be used. See L for available options. =head1 EXAMPLES Some simple examples are shown below. Many more come with the distribution. =over =item 1. Plot a mathematical expression my $chart = Chart::Gnuplot->new( output => "expression.png" ); my $dataSet = Chart::Gnuplot::DataSet->new( func => "sin(x)" ); $chart->plot2d($dataSet); =item 2. Plot from two Perl arrays, one for the x-axis data and the other the y-axis. my $chart = Chart::Gnuplot->new( output => "arrays.png" ); my $dataSet = Chart::Gnuplot::DataSet->new( xdata => \@x, ydata => \@y, ); $chart->plot2d($dataSet); =item 3. Plot x-y pairs # Data my @xy = ( [1.1, -3], [1.2, -2], [3.5, 0], ... ); my $chart = Chart::Gnuplot->new( output => "points.png" ); my $dataSet = Chart::Gnuplot::DataSet->new( points => \@xy ); $chart->plot2d($dataSet); =item 4. Plot data from a data file my $chart = Chart::Gnuplot->new( output => "file.png" ); my $dataSet = Chart::Gnuplot::DataSet->new( file => "in.dat" ); $chart->plot2d($dataSet); =item 5. Chart title, axis label and legend # Chart object my $chart = Chart::Gnuplot->new( output => "trigonometric.gif", title => "Three basic trigonometric functions", xlabel => "angle in radian", ylabel => "function value" ); # Data set objects my $sine = Chart::Gnuplot::DataSet->new( func => "sin(x)", title => "sine function" ); my $cosine = Chart::Gnuplot::DataSet->new( func => "cos(x)", title => "cosine function" ); my $tangent = Chart::Gnuplot::DataSet->new( func => "tan(x)", title => "tangent function" ); $chart->plot2d($sine, $cosine, $tangent); =item 6. Plot a financial time series my $chart = Chart::Gnuplot->new( output => "dj.ps", title => "Dow-Jones Index time series", timeaxis => 'x', xtics => { labelfmt => '%b%y', }, ); my $dow = Chart::Gnuplot::DataSet->new( file => "dj.dat", timefmt => '%Y-%m-%d', # time format of the input data style => "candlesticks", grid => 'on', ); $chart->plot2d($dow); =item 7. Plot several graphs on the same image my $chart = Chart::Gnuplot->new( output => "multiplot.gif", ); my $left = Chart::Gnuplot->new(); my $sine = Chart::Gnuplot::DataSet->new( func => "sin(x)", ); $left->add2d($sine); my $center = Chart::Gnuplot->new(); my $cosine = Chart::Gnuplot::DataSet->new( func => "cos(x)", ); $center->add2d($cosine); my $right = Chart::Gnuplot->new(); my $tangent = Chart::Gnuplot::DataSet->new( func => "tan(x)", ); $right->add2d($tangent); # Place the Chart::Gnuplot objects in matrix to indicate their locations $chart->multiplot([ [$left, $center, $right] ]); =back =head1 FUTURE PLAN =over =item 1. Improve the manual. =item 2. Add more control to the 3D plots. =item 3. Add more control to the legend. =item 4. Add curve fitting method. =item 5. Add method to copy Chart and DataSet objects. =item 6. Improve the testsuite. =back =head1 REQUIREMENTS L, L =head1 TEST ENVIRONMENT This version is tested against Gnuplot 4.2 patchlevel 0 and patchlevel 2 in Linux. =head1 SEE ALSO Gnuplot official website L L =head1 AUTHOR Ka-Wai Mak =head1 COPYRIGHT Copyright (c) 2008 Ka-Wai Mak. All rights reserved. =head1 LICENSE This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut