org.openpnp.vision.pipeline.stages

Class ImageWriteDebug

java.lang.Object

org.openpnp.vision.pipeline.CvStage

org.openpnp.vision.pipeline.stages.ImageWriteDebug

public class ImageWriteDebug
extends CvStage

Save the working image as an image file in the debug directory using the specified prefix and suffix. The suffix should be a file extension (including the period).

Nested Class Summary

Nested classes/interfaces inherited from class org.openpnp.vision.pipeline.CvStage

CvStage.CvStageBeanInfo, CvStage.Result

Constructor Summary

Constructors

Constructor and Description
ImageWriteDebug()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrefix()
java.lang.String	getSuffix()
CvStage.Result	process(CvPipeline pipeline) Perform an operation in a pipeline.
void	setPrefix(java.lang.String prefix)
void	setSuffix(java.lang.String suffix)

Methods inherited from class org.openpnp.vision.pipeline.CvStage

customizePropertySheet, getBeanInfo, getCategory, getDescription, getDescription, getLengthUnit, getName, getPossiblePipelinePropertyOverride, getPossiblePipelinePropertyOverride, isEnabled, recordPropertyOverride, setEnabled, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageWriteDebug

public ImageWriteDebug()

Method Detail

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

getSuffix

public java.lang.String getSuffix()

setSuffix

public void setSuffix(java.lang.String suffix)

process

public CvStage.Result process(CvPipeline pipeline)
                       throws java.lang.Exception

Description copied from class: CvStage

Perform an operation in a pipeline. Typical implementations will call CvPipeline#getWorkingImage(), perform some type of operation on the image and will return a Result containing a modified image and model data about features found in the image. If the stage only modifies the working image, it is sufficient to just return null, and this will typically be the most common case.

Specified by:

process in class CvStage

Returns:

Null or a Result object containing an optional image and optional model. If the return value is null the pipeline will store a copy of the working image as the result for this stage. Otherwise it will set the working image to the result image and store the result image.

Throws:

java.lang.Exception