Merge branch 'master' of https://github.com/jvleta/pyplot-fortran

Author: jacobwilliams

src/pyplot_module.f90

@@ -54,7 +54,7 @@ module pyplot_module
         procedure, public :: add_contour   !! add a contour plot to pyplot instance
         procedure, public :: add_bar       !! add a barplot to pyplot instance
         procedure, public :: add_imshow    !! add an image plot (using `imshow`)
-
+        procedure, public :: add_hist      !! add a histogram plot to pyplot instance
         procedure, public :: savefig       !! save plots of pyplot instance
         procedure, public :: destroy       !! destroy pyplot instance
 
@@ -302,6 +302,90 @@ subroutine add_plot(me, x, y, label, linestyle, markersize, linewidth, xlim, yli
     end subroutine add_plot
 !*****************************************************************************************
 
+!*****************************************************************************************
+!> author: Jimmy Leta
+!
+! Add a histogram plot.
+
+    subroutine add_hist(me, x, label, xlim, ylim, xscale, yscale, bins, normed, cumulative)
+
+    class(pyplot),          intent (inout)        :: me           !! pyplot handler
+    real(wp), dimension(:), intent (in)           :: x            !! array of data
+    character(len=*),       intent (in)           :: label        !! plot label
+    real(wp),dimension(2),  intent (in), optional :: xlim         !! x-axis range
+    real(wp),dimension(2),  intent (in), optional :: ylim         !! y-axis range
+    character(len=*),       intent (in), optional :: xscale       !! example: 'linear' (default), 'log'
+    character(len=*),       intent (in), optional :: yscale       !! example: 'linear' (default), 'log'
+    integer,                intent (in), optional :: bins         !! number of bins
+    logical,                intent (in), optional :: normed       !! boolean flag that determines whether bin counts are normalized
+    logical,                intent (in), optional :: cumulative   !! boolean flag that determines whether histogram represents the cumulative density of dataset
+
+    character(len=:), allocatable :: xstr             !! x values stringified
+    character(len=:), allocatable :: xlimstr          !! xlim values stringified
+    character(len=:), allocatable :: ylimstr          !! ylim values stringified
+    character(len=*), parameter   :: xname = 'x'      !! x variable name for script
+    character(len=:), allocatable :: extras           !! optional stuff
+    character(len=5)              :: normedstr=''     !!
+    character(len=5)              :: cumulativestr='' !!
+    character(len=max_int_len)    :: binsstr          !!
+
+
+    if (allocated(me%str)) then
+
+        !axis limits (optional):
+        if (present(xlim)) call vec_to_string(xlim, me%real_fmt, xlimstr, me%use_numpy)
+        if (present(ylim)) call vec_to_string(ylim, me%real_fmt, ylimstr, me%use_numpy)
+
+        !convert the arrays to strings:
+        call vec_to_string(x, me%real_fmt, xstr, me%use_numpy)
+
+        !write the arrays:
+        call me%add_str(trim(xname)//' = '//xstr)
+        call me%add_str('')
+
+        !get optional inputs (if not present, set default value):
+        call optional_int_to_string(bins, binsstr, '10')
+
+        !optional arguments:
+        if (present(bins))       extras = extras//','//'bins="'//binsstr//'"'
+
+        if (present(normed) .and. normed) then
+          normedstr = 'True'
+        else
+          normedstr = 'False'
+        end if
+
+        if (present(cumulative) .and. cumulative) then
+          cumulativestr = 'True'
+        else
+          cumulativestr = 'False'
+        end if
+
+        !write the plot statement:
+        call me%add_str('ax.hist('//&
+                        trim(xname)//','//&
+                        'label="'//trim(label)//'",'//&
+                        'bins='//trim(binsstr)//','//&
+                        'cumulative='//trim(cumulativestr)//','//&
+                        'normed='//trim(normedstr)//')')
+
+        !axis limits:
+        if (allocated(xlimstr)) call me%add_str('ax.set_xlim('//xlimstr//')')
+        if (allocated(ylimstr)) call me%add_str('ax.set_ylim('//ylimstr//')')
+
+        !axis scales:
+        if (present(xscale)) call me%add_str('ax.set_xscale("'//xscale//'")')
+        if (present(yscale)) call me%add_str('ax.set_yscale("'//yscale//'")')
+
+        call me%add_str('')
+
+    else
+        error stop 'Error in add_plot: pyplot class not properly initialized.'
+    end if
+
+    end subroutine add_hist
+!*****************************************************************************************
+
 !*****************************************************************************************
 !> author: Jacob Williams
 !

src/tests/test.f90

@@ -85,5 +85,41 @@ program test
     call plt%add_imshow(mat,xlim=[0.0_wp, 100.0_wp],ylim=[0.0_wp, 100.0_wp])
     call plt%savefig('imshow.png', pyfile='imshow.py')
 
+    !histogram chart:
+    x = [0.194,0.501,-1.241,1.425,-2.217,-0.342,-0.979,0.909,0.994,0.101,       &
+         -0.131,-0.627,0.463,1.404,0.036,-2.000,0.109,1.250,-1.035,-1.115,      &
+          0.935,0.496,1.100,0.770,-1.307,-0.693,-0.072,-1.331,-0.701,           &
+         -0.494,0.666,-0.313,-0.430,-0.654,1.638,-0.334,-0.418,0.550,-0.034,    &
+          0.473,0.704,0.801,-0.157,0.055,-0.057,-1.049,-1.022,0.495,0.756,      &
+          0.149,0.543,-0.813,-0.171,-0.994,-1.532,0.502,1.324,-0.593,-0.467,    &
+          0.372,-0.904,1.255,0.931,-0.779,1.529,-0.036,0.783,0.292,-0.792,      &
+          -0.223,-0.325,0.225,-0.492,-0.941,0.065,1.300,-1.241,-1.124,-0.499,   &
+          1.233,-0.845,-0.948,-1.060,1.103,-1.154,-0.594,0.335,-1.423,0.571,    &
+         -0.903,1.129,-0.372,-1.043,-1.327,0.147,1.056,1.068,-0.699,0.988,-0.630]
+
+    call plt%initialize(grid=.true.,xlabel='x',&
+                        title='hist test',&
+                        legend=.true.,figsize=[20,10],&
+                        font_size = 20,&
+                        axes_labelsize = 20,&
+                        xtick_labelsize = 20,&
+                        ytick_labelsize = 20,&
+                        legend_fontsize = 20 )
+
+    call plt%add_hist(x=x, label='x', normed=.true.)
+    call plt%savefig('histtest1.png', pyfile='histtest1.py')
+
+    call plt%initialize(grid=.true.,xlabel='x',&
+                        title='cumulative hist test',&
+                        legend=.true.,figsize=[20,10],&
+                        font_size = 20,&
+                        axes_labelsize = 20,&
+                        xtick_labelsize = 20,&
+                        ytick_labelsize = 20,&
+                        legend_fontsize = 20 )
+
+    call plt%add_hist(x=x, label='x', bins=8, cumulative=.true.)
+    call plt%savefig('histtest2.png', pyfile='histtest2.py')
+
     end program test
 !*****************************************************************************************