figures.py

Go to the documentation of this file.

#  This file is part of repro, a Python package for automating 
#  reproducible research in scientific computing.
#
#  Copyright (C) 2008  Gilles Hennenfent, Sean Ross-Ross
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

##
# 
# @package figures
# Provide two builders, EPS and PNG, and extend a third one, PDF, to 
# convert images between different file format.
# 
# @page pg_convertblds Make figures
# 
# @section sec_epsbld EPS
# 
# Defined in the figures tool. Builder to convert arbitrary image to 
# EPS file format.
# 
# @section sec_pngbld PNG
# 
# Defined in the figures tool. Builder to convert arbitrary image to 
# PNG file format.
# 
# @section sec_fig2pdfbld PDF
# 
# Extended in the figures tool. Builder to convert arbitrary image to 
# PDF file format.
# 

from SCons.Script import Builder, Action, Delete
from os import environ
from repro.functions.reproexports import reproexports
from string import join

PNGCMD = 'pstoimg'

##
# 
#     @brief Alias target(s) of PNG to 'scons png'.
#     
def png_emitter( target, source, env ):

    env.Default( source )
    env.Alias( 'png', target)
    return target, source

##
# 
#     @brief Alias target(s) of EPS to 'scons eps'.
#     
def eps_emitter( target, source, env ):
    reproexports( env )

    env.Default( source )
    env.Alias( 'eps', target)
    return target, source

def always_succeed(s):
    # Always return 0, which indicates success.
    return 0
    
##
# 
#     @brief Export some SCons environment variables to shell environment.
#     
def pdf_vpl_emitter( target, source, env ):
    reproexports( env )
    
    return target, source

##
# 
#     @brief Construct Actions for EPS, PNG, and PDF builders and add these
#     builders to the environment.
#     
def generate(env):

    # EPS builder
    REPROEXPORTS= ['RSFROOT','PSTEXPENOPTS','PSBORDER','GS_OPTIONS']    
    
    vpl2eps_act =  Action('vplot2eps ${SOURCE} ${TARGET}', 
                          exitstatfunc=always_succeed,
                          varlist=REPROEXPORTS,
                          )
    
    env['PSIMAGEOPTS'] = ""
    su2eps_act =  Action('supsimage <${SOURCE} $PSIMAGEOPTS >${TARGET}', 
                          exitstatfunc=always_succeed,
                          )

    eps_builder = Builder(action={".vpl":vpl2eps_act,
                                  ".su":su2eps_act},
                          suffix=".eps",
                          single_source=True,
                          emitter=eps_emitter
                          )
    env['BUILDERS']['EPS'] = eps_builder

    # PNG builder
    env['aaliastext'] = True
    env['antialias'] = True
    env['color'] = 24
    env['density'] = 100
    env['interlaced'] = True
    env['itype'] = 'png'

    env['PNGCMD'] = PNGCMD
    env['_aaliastext'] = "${aaliastext and '-aaliastext' or ' '}"
    env['_antialias'] = "${antialias and '-antialias' or ' '}"
    env['_interlaced'] = "${interlaced and '-interlaced' or ' '}"
    env['PNGOPTS'] = "$_aaliastext $_antialias -color $color -density $density $_interlaced -type $itype"

    png_act = Action( "$PNGCMD $SOURCE -out $TARGET $PNGOPTS",
                       varlist=['PSTEXPENOPTS'],
                       )
    
    png_builder = Builder(action={".pdf":png_act,
                                  ".eps":png_act
                                  },
                          source_suffix=['.pdf','.eps'],
                          suffix=".png",
                          single_source=True,
                          emitter=png_emitter,
                          src_builder=eps_builder
                          )
    env['BUILDERS']['PNG'] = png_builder

    # PDF stuff
    PS2PDFACTION = Action('epstopdf ${TARGET.base}.eps >${TARGET}', chdir=1 )
        
    env.PDF.method.add_action( '.vpl', [ vpl2eps_act , PS2PDFACTION, Delete('${TARGET.base}.eps')] )
    
    env.Append( REPROEXPORTS=REPROEXPORTS )
    
    env['PSTEXPENOPTS'] = environ.get('PSTEXPENOPTS') 
    env['PSBORDER'] = environ.get('PSBORDER')
    env.PDF.method.builder.add_emitter( '.vpl', pdf_vpl_emitter )

    gs_options = join(['-dAutoFilterColorImages=false',
                       '-dColorImageFilter=/LZWEncode', 
                       '-dAutoFilterGrayImages=false',
                       '-dGrayImageFilter=/LZWEncode'])
    env['GS_OPTIONS'] = environ.get( 'GS_OPTIONS',gs_options )
    env.PDF.method.add_action( '.ps',  Action('epstopdf ${SOURCE} >${TARGET}') )
    env.PDF.method.add_action( '.eps', Action('epstopdf ${SOURCE} >${TARGET}') )

##
# 
#     Return True (this tool always exists).
#     
def exists( env ):
    return 1

---