Package adams.flow.transformer

Class CountObjectsInPolygon

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.CountObjectsInPolygon

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, ObjectPrefixHandler, Serializable, Comparable

public class CountObjectsInPolygon
extends AbstractTransformer
implements ObjectPrefixHandler

Counts the objects in the report passing through that fall into the defined region.
Partial hits can be counted as well, using their percentage in overlap as count.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_CheckType	whether to check the type (if a suffix provided).
protected boolean	m_OneBased	whether report contains one-based coordinates.
protected boolean	m_PartialCounts	whether to include partial counts.
protected String	m_Prefix	the prefix to use when generating a report.
protected BaseRegExp	m_TypeFind	the regular expression to apply to the type.
protected String	m_TypeSuffix	the suffix for the type.
protected String	m_X	the x coordinates.
protected String	m_Y	the y coordinates.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

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
CountObjectsInPolygon()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	checkTypeTipText()	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 the class of objects that it generates.
boolean	getCheckType()	Returns the field suffix for the type used in the report (ignored if empty).
boolean	getOneBased()	Returns whether to assume 1-based coordinates in report.
boolean	getPartialCounts()	Returns whether to include partial hits.
String	getPrefix()	Returns the field prefix used in the report.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
BaseRegExp	getTypeFind()	Returns the regular expression to apply to the type, ignored if no check.
String	getTypeSuffix()	Returns the field suffix for the type used in the report (ignored if no check).
String	getX()	Returns the comma-separated list of X coordinates (1-based).
String	getY()	Returns the comma-separated list of Y coordinates (1-based).
String	globalInfo()	Returns a string describing the object.
String	oneBasedTipText()	Returns the tip text for this property.
String	partialCountsTipText()	Returns the tip text for this property.
String	prefixTipText()	Returns the tip text for this property.
void	setCheckType(boolean value)	Sets whether to check the type as well.
void	setOneBased(boolean value)	Sets whether to assume 1-based coordinates in report.
void	setPartialCounts(boolean value)	Sets whether to include partial hits.
void	setPrefix(String value)	Sets the field prefix used in the report.
void	setTypeFind(BaseRegExp value)	Sets the regular expression to apply to the type, ignored if no check.
void	setTypeSuffix(String value)	Sets the field suffix for the type used in the report (ignored if no check).
void	setX(String value)	Sets the X coordinates (1-based) as comma-separated list.
void	setY(String value)	Sets the X coordinates (1-based) as comma-separated list.
String	typeFindTipText()	Returns the tip text for this property.
String	typeSuffixTipText()	Returns the tip text for this property.
String	XTipText()	Returns the tip text for this property.
String	YTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, 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, preExecute, pruneBackup, pruneBackup, reset, 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 class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, 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_X

protected String m_X

the x coordinates.

m_Y

protected String m_Y

the y coordinates.

m_PartialCounts

protected boolean m_PartialCounts

whether to include partial counts.

m_OneBased

protected boolean m_OneBased

whether report contains one-based coordinates.

m_Prefix

protected String m_Prefix

the prefix to use when generating a report.

m_CheckType

protected boolean m_CheckType

whether to check the type (if a suffix provided).

m_TypeSuffix

protected String m_TypeSuffix

the suffix for the type.

m_TypeFind

protected BaseRegExp m_TypeFind

the regular expression to apply to the type.

Constructor Detail

CountObjectsInPolygon

public CountObjectsInPolygon()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractActor

setX

public void setX(String value)

Sets the X coordinates (1-based) as comma-separated list.

Parameters:

value - the comma-separated list

getX

public String getX()

Returns the comma-separated list of X coordinates (1-based).

Returns:

the comma-separated list

XTipText

public String XTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setY

public void setY(String value)

Sets the X coordinates (1-based) as comma-separated list.

Parameters:

value - the comma-separated list

getY

public String getY()

Returns the comma-separated list of Y coordinates (1-based).

Returns:

the comma-separated list

YTipText

public String YTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPartialCounts

public void setPartialCounts(boolean value)

Sets whether to include partial hits.

Parameters:

value - true if to include partial hits

getPartialCounts

public boolean getPartialCounts()

Returns whether to include partial hits.

Returns:

true if to count partial hits

partialCountsTipText

public String partialCountsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setOneBased

public void setOneBased(boolean value)

Sets whether to assume 1-based coordinates in report.

Parameters:

value - true if to use 1-based coordinates

getOneBased

public boolean getOneBased()

Returns whether to assume 1-based coordinates in report.

Returns:

true if to use 1-based coordinates

oneBasedTipText

public String oneBasedTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPrefix

public void setPrefix(String value)

Sets the field prefix used in the report.

Specified by:

setPrefix in interface ObjectPrefixHandler

Parameters:

value - the field prefix

getPrefix

public String getPrefix()

Returns the field prefix used in the report.

Specified by:

getPrefix in interface ObjectPrefixHandler

Returns:

the field prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Specified by:

prefixTipText in interface ObjectPrefixHandler

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCheckType

public void setCheckType(boolean value)

Sets whether to check the type as well.

Parameters:

value - true if to check

getCheckType

public boolean getCheckType()

Returns the field suffix for the type used in the report (ignored if empty).

Returns:

true if to check

checkTypeTipText

public String checkTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setTypeSuffix

public void setTypeSuffix(String value)

Sets the field suffix for the type used in the report (ignored if no check).

Parameters:

value - the field suffix

getTypeSuffix

public String getTypeSuffix()

Returns the field suffix for the type used in the report (ignored if no check).

Returns:

the field suffix

typeSuffixTipText

public String typeSuffixTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setTypeFind

public void setTypeFind(BaseRegExp value)

Sets the regular expression to apply to the type, ignored if no check.

Parameters:

value - the expression

getTypeFind

public BaseRegExp getTypeFind()

Returns the regular expression to apply to the type, ignored if no check.

Returns:

the expression

typeFindTipText

public String typeFindTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

the Class of the generated tokens

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message