Package adams.flow.source

Class WebcamImage

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.OutputProducer, Serializable, Comparable
    public class WebcamImage
extends adams.flow.source.AbstractSource
    Grabs a frame from the specified webcam.

    Input/output:
    - generates:
       adams.data.image.BufferedImageContainer


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WebcamImage
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -webcam <java.lang.String> (property: webcam)
    The webcam name (leave empty for default one).
    default: 
 
    -width <int> (property: width)
    The width of the image.
    default: 640
    minimum: 1
 
    -height <int> (property: height)
    The height of the image.
    default: 480
    minimum: 1
 
    -conversion <adams.data.conversion.BufferedImageToOtherFormatConversion> (property: conversion)
    The conversion for turning the adams.data.image.BufferedImageContainer into 
    another format if necessary.
    default: adams.data.conversion.BufferedImageToBufferedImage
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.conversion.BufferedImageToOtherFormatConversion m_Conversion
      the conversion to perform.
      protected com.github.sarxos.webcam.Webcam m_Current
      the webcam.
      protected int m_Height
      the height of the image.
      protected String m_Webcam
      the webcam to access.
      protected int m_Width
      the width of the image.

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      WebcamImage()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String conversionTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      Class[] generates()
      Returns a string describing the object.
      adams.data.conversion.BufferedImageToOtherFormatConversion getConversion()
      Returns the conversion for converting the BufferedImageContainer into another format if necessary.
      int getDefaultHeight()
      Returns the default height of the image.
      int getDefaultWidth()
      Returns the default width of the image.
      int getHeight()
      Returns the height of the image.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String getWebcam()
      Returns the webcam name (leave empty for default one).
      int getWidth()
      Returns the width of the image.
      String globalInfo()
      Returns a string describing the object.
      boolean hasPendingOutput()
      Checks whether there is pending output to be collected after executing the flow item.
      String heightTipText()
      Returns the tip text for this property.
      adams.flow.core.Token output()
      Returns the generated token.
      void setConversion​(adams.data.conversion.BufferedImageToOtherFormatConversion value)
      Sets the conversion for converting the BufferedImageContainer into another format if necessary.
      void setHeight​(int value)
      Sets the height of the image.
      void setWebcam​(String value)
      Sets the webcam name (leave empty for default one).
      void setWidth​(int value)
      Sets the width of the image.
      String webcamTipText()
      Returns the tip text for this property.
      String widthTipText()
      Returns the tip text for this property.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Width

        protected int m_Width
        the width of the image.

      • m_Height

        protected int m_Height
        the height of the image.

      • m_Conversion

        protected adams.data.conversion.BufferedImageToOtherFormatConversion m_Conversion
        the conversion to perform.

      • m_Webcam

        protected String m_Webcam
        the webcam to access.

      • m_Current

        protected transient com.github.sarxos.webcam.Webcam m_Current
        the webcam.

    • Constructor Detail

      • WebcamImage

        public WebcamImage()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.core.AbstractActor

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • setWebcam

        public void setWebcam​(String value)
        Sets the webcam name (leave empty for default one).
        Parameters:
        value - the webcam

      • getWebcam

        public String getWebcam()
        Returns the webcam name (leave empty for default one).
        Returns:
        the webcam

      • webcamTipText

        public String webcamTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultWidth

        public int getDefaultWidth()
        Returns the default width of the image.
        Returns:
        the default width

      • setWidth

        public void setWidth​(int value)
        Sets the width of the image.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width of the image.
        Returns:
        the width

      • widthTipText

        public String widthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultHeight

        public int getDefaultHeight()
        Returns the default height of the image.
        Returns:
        the default height

      • setHeight

        public void setHeight​(int value)
        Sets the height of the image.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height of the image.
        Returns:
        the height

      • heightTipText

        public String heightTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setConversion

        public void setConversion​(adams.data.conversion.BufferedImageToOtherFormatConversion value)
        Sets the conversion for converting the BufferedImageContainer into another format if necessary.
        Parameters:
        value - the conversion

      • getConversion

        public adams.data.conversion.BufferedImageToOtherFormatConversion getConversion()
        Returns the conversion for converting the BufferedImageContainer into another format if necessary.
        Returns:
        the conversion

      • conversionTipText

        public String conversionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • generates

        public Class[] generates()
        Returns a string describing the object.
        Returns:
        a description suitable for displaying in the gui

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Returns:
        true if there is pending output

      • output

        public adams.flow.core.Token output()
        Returns the generated token.
        Returns:
        the generated token

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished. Graphical output is left untouched.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.core.AbstractActor