org.fit.segm.grouping.op

Class SeparatorSet

java.lang.Object

org.fit.segm.grouping.op.SeparatorSet

Direct Known Subclasses:

SeparatorSetHVS

public abstract class SeparatorSet
extends java.lang.Object

A generic set of horizontal and vertical separators for a page.

Author:

radek

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ART_SEP_WIDTH The width of the 'artificial' separators created by background colors
protected java.util.Vector<Separator>	bsep List of separators comming from the box analysis
protected java.util.Vector<Separator>	hsep List of horizontal separators
protected static double	HSEP_MIN_HEIGHT The minimal height of a horizontal separator in "em" units
protected AreaImpl	root The root of the area tree that will be processed
protected static double	SEP_MIN_RATIO The minimal width/height ratio of the separator
protected java.util.Vector<Separator>	vsep List of vertical separators
protected static double	VSEP_MIN_WIDTH The minimal width of a vertical separator in "em" units

Constructor Summary

Constructors

Constructor and Description
SeparatorSet(AreaImpl root) Creates a new separator set with one horizontal and one vertical separator.
SeparatorSet(AreaImpl root, Area filter) Creates a new separator set with one horizontal and one vertical separator.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyFinalFilters() Applies various filters on the current separator sets in order to remove irrelevant separators or adjust the sizes.
protected void	applyRegularFilters() Applies various filters on the current separator sets in order to remove irrelevant separators or adjust the sizes.
protected void	filterMarginalSeparators() Removes the separators that are placed on the area borders.
protected void	filterSeparators() Removes all the separators where the weight is lower than the specified threshold.
protected abstract void	findSeparators(AreaImpl area, Area filter) Finds the horizontal and vertical list of separators
java.util.Vector<Separator>	getBoxsep()
java.util.Vector<Separator>	getHorizontal()
int	getMinHSepHeight() Computes the minimal height of a horizontal separator that is accepted with this separator set.
int	getMinVSepWidth() Computes the minimal width of a vertical separator that is accepted with this separator set.
Separator	getMostImportantSeparator() Obtains the most important (with the greatest weight) separator from all the separators.
java.util.Vector<Separator>	getVertical()
boolean	isSeparatorAt(int x, int y) Checks if a point is covered by a separator.
protected void	processIntersections() Processes the separators so that they do not intersect.
protected void	processIntersectionsRemoveHorizontal() Processes the separators so that they do not intersect.
protected void	processIntersectionsSplitHorizontal() Processes the separators so that they do not intersect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HSEP_MIN_HEIGHT

protected static final double HSEP_MIN_HEIGHT

The minimal height of a horizontal separator in "em" units

See Also:

Constant Field Values

VSEP_MIN_WIDTH

protected static final double VSEP_MIN_WIDTH

The minimal width of a vertical separator in "em" units

See Also:

Constant Field Values

SEP_MIN_RATIO

protected static final double SEP_MIN_RATIO

The minimal width/height ratio of the separator

See Also:

Constant Field Values

ART_SEP_WIDTH

protected static final int ART_SEP_WIDTH

The width of the 'artificial' separators created by background colors

See Also:

Constant Field Values

root

protected AreaImpl root

The root of the area tree that will be processed

hsep

protected java.util.Vector<Separator> hsep

List of horizontal separators

vsep

protected java.util.Vector<Separator> vsep

List of vertical separators

bsep

protected java.util.Vector<Separator> bsep

List of separators comming from the box analysis

Constructor Detail

SeparatorSet

public SeparatorSet(AreaImpl root)

Creates a new separator set with one horizontal and one vertical separator.

SeparatorSet

public SeparatorSet(AreaImpl root,
            Area filter)

Creates a new separator set with one horizontal and one vertical separator.

Method Detail

getHorizontal

public java.util.Vector<Separator> getHorizontal()

getVertical

public java.util.Vector<Separator> getVertical()

getBoxsep

public java.util.Vector<Separator> getBoxsep()

getMostImportantSeparator

public Separator getMostImportantSeparator()

Obtains the most important (with the greatest weight) separator from all the separators. The separators must be sorted before this metod is called.

Returns:

The selected separator or null when there are no separators

getMinHSepHeight

public int getMinHSepHeight()

Computes the minimal height of a horizontal separator that is accepted with this separator set. Usually, it depends on the average font size of the corresponding visual area.

Returns:

the minimal height in pixels

getMinVSepWidth

public int getMinVSepWidth()

Computes the minimal width of a vertical separator that is accepted with this separator set. Usually, it depends on the average font size of the corresponding visual area.

Returns:

the minimal width in pixels

isSeparatorAt

public boolean isSeparatorAt(int x,
                    int y)

Checks if a point is covered by a separator.

Parameters:

x - the point x coordinate

y - the point y coordinate

Returns:

true if any of the separators in this set covers the specified point

findSeparators

protected abstract void findSeparators(AreaImpl area,
                  Area filter)

Finds the horizontal and vertical list of separators

Parameters:

area - the root area

filter - if not null, only the sub areas enclosed in the filter area are considered

applyRegularFilters

protected void applyRegularFilters()

Applies various filters on the current separator sets in order to remove irrelevant separators or adjust the sizes. This is calle automatically after each recursive iteration.

applyFinalFilters

public void applyFinalFilters()

Applies various filters on the current separator sets in order to remove irrelevant separators or adjust the sizes. This must be called manually after the final results are obtained.

filterMarginalSeparators

protected void filterMarginalSeparators()

Removes the separators that are placed on the area borders.

filterSeparators

protected void filterSeparators()

Removes all the separators where the weight is lower than the specified threshold.

processIntersections

protected void processIntersections()

Processes the separators so that they do not intersect.

processIntersectionsSplitHorizontal

protected void processIntersectionsSplitHorizontal()

Processes the separators so that they do not intersect. The vertical separators are left untouched, the horizontal separators are split by the vertical ones when necessary.

processIntersectionsRemoveHorizontal

protected void processIntersectionsRemoveHorizontal()

Processes the separators so that they do not intersect. The vertical separators are left untouched, the horizontal separators are removed when they intersect with a vertical one.