org.openpnp.vision.pipeline

Class CvStage

java.lang.Object

org.openpnp.vision.pipeline.CvStage

Direct Known Subclasses:

ActuatorWrite, Add, AffineUnwarp, AffineWarp, BlurGaussian, BlurMedian, ClosestModel, ComposeResult, ConvertColor, ConvertModelToKeyPoints, ConvertModelToPoints, CreateFootprintTemplateImage, CreateModelTemplateImage, CreateShapeTemplateImage, CvAbstractParameterStage, DetectCirclesHough, DetectCircularSymmetry, DetectEdgesCanny, DetectEdgesLaplacian, DetectEdgesRobertsCross, DetectFixedCirclesHough, DetectLinesHough, DetectRectangleHough, DetectRectlinearSymmetry, DilateModel, DrawCircles, DrawContours, DrawEllipses, DrawImageCenter, DrawKeyPoints, DrawRotatedRects, DrawTemplateMatches, FilterContours, FilterRects, FindContours, FitEllipseContours, GrabCut, HistogramEqualize, HistogramEqualizeAdaptive, ImageCapture, ImageRead, ImageRecall, ImageWrite, ImageWriteDebug, MaskCircle, MaskHsv, MaskModel, MaskPolygon, MaskRectangle, MatchPartsTemplate, MatchPartTemplate, MatchTemplate, MinAreaRect, MinAreaRectContours, MinEnclosingCircle, Normalize, OrientRotatedRects, ReadModelProperty, ReadPartTemplateImage, Rotate, ScriptRun, SelectSingleRect, SetColor, SetModel, SetResult, SimpleBlobDetector, SimpleOcr, SizeCheck, Threshold, ThresholdAdaptive, WritePartTemplateImage

public abstract class CvStage
extends java.lang.Object

Base class for a stage in a CvPipeline. A CvStage has a unique name within a pipeline and is able to perform computer vision operations resulting in either a modified working image or a new image and optional model data extracted from the image.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CvStage.CvStageBeanInfo
static class	CvStage.Result

Constructor Summary

Constructors

Constructor and Description
CvStage()

Method Summary

Modifier and Type	Method and Description
void	customizePropertySheet(PipelinePropertySheetTable table, CvPipeline pipeline) Stages can override to register customized PropertyEditors.
java.beans.BeanInfo	getBeanInfo()
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getDescription(java.lang.String propertyName)
LengthUnit	getLengthUnit()
java.lang.String	getName()
<T> T	getPossiblePipelinePropertyOverride(T parameter, CvPipeline pipeline, java.lang.String pipelinePropertyName, java.lang.Class<?>... acceptablePropertyTypes) Calls getPossiblePipelinePropertyOverride(Object, String, CvPipeline, String, Class...) with the stagePropertyName deducted from the pipelinePropertyName.
<T> T	getPossiblePipelinePropertyOverride(T parameter, java.lang.String stagePropertyName, CvPipeline pipeline, java.lang.String pipelinePropertyName, java.lang.Class<?>... acceptablePropertyTypes) Attempts to override a generic parameter value using a property from the pipeline.
boolean	isEnabled()
abstract CvStage.Result	process(CvPipeline pipeline) Perform an operation in a pipeline.
void	recordPropertyOverride(java.lang.String stagePropertyName, java.lang.Object stageProperty) Record the override of a stage property.
void	setEnabled(boolean enabled)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

CvStage

public CvStage()

Method Detail

process

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

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.

Parameters:

pipeline -

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

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getCategory

public java.lang.String getCategory()

getDescription

public java.lang.String getDescription()

getDescription

public java.lang.String getDescription(java.lang.String propertyName)

Parameters:

propertyName -

Returns:

The @Property.description annotation of the given field name.

getLengthUnit

public LengthUnit getLengthUnit()

getBeanInfo

public java.beans.BeanInfo getBeanInfo()

customizePropertySheet

public void customizePropertySheet(PipelinePropertySheetTable table,
                                   CvPipeline pipeline)

Stages can override to register customized PropertyEditors.

Parameters:

table -

pipeline -

getPossiblePipelinePropertyOverride

public <T> T getPossiblePipelinePropertyOverride(T parameter,
                                                 java.lang.String stagePropertyName,
                                                 CvPipeline pipeline,
                                                 java.lang.String pipelinePropertyName,
                                                 java.lang.Class<?>... acceptablePropertyTypes)
                                          throws java.lang.Exception

Attempts to override a generic parameter value using a property from the pipeline. If no overriding property is found on the pipeline, the parameter passes through unchanged. Handles the following conversions:

 Parameter Type(s)            Acceptable Pipeline Property Type(s)
 -----------------------      --------------------------------------------------------
 boolean, Boolean         <-  Boolean
 double, Double           <-  Double, Integer, Long, Area, Length
 int, Integer             <-  Double, Integer, Long, Area, Length
 long, Long               <-  Double, Integer, Long, Area, Length
 String                   <-  String
 org.opencv.core.Point    <-  org.opencv.core.Point, org.openpnp.model.Point, Location 
 org.openpnp.model.Point  <-  org.opencv.core.Point, org.openpnp.model.Point, Location
 Area                     <-  Area
 Length                   <-  Length
 Location                 <-  Location
 T                        <-  T (no conversion)
 

Note: Doubles are rounded before assignment to integer types; Java's standard narrowing conversions are applied where necessary; Area, Length, and Location are converted to pixels via the camera's units per pixel scaling; and Locations are taken as offsets from the image center

Parameters:

parameter - - the generic parameter value to be possibly overridden

pipeline - - the pipeline with the overriding property

pipelinePropertyName - - the name of the overriding pipeline property

acceptablePropertyTypes - - Zero or more acceptable types for the overriding property, if none are specified, the only acceptable type is the same type as the input parameter

Returns:

the overridden parameter value if a pipeline property override was found, otherwise the original parameter value

Throws:

java.lang.Exception - If a property is defined on the pipeline with the expected name but it could not be converted to the type of the input parameter

recordPropertyOverride

public void recordPropertyOverride(java.lang.String stagePropertyName,
                                   java.lang.Object stageProperty)

Record the override of a stage property. This is used to indicate it on the property editor UI.

Parameters:

stagePropertyName -

stageProperty -

getPossiblePipelinePropertyOverride

public <T> T getPossiblePipelinePropertyOverride(T parameter,
                                                 CvPipeline pipeline,
                                                 java.lang.String pipelinePropertyName,
                                                 java.lang.Class<?>... acceptablePropertyTypes)
                                          throws java.lang.Exception

Calls getPossiblePipelinePropertyOverride(Object, String, CvPipeline, String, Class...) with the stagePropertyName deducted from the pipelinePropertyName.

Type Parameters:

T -

Parameters:

parameter -

pipeline -

pipelinePropertyName -

acceptablePropertyTypes -

Returns:

Throws:

java.lang.Exception