imgcrush.filetester.FileTester Class Reference

List of all members.

Public Member Functions

def __init__
def abs_max_size
def abs_min_quality
def compare_files_quality
def compare_files_size
def select_best_file
def set_max_size
def set_min_quality
def set_mode

Public Attributes

 FileList
 MaxSize
 MinQuality
 Mode


Detailed Description

Tests the generated files and selects which one should be output.

Removes other temporary files in the process.

Definition at line 10 of file filetester.py.


Member Function Documentation

def imgcrush.filetester.FileTester.__init__ (   self  ) 

Constructor.

Data members:
Mode       : Mode of file selection. available modes:
     "q" : choose the smallest file w/ at least given quality.
     "s" : choose the best file with at most given filesize.
MinQuality : Minimum quality - used when mode is q . Specified in %,
     e.g. "10.1%" or in subjective units, e.g. "10.1", that 
     are closer to JPG quality settings.
MaxSize    : Maximum filesize - used when mode is s . Specified in %
     of input filesize, e.g. "10.1%", % of filesize of the
     reference file, e.g. "10.1r%", kiB, MiB, GiB, e.g. 
     "10.1kiB", in bytes, e.g. "10342" or in average bits per
     pixel, e.g. "2.4bpp" .
FileList   : List of all temporaty images. Contains their filenames,
     filesizes, quality values and data about how they were
     saved.

Definition at line 15 of file filetester.py.

def imgcrush.filetester.FileTester.abs_max_size (   self,
  reffile 
)

Returns maximum size in bytes.

Parses stored maximum size data and returns it's equivalent in bytes.

Arguments:
reffile : Reference file used for relative max size options (i.e. in %)

Definition at line 98 of file filetester.py.

def imgcrush.filetester.FileTester.abs_min_quality (   self  ) 

Returns minimum quality in %.

Parses stored minimum quality data and returns it's equivalent in %.

Definition at line 87 of file filetester.py.

def imgcrush.filetester.FileTester.compare_files_quality (   self,
  bestqual,
  maxsize,
  file,
  bestfile 
)

Compares quality of file and bestfile.Returns True if file is better.

If files have same quality, file with better filesize is determined
to be better. If file is better than bestfile, bestfile is deleted.

Definition at line 148 of file filetester.py.

def imgcrush.filetester.FileTester.compare_files_size (   self,
  minqual,
  bestsize,
  file,
  bestfile 
)

Compares size of file and bestfile. Returns True if file is better.

If files have same filesize, file with better quality is determined
to be better. If file is better than bestfile, bestfile is deleted.

Definition at line 122 of file filetester.py.

def imgcrush.filetester.FileTester.select_best_file (   self,
  filelist,
  reffile,
  outfilename 
)

Selects which of generated files should be output, deletes others.

Arguments:
filelist    : List of generated temporary files to select from.
reffile     : Data about the current reference file to compare to.
outfilename : Filename the output will have.

Definition at line 174 of file filetester.py.

def imgcrush.filetester.FileTester.set_max_size (   self,
  s 
)

Sets maximum size used in "s" mode.

Arguments:
s: size to set. Valid values are floats 0-100% , 0-100r% , 
   0-1048576kiB/MiB/GiB , 0-1073741824

Definition at line 64 of file filetester.py.

def imgcrush.filetester.FileTester.set_min_quality (   self,
  q 
)

Sets minimum quality used in "q" mode.

Argumets:
q: quality to set. Valid values are floats 0-100% or 0-100.

Definition at line 50 of file filetester.py.

def imgcrush.filetester.FileTester.set_mode (   self,
  m 
)

Sets mode of file selection.

Arguments:
m: Mode to set. Valid values are "q" and "s"

Definition at line 39 of file filetester.py.


The documentation for this class was generated from the following file:

Generated on Sun Oct 18 14:02:29 2009 for IMGCrush by  doxygen 1.5.8