Home       Trees       Indices       Help   
Package bar :: Module parsers :: Class barGenericParser
[hide private]
[frames] | no frames]

Class barGenericParser

Change Log: pią, 21 sty 2011, 11:40:31 CET, Creating index without parsing all nlides again: method introduced.

Instance Methods [hide private]
 
__init__(self, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
barTracedSlideRenderer
parse(self, slideNumber)
Returns: Traced slide with given slideNumber.
None
parseAll(self)
Performs tracing of all slides enumerated in self.slideRange.
None
parseRange(self, firstSlide, lastSlide)
Returns: None
None
writeIndex(self, rescanSlides=False)
Returns: None
None
reindex(self)
Returns: None
 
__setInternalData(self, name, value)
 
__getInternalData(self, name)
None
getProperty(self, name)
Returns: None
None
setProperty(self, name, value)
Returns: None
None
_validateInternalData(self)
Performs internal parsing properties validation.
str
_getOutputFilename(self, slideNumber, version=0)
Returns: Path for given traced slide number with given version.
str
_getIndexFilename(self)
Returns: Provides CAF index file path.
 
RGBToHTMLColor(self, rgb_tuple)
convert an (R, G, B) tuple to #RRGGBB
str
_performTracing(self, binaryImage)
Returns: Raw tracing output string.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
list _requiredInternalData = ['outputDirectory', 'filenameTemplates...
Required instance attributtes.
Instance Variables [hide private]
dict filenameTemplates
Dictionary holding templates of output filenames used by parser and indexing module.
string outputDirectory
Final CAF dataset directory.
dict renderingProperties
Set of rendering properties for generating bitmap representations of SVG slides.
list slideRange
List of integers containing consecutive slide numbers.
dict tracingProperties
Dictionary holding preferences regarding tracing wiht PoTrace.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

parse(self, slideNumber)

 
Parameters:
  • slideNumber (int) - Number of slide to parse
Returns: barTracedSlideRenderer
Traced slide with given slideNumber.

Performs all operation related to creating CAF slide from souce data. Should be customized in each parser.

Note: Parsing cannot be performed until all attributes enumerated in _requiredInternalData will be provided.

parseAll(self)

 

Performs tracing of all slides enumerated in self.slideRange. Should be customized in each parser. Has the same effect as parseRange(slideRange[0],slideRange[-1]).

Returns: None
None

parseRange(self, firstSlide, lastSlide)

 
Parameters:
  • firstSlide (integer) - number of the first slide to process
  • lastSlide (integer) - number of the last slide to process
Returns: None
None

To Do: Implement checking if provided range is withing the limits.

Parses slides starting from firstSlide up to lastSlide.

writeIndex(self, rescanSlides=False)

 
Parameters:
  • rescanSlides (bool) - Determines if all slides will be reindexed before creating index file
Returns: None
None

Creates and writex index file on disk. Whole index is regenerated when rescanSlides is True. This option is useful when consecutive slides were not indexed during tracing procedure.

To Do: Check if all required data is set.

reindex(self)

 
Returns: None
None

Reindexes all slides in self.slideRange. This option is useful when consecutive slides were not indexed during tracing procedure.

getProperty(self, name)

 
Parameters:
  • name (string) - name of the arribute
Returns: None
None

Returns value of the given attribute.

setProperty(self, name, value)

 
Parameters:
  • name (string) - name of the arribute
  • value (various) - value of the attribute. Usually value of the attribute is dictionary but it may be also list, etc.
Returns: None
None

Sets internal property of the parser.

_validateInternalData(self)

 

Performs internal parsing properties validation. Parsing properties are properties provided by the user required for proper parsing procedure. Required parameters are listed in _requiredInternalData. If not all parameters are provided parse cannot be invoked.

Returns: None
None

_getOutputFilename(self, slideNumber, version=0)

 
Parameters:
  • slideNumber (integer) - Number of page to parse
  • version (integer) - slide version 0 by default.
Returns: str
Path for given traced slide number with given version.

Generates filename for traced file with given version. Function requires filenameTempates to be provided.

_getIndexFilename(self)

 
Returns: str
Provides CAF index file path.

_performTracing(self, binaryImage)

 
Parameters:
  • binaryImage (PIL image) - Flooded image for tracing.

    Preforms tracing procedure. Alias for performTracing.

Returns: str
Raw tracing output string.

Class Variable Details [hide private]

_requiredInternalData

Required instance attributtes. Without prividing them parsing cannot be invoked. Meaning of each attribute is explained below.
Type:
list
Value:
['outputDirectory',
 'filenameTemplates',
 'slideRange',
 'tracingProperties',
 'renderingProperties']

Instance Variable Details [hide private]

filenameTemplates

Dictionary holding templates of output filenames used by parser and indexing module. Keys are type of slides (ie. contour or traced) while values are strings with templates. Usually simple parser requires only traced file template: dict(traced='%d_traced_v%d.svg').
Type:
dict

outputDirectory

Final CAF dataset directory. Directory in which traced files ans CAF index file is stored. Used mostly by _getOutputFilename and for saving index CAF index file: writeXMLtoFile
Type:
string

renderingProperties

Set of rendering properties for generating bitmap representations of SVG slides. Although there are default renderingProperties defined (see here), this parser requires providing its own renderinf properes. Each element of the dictinary is explained here.
Type:
dict

slideRange

List of integers containing consecutive slide numbers. it is assumed that list contains consecutive slide numbers. List does not have to start from zero.
Type:
list

tracingProperties

Dictionary holding preferences regarding tracing wiht PoTrace. All entries are decribed here: CONF_POTRACE_ACCURACY_PARAMETER, CONF_POTRACE_SVG_RESOLUTION_STRING, CONF_POTRACE_WIDTH_STRING, CONF_POTRACE_HEIGHT_STRING.
Type:
dict

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Mar 20 14:31:40 2013 http://epydoc.sourceforge.net