org.openpnp.vision.pipeline

Class CvAbstractParameterStage

java.lang.Object

org.openpnp.vision.pipeline.CvStage

org.openpnp.vision.pipeline.CvAbstractParameterStage

Direct Known Subclasses:

CvAbstractScalarParameterStage

public abstract class CvAbstractParameterStage
extends CvStage

Nested Class Summary

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

CvStage.CvStageBeanInfo, CvStage.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	effectStageName
protected java.lang.String	parameterDescription
protected java.lang.String	parameterLabel
protected boolean	previewResult
protected java.lang.String	propertyName
protected java.lang.String	stageName

Constructor Summary

Constructors

Constructor and Description
CvAbstractParameterStage()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	appliedValue(CvPipeline pipeline, java.lang.Object value)
abstract java.lang.Object	defaultParameterValue()
abstract java.lang.String	displayValue(java.lang.Object value)
java.lang.String	getEffectStageName()
java.lang.String	getParameterDescription()
java.lang.String	getParameterLabel()
java.lang.String	getPropertyName()
java.lang.String	getStageName()
protected void	invokeSetter(CvStage stage, java.lang.String propertyName, java.lang.Object parameterValue)
boolean	isPreviewResult()
java.lang.String	parameterName()
protected abstract java.lang.Class<?>	parameterValueType()
CvStage.Result	process(CvPipeline pipeline) Perform an operation in a pipeline.
void	setEffectStageName(java.lang.String effectStageName)
void	setParameterDescription(java.lang.String parameterDescription)
void	setParameterLabel(java.lang.String parameterLabel)
void	setPreviewResult(boolean previewResult)
void	setPropertyName(java.lang.String propertyName)
void	setStageName(java.lang.String stageName)

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

Field Detail

parameterLabel

protected java.lang.String parameterLabel

parameterDescription

protected java.lang.String parameterDescription

stageName

protected java.lang.String stageName

propertyName

protected java.lang.String propertyName

effectStageName

protected java.lang.String effectStageName

previewResult

protected boolean previewResult

Constructor Detail

CvAbstractParameterStage

public CvAbstractParameterStage()

Method Detail

getParameterLabel

public java.lang.String getParameterLabel()

setParameterLabel

public void setParameterLabel(java.lang.String parameterLabel)

getStageName

public java.lang.String getStageName()

getParameterDescription

public java.lang.String getParameterDescription()

setParameterDescription

public void setParameterDescription(java.lang.String parameterDescription)

setStageName

public void setStageName(java.lang.String stageName)

getPropertyName

public java.lang.String getPropertyName()

setPropertyName

public void setPropertyName(java.lang.String propertyName)

getEffectStageName

public java.lang.String getEffectStageName()

setEffectStageName

public void setEffectStageName(java.lang.String effectStageName)

isPreviewResult

public boolean isPreviewResult()

setPreviewResult

public void setPreviewResult(boolean previewResult)

appliedValue

public abstract java.lang.Object appliedValue(CvPipeline pipeline,
                                              java.lang.Object value)

defaultParameterValue

public abstract java.lang.Object defaultParameterValue()

displayValue

public abstract java.lang.String displayValue(java.lang.Object value)

parameterValueType

protected abstract java.lang.Class<?> parameterValueType()

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

invokeSetter

protected void invokeSetter(CvStage stage,
                            java.lang.String propertyName,
                            java.lang.Object parameterValue)
                     throws java.beans.IntrospectionException,
                            java.lang.IllegalAccessException,
                            java.lang.IllegalArgumentException,
                            java.lang.reflect.InvocationTargetException

Throws:

java.beans.IntrospectionException

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

java.lang.reflect.InvocationTargetException

parameterName

public java.lang.String parameterName()

Returns:

The parameter name, which is the stage name, but properly validated. Otherwise null is returned.