Added basic imshow plot type.

Fixes #11

Author: jacobwilliams

README.md

@@ -20,6 +20,7 @@ Supported plot types
 * ```matplotlib.pyplot.bar``` -- bar plot
 * ```matplotlib.pyplot.contour``` -- contour plot
 * ```matplotlib.pyplot.contourf``` -- filled contour plot
+* ```matplotlib.pyplot.imshow``` -- image plot
 
 Example
 ---------------

src/pyplot_module.f90

@@ -53,6 +53,7 @@ module pyplot_module
         procedure, public :: add_3d_plot   !! add a 3d plot to pyplot instance
         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 :: savefig       !! save plots of pyplot instance
         procedure, public :: destroy       !! destroy pyplot instance
@@ -453,7 +454,8 @@ end subroutine add_3d_plot
 !
 ! Add a bar plot.
 
-    subroutine add_bar(me, left, height, label, width, bottom, color, yerr, align, xlim, ylim, xscale, yscale)
+    subroutine add_bar(me, left, height, label, width, bottom, color, &
+                        yerr, align, xlim, ylim, xscale, yscale)
 
     class(pyplot),          intent(inout)        :: me            !! pyplot handler
     real(wp), dimension(:), intent(in)           :: left          !! left bar values
@@ -535,6 +537,54 @@ subroutine add_bar(me, left, height, label, width, bottom, color, yerr, align, x
     end subroutine add_bar
 !*****************************************************************************************
 
+!*****************************************************************************************
+!>
+! Add an image plot using `imshow`.
+!
+!### Note
+!  * Based on code by Ricardo Torres, 4/2/2017.
+
+    subroutine add_imshow(me, x, xlim, ylim)
+
+    class(pyplot),          intent (inout) :: me          !! pyplot handler
+    real(wp),dimension(:,:),intent (in)    :: x           !! x values
+    real(wp),dimension(2),  intent (in), optional :: xlim !! x-axis range
+    real(wp),dimension(2),  intent (in), optional :: ylim !! y-axis range
+
+    character(len=:), allocatable :: xstr         !! x values stringified
+    character(len=*), parameter   :: xname = 'x'  !! x variable name for script
+
+    !axis limits (optional):
+    character(len=:), allocatable :: xlimstr      !! xlim values stringified
+    character(len=:), allocatable :: ylimstr      !! ylim values stringified
+
+    if (allocated(me%str)) then
+
+        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 matrix_to_string(x, me%real_fmt, xstr, me%use_numpy)
+
+        !write the arrays:
+        call me%add_str(trim(xname)//' = '//xstr)
+        call me%add_str('')
+
+        !write the plot statement:
+        call me%add_str('ax.imshow('//trim(xname)//')')
+        call me%add_str('')
+
+        !axis limits:
+        if (allocated(xlimstr)) call me%add_str('ax.set_xlim('//xlimstr//')')
+        if (allocated(ylimstr)) call me%add_str('ax.set_ylim('//ylimstr//')')
+
+    else
+        error stop 'Error in add_imshow: pyplot class not properly initialized.'
+    end if
+
+    end subroutine add_imshow
+!*****************************************************************************************
+
 !*****************************************************************************************
 !> author: Jacob Williams
 !

src/tests/test.f90

@@ -26,13 +26,21 @@ program test
     integer                  :: j     !! counter
     real(wp)                 :: r2    !! temp variable
 
+    real(wp), dimension(n,n) :: mat     !! image values
+
     !generate some data:
     x    = [(real(i,wp), i=0,size(x)-1)]/5.0_wp
     sx   = sin(x)
     cx   = cos(x)
     tx   = sx * cx
     yerr = abs(sx*.25_wp)
 
+    do i=1,n
+        do j=1,n
+            mat(i,j) = sin(real(i,wp)*real(j,wp))
+        end do
+    end do
+
     !2d line plot:
     call plt%initialize(grid=.true.,xlabel='angle (rad)',figsize=[20,10],&
                         title='plot test',legend=.true.,axis_equal=.true.)
@@ -63,10 +71,19 @@ program test
             z(i,j) = sin(x(i))*cos(y(j))*sin(r2)/(1.0_wp+log(r2+1.0_wp))
         end do
     end do
-    call plt%initialize(grid=.true.,xlabel='x angle (rad)',ylabel='y angle (rad)',figsize=[10,10],&
+    call plt%initialize(grid=.true.,xlabel='x angle (rad)',&
+                        ylabel='y angle (rad)',figsize=[10,10],&
                         title='Contour plot test', real_fmt='*')
-    call plt%add_contour(x, y, z, label='contour', linestyle='-', linewidth=2, filled=.true., cmap='bone')
+    call plt%add_contour(x, y, z, label='contour', linestyle='-', &
+                         linewidth=2, filled=.true., cmap='bone')
     call plt%savefig('contour.png',pyfile='contour.py')
 
+    !image plot:
+    call plt%initialize(grid=.true.,xlabel='x',ylabel='y',figsize=[20,20],&
+                        title='imshow test',&
+                        real_fmt='(F9.3)')
+    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')
+
     end program test
 !*****************************************************************************************