org.openimaj.image.processing.pyramid
Class PyramidOptions<OCTAVE extends Octave<?,?,IMAGE>,IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>

java.lang.Object
  org.openimaj.image.processing.pyramid.PyramidOptions<OCTAVE,IMAGE>

Type Parameters:

OCTAVE - type of underlying octave

IMAGE - type of underlying image.

Direct Known Subclasses:

GaussianPyramidOptions

public class PyramidOptions<OCTAVE extends Octave<?,?,IMAGE>,IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>>
extends Object

Basic options for constructing a pyramid

Author:

Jonathon Hare

Field Summary

protected boolean	keepOctaves Should the Pyramid hold onto its octaves?
protected OctaveProcessor<OCTAVE,IMAGE>	octaveProcessor An OctaveProcessor to apply to each octave of the pyramid.
protected PyramidProcessor<IMAGE>	pyramidProcessor PyramidProcessor for processing the pyramid after construction.

Constructor Summary

PyramidOptions()

Method Summary

OctaveProcessor<OCTAVE,IMAGE>	getOctaveProcessor() Get an OctaveProcessor to apply to each octave of the pyramid or null if none is set.
PyramidProcessor<IMAGE>	getPyramidProcessor() Gets the currently set PyramidProcessor or null if none is set.
boolean	isKeepOctaves() Determine whether the Pyramid should retain its octaves.
void	setKeepOctaves(boolean keepOctaves) Set whether the Pyramid should retain its octaves.
void	setOctaveProcessor(OctaveProcessor<OCTAVE,IMAGE> octaveProcessor) Get an OctaveProcessor to apply to each octave of the pyramid.
void	setPyramidProcessor(PyramidProcessor<IMAGE> pyramidProcessor) Sets the PyramidProcessor.

Methods inherited from class java.lang.Object

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

Field Detail

keepOctaves

protected boolean keepOctaves

Should the Pyramid hold onto its octaves?

octaveProcessor

protected OctaveProcessor<OCTAVE extends Octave<?,?,IMAGE>,IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>> octaveProcessor

An OctaveProcessor to apply to each octave of the pyramid.

pyramidProcessor

protected PyramidProcessor<IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>> pyramidProcessor

PyramidProcessor for processing the pyramid after construction. Setting a PyramidProcessor will cause the Pyramid to hold onto its entire set of octaves.

Constructor Detail

PyramidOptions

public PyramidOptions()

Method Detail

getOctaveProcessor

public OctaveProcessor<OCTAVE,IMAGE> getOctaveProcessor()

Get an OctaveProcessor to apply to each octave of the pyramid or null if none is set.

Returns:

the octaveProcessor or null

getPyramidProcessor

public PyramidProcessor<IMAGE> getPyramidProcessor()

Gets the currently set PyramidProcessor or null if none is set. PyramidProcessors process the pyramid after construction. Setting a PyramidProcessor will cause the Pyramid to hold onto its entire set of octaves.

Returns:

the pyramidProcessor or null

isKeepOctaves

public boolean isKeepOctaves()

Determine whether the Pyramid should retain its octaves. Value is overridden if a PyramidProcessor is set.

Returns:

the keepOctaves

setKeepOctaves

public void setKeepOctaves(boolean keepOctaves)

Set whether the Pyramid should retain its octaves. Default value is false, but is overridden if a PyramidProcessor is set.

Parameters:

keepOctaves - the keepOctaves to set

setOctaveProcessor

public void setOctaveProcessor(OctaveProcessor<OCTAVE,IMAGE> octaveProcessor)

Get an OctaveProcessor to apply to each octave of the pyramid. Setting the OctaveProcessor to null disables it.

Parameters:

octaveProcessor - the octaveProcessor to set

setPyramidProcessor

public void setPyramidProcessor(PyramidProcessor<IMAGE> pyramidProcessor)

Sets the PyramidProcessor. PyramidProcessors for process the pyramid after construction. Setting a PyramidProcessor will cause the Pyramid to hold onto its entire set of octaves. Setting the PyramidProcessor to null disables it.

Parameters:

pyramidProcessor - the pyramidProcessor to set