Uses of Interface
adams.core.option.OptionHandler
-
-
Uses of OptionHandler in adams.console
Classes in adams.console that implement OptionHandler Modifier and Type Class Description classAbstractConsoleApplicationAncestor for simple console applications.classLoggingAllows to capture the logging of an ADAMS instance. -
Uses of OptionHandler in adams.core
Subinterfaces of OptionHandler in adams.core Modifier and Type Interface Description interfaceDeepCopyOperatorInterface for option handlers that can perform optional deep copies.Classes in adams.core that implement OptionHandler Modifier and Type Class Description classNumericStringCompareCompares the numeric portion of two String objects by extracting it using the supplied regexp.classPropertiesToCodeTurns a Properties object into Java code.classVariablesFinderOption traverser for locating variables.Methods in adams.core with parameters of type OptionHandler Modifier and Type Method Description static StringQuickInfoHelper. getVariable(OptionHandler handler, String property)Returns the variable attached to optionhandler's property.static booleanQuickInfoHelper. hasVariable(OptionHandler handler, String property)Checks whether a variable is attached to the optionhandler's property.static StringQuickInfoHelper. toString(OptionHandler handler, String property, boolean current, String text)Returns either the variable name attached to optionhandler's property or the text if the current value is true.static StringQuickInfoHelper. toString(OptionHandler handler, String property, boolean current, String text, String prefix)Returns either the variable name attached to optionhandler's property or the text if the current value is true.static StringQuickInfoHelper. toString(OptionHandler handler, String property, BaseRegExp current)Returns either the variable name attached to optionhandler's property or the current value as string.static StringQuickInfoHelper. toString(OptionHandler handler, String property, BaseRegExp current, String prefix)Returns either the variable name attached to optionhandler's property or the current value as string.static StringQuickInfoHelper. toString(OptionHandler handler, String property, BaseRegExp current, String ifEmpty, String prefix)Returns either the variable name attached to optionhandler's property or the current value as string.static StringQuickInfoHelper. toString(OptionHandler handler, String property, Object current)Returns either the variable name attached to optionhandler's property or the current value as string.static StringQuickInfoHelper. toString(OptionHandler handler, String property, Object current, String prefix)Returns either the variable name attached to optionhandler's property or the current value as string. -
Uses of OptionHandler in adams.core.command
Subinterfaces of OptionHandler in adams.core.command Modifier and Type Interface Description interfaceAsyncCapableExternalCommandInterface for external commands that support asynchronous mode.interfaceExternalCommandInterface for classes that execute external commands.interfaceExternalCommandWithOptionsInterface for external commands that take options.interfaceExternalCommandWithProgrammaticArgumentsInterface for external commands that support programmatic options that get folded into the command.Classes in adams.core.command that implement OptionHandler Modifier and Type Class Description classAbstractAsyncCapableExternalCommandAncestor for external commands that can be run in blocking or async mode.classAbstractAsyncCapableExternalCommandWithOptionsAncestor for commands that can be run in async mode that support options.classAbstractExternalCommandAncestor for external commands.classAbstractExternalCommandWithOptionsAncestor for commands that take options. -
Uses of OptionHandler in adams.core.command.output
Classes in adams.core.command.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputFormatterAncestor for output formatters.classLineSplitSplits the incoming data on the new line character and forwards string arrays.classPassThroughSimply forwards the received output without any processing. -
Uses of OptionHandler in adams.core.command.stderr
Subinterfaces of OptionHandler in adams.core.command.stderr Modifier and Type Interface Description interfaceStdErrProcessorInterface for classes that process stderr output.Classes in adams.core.command.stderr that implement OptionHandler Modifier and Type Class Description classAbstractStdErrProcessorAncestor for processing the command output received on stderr.classCallableActorSinkForwards the data to the callable actor sink.classEnqueueAdds the output from stderr to the specified queue.classLogOutputs the data received from the command's stderr via its logger instance.classNullSimply suppresses any output. -
Uses of OptionHandler in adams.core.command.stdout
Subinterfaces of OptionHandler in adams.core.command.stdout Modifier and Type Interface Description interfaceStdOutProcessorInterface for classes that process stdout output.Classes in adams.core.command.stdout that implement OptionHandler Modifier and Type Class Description classAbstractStdOutProcessorAncestor for processing the command output received on stdout.classCallableActorSinkForwards the data to the callable actor sink.classEnqueueAdds the output from stdout to the specified queue.classLogOutputs the data received from the command's stdout via its logger instance.classNullSimply suppresses any output. -
Uses of OptionHandler in adams.core.discovery
Classes in adams.core.discovery that implement OptionHandler Modifier and Type Class Description classAbstractDiscoveryHandlerAncestor for discovery algorithms.classActorHandles actors. -
Uses of OptionHandler in adams.core.discovery.genetic
Classes in adams.core.discovery.genetic that implement OptionHandler Modifier and Type Class Description classAbstractGeneticDiscoveryHandlerAncestor for genetic algorithm related discovery handlers.classAbstractGeneticDoubleDiscoveryHandlerAncestor for genetic discovery handlers that handle integer properties.classAbstractGeneticDoubleDiscoveryHandlerResolutionAncestor for genetic discovery handlers that handle double properties with a specified number of splits.classAbstractGeneticDoubleMatrixDiscoveryHandlerAncestor for genetic discovery handlers that handle matrix properties.classAbstractGeneticFloatDiscoveryHandlerAncestor for genetic discovery handlers that handle integer properties.classAbstractGeneticFloatDiscoveryHandlerResolutionAncestor for genetic discovery handlers that handle float properties with a specified number of splits.classAbstractGeneticIntegerArrayDiscoveryHandlerAncestor for genetic discovery handlers that handle integer array properties.classAbstractGeneticIntegerDiscoveryHandlerAncestor for genetic discovery handlers that handle integer properties.classAbstractGeneticStringDiscoveryHandlerAncestor for genetic discovery handlers that handle string properties.classGenericDoubleResolutionGeneric handler for double properties (using resolution).classGenericFloatResolutionGeneric handler for float properties (using resolution).classGenericIntegerGeneric handler for integer properties.classGenericStringGeneric handler for string properties.classGPDGammaGPD gamma handler.classGPDNoiseGPD noise handler.classPLSFilterNumComponentsSavitzkyGolay numPoints handler.classSavitzkyGolay2NumPointsSavitzkyGolay numPoints handler.classSIMPLSWeightsMatrixSIMPLS pls internal weights handler. -
Uses of OptionHandler in adams.core.io
Classes in adams.core.io that implement OptionHandler Modifier and Type Class Description classAbstractFilenameGeneratorAncestor for filename generators.classAbstractFilenameGeneratorWithDirectoryAncestor for filename generators that use a directory.classAbstractFilenameGeneratorWithExtensionAncestor for filename generators that require a provided extension.classDefaultFilenameGeneratorThe default generator for database ID and ID handlers.classFixedFilenameGeneratorSimple concatenates directory, provided name and extension.classNullFilenameGeneratorDummy filename generator, always outputs null.classReportFieldFilenameGeneratorObtains the filename from a field in the attached report.classSimpleFilenameGeneratorSimple generator that assembles filename based on output dir, prefix, current object (string representation), suffix and extension.classSimpleFixedFilenameGeneratorSimply returns the supplied file name.classSimpleObjectToStringFilenameGeneratorSimple generator that just turns the incoming object into a string using the 'toString()' method.classTimestampFilenameGeneratorGenerator that assembles a filename based on output dir, prefix, current timestamp (according to format string), suffix and extension. -
Uses of OptionHandler in adams.core.io.filechanged
Classes in adams.core.io.filechanged that implement OptionHandler Modifier and Type Class Description classAbstractFileChangeMonitorAncestor for file change monitors.classAbstractMessageDigestBasedMonitorAncestor for message digest based monitors.classFlowFileDigestGenerates a message digest for a flow file and uses that for comparison.classLastModifiedUses the lastmodified timestamp.classMessageDigestGenerates a message digest and uses that for comparison.classMultiMonitorCombines the results of the specified monitors according to the combination type.classNoChangeDummy, never reports a change.classSizeUses the file size. -
Uses of OptionHandler in adams.core.io.filecomplete
Classes in adams.core.io.filecomplete that implement OptionHandler Modifier and Type Class Description classAbstractFileCompleteCheckAncestor for classes that check whether a file is complete.classAbstractStrictCheckSizeFileCompleteCheckAncestor for checks that look for EOF markers that can limit the number of bytes to read from the end of the file used to look for the EOF marker.classAbstractStrictFileCompleteCheckAncestor for file checks thatclassBMPChecks whether the BMP file has sufficient bytes according to its header.
See also:
https://en.wikipedia.org/wiki/BMP_file_format#File_structure
classJPEGChecks whether the JPEG file ends with bytes FFD9 (EOF for JPEGs).
See also:
http://en.wikipedia.org/wiki/JPEG#Syntax_and_structure
classJSONChecks whether the JSON can be parsed.classNoCheckPerforms no check, always states that file is complete.classPNGChecks whether the PNG file ends with bytes IEND (EOF for PNGs).
See also:
https://en.wikipedia.org/wiki/Portable_Network_Graphics#Critical_chunks
http://www.libpng.org/pub/png/spec/1.2/PNG-Structure.html#Chunk-layout
http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html#C.IEND
classXMLChecks whether the XML can be parsed. -
Uses of OptionHandler in adams.core.io.filesearch
Classes in adams.core.io.filesearch that implement OptionHandler Modifier and Type Class Description classAbstractFileSearchHandlerAncestor for search handlers.classAbstractFileSearchHandlerWithEncodingAncestor for file search handlers that use file encodings.classAbstractMetaFileSearchHandlerAncestor for file search handlers that use the base handler to do the actual search.classAbstractMetaFileSearchHandlerWithEncodingAncestor for file search handlers that use file encodings.classBzip2FileSearchHandlerSearches bzip2-compressed (text) files.classGzipFileSearchHandlerSearches gzip-compressed (text) files.classLzfFileSearchHandlerSearches lzf-compressed (text) files.classLzmaFileSearchHandlerSearches lzma-compressed (text) files.classRarFileSearchHandlerSearches rar-compressed (text) files.classTextFileSearchHandlerSearches text files, skips binary files.classXzFileSearchHandlerSearches xz-compressed (text) files.classZipFileSearchHandlerSearches zip-compressed (text) files.classZstdFileSearchHandlerSearches zstd-compressed (text) files. -
Uses of OptionHandler in adams.core.io.fileuse
Classes in adams.core.io.fileuse that implement OptionHandler Modifier and Type Class Description classAbstractFileUseCheckAncestor for classes that check whether a file is in use.classDefaultOn Unix/Linux, uses 'lsof' to determine file use.classDeserializeAttempts to deserialize the file.classFileIncompleteAssumes the file to be in use when not complete, i.e., still being written.classFileSizeChangeChecks the file size before and after the specified wait interval.classImageMetaDataExtractorUses the specified image reader to load the file for checking the 'in use' state: if reading fails, then it is assumed the file is in use.classImageReaderUses the specified image reader to load the file for checking the 'in use' state: if reading fails, then it is assumed the file is in use.classJpegIsCompleteChecks whether the JPEG file ends with bytes FFD9 (EOF for JPEGs).
See also:
http://en.wikipedia.org/wiki/JPEG#Syntax_and_structure
classLastLineMatchesReads the file as text file and makes sure that the last line matches the regular expression.
If the last line doesn't match the expression, failing to read or reading no lines at all are all interpreted as 'in use'.classMultiCheckApplies the specified checks sequentially, stops as soon one of them returns that the file is 'in use'.classNoCheckPerforms no check, always states that file is not in use.classNonWindowsUses 'lsof' to determine file use (OS other than Windows).classPngIsCompleteChecks whether the PNG file ends with bytes IEND (EOF for PNGs).
See also:
https://en.wikipedia.org/wiki/Portable_Network_Graphics#Critical_chunks
http://www.libpng.org/pub/png/spec/1.2/PNG-Structure.html#Chunk-layout
http://www.libpng.org/pub/png/spec/1.2/PNG-Chunks.html#C.IEND
classTextReaderUses the specified text reader to load the file for checking the 'in use' state: if reading fails, then it is assumed the file is in use.classWindowsTries to open a FileOutputStream (Windows only). -
Uses of OptionHandler in adams.core.management
Subinterfaces of OptionHandler in adams.core.management Modifier and Type Interface Description interfaceEnvironmentVariablesHandlerInterface for classes that handle environment variables.interfaceOptionHandlingLocaleSupporterInterface for option handlers that support a user-specified Locale.interfaceRestartableApplicationFor applications that can be restarted via the Launcher class.interfaceWorkingDirectoryHandlerInterface for classes that manage a working directory. -
Uses of OptionHandler in adams.core.net
Classes in adams.core.net that implement OptionHandler Modifier and Type Class Description classAbstractSendEmailAncestor for classes that can send emails.classApacheSendEmailUses Apache commons-netSMTPClientorSMTPSClientfor sending emails.classEmailContactEncapsulates an email contact.classJavaMailSendEmailUses JavaMail for sending emails.classSimpleApacheSendEmailUses Apache commons-email for sending emails. -
Uses of OptionHandler in adams.core.net.hostnameverifier
Classes in adams.core.net.hostnameverifier that implement OptionHandler Modifier and Type Class Description classAbstractHostnameVerifierAncestor for hostname verifiers.classAllVerifies all hosts.classRegExpHostnames must match regular expression. -
Uses of OptionHandler in adams.core.net.trustmanager
Classes in adams.core.net.trustmanager that implement OptionHandler Modifier and Type Class Description classAbstractTrustManagerAncestor for SSL trust managers.classAllTrusts all certificates. -
Uses of OptionHandler in adams.core.option
Subinterfaces of OptionHandler in adams.core.option Modifier and Type Interface Description interfaceOptionConsumerWithOptionHandling<C,V>Interface for option consumers that offer option handling.interfaceOptionProducerWithOptionHandling<O,I>Interface for option producers that offer option handling.Classes in adams.core.option that implement OptionHandler Modifier and Type Class Description classAbstractActorJavaCodeProducerAncestor for producers that generate Java code from actors.classAbstractDocumentationProducer<O>Ancestor for producers that generate documentation that is split into two parts: 1.classAbstractFlowJavaCodeProducerAncestor for producers that generate Java code from flows.classAbstractJavaCodeProducerAncestor for producers that generate Java code.classAbstractOptionGroupAncestor for grouped options.classAbstractOptionHandlerAbstract superclass for classes that handle options.classAbstractOptionTraverserAncestor for option traversers.classAbstractOptionTraverserWithResult<T>Ancestor for option traversers that return a result.classAbstractRecursiveOptionProducerWithOptionHandling<O,I>Ancestor for recursive option producers that offer option handling.classActorExecutionClassProducerGenerates a wrapper class for executing an actor.classApplyActorProducerGenerates a Java class that allows executing/applying an actor as a method.classDatabaseActorExecutionClassProducerGenerates a wrapper for an actor that works in conjunction with a database.classFileListerLists all file objects.classFlowJUnitTestProducerGenerates a JUnit test case for flows.classFlowStructureDotProducerOutputs the flow structure in DOT (GraphViz) format.classFlowStructureGraphMLProducerOutputs the flow structure in GraphML XML format.classJavaInstantiationProducerGenerates Java code for instantiating the object.classVariableListerLists all variables in the flow.classVariablesInstanceListerLists the hashcodes of the adams.core.Variables objects in use by the adams.core.option.OptionManager objects.classXhtmlProducerGenerates documentation in XHTML.Fields in adams.core.option declared as OptionHandler Modifier and Type Field Description protected OptionHandlerAbstractOptionProducer. m_Inputthe top-level visited object.protected OptionHandlerAbstractOptionConsumer. m_Outputthe generated object.protected OptionHandlerOptionManager. m_Ownerthe owner.Methods in adams.core.option that return OptionHandler Modifier and Type Method Description protected OptionHandlerAbstractOptionProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.protected OptionHandlerCompactFlowProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.protected OptionHandlerFlowStructureDotProducer. checkInput(OptionHandler object)Makes sure that the input is an Actor object.protected OptionHandlerFlowStructureGraphMLProducer. checkInput(OptionHandler object)Makes sure that the input is an Actor object.protected OptionHandlerMaterializedArrayProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.OptionHandlerAbstractOptionConsumer. consume()Consumes the current input.OptionHandlerAbstractOptionConsumer. consume(OptionHandler output, C input)Consumes the provided input and updates the provided option handler.static OptionHandlerAbstractOptionConsumer. consume(Class<? extends OptionConsumer> cls, Object input)Uses the specified consumer to process the given object and return the option handler.OptionHandlerOptionConsumer. consume()Consumes the current input.OptionHandlerOptionConsumer. consume(OptionHandler output, C input)Consumes the provided input and updates the provided option handler.static OptionHandlerOptionUtils. forCommandLine(Class classType, String cmdline)Creates a new instance of an option handler given its command-line, including class name and (optional) arguments to pass to its setOptions method.static OptionHandlerOptionUtils. forCommandLine(Class classType, String cmdline, MessageCollection warnings, MessageCollection errors, boolean quiet)Creates a new instance of an option handler given its command-line, including class name and (optional) arguments to pass to its setOptions method.static OptionHandler[]OptionUtils. forCommandLines(Class classType, String[] cmdlines)Creates new instances of option handlers given their command-line, including class name and (optional) arguments to pass to its setOptions method.OptionHandlerAbstractOptionConsumer. fromFile(File file)Processes the specified file.static OptionHandlerAbstractOptionConsumer. fromFile(Class<? extends OptionConsumer> cls, File file)Uses the specified consumer to parse the content of the specified file and return the option handler.OptionHandlerOptionConsumer. fromFile(File file)Processes the specified file.static OptionHandlerAbstractOptionConsumer. fromString(Class<? extends OptionConsumer> cls, String s)Uses the specified consumer to parse the given string and return the option handler.OptionHandlerAbstractOptionConsumer. fromString(String s)Processes the specified string.OptionHandlerOptionConsumer. fromString(String s)Processes the specified string.OptionHandlerAbstractOptionProducer. getInput()Returns the visited top-level object.OptionHandlerOptionProducer. getInput()Returns the visited top-level object.OptionHandlerAbstractOption. getOptionHandler()Returns the option handler this option belongs to.OptionHandlerAbstractOptionConsumer. getOutput()Returns the visited top-level object.OptionHandlerOptionConsumer. getOutput()Returns the visited top-level object.OptionHandlerOptionManager. getOwner()Returns the owning OptionHandler.protected abstract OptionHandlerAbstractOptionConsumer. initOutput()Creates the empty option handler from the internal data structure and returns it.protected OptionHandlerArrayConsumer. initOutput()Creates the empty option handler from the internal data structure and returns it.protected OptionHandlerCompactFlowConsumer. initOutput()Creates the empty option handler from the internal data structure and returns it.protected OptionHandlerJsonConsumer. initOutput()Initializes the output data structure.protected OptionHandlerNestedConsumer. initOutput()Creates the empty option handler from the internal data structure and returns it.OptionHandlerAbstractOptionConsumer. read(String filename)Reads the option handler from the specified file.OptionHandlerOptionConsumer. read(String filename)Reads the option handler from the specified file.static OptionHandler[]OptionUtils. shallowCopy(OptionHandler[] o, boolean expand)Creates an OptionHandler array with the same options as the specified one.static OptionHandler[]OptionUtils. shallowCopy(OptionHandler[] o, boolean expand, boolean transferVars)Creates an OptionHandler array with the same options as the specified one.static OptionHandlerOptionUtils. shallowCopy(OptionHandler o, boolean expand)Creates an OptionHandler object with the same options as the specified one.static OptionHandlerOptionUtils. shallowCopy(OptionHandler o, boolean expand, boolean transferVars)Creates an OptionHandler object with the same options as the specified one.Methods in adams.core.option with parameters of type OptionHandler Modifier and Type Method Description protected OptionHandlerAbstractOptionProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.protected OptionHandlerCompactFlowProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.protected OptionHandlerFlowStructureDotProducer. checkInput(OptionHandler object)Makes sure that the input is an Actor object.protected OptionHandlerFlowStructureGraphMLProducer. checkInput(OptionHandler object)Makes sure that the input is an Actor object.protected OptionHandlerMaterializedArrayProducer. checkInput(OptionHandler object)Hook method for performing checks on the input.OptionHandlerAbstractOptionConsumer. consume(OptionHandler output, C input)Consumes the provided input and updates the provided option handler.OptionHandlerOptionConsumer. consume(OptionHandler output, C input)Consumes the provided input and updates the provided option handler.static PropertyDescriptorOptionUtils. getDescriptor(OptionHandler owner, String property)Returns the bean property descriptor for the get/set methods.static String[]ArrayProducer. getOptions(OptionHandler handler)Returns the string array with all the options of the handler, but without the classname of the handler.static StringOptionUtils. list(OptionHandler handler)Returns a string with all the options listed.OAbstractOptionProducer. produce(OptionHandler visitedObject)Visits the option and obtains information from it.static ObjectAbstractOptionProducer. produce(Class<? extends OptionProducer> cls, OptionHandler handler)Uses the specified producer to process the option handler and return the generated data structure.ListCompactFlowProducer. produce(OptionHandler visitedObject)Visits the option and obtains information from it.OOptionProducer. produce(OptionHandler visitedObject)Visits the option and obtains information from it.static voidArrayConsumer. setOptions(OptionHandler handler, String[] options)Sets the options of the option handler.static voidArrayConsumer. setOptions(OptionHandler handler, String[] options, boolean remaining)Sets the options of the option handler.static OptionHandler[]OptionUtils. shallowCopy(OptionHandler[] o, boolean expand)Creates an OptionHandler array with the same options as the specified one.static OptionHandler[]OptionUtils. shallowCopy(OptionHandler[] o, boolean expand, boolean transferVars)Creates an OptionHandler array with the same options as the specified one.static OptionHandlerOptionUtils. shallowCopy(OptionHandler o, boolean expand)Creates an OptionHandler object with the same options as the specified one.static OptionHandlerOptionUtils. shallowCopy(OptionHandler o, boolean expand, boolean transferVars)Creates an OptionHandler object with the same options as the specified one.static StringAbstractOptionProducer. toString(Class<? extends OptionProducer> cls, OptionHandler handler)Uses the specified producer to generate a string representation of the given option handler.static booleanOptionUtils. transferOptions(OptionHandler source, OptionHandler dest)Transfers the option from oneOptionHandlerto another.Constructors in adams.core.option with parameters of type OptionHandler Constructor Description OptionManager(OptionHandler owner)Initializes the manager. -
Uses of OptionHandler in adams.core.option.help
Classes in adams.core.option.help that implement OptionHandler Modifier and Type Class Description classAbstractHelpGeneratorAncestor for help generators.classAdditionalInformationGenerates help for classes that implement the adams.core.AdditionalInformationHandler interface.classCapabilitiesInfoGenerates help for classes that implement the adams.ml.capabilities.CapabilitiesHandler interface.classClassCrossReferencesGenerates help for cross-references of classes that implement the adams.core.ClassCrossReference interface.classConditionalEquivalentActorGenerates help for classes that implement the adams.flow.core.ActorWithConditionalEquivalent interface.classDeprecationGenerates help for deprecated classes.classSupportedTagsGenerates help for classes that implement the adams.data.processing.TagProcessor interface. -
Uses of OptionHandler in adams.core.optiontransfer
Methods in adams.core.optiontransfer with parameters of type OptionHandler Modifier and Type Method Description protected voidAbstractOptionTransfer. transferVariable(OptionHandler source, OptionHandler target, String property)Transfers the variable (if any attached).protected voidAbstractOptionTransfer. transferVariable(OptionHandler source, String sourceProperty, OptionHandler target, String targetProperty)Transfers the variable (if any attached) form one property to another. -
Uses of OptionHandler in adams.core.scripting
Classes in adams.core.scripting that implement OptionHandler Modifier and Type Class Description classAbstractScriptingHandlerAncestor for all scripting handlers.classDummyDummy handler, which does nothing.classGroovyHandlerScripting handler for Groovy. -
Uses of OptionHandler in adams.core.shutdown
Classes in adams.core.shutdown that implement OptionHandler Modifier and Type Class Description classAbstractShutdownHookAncestor for shutdown hooks for the JVM.classMultiHookExecutes the specified hooks sequentially.classNullDummy, does nothing.classPIDJust outputs message with PID on stdout.classStopFlowsStops registered flows. -
Uses of OptionHandler in adams.data
Subinterfaces of OptionHandler in adams.data Modifier and Type Interface Description interfaceCompressionSupporterInterface forAbstractDataContainerWriterclasses that support compression. -
Uses of OptionHandler in adams.data.analysis
Classes in adams.data.analysis that implement OptionHandler Modifier and Type Class Description classAbstractAnalysis<T>Ancestor for data analysis classes. -
Uses of OptionHandler in adams.data.areaoverlap
Subinterfaces of OptionHandler in adams.data.areaoverlap Modifier and Type Interface Description interfaceAreaOverlapInterface for classes that compute the overlapping areas between annotations and predictions.Classes in adams.data.areaoverlap that implement OptionHandler Modifier and Type Class Description classAbstractAreaOverlapAncestor for area overlap computation schemes.classBoundingBoxBasedUses bounding boxes for the calculation.classPolygonBasedUses polygons for the calculation. -
Uses of OptionHandler in adams.data.autocorrelation
Classes in adams.data.autocorrelation that implement OptionHandler Modifier and Type Class Description classAbstractAutoCorrelationAncestor for autocorrelatin algorithms..classBruteForceUses brute force approach to autocorrelation.
For more information see:
WikiPedia.classFFTUses FFT approach to autocorrelation.
For more information see:
WikiPedia. -
Uses of OptionHandler in adams.data.barcode.decode
Classes in adams.data.barcode.decode that implement OptionHandler Modifier and Type Class Description classAbstractBarcodeDecoderAncestor for Barcode decoders.classMultiQRCodeDecodes all the QR codes using the ZXing library.
For more information see:
https://github.com/zxing/zxing
classPassThroughDummy decoder, does nothing.classZXingDecodes the data in a barcode using the ZXing library.
For more information see:
https://github.com/zxing/zxing
-
Uses of OptionHandler in adams.data.barcode.encode
Classes in adams.data.barcode.encode that implement OptionHandler Modifier and Type Class Description classAbstractBarcodeEncoderAncestor for barcode encoders, i.e., classes that generated barcode images.classEAN13Draws an EAN13 barcode at a specified location and size.Digits must be 13 characters long.classPassThrough* Dummy barcode type, draws nothing.classQRCodeDraws a QR code at a specified location and size.classUPCADraws a UPCA barcode at a specified location and size.Digits must be 11 (checksum gets calculated) or 12 (incl. -
Uses of OptionHandler in adams.data.baseline
Classes in adams.data.baseline that implement OptionHandler Modifier and Type Class Description classAbstractBaselineCorrection<T extends DataContainer>Abstract base class for baseline correction schemes.classAbstractDatabaseConnectionBaselineCorrection<T extends DataContainer>Ancestor for baseline correction schemes that require database access.classAbstractLinearRegressionBased<T extends DataContainer>Abstract ancestor for linear regression based baseline correction schemes.classAbstractLOWESSBased<T extends DataContainer>Ancestor for LOWESS-based baseline correction schemes.classAbstractSavitzkyGolayBased<T extends DataContainer>Ancestor for SavitzkyGolay-based baseline correction schemes.classPassThroughDummy scheme, performs no basline correction at all.classSlidingWindow<T extends DataContainer>Applies a baseline correction scheme on partitions of the data with a sliding window approach.classTimeseriesLOWESSBasedA baseline correction scheme that uses LOWESS smoothing to determine the baseline.
For more information see:
WikiPedia.classTimeseriesSavitzkyGolayBasedA baseline correction scheme that uses SavitzkyGolay smoothing to determine the baseline.
For more information see:
A. -
Uses of OptionHandler in adams.data.binning.algorithm
Subinterfaces of OptionHandler in adams.data.binning.algorithm Modifier and Type Interface Description interfaceBinningAlgorithmInterface for binning algorithms.interfaceFixedBinWidthBinningAlgorithmInterface for binning algorithms that require a fixed bin width.interfaceFixedNumBinsBinningAlgorithmInterface for binning algorithms that require to specify the number of bins.Classes in adams.data.binning.algorithm that implement OptionHandler Modifier and Type Class Description classAbstractBinningAlgorithmAncestor for binning algorithms.classAbstractEqualWidthBinningAlgorithmAncestor for algorithms that use bins with the same width.classDensityBinningPerforms density-based binning.classFreedmanDiaconisChoiceBinningThe Freedman-Diaconis' choice is based on the interquartile range.classFrequencyBinningPerforms frequency binning.classManualBinningGenerates a predefined number of equal sized bins.classNoBinningPerforms no real binning, just places all items in one bin.classRiceRuleBinningThe Rice Rule is presented as a simple alternative to Sturges's rule.classScottsNormalReferenceRuleBinningScott's normal reference rule is optimal for random samples of normally distributed data, in the sense that it minimizes the integrated mean squared error of the density estimate.classSquareRootChoiceBinningTakes the square root of the number of data points in the sample used by Excel histograms and many others) and rounds to the next integer.classSturgesFormulaBinningSturges' formula is derived from a binomial distribution and implicitly assumes an approximately normal distribution. -
Uses of OptionHandler in adams.data.binning.postprocessing
Subinterfaces of OptionHandler in adams.data.binning.postprocessing Modifier and Type Interface Description interfaceBinPostProcessingInterface for schemes for post-processing bins.Classes in adams.data.binning.postprocessing that implement OptionHandler Modifier and Type Class Description classAbstractBinPostProcessingAncestor for schemes for post-processing bins.classMinBinSizeEnsures that bins have the specified minimum number of objects stored.classPassThroughPerforms no post-processing. -
Uses of OptionHandler in adams.data.boofcv.features
Classes in adams.data.boofcv.features that implement OptionHandler Modifier and Type Class Description classAbstractBoofCVFeatureGeneratorAbstract base class for BoofCV feature generation.classAbstractScriptAncestor for BoofCV feature generator scripts.classAbstractScriptedFeatureGeneratorAbstract ancestor for BoofCV feature generator that execute external scripts.classFilteredBoofCVFeatureGeneratorApplies the filter (an image transformer) to the image first before generating the features from the transformed images.classHistogramGenerates a histogram from the image.classMultiBoofCVFeatureGeneratorApplies multiple generators to the same image and merges the generate a feature vectors side-by-side.classOtsuComputes the variance based threshold using Otsu's method from an input image (gray scale; boofcv.struct.image.GrayU8).
For more information see:
WikiPedia.classPixelsGets all the pixels of the image.classScriptedA feature generator that uses any scripting handler for processing the data with a script located in the specified file. -
Uses of OptionHandler in adams.data.boofcv.multiimageoperation
Classes in adams.data.boofcv.multiimageoperation that implement OptionHandler Modifier and Type Class Description classAbstractBoofCVMultiImageOperationAbstract base class for operations that require multiple images of type BoofCVImageContainer.classAndPerforms a logical AND on the binary pixels of the images.
Converts images automatically to type UNSIGNED_INT_8.classDiffCompares two images and returns a third image with the differences between them
classOrPerforms a logical OR on the binary pixels of the images.
Converts images automatically to type UNSIGNED_INT_8.classPassThroughDummy operation, simply passes on the input images.classReportFieldSubtractionFor each of the specified report fields, the difference between the value from the first report and the second is calculated.classXOrPerforms a logical XOR on the binary pixels of the images.
Converts images automatically to type UNSIGNED_INT_8. -
Uses of OptionHandler in adams.data.boofcv.transformer
Classes in adams.data.boofcv.transformer that implement OptionHandler Modifier and Type Class Description classAbstractBoofCVTransformerAbstract base class for BoofCV transformations.classAbstractScriptAncestor for BoofCV transformer scripts.classAbstractScriptedTransformerAbstract ancestor for transformers that execute external scripts.classBinaryCreates a binary image.classBinaryContoursUses the BoofCV binary contours algorithm to detect edges in a binary image.classCannyEdgeDetectionPerforms edge detection using the Canny Edge detection algorithm.
For more information on the algorithm, see:
WikiPedia.classDilate4Applies the BoofCV dilate4 algorithm to a binary image.classDilate8Applies the BoofCV dilate8 algorithm to a binary image.classErode4Applies the BoofCV erode4 algorithm to a binary image.classErode8Applies the BoofCV erode8 algorithm to a binary image.classGray8Transforms the image into an 8-bit gray image.classImageTypeTurns an image into the specified type of image.classInverterTakes a binary image in the BoofCV Unsigned Int 8 format and inverts each pixel.classMultiTransformerApplies the specified BoofCV transformers one after the other.classPassThroughA dummy transform that just passes the image through.classScriptedAn image transformer that uses any scripting handler for processing the data with a script located in the specified file.classSharpen4Applies a Laplacian-4 based sharpen filter to the image.classSharpen8Applies a Laplacian-8 based sharpen filter to the image.classSuperPixelsTakes an image and divides it into super pixels.
For more information see:
http://boofcv.org/index.php?title=Tutorial_Image_Segmentation
classWaveletDenoiseRemoves noise using wavelet transformation. -
Uses of OptionHandler in adams.data.compare
Classes in adams.data.compare that implement OptionHandler Modifier and Type Class Description classAbstractObjectCompare<T,R>Ancestor for classes that compare objects and return a result.classDataContainerCompares adams.data.container.DataContainer objects (header, data or both) and returns the result of that comparison.classJavaComparableCompares objects that implement the Java java.lang.Comparable interface and returns the result of that comparison. -
Uses of OptionHandler in adams.data.conversion
Classes in adams.data.conversion that implement OptionHandler Modifier and Type Class Description classAbstractConversionAncestor for all conversions.classAbstractConversionFromStringAncestor for conversion schemes that convert strings into other objects.classAbstractConversionToStringAncestor for conversion schemes that convert objects into strings.classAbstractImageToByteArrayConverts an image into a byte array.classAbstractInPlaceSpreadSheetConversionAncestor for spreadsheet conversion that allow working on the incoming data rather than on a copy (to conserve memory).classAbstractMatchWekaInstanceAgainstHeaderAncestor for classes that match Instance objects against Instances headers.classAbstractMatrixToSpreadSheetAncestor for conversions that turn a matrix of some type into a spreadsheet.classAbstractObjectToJsonConverts the Map into a JSON object.classAbstractScriptAncestor for conversion scripts.classAbstractScriptedConversionAbstract ancestor for actors that execute external scripts.classAbstractSpreadSheetColumnConverter<T>Ancestor for column converter schemes.classAbstractSpreadSheetConversionAncestor for conversion schemes that transform one spreadsheet into another one.classAbstractSpreadSheetToMatrix<T>Ancestor for conversions that turn a spreadsheet into a matrix of some data type.classAbstractStringConversionAncestor for string conversion schemes.classAbstractSwapObjectAncestor for classes that swap all occurrences of one object for another.classAbstractValidateStringAncestor for string conversions that ensure a string only contains valid characters according to some rules.classAdamsInstanceToWekaInstanceConverts adams.data.instance.Instance objects into weka.core.Instance ones.classAnyImageToByteArrayTurns any image container into a byte array.classAnyImageToOpenCVTurns an Image container into an OpenCV container.classAnyToCommandlineGenerates a commandline string from any object.classAnyToStringTurns any object into a String, using its 'toString()' method.classArrayToCollectionDeprecated.classArrayToJsonArrayTurns an object array into a JSON array.classArrayToReportTurns an array into a report.classArrayToYamlStringConverts the object array into a YAML string.classBackQuoteBackquotes, i.e., escapes with a backslash, characters like quotes (single and double), new lines, tabs.
See also:
adams.data.conversion.Quote
adams.data.conversion.UnQuote
adams.data.conversion.UnBackQuote
Valid options are:classBase64ToByteArrayDecodes a base64 string into a byte array.classBase64ToStringDecodes a base64 string.classBaseDateTimeMsecToStringTurns a BaseDateTimeMsec format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 07:13:12.034 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (MILLISECOND|SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseDateTimeToStringTurns a BaseDateTime format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 07:13:12 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseDateToStringTurns a BaseDate format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 +3 DAY
(<date>|NOW|-INF|+INF|START|END) [expr (DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseTimeToStringTurns a BaseTime format string into a String, evaluted using user-supplied start and end times (ignored if future INF times).
Example: 07:13:12 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBlobContainerToByteArrayObtains the byte array content of a adams.data.blob.BlobContainer and forwards that.classBoofCVToBufferedImageTurns a BoofCV container into a BufferedImage one.classBooleanToStringTurns a Boolean into a String.classBreakUpStringBreaks up a string into multiple lines if wider than the specified number of columns.classBufferedImageBitmaskContainerToBufferedImagesTurns the bitmask container back into an array of containers for BufferedImage objects, with the image being the first and the bitmasks the other elements.
The incoming report gets cloned into all of the outgoing containers.classBufferedImagesToBufferedImageBitmaskContainerTurns the BufferedImage containers into a container with image (index=0) and bitmasks (index>=1).
Only the report from the first container is transferred.classBufferedImageSupporterToBufferedImageContainerConverts a adams.data.image.BufferedImageSupporter to a adams.data.image.BufferedImageContainer
classBufferedImageToBoofCVTurns a BufferedImage container into a BoofCV one.classBufferedImageToBufferedImageDummy conversion, performs no conversion at all.classBufferedImageToByteArrayTurns a BufferedImage object into a byte array.classByteArrayToBase64Encodes a byte array as base64 string.classByteArrayToBlobContainerWraps the byte array in a adams.data.blob.BlobContainer, which allows the storage of meta-data using the attached report and/or notes.classByteArrayToBufferedImageConverts the byte array representating a binary image (e.g., JPG or PNG) into a BufferedImage container.classByteArrayToImageContainerclassByteArrayToJavaObjectDeserializes a Java object from the byte array.classByteArrayToPrimitiveArrayTurns a byte array (IEE754) into a primitive array.classByteArrayToStringTurns a byte array into a String.classByteToHexTurns a Byte into a hexadecimal string.classByteToIntTurns a Byte into an Integer.classByteToStringTurns a Byte into a String.classCharArrayToStringTurns a char array into a String.classCollectionToArrayTurns a collection into an array.classColorToHexTurns a color object into its hexa-decimal representation, e.g., '#ffffff'.classCommandlineToAnyTurns a command-line into an object.classContainerToSpreadSheetConverts any container into a SpreadSheet object.classConvertDateTimeTypeTurns instances of the specified input date/time type into instances of the specified output date/time type.classConvertSpreadSheetRowsConverts the rows in the spreadsheet into a new format.classDateTimeTypeToStringTurns instances of the specified date/time type into a string using the specified format.classDOMNodeListToArrayTurns a DOM org.w3c.dom.NodeList into an array of org.w3c.dom.Node.classDOMNodeToStringTurns a org.w3c.dom.Node DOM object into a String.classDOMToPropertiesFlattens a DOM object (or node) into a Properties object.classDOMToStringTurns a org.w3c.dom.Node or org.w3c.dom.Document DOM object into a String.
In case of org.w3c.dom.Node objects, the owner document is converted to String.classDoubleMatrixToBufferedImageTurns a matrix of double values into a BufferedImage.classDoubleMatrixToMat5ArrayTurns a double matrix into a 2-dimensional Matlab matrix array.classDoubleMatrixToSpreadSheetConverts a double matrix into a SpreadSheet object.classDoubleToFloatTurns a Double into a Float.classDoubleToIntTurns a Double into an Integer.classDoubleToLongTurns a Double into a Long.classDoubleToStringTurns a Double into a String.classEmailToPlainTextTurns an Email object into a plain text string.classExcelDoubleColumnToDateConverts the specified double column to a date column.classExcelDoubleColumnToDateTimeConverts the specified double column to a date/time column.classExtractDateTimeFieldExtracts the specified field from a date/time type.
A custom format string can be used with field CUSTOM.classExtractSimpleContainerContentObtains the content of a adams.data.container.AbstractSimpleContainer derived class and forwards that.classFieldToStringTurns a Field object into a String.classFileToStringTurns a File object into a String.classFloatToDoubleTurns a Float into a Double.classGroovyA conversion that uses a Groovy script for processing the data.classHashCodeGenerates the hash code of an arbitrary object, using the object's hashcode() method.classHexToByteTurns a hexadecimal string into a Byte.classHexToColorTurns a hexa-decimal representation of a color, e.g., '#ffffff' into a color object again.classHexToIntTurns a hexadecimal string into an Integer.classHtmlCharacterEntitiesToStringTurns HTML character entities like '<' into their character representations like '<'.classImageContainerToByteArrayclassImageContainerToSpreadSheetTurns the image of an image container into a spreadsheet for viewing the pixel values.classInformativeStatisticTurns the statistics obtained from a adams.data.statistics.InformativeStatisticSupporter into a spreadsheet.classIntToByteTurns an Integer into a Byte.classIntToDoubleTurns an Integer into a Double.classIntToHexTurns an Integer into a hexadecimal string.classIntToLongTurns an Integer into a Long.classIntToRomanConverts an integer (1-3999) into a roman numeral string (eg 'MCM').classIntToStringTurns an Integer into a String.
Can be optionally formatted using a byte format string.classJavaObjectToByteArraySerializes the Java Object into a byte array.classJoinOptionsAssumes the string array to be an option array and joins them into a single string.classJsonArrayToArrayTurns a JSON array into an object array.classJsonArrayToListclassJsonObjectToMapTurns a JSON object into a map.classJsonToReportTurns a JSON string into a report.
Input format:
{
"Sample ID": "someid",
"GLV2": 1.123,
"valid": true
}
classJsonToSpreadSheetTurns a JSON object into a spreadsheet, essentially flattening it.classJsonToStringTurns a JSON object/array into a string.classLeftPadLeft pads a string up to a maximum number of characters.classListToJsonConverts the java.util.List into a JSON object.classListToJsonArrayTurns a Java list into a JSON array.classListToYamlStringConverts the java.util.List object into a YAML string.classLocatedObjectsToReportConverts the array of LocatedObject instances to a report.classLocatedObjectToRectangleConverts a adams.flow.transformer.locateobjects.LocatedObject to a rectangle.classLongToDoubleTurns a Long into a Double.classLongToIntTurns a Long into an Integer.classLongToStringTurns a Long into a String.
Can be optionally formatted using a byte format string.classLowerCaseTurns a String into a lowercase String.classMapToJsonConverts the java.util.Map into a JSON object.classMapToKeyValuePairsConverts the java.util.Map into key-value pairs.classMapToMat5FileConverts a map into a Matlab file object.
Supported nested elements:
- java.util.Map
- Matlab array/struct
- spreadsheet
- Double matrix
classMapToMat5StructConverts a map into a Matlab struct object.
Supported nested elements:
- java.util.Map
- Matlab array/struct
- spreadsheet
- Double matrix
classMapToReportTurns a map object into a report.classMapToSpreadSheetTurns a java.util.Map object into a SpreadSheet object.classMapToStringTurns a map object into a simple string.
When encountering date objects as values, they get turned into a string using: yyyy-MM-dd HH:mm:ss
Output format:
<key>:
<value>
classMapToWekaInstanceConverts a map into a Weka Instance, using the provided storage object (Instances) as template.classMapToYamlStringConverts the java.util.Map object into a YAML string.classMat5ArrayToDoubleMatrixConverts a 2-dimensional Matlab array into a double matrix.classMat5ArrayToSpreadSheetTurns the Matlab array into a spreadsheet.classMat5ArrayToStringConverts matrices into a textual representation, otherwise just outputs the dimensions.classMat5CharToStringclassMat5FileToMapTurns the Mat5File data structure into a nested map.classMat5StructToMapTurns the Matlab struct into a map.
In case of multi-dimensional (outermost) structs, an index can be supplied to retrieve just a single element instead of all of them.classMatchWekaInstanceAgainstFileHeaderMatches an Instance against a dataset header loaded from a file, i.e., it automatically converts STRING attributes into NOMINAL ones and vice versa.
The file can be any format that WEKA recognizes.classMatchWekaInstanceAgainstStorageHeaderMatches an Instance against a dataset header from storage, i.e., it automatically converts STRING attributes into NOMINAL ones and vice versa.classMathExpressionEvaluates a mathematical expression.
The input value (double or integer) can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classMaximumIf the numbers passing through get above the defined maximum, the maximum is returned instead.classMinimumIf the numbers passing through fall below the defined minimum, the minimum is returned instead.classMovingAverageComputes the average on a window of numbers that have passed through and outputs the average.classMultiConversionMeta-conversion that allows the chaining of multiple conversions.classNotesSubsetGenerates a subset of a adams.data.Notes object.classNotesToSpreadSheetTurns an adams.data.Notes object into a SpreadSheet object.classNotesToStringTurns an adams.data.Notes object into a string.classNumberToByteTurns an Number into a Byte.classNumberToDoubleTurns an Number into a Double.classNumberToFloatTurns an Number into a Float.classNumberToIntTurns an Number into a Int.classNumberToLongTurns an Number into a Long.classObjectAnnotationsToImageSegmentationLayersConverts the annotations to image segmentation layers.classObjectArrayToPrimitiveArrayConverts an object array to its primitive counterpart.classObjectContainerToObjectObtains the object content of a adams.data.container.ObjectContainer and forwards that.classObjectToObjectDummy converter, does not perform any conversion.classObjectToObjectContainerWraps the object in a adams.data.container.ObjectContainer, which allows the storage of meta-data using the attached report and/or notes.classOpenCVToBufferedImageTurns an OpenCV container into a BufferedImage one.classPathSplitSplits the path into its individual parts.
Handles forward slashes and backslashes.
Drive letters and servers from UNC paths are handled as separate part.classPoint2DToStringTurns a java.awt.geom.Point2D into a string of the format 'x y'.classPrettyPrintXMLTurns the XML string into a pretty-printed XML string.
See also:
adams.data.conversion.XMLToDOM
adams.data.conversion.DOMToString
classPrimitiveArrayToByteArrayTurns a primitive array into a byte array (IEE754).classPrimitiveArrayToObjectArrayConverts a primitive array to its object counterpart.classPropertiesToKeyValuePairsConverts the java.util.Properties into key-value pairs.classPropertiesToMapTurns a Properties object into a java.util.Map.classPropertiesToSpreadSheetTurns a properties object into a spreadsheet with two columns, one for the key and one for the value.classPropertiesToStringTurns a Properties object into a String.classQuadrilateralLocationCenterDetermines the center of the quadrilateral object and returns them as a java.awt.geom.Point2D.classQuadrilateralLocationToStringTurns a quadrilateral object into a string of the format 'A.x A.y B.x B.y C.x C.y D.x D.y'.classQuoteSurrounds a string with quotes (single or double), if necessary due to blanks or other characters (new line, tab) in the string.
However, you can also 'force' the quoting.
See also:
adams.data.conversion.UnQuote
adams.data.conversion.BackQuote
adams.data.conversion.UnBackQuote
classRectangleCenterDetermines the center of the rectangle and returns them as a java.awt.geom.Point2D.classRectangleToStringTurns a rectangle into a string of the format 'x y w h' or 'x0 y0 x1 y1'.classRemoteCommandToStringTurns a remote command into a string.classRenameSpreadSheetRenames the spreadsheet.classRenameSpreadSheetColumnRenames a single column in a spreadsheet.classReplaceFileExtensionInterprets the string as file name and replaces its extension with the provided one.classReportArrayToMapConverts the incoming report array into a map using the sample ID as key.classReportToJsonTurns a report into a JSON string.
Output format:
{
"Sample ID": "someid",
"GLV2": 1.123,
"valid": true
}
classReportToMapTurns a Report object into a java.util.Map.classReportToSpreadSheetTurns a report into a spreadsheet.classReportToStringGenerates a string representation from the report using the specified report writer.classReportToWekaInstanceConverts a report into a weka.core.Instance objects.classRightPadRight pads a string up to a maximum number of characters.classRomanToIntConverts a roman numeral string (eg 'MCM') into an integer (eg 1900).classRoundRounds double values and turns them into integers..classRowArrayToSpreadSheetConverts a an array of spreadsheet rows into a single spreadsheet.classScriptedA conversion that uses any scripting handler for processing the data with a script located in the specified file.classSideBySideDiffToStringTurns a side-by-side diff object into a string.classSimpleAsciiToUnicodeTurns an ASCII string into a Unicode one, by replacing hexadecimal unicode character representations like '\xf3' with their unicode characters.
For instance, "D'\xe1'cil" becomes "Dácil".classSimpleUnicodeToAsciiTurns a Unicode string into an ASCII one, by replacing the Unicode characters with something like '\xf3' (including the single quotes).
For instance, "Dácil" becomes "D'\xe1'cil".classSplitOptionsAssumes the string to be an option string and splits it into its individual elements.classSpreadSheetAddFormulaColumnAdds a column with a user-supploed formula for the specified rows.classSpreadSheetAddFormulaRowAdds a row with a user-supplied formula for the specified columns.classSpreadSheetAddRowIDAdds an ID column to the spreadsheet, using the row index as value.classSpreadSheetAddSumColumnAdds a column with 'sum' formulas for the specified rows.classSpreadSheetAddSumRowAdds a row with 'sum' formulas for the specified columns.classSpreadSheetAnyColumnToStringConverts the specified spreadsheet column from any type to string.classSpreadSheetBinarizeBinarizes the non-numeric columns in the selected column range by creating a new column for each of the labels.classSpreadSheetCellFinderToPositionsDeprecated.classSpreadSheetCellLocationToCoordinatesTurns the cell location obtained from a cell finder into an integer array with the 1-based coordinates (row/column).classSpreadSheetCellLocationToPositionTurns the cell location obtained from a cell finder into a position (like 'A2').classSpreadSheetColumnFinderToRangeTurns the columns that the specified column finder locates into a 1-based range string.classSpreadSheetColumnsToReportTurns spreadsheet columns into reports.classSpreadSheetDoubleColumnToLongConverts the specified spreadsheet column from double to long.
Simply uses the Double's 'longValue()' method.classSpreadSheetDoubleColumnToStringConverts the specified spreadsheet double column to string.classSpreadSheetEscapeColumnNameEscapes a column name (if necessary) to be used in a column range expression.classSpreadSheetHeaderToMat5ArrayConverts the spreadsheet header with the column names into a Matlab array.classSpreadSheetInsertCellLocationReplaces the specified placeholder with a cell location generated from the user-supplied row and column.classSpreadSheetInsertColumnPositionReplaces the specified placeholder with a column string (e.g., BG) generated from the user-supplied column.classSpreadSheetJoinColumnsMerges two or more columns in a spreadsheet into a single column.
Columns can be out-of-order.classSpreadSheetLongColumnToDoubleConverts the specified spreadsheet column from long to double.
Simply uses the cell's 'toDouble()' method.classSpreadSheetMaterializeFormulasFinds cells with formulas in a spreadsheet and replaces the cell content with the value calculated by the formula.classSpreadSheetObjectColumnToStringConverts the specified spreadsheet column from the object type to string.classSpreadSheetRowFinderToRangeTurns the rows that the specified row finder locates into a 1-based range string.classSpreadSheetRowsToReportTurns spreadsheet rows into report.classSpreadSheetSplitColumnSplits the string representation of the cells of a column into multiple columns using a regular expression.classSpreadSheetStringColumnToBooleanConverts the specified spreadsheet column from string to boolean.classSpreadSheetStringColumnToDateConverts the specified spreadsheet column from string to date, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDateTimeConverts the specified spreadsheet column from string to date/time, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDateTimeMsecConverts the specified spreadsheet column from string to date/time/msec, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDoubleConverts the specified spreadsheet column from string to double, according to the provided format.
For more information on the format, see Javadoc of 'java.text.DecimalFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html
Valid options are:classSpreadSheetStringColumnToLongConverts the specified spreadsheet column from string to long, according to the provided format.
For more information on the format, see Javadoc of 'java.text.DecimalFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html
Valid options are:classSpreadSheetStringColumnToObjectConverts the specified spreadsheet column from string to an object, using the specified handler.classSpreadSheetStringColumnToTimeConverts the specified spreadsheet column from string to time, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleTimeFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
classSpreadSheetStringColumnToTimeMsecConverts the specified spreadsheet column from string to time/msec, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleTimeFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
classSpreadSheetSupporterToSpreadSheetclassSpreadSheetToCreateTableStatementTurns a spreadsheet into a SQL 'CREATE TABLE' statement.
Requires two columns: column names, SQL column types.
An optional 3rd column can be used to indicate whether a column is to be used as an index (boolean).classSpreadSheetToDatasetTurns a spreadsheet object into a dataset object.classSpreadSheetToDoubleMatrixTurns a spreadsheet into a double matrix, using only the numeric columns.classSpreadSheetToJsonTurns a spreadsheet into a JSON array.classSpreadSheetToMapTurns two columns (key and value) of a spreadsheet into a map object of the specified type.classSpreadSheetToMat5ArrayConverts a spreadsheet to a Matlab array (either matrix or a cell array)
classSpreadSheetToNumericTurns a spreadsheet into a purely numeric one.
Missing cells can get replaced with a specified value or skipped.
Booleans gets turned into 0/1 (false/true).
Date/time types get turned into numeric ones by using their Java epoch.
Strings (per column) get a 0-based index assigned in the order they appear.
Any other cell type get flagged as missing or, if provided, set to the unhandled value.classSpreadSheetToRowArrayConverts a spreadsheet into an array of spreadsheet rows.classSpreadSheetToStringTurns a spreadsheet into a string using the specified spreadsheet writer.classSpreadSheetToStringMatrixTurns a spreadsheet into a string matrix.classSpreadSheetToTimeseriesTurns a SpreadSheet object into a Timeseries.classSpreadSheetToWekaInstancesGenerates a weka.core.Instances object from a SpreadSheet object.
If there are too many unique lables for a NOMINAL attribute, it gets turned into a STRING attribute (see 'maxLabels' property).classSpreadSheetUnescapeColumnNameUnescapes a column name (if necessary) that was to be used in a column range expression.classSpreadSheetUniqueColumnNamesEnsures that column names are unique.classSpreadSheetUseRowAsHeaderUses the values of the specified data row for the header.classStringArrayToURLParametersTurns a string array into parameters of a URL, e.g., '?k1=v1&k2=v2' (uses java.net.URLEncoder).classStringExpressionEvaluates a string expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classStringMatrixToSpreadSheetConverts a string matrix into a SpreadSheet object.classStringToBase64Encodes a string as base64.classStringToBooleanTurns a String into a Boolean, ie any string regardless of case that matches 'true' returns true otherwise false.classStringToByteTurns a String into a Byte.classStringToByteArrayConverts a string into a byte array.classStringToCharArrayConverts a string into a char array.classStringToCustomStringRepresentationTurns a String into an object of a class with an associated object editor that has implements adams.gui.goe.CustomStringRepresentationHandler.classStringToDateTimeTypeParses a string and turns it into an instance of the specified date/time type.classStringToDoubleTurns a String into a Double.classStringToFieldTurns a String into a Field object.classStringToFileTurns a String into a File object.classStringToHtmlCharacterEntitiesTurns a string into valid HTML, replacing characters like '<', '>' etc with their character entities.classStringToIntTurns a String into an Integer.classStringToJsonTurns a string into a JSON object or array.classStringToLongTurns a String into a Long.classStringToMat5ArrayConverts a string like '[1, 2; 3, 4]' into a Matlab matrix.classStringToPoint2DclassStringToPropertiesTurns a String into a Properties object.classStringToQuadrilateralLocationConverts a string into a adams.core.base.QuadrilateralLocation object.classStringToRectangleConverts a string into a adams.core.base.BaseRectangle object, using 'x y w h' or 'x0 y0 x1 y1'.classStringToRemoteCommandParses the String and turns it into a RemoteCommand object.classStringToReportReads the report from the incoming string using the specified report reader.classStringToSpreadSheetTurns a string representation of a spreadsheet into a SpreadSheet object, using the specified reader setup.classStringToStringDummy converter, does not perform any conversion.classStringToTextContainerWraps the String in a adams.data.text.TextContainer, which allows the storage of meta-data using the attached report and/or notes.classStringToURLTurns a String into a URL object.classStringToValidFileNameTurns any string into a valid file name.classStringToValidStorageNameTurns any string into a valid storage name.classStringToValidVariableNameTurns any string into a valid variable name.classSwapObjectsSwaps all occurrences of one object with another one.classSwapPLSSwaps one PLS filter for another.classTextContainerToStringObtains the string content of a adams.data.text.TextContainer and forwards that.classTextRendererTurns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.
See also:
adams.flow.transformer.TextRenderer
classTimeseriesToArrayTurns the values of a timeseries into a Double array.classTimeseriesToSpreadSheetTurns a timeseries into a SpreadSheet object.classTimeseriesToWekaInstancesTurns a timeseries into a WEKA Instances object.classTimeToStringTurns a number representing milli-seconds since 1970 (Java date) into a String.
For more information on formatting the date, see:
Javadoc.classTransposeSpreadSheetTransposes a spreadsheet, i.e., swaps columns with rows.classUnBackQuoteReverses backquoting, i.e., removes the escaping with backslash, restoring characters like quotes (single and double), new lines, tabs.
See also:
adams.data.conversion.Quote
adams.data.conversion.UnQuote
adams.data.conversion.BackQuote
Valid options are:classUnknownToUnknownDummy converter, does not perform any conversion.classUnQuoteRemoves the quotes (single or double) surrounding a string.classUpperCaseTurns a String into an uppercase String.classURLDecodeDecodes the URL encoded string back to a regular string (uses java.net.URLDecoder).classURLEncodeEncodes the string to make it usable within a URL (uses java.net.URLEncoder).classURLParametersToStringArrayTurns URL parameters like '...?k1=v1&k2=v2' back into a string array (uses java.net.URLDecoder).classURLToStringTurns a URL object into a String.classUseForwardSlashesConverts backslashes in file names to forward slashes.
Does not touch the '\\' prefix of UNC paths.classWekaCapabilitiesToInstancesTurns a weka.core.Capabilities object into a Weka dataset filled with random data that is compatible with these capabilities.classWekaCapabilitiesToSpreadSheetTurns a weka.core.Capabilities object into a spreadsheet, listing all individual capabilities and whether they are supported.classWekaCommandToCodeApplies a commandline converter to the incoming commandline to generate code.
Uses the following project:
https://github.com/fracpete/command-to-code-weka-package
classWekaDrawableToStringExtracts the string representation of a weka.core.Drawable object, e.g., the tree representation of a decision tree or the graph of a BayesNet.classWekaEvaluationToCostCurveGenerates cost-curve data from a WEKA Evaluation object.classWekaEvaluationToMarginCurveGenerates margin-curve data from a WEKA Evaluation object.classWekaEvaluationToThresholdCurveGenerates threshold-curve data from a WEKA Evaluation object.classWekaForecastContainerToArrayTurns a series of predictions of a adams.flow.container.WekaForecastContainer container into a Double array.classWekaForecastContainerToTimeseriesTurns a series of predictions of a adams.flow.container.WekaForecastContainer container into a adams.data.timeseries.Timeseries.classWekaInstancesToSpreadSheetGenerates a spreadsheet from a weka.core.Instances object.classWekaInstancesToTimeseriesTurns a WEKA Instances object into a Timeseries.classWekaInstanceToAdamsInstanceConverts weka.core.Instance objects into adams.data.instance.Instance ones.classWekaInstanceToMapTurns the Weka Instance into a Map, with the attribute names the keys.classWekaPredictionContainerToSpreadSheetTurns a WEKA prediction container into a SpreadSheet object.classXMLToDOMTurns an XML string into a org.w3c.dom.Document DOM object.classYamlStringToListConverts the YAML string into a java.util.Map object.classYamlStringToMapConverts the YAML string into a java.util.Map object. -
Uses of OptionHandler in adams.data.distribution
Classes in adams.data.distribution that implement OptionHandler Modifier and Type Class Description classAbstractRealDistributionAncestor for distributions.classBetaBeta distribution.classCauchyCauchy distribution.classChiSquaredChiSquared distribution.classEmpiricalEmpirical distribution.classExponentialExponential distribution.classFFDistribution distribution.classGammaGamma distribution.classLogNormalLogNormal distribution.classNormalNormal distribution.classTT distribution.classTriangularTriangular distribution.classUniformUniform distribution.classWeibullWeibull distribution. -
Uses of OptionHandler in adams.data.featureconverter
Classes in adams.data.featureconverter that implement OptionHandler Modifier and Type Class Description classAbstractFeatureConverter<D,R>Ancestor for generic feature converter schemes.classAbstractMetaFeatureConverterAncestor for converters that use a base converter.classCountValuesMeta-feature-converter that counts numeric values that satisfy the specified min/max range.classDatasetTurns the features into ADAMS dataset format.classFeatureContainerSimply returns the header definition/row in a adams.flow.container.FeatureConverterContainer container.classFixedColumnTextSimple feature converter that generates textual output with fixed column width.classFixedNumFeaturesMeta-feature-converter that ensures that the generated output has a fixed number of data points.
In case of filler type FIRST, the data gets inserted at the start, as opposed to at the end when using LAST.
NUMERIC/STRING/BOOLEAN use the appropriate filler value that the user specified.
The MISSING_* types just add a missing value of the appropriate data type.classSpreadSheetGenerates features in spreadsheet format.classTextSimple feature converter that generates a CSV-like textual output.classWekaGenerates features in spreadsheet format. -
Uses of OptionHandler in adams.data.filter
Subinterfaces of OptionHandler in adams.data.filter Modifier and Type Interface Description interfaceBatchFilter<T extends DataContainer>Interface for filters that can filter multiple data containers in one go.interfaceFilter<T extends DataContainer>Interface for filters.interfaceTrainableBatchFilter<T extends DataContainer>Interface for trainable batch filters.Classes in adams.data.filter that implement OptionHandler Modifier and Type Class Description classAbstractAutocorrelation<T extends DataContainer>Abstract ancestor for autocorrelation filters.classAbstractBatchFilter<T extends DataContainer>Ancestor for batch filters.classAbstractDatabaseConnectionFilter<T extends DataContainer>Ancestor for filters that require database access.classAbstractDerivative<T extends DataContainer>Abstract ancestor for Derivative filters.classAbstractEquiDistance<T extends DataContainer>Abstract ancestor for filters that equi-distance the data.classAbstractEquiDistanceWithOffset<T extends DataContainer>Abstract ancestor for filters that equi-distance the data.classAbstractFastWavelet<T extends DataContainer>Abstract ancestor for Wavelet filters based on the JSci library.classAbstractFFT<T extends DataContainer>Abstract ancestor for Fast Fourier Transform filters based on the JSci library.classAbstractFilter<T extends DataContainer>Abstract base class for filters.classAbstractHistogram<T extends DataContainer>Ancestor for filters that generate a histogram from the incoming data.classAbstractLOWESS<T extends DataContainer>Abstract ancestor for LOWESS filters.classAbstractPreFilter<T extends DataContainer>Abstract ancestor for filters that use pre-filtered data as the basis for manipulating the original data.classAbstractSavitzkyGolay<T extends DataContainer>Abstract ancestor for Savitzky-Golay filters.classAbstractSAX<T extends DataContainer>Ancestor for SAX filters.classAbstractScriptAncestor for filter scripts.classAbstractScriptedFilterAbstract ancestor for filters that execute external scripts.classAbstractSimpleSavitzkyGolay<T extends DataContainer>Abstract ancestor for simple Savitzky-Golay filters.classBaselineCorrection<T extends DataContainer>A filter that runs a baseline correction scheme over the data.classDownSample<T extends DataContainer>A filter that returns only every n-th data point.classDownSize<T extends DataContainer>A filter that picks a specified number of evenly spaced data points from the data.classGroovyA filter that uses a Groovy script for processing the data.classMultiFilter<T extends DataContainer>A meta-filter that runs multiple filters over the data.classOutlierDetector<T extends DataContainer>A filter that runs an outlier detector over the data and attaches the generated detections as notes to the chromatogram.classPassThrough<T extends DataContainer>A dummy filter that just passes the data through.classRemoveNoise<T extends DataContainer & Mergeable>A filter that removes noise from the data with a user-supplied noise level algorithm.classReportFilter<T extends DataContainer>A filter that modifies the reports of data containers being passed through.classScriptedA filter that uses any scripting handler for processing the data with a script located in the specified file.classSmoothing<T extends DataContainer>A filter that runs a smoothing scheme over the data.classTimeseriesAutocorrelationPerforms autocorrelation on the timeseries.classTimeseriesChangeResolutionGenerates a new timeseries with a (user-defined) fixed-length interval between data points.classTimeseriesDerivativeA filter for generating derivatives of timeseries data.classTimeseriesEquiDistanceA filter for interpolating the values of a time series.classTimeseriesFastWaveletA filter that transforms the data with a wavelet.
For more information see:
(2009).classTimeseriesFFTA filter that transforms the data with Fast Fourier Transform.
For more information see:
Mark Hale (2009).classTimeseriesHistogramGenerates a histogram from the timeseries.classTimeseriesLOWESSA filter that applies LOWESS smoothing.
For more information see:
WikiPedia.classTimeseriesResetTimestampsResets the timestamps, makes them start at the specified date/time.classTimeseriesRoundRounds the values of the timeseries points.classTimeseriesRowNormRow wise normalization.classTimeseriesSavitzkyGolayA filter that applies Savitzky-Golay smoothing.
For more information see:
A.classTimeseriesSAXPerforms Symbolic Aggregate approXimation (SAX).
The data must be normalized using adams.data.filter.RowNorm beforehand.
For more information see:
Chiu, B., Keogh, E., Lonardi, S.classTimeseriesSetStartSets the starting point of the timeseries to a new fixed timestamp and all other data points accordingly.classTimeseriesShiftTimestampsShifts the timestamps of the timeseries by a calculated amount.
The amount is either the difference between the 'new' timestamp and a timestamp from the report or a supplied timestamp.
Accepted date formats (unless custom format specified):
yyyy-MM-dd HH:mm:ss
yyyy-MM-dd HH:mm:ss.S
yyyy-MM-dd
classTimeseriesShiftValuesShifts the values of the timeseries by the specified amount (up or down, depending on the sign).classTimeseriesValueSubsetGenerates a new timeseries with the first block of values that fits between the specified min/max (both included).classTimeseriesWindowLeaves only the specified window in the timeseries (borders included).
The matching can be inverted, i.e., everything but the window is returned. -
Uses of OptionHandler in adams.data.groupextraction
Subinterfaces of OptionHandler in adams.data.groupextraction Modifier and Type Interface Description interfaceGroupExtractorAncestor for schemes that extract the group from objects.interfaceSpreadSheetRowGroupExtractorIndicator interface for extractors that work on spreadsheet rows.interfaceSpreadSheetRowGroupExtractorWithColumnExtractors that work on spreadsheet rows.Classes in adams.data.groupextraction that implement OptionHandler Modifier and Type Class Description classAbstractGroupExtractorAncestor for schemes that extract the group from objects.classManualJust returns the supplied group.classNullDummy, extracts nothing.classReportFieldReturns the value of the specified field.classReportFieldRegExpReturns the value of the regexp group applied to the specified report field.classSpreadSheetCellReturns the cell value of the spreadsheet row.classSpreadSheetCellRegExpApplies regular expression to the cell value of the spreadsheet row and returns the specified expression group.classSpreadSheetCellWithLookUpReturns the cell value of the spreadsheet row. -
Uses of OptionHandler in adams.data.groupupdate
Subinterfaces of OptionHandler in adams.data.groupupdate Modifier and Type Interface Description interfaceGroupUpdaterAncestor for schemes that update the group of objects.Classes in adams.data.groupupdate that implement OptionHandler Modifier and Type Class Description classAbstractGroupUpdaterAncestor for schemes that update the group of objects.classPassThroughPerforms no update.classReportFieldSets the group under the specified field in the report (either report or report handler). -
Uses of OptionHandler in adams.data.id
Classes in adams.data.id that implement OptionHandler Modifier and Type Class Description classAbstractIDFilenameGenerator<T>Abstract base class for ID string generators.classAbstractIDGenerator<T>Abstract base class for ID string generators.classIDGeneratorPostProcessorA simple ID generator that can make use of data provided by classes implementing IDHandler and DatabaseIDHandler.classSimpleIDGeneratorA simple ID generator that can make use of data provided by classes implementing IDHandler and DatabaseIDHandler. -
Uses of OptionHandler in adams.data.idextraction
Subinterfaces of OptionHandler in adams.data.idextraction Modifier and Type Interface Description interfaceIDExtractorAncestor for schemes that extract the ID from objects.Classes in adams.data.idextraction that implement OptionHandler Modifier and Type Class Description classAbstractIDExtractorAncestor for schemes that extract the ID from objects.classManualJust returns the supplied ID.classNullDoes nothing.classReportFieldReturns the value of the specified field.classReportFieldRegExpReturns the value of the specified field after passing it through the find/replace pair.classSpreadSheetCellReturns the cell value of the spreadsheet row. -
Uses of OptionHandler in adams.data.idupdate
Subinterfaces of OptionHandler in adams.data.idupdate Modifier and Type Interface Description interfaceIDUpdaterAncestor for schemes that update the ID of objects.Classes in adams.data.idupdate that implement OptionHandler Modifier and Type Class Description classAbstractIDUpdaterAncestor for schemes that update the ID of objects.classIDHandlerUpdates the ID of (mutable) ID handlers.classPassThroughPerforms no update.classReportFieldSets the ID under the specified field in the report (either report or report handler). -
Uses of OptionHandler in adams.data.image
Subinterfaces of OptionHandler in adams.data.image Modifier and Type Interface Description interfaceImageTransformer<T extends AbstractImageContainer>Abstract base class for AbstractImage transformations.Classes in adams.data.image that implement OptionHandler Modifier and Type Class Description classAbstractImageFeatureGenerator<T extends AbstractImageContainer>Abstract base class for AbstractImage feature generation.classAbstractImageTransformer<T extends AbstractImageContainer>Abstract base class for AbstractImage transformations.classAbstractMultiImageOperation<T extends AbstractImageContainer>Abstract base class for operations that require multiple images. -
Uses of OptionHandler in adams.data.image.features
Classes in adams.data.image.features that implement OptionHandler Modifier and Type Class Description classAbstractBufferedImageFeatureGeneratorAbstract base class for BufferedImage feature generators.classAbstractCountColorAncestor for feature generators that count pixels based on color.classAbstractScriptAncestor for BufferedImage feature generator scripts.classAbstractScriptedFeatureGeneratorAbstract ancestor for BufferedImage feature generator that execute external scripts.classBarcodeDecodes any barcode in the image.classBasicStatisticsCalculates min/max/mean/median/stdev for each channel (R,G,B).classColorCountsCounts the occurrences of colors in the image (alpha channel gets ignored).classCountColorCounts the occurrences of a specific color (alpha channel gets ignored).classCountColorOutsideclassDimensionsOutputs the dimensions of the image: width, height, area, ratio.classEccentricityComputes the eccentricity of the object.classEntropyCalculates the Shannon entropy of an image.
Original code taken from here:
http://stackoverflow.com/a/22280200
classFilteredBufferedImageFeatureGeneratorApplies the filter (an image transformer) to the image first before generating the features from the transformed images.classHistogramTurns an image into a histogram.
In case of an 8-bit histogram, the image must already be converted to a gray image.
The number of bins per channel can be chosen as well (1-256).classHusMomentsCalculates Hu's moments.classMaxSimply outputs the RGB value of the brightest pixel.classMinSimply outputs the RGB value of the darkest pixel.classMomentComputes the specified moment.classMultiBufferedImageFeatureGeneratorApplies multiple generators to the same image and merges the generated a feature vectors side-by-side.classOrientationVectorGenerates a vector thatclassPixelClassificationsGenerates a feature vector for each pixel classification that is stored in the image's report.
Pixel classifications are generated with the adams.flow.transformer.PixelSelector transformer, using the adams.flow.transformer.pixelselector.AddClassification action.
Automatically adds the classification label associated with a classification position in the report as a separate attribute.classPixelsGets all the pixels of the image.classScriptedA feature generator that uses any scripting handler for processing the data with a script located in the specified file. -
Uses of OptionHandler in adams.data.image.luminance
Classes in adams.data.image.luminance that implement OptionHandler Modifier and Type Class Description classAbstractLuminanceParametersAncestor for classes that return luminance parameters for RGB into grayscale conversions.classBT2020Parameters for BT 2020: https://en.wikipedia.org/wiki/Rec._2020classBT601Parameters for BT 601: https://en.wikipedia.org/wiki/Rec._601classBT709Parameters for BT 709: https://en.wikipedia.org/wiki/Rec._709classCustomCustom luminance parameters. -
Uses of OptionHandler in adams.data.image.moments
Classes in adams.data.image.moments that implement OptionHandler Modifier and Type Class Description classAbstractBufferedImageMomentAncestor for moments for BufferedImage containers.classAbstractMoment<T>Top level interface for moment classesclassCentralMomentThe central moment.classMomentThe moment.classNormalizedMomentThe normalized moment. -
Uses of OptionHandler in adams.data.image.multiimageoperation
Classes in adams.data.image.multiimageoperation that implement OptionHandler Modifier and Type Class Description classAbstractBufferedImageMultiImageOperationAbstract base class for operations that require multiple images of type BufferedImageContainer.classAndPerforms a logical AND on the binary pixels of the images.
Converts images automatically to type BufferedImage.TYPE_BYTE_BINARY.classApplyMask
classAverageComputes the average from the images (each channel separately).classCombineChannelsCombines the channels into a single image.classDiffclassMedianComputes the median from the images (each channel separately).classMergeGridMerges a grid of sub-images into a single image, including the annotations.
Opposite operation to adams.data.image.transformer.subimages.Grid.
Expects the image array to represent the cells in the grid in a row-wise fashion.
Only combines object annotations from reports, other field values will be discarded.
Does not remove overlapping objects, see adams.flow.transformer.DeleteOverlappingImageObjects.
See also:
adams.data.image.transformer.subimages.Grid
adams.flow.transformer.DeleteOverlappingImageObjects
classOrPerforms a logical OR on the binary pixels of the images.
Converts images automatically to type BufferedImage.TYPE_BYTE_BINARY.classPassThroughDummy operation, simply passes on the input images.classReportFieldSubtractionFor each of the specified report fields, the difference between the value from the first report and the second is calculated.classXOrPerforms a logical XOR on the binary pixels of the images.
Converts images automatically to type BufferedImage.TYPE_BYTE_BINARY. -
Uses of OptionHandler in adams.data.image.transformer
Subinterfaces of OptionHandler in adams.data.image.transformer Modifier and Type Interface Description interfaceImageColorizerInterface for image colorizers (only for making it easier to select them in the GUI).interfaceImageColorizerWithColorProviderInterface for image colorizers that support a color provider.Classes in adams.data.image.transformer that implement OptionHandler Modifier and Type Class Description classAbstractBufferedImageTransformerAbstract base class for BufferedImage transformations.classAbstractScriptAncestor for JAI transformer scripts.classAbstractScriptedTransformerAbstract ancestor for transformers that execute external scripts.classBinaryTurns an image into a binary image, using a grayscale threshold to determine which pixels are black (below) and which are white (equal to or above).classBinaryMaskGenerates a binary image from the input and uses this mask to determine which pixels get replaced by the specified replacement color.classBlueChannelColorizerInterprets the values in the blue channel (e.g., used by image segmentation frameworks) of the images as indices and replaces them with colors from the specified color provider.classChangeCanvasSizePlaces the image on a canvas of specified size based on the anchor.classCroppingCrops the images passing through using the specified crop algorithm.classDownSampleGenerates a smaller image by taken every nth pixel (on the x and y axis).classFixObjectsEnsures that no invalid object shapes are present in the report.classGaussianBlurPerforms a gaussian blur.
Original code taken from here:
http://www.jhlabs.com/ip/blurring.html
Valid options are:classGrayOrIndexedColorizerColorizes grayscale or indexed images using the specified color provider.
Other images types get converted to grayscale first.classGrayscaleGenerates a grayscale images using the specified luminance parameters.classImageFilterApplies an ImageFilter to the buffered image.classImageTypeTurns an image into the specified type of image.classLaplaceOfGaussianApplies the Laplacian of Gaussian (LoG) to the image, using the following formula
(x^2 + y^2 - 2*sigma^2) / sigma^4 * exp(-(x^2 +y^2) / (2*sigma^2)
For more information on LoG, see:
http://fourier.eng.hmc.edu/e161/lectures/gradient/node8.html
classLaplaceOperatorApplies the Laplace operator, using the following matrix:
0 1 0
1 -4 1
0 1 0
For more information on the Laplace operator, see:
http://docs.opencv.org/modules/imgproc/doc/filtering.html?highlight=laplacian#laplacian
classLocalMedianFilterTODO: what class does.classMaxRGBclassMinRGBclassMinRGBOldclassMultiTransformerApplies the specified JAI transformers one after the other.classObjectAnnotationsMaskOnly leaves pixels in the image that are covered by the object annotations (= masking).classPassThroughA dummy transform that just passes the image through.classReplaceColorsAllows replacing one color with another.classReplacePredominantColorAllows replacing the predominant color with another.classResizeResizes the image to predefined width and height.
For more information on the scaling types, see:
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/Image.html
classScriptedAn image transformer that uses any scripting handler for processing the data with a script located in the specified file.classSplitChannelsSplits the image into the specified separate RGB channels.classSplitChannelsHSVSplits the image into the specified separate HSV channels.classSplitChannelsYIQSplits the image into the specified separate YIQ channels.classSplitChannelsYUVSplits the image into the specified separate YUV channels.classSubImagesProduces subimages from the input image using the specified generator.classSuppliedImageMaskMasks out regions on the image using a supplied image from internal storage, making them transparent.classThresholdReplacementReplaces pixels of the image that fall below or above (depending on configuration) a user defined threshold in the grayscale space with the supplied replacement color.
Can be replaced to remove dark or light splotches.classTrimapColorizerColorizes trimap images using the specified color provider.classWhiteBalanceProcesses the images passing through using the specified white balance algorithm.classXScreenMaskMasks out a color by making it transparent. -
Uses of OptionHandler in adams.data.image.transformer.crop
Classes in adams.data.image.transformer.crop that implement OptionHandler Modifier and Type Class Description classAbstractCropAlgorithmAncestor to cropping algorithms.classBinaryCropTurns image into binary (ie black and white) image and determines the largest rectangle encompassing a (white) object in the middle to crop to.
When looking for a black object, check the 'invert' option.classCropBackgroundPicks the background at the specified anchor position and crops to the smallest possible rectangle.classNoCropDummy crop algorithm, performs no cropping at all.classRectangleCropTurns the image into one with only two indexed colors and then determines from all four sides the locations where the color changes from the one on the edge.classRelativeCropCrops the image to specified width and height.classSimpleCropSimple cropping algorithm that uses a fixed window.classThresholdedCropSimple cropping algorithm that assumes a good contrast between background and foreground.
Algorithm:
- create histogram of grayscale image
- remove counts from histogram that fall below noise-level
- determine left-most (L) and right-most (R) non-zero count
- divide region between L and R into two and determine highest peak in each (LP and RP)
- 8-bit threshold is halfway between LP and RP
- determine first pixel that is above threshold from top, bottom, left and right, which is used for the crop
-
Uses of OptionHandler in adams.data.image.transformer.subimages
Classes in adams.data.image.transformer.subimages that implement OptionHandler Modifier and Type Class Description classAbstractSubImagesGeneratorAncestor for classes that generate subimages from a single image.classGridSplits the image using a grid of specified number of columns and rows.
Additional report values:
- Row for the row
- Column for the column
- Coordinates for the 1-based coordinates (x,y,w,h)
It is possible to generate overlapping images (all but last row and last column) by defining overlaps.classObjectsExtracts sub-images defined by the objects that the object finder locates.classPassThroughDummy generator, simply passes the original image through.classRegionsExtracts the sub-images according to the region definitions.
Additional report values:
- Region for the region
-
Uses of OptionHandler in adams.data.image.transformer.whitebalance
Classes in adams.data.image.transformer.whitebalance that implement OptionHandler Modifier and Type Class Description classAbstractWhiteBalanceAlgorithmAncestor to white balance algorithms.classGIMPUses the algorithm for white balancing as used by GIMP.
The White Balance command automatically adjusts the colors by stretching the Red, Green and Blue channels separately.classGrayWorldBasic algorithm that incorporates the Gray World assumption, which argues that the average reflectance of scene is achromatic.classNoBalanceDummy white balance algorithm, performs no balancing at all.classWhitePatchBasic algorithm that is based on the Retinex theory of visual color constancy, which argues that perceived white is associated with the maximum cone signals. -
Uses of OptionHandler in adams.data.imagefilter
Classes in adams.data.imagefilter that implement OptionHandler Modifier and Type Class Description classAbstractImageFilterProviderAncestor for providers ofImageFilterobjects.classGrayFilterProviderGenerates a javax.swing.GrayFilter image filter.classKeepOnlyColorsKeeps only the specified colors and turns all other pixels to transparent.classTransparentBackgroundUses the color at the specified location as background and turns it transparent. -
Uses of OptionHandler in adams.data.imagesegmentation.filter
Classes in adams.data.imagesegmentation.filter that implement OptionHandler Modifier and Type Class Description classAbstractImageSegmentationContainerFilterAncestor for filters for image segmentation containers.classDrawDraws the layers that have a color specified onto the base image.classMergeLayersMerges two or more layers into a new one (or replacing an existing one).classMultiFilterApplies the base filters sequentially.classPassThroughDummy, just passes through the container.classRemoveOverlapsRemoves any overlaps of annotations between the layers. -
Uses of OptionHandler in adams.data.imagesegmentation.layerorder
Classes in adams.data.imagesegmentation.layerorder that implement OptionHandler Modifier and Type Class Description classAbstractImageSegmentationContainerLayerOrderAncestor for schemes that generate an ordering of image segmentation layers.classAsIsReturns the order as provided by the underlying hash map.classPredefinedReturns the layers in sorted order.classSortedReturns the layers in sorted order. -
Uses of OptionHandler in adams.data.imagesegmentation.operation
Classes in adams.data.imagesegmentation.operation that implement OptionHandler Modifier and Type Class Description classAbstractImageSegmentationContainerOperationAbstract base class for operations that require multiple images.classCompareAnnotationWithPredictionCompares a prediction (first container) with the annotation (second container) and outputs a color image per label that shows the correct overlaps, the missed annotations and additionally predicted pixels.classConfusionMatrixEvaluates a prediction (first container) against the annotation (second container) and outputs a spreadsheet with the confusion matrix.classCountPixelsCounts the pixels and generates a spreadsheet with count per layer.classEvaluatePredictionEvaluates a prediction (first container) against the annotation (second container) and outputs a spreadsheet with the results.classPassThroughDummy, just passes through the containers.classSimpleOverlayCombines base image (or just background color) and layers into a single image. -
Uses of OptionHandler in adams.data.imagesharpness
Classes in adams.data.imagesharpness that implement OptionHandler Modifier and Type Class Description classAbstractImageSharpnessAncestor for classes that determine whether an image is sharp (ie focused) or not.classDummyDummy algorithm, always returns that image is sharp. -
Uses of OptionHandler in adams.data.indexedsplits
Subinterfaces of OptionHandler in adams.data.indexedsplits Modifier and Type Interface Description interfaceIndexedSplitsRunsCompatibilityInterface for compatibility checks between data and indexed splits runs.Classes in adams.data.indexedsplits that implement OptionHandler Modifier and Type Class Description classAbstractIndexedSplitsRunsCompatibilityFor checking compatibility between indexed splits and data.classInstancesIndexedSplitsRunsCompatibilityPerforms compatibility tests between indexed splits configurations and Weka Instances objects. -
Uses of OptionHandler in adams.data.instances
Classes in adams.data.instances that implement OptionHandler Modifier and Type Class Description classAbstractInstanceGenerator<T extends DataContainer & ReportHandler>Abstract base class for schemes that turn temperature profiles into weka.core.Instance objects. -
Uses of OptionHandler in adams.data.instancesanalysis
Classes in adams.data.instancesanalysis that implement OptionHandler Modifier and Type Class Description classAbstractInstancesAnalysisAncestor for data analysis classes.classFastICAPerforms independent components analysis and allows access to components and sources.classPCAPerforms principal components analysis and allows access to loadings and scores.classPLSPerforms partial least squares analysis and allows access to loadings and scores. -
Uses of OptionHandler in adams.data.instancesanalysis.pls
Classes in adams.data.instancesanalysis.pls that implement OptionHandler Modifier and Type Class Description classAbstractMultiClassPLSAncestor for schemes that predict multiple classes.classAbstractPLSAncestor for PLS implementations.classAbstractSingleClassPLSAncestor for schemes that predict a single class.classDIPLSclassKernelPLSclassNIPALSclassOPLSclassPLS1Implementation of PLS1 algorithm.
For more information see:
Tormod Naes, Tomas Isaksson, Tom Fearn, Tony Davies (2002).classPRMclassSIMPLSImplementation of SIMPLS algorithm.
Available matrices: W, B
For more information see:
Tormod Naes, Tomas Isaksson, Tom Fearn, Tony Davies (2002).classSparsePLSclassVCPLS -
Uses of OptionHandler in adams.data.io.input
Subinterfaces of OptionHandler in adams.data.io.input Modifier and Type Interface Description interfaceFlowReaderInterface for flow readers.interfaceImageReader<T extends AbstractImageContainer>Interface for image readers.interfaceImageSegmentationAnnotationReaderInterface for readers for image segmentation annotations.interfaceImageSegmentationAnnotationReaderWithLayerNamesInterface for image segmentation readers that make use of layer names.interfaceInitialRowSkippingSpreadSheetReaderInterface for spreadsheet readers that can skip initial rows.interfaceInputStreamImageReader<T extends AbstractImageContainer>Interface for image readers that support reading from input streams.interfaceMissingValueSpreadSheetReaderInterface for spreadsheet readers that handle missing values.interfaceMultiSheetSpreadSheetReader<T extends Range>Interface for spreadsheet readers that can read multiple sheets from the same document.interfaceNestedFlowReaderInterface for flow readers that support the faster nested format.interfaceNoHeaderSpreadSheetReaderInterface for spreadsheet readers that support sheets with no headers.interfaceSpreadSheetReaderInterface for spreadsheet readers.interfaceWindowedSpreadSheetReaderAllows the retrieval of a certain "window" of rows from the data.Classes in adams.data.io.input that implement OptionHandler Modifier and Type Class Description classAbstractAdamsExperimentReaderAncestor for readers for ADAMS Experiments.classAbstractCompressedTextReaderAncestor for text readers of compressed files.classAbstractCustomPNGAnnotationImageSegmentationReaderAncestor for readers that read the annotations from a single PNG file and allow the reader to be specified.classAbstractDataContainerReader<T extends DataContainer>Abstract ancestor for readers that read files in various formats and turn them into data containers.classAbstractEmailFileReaderAncestor of email readers that read emails from files.classAbstractEmailReaderAncestor for classes that read emails.classAbstractExcelSpreadSheetReader<T extends Range>Ancestor for special Excel readers.classAbstractFlowReaderAncestor for classes that can read flows.classAbstractImageReader<T extends AbstractImageContainer>Ancestor for image readers.classAbstractImageSegmentationAnnotationReaderAncestor for readers for image segmentation annotations.classAbstractIndexedSplitsRunsReaderAncestor for readers that load files containing IndexedSplitsRuns.classAbstractMultiSheetSpreadSheetReader<T extends Range>Ancestor for spreadsheet readers that can read multiple sheets from a document in one go.classAbstractMultiSheetSpreadSheetReaderWithMissingValueSupport<T extends Range>Ancestor for spreadsheet readers that allow the specification of a custom missing value string.classAbstractNestedFlowReaderAncestor for flow readers that support the nested format as well.classAbstractObjectReaderAncestor for object readers.classAbstractParameterMapReaderAncestor for classes that read parameter maps.classAbstractPNGAnnotationImageSegmentationReaderAncestor for readers that read the annotations from a single PNG file.classAbstractReportReader<T extends Report>Abstract ancestor for readers that read files in various formats and creates a reports.classAbstractSimpleCSVReportReader<T extends Report>Abstract ancestor for reports to be written in CSV format.classAbstractSimpleJsonReportReader<T extends Report>Abstract ancestor for reports to be written in CSV format.classAbstractSimpleReportReader<T extends Report>Abstract ancestor for reports to be written in properties format.classAbstractSpreadSheetReaderAncestor for classes that can read spreadsheets.classAbstractSpreadSheetReaderWithMissingValueSupportAncestor for spreadsheet readers that allow the specification of a custom missing value string.classAbstractTextReader<T>Ancestor for readers for text streams.classAbstractTextReaderWithEncoding<T>Ancestor for text readers that support file encodings.classAbstractTimeseriesReaderAncestor for timeseries readers.classAbstractWekaSpreadSheetReaderAncestor for WEKA file format readers.classAccessSpreadSheetReaderAllows the reading of MS Access databases.classApacheCommonsImageReaderApache Commons image reader for: bmp, gif, ico, pbm, pgm, png, pnm, ppm, psd, tif, tiff
classArffSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classAutoWidthTabularSpreadSheetReaderReads simple tabular text files, using column widths as defined by the header row.classBlueChannelImageSegmentationReaderThe layers are stored in the blue channel, with 0 being the background.classBoofCVImageReaderBoofCV image reader for: bmp, gif, jpeg, jpg, pgm, png, ppm, wbmp
For more information see:
http://boofcv.org/
classBzip2TextFileReaderReads content from bzip2 compressed text files.classCocoAnnotationsReportReaderLoads COCO annotations from the JSON file, with one report per image.
Handles only segmentations with polygons (not RLE) and only one polygon per annotation.classCommandlineReaderLoads objects using the commandline store in the file.classCsvSpreadSheetReaderReads CSV files.
It is possible to force columns to be text.classDeepLabCutCSVReaderReads point annotations into multiple reports from DeepLabCut's CSV format.classDefaultFlowReaderReads flows in the default format (nested).classDefaultSimpleCSVReportReaderDefault implementation of a report reader of the simple CSV format.classDefaultSimpleJsonReportReaderDefault implementation of a report reader of the simple Json format.classDefaultSimpleReportReaderDefault implementation of a report reader of the simple format.classDetectronAnnotationsReportReaderInterprets rectangle annotations present in Detectron annotations JSON file.classEmlEmailFileReaderReads emails stored in EML files.classExcelSpreadSheetReaderReads MS Excel files (using DOM).classExcelStreamingSpreadSheetReaderReads large MS Excel XML files (using streaming via SAX).
Increasing the debug level to more than 1 results in outputting detailed information on cells.classFastCsvSpreadSheetReaderSimplified CSV spreadsheet reader for loading large files.classFixedTabularSpreadSheetReaderReads simple tabular text files with fixed column widths, as used by dot matrix printers in days gone by.classGnumericSpreadSheetReaderReads Gnumeric workbook files (GZIP compressed or uncompressed XML), version 1.10.13.classGrayscaleImageSegmentationReaderThe layers are stored as grayscale values, with 0 being the background.classGzippedTextFileReaderReads content from gzipped text files.classImageClassificationGridSpreadSheetReaderTurns grid cells in the spreadsheet with labels ('label=score') into object locations.
Spreadsheet format:
y,x,label1,label2,...
0,0,cat=0.98,,...
0,1,,,...
0,2,dog=0.9,cat=0.2,...classImageClassificationJsonReportReaderRetrieves the label with the highest score from the JSON file and stores them in a report.
JSON file format: { LABEL1: SCORE1; LABEL2: SCORE2; }
classImageClassificationSpreadSheetReportReaderRetrieves the label with the highest score from the spreadsheet and stores them in a report.classIndexedPNGImageSegmentationReaderThe layers are stored in the blue channel, with 0 being the background.classIndividualImageSegmentationLayerReaderUses a JPG as base image and indexed PNG files for the individual layers (0 = background, 1 = annotation).classInstanceReaderReads WEKA datasets in various formats.classJAIImageReaderJava Advanced Imaging (JAI) image reader for: jpg, bmp, gif, png, jpeg, wbmp
classJsonAdamsExperimentReaderReads ADAMS Experiments in JSON format.classJsonFlowReaderReads flows in JSON format.classJsonIndexedSplitsRunsReaderReads runs of indexed splits from JSON.classJsonParameterMapReaderReads parameters in JSON format.classJSONSpreadSheetReaderReads WEKA datasets in JSON format and turns them into spreadsheets.classLibSVMSpreadSheetReaderReads WEKA datasets in LibSVM format and turns them into spreadsheets.classLineArrayTextReaderReads the text in as array of strings (each line is an array element).
For large files, the data can be 'chunked' (ie outputting it in blocks).classLineByLineTextReaderReads the text data, line by line.classLzfTextFileReaderReads content from LZF compressed text files.classLzmaTextFileReaderReads content from LZMA compressed text files.classMat5SpreadSheetReaderReads Matlab .mat files (format 5)
classMatlabSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classNestedAdamsExperimentReaderReads ADAMS Experiments in nested format.classNestedCommandlineReaderLoads objects using the commandline store in the file (nested format).classObjectLocationsSpreadSheetReaderReads object locations from a spreadsheet into a report.
Top/left column is required.
Either right/bottom or width/height need to be supplied.
In addition, polygon coordinates (X and Y coordinates as comma-separated lists in two separate columns) can be read as well.
If the coordinates/dimensions represent normalized ones (ie 0-1), then specify the width/height of the image to relate them back to actual pixel-based sizes.classODFSpreadSheetReaderReads ODF (Open Document Format) spreadsheet files.
If a row contains only empty cells, this is interpreted as the end of the sheet.classOpenCVImageReaderReads images using OpenCV.classOpexObjectLocationsReaderReads object locations from JSON generated by the opex library.
See more:
https://github.com/WaikatoLink2020/objdet-predictions-exchange-format
classPascalVOCObjectLocationsReaderReads object locations in Pascal VOC format.
See more:
https://github.com/WaikatoLink2020/objdet-predictions-exchange-format
classPNGImageReaderReads images in PNG format.classPNGSpreadSheetReaderReads PNGs as spreadsheet, e.g., for reading indexed PNGs.classPropertiesEmailFileReaderReads emails stored in properties files.classPropertiesIndexedSplitsRunsReaderReads runs of indexed splits from .props files.classPropertiesSpreadSheetReaderTurns Java properties files into spreadsheets with two columns: Key and Value.classSerializableObjectReaderLoads aSerializableObject.classSerializedAdamsExperimentReaderReads serialized ADAMS Experiments.classSerializedObjectReaderLoads objects using Java serialization.classSerializedParameterMapReaderReads a parameter map from a serialized file.classSimpleArffSpreadSheetReaderSimple reader for Weka ARFF files, only supports NUMERIC, NOMINAL, STRING and DATE attributes.classSimpleCsvSpreadSheetReaderReads CSV files.
It is possible to force columns to be text.classSimpleStreamSpreadSheetReaderReads file in simple stream format:
- one spreadsheet row per line in the output
- cells are separated by TAB
- cell format: '<1-based index>:<content-type ID>:<content>'
NB: tabs, new lines etc in the content get backquoted.classSimpleTimeseriesReaderReader for the simple timeseries data format, CSV-like with preceding comments.classSingleStringTextReaderReads all text data into a single string and returns that
classSpreadSheetTimeseriesReaderReads timeseries containers from columns of a spreadsheet.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).
However, it is not required to have an ID column present.classSqlDumpSpreadSheetReaderReads in SQL dump files.classSVMLightSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classTsvSpreadSheetReaderReads TSV (tab-separated values) files.
It is possible to force columns to be text.classVggXmlAnnotationReportReaderReads XML image annotation files, like used in the pets dataset:
http://www.robots.ox.ac.uk/~vgg/data/pets/
classViaAnnotationsReportReaderInterprets polygon annotations generated by VGG Image Annotator.
For more information, see:
http://www.robots.ox.ac.uk/~vgg/software/via/
classXrffSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classXStreamReaderLoads objects using XStream.classXzTextFileReaderReads content from XZ compressed text files.classYamlParameterMapReaderStores the parameters in YAML format.classYoloAnnotationsReportReaderReads text files with YOLO object annotations, one object definition per line:
BBox format:
- format: <object-class> <x> <y> <width> <height>
- object-class: 0-based index
- x/y: normalized center of annotation
- width/height: normalized width/height
- Normalization uses image width/height
Polygon format:
- format: <object-class> <x0> <y0> <x1> <y1>...
- object-class: 0-based index
- x/y: normalized polygon point
classZstdTextFileReaderReads content from ZStd compressed text files. -
Uses of OptionHandler in adams.data.io.output
Subinterfaces of OptionHandler in adams.data.io.output Modifier and Type Interface Description interfaceFlowWriterInterface for flow writers.interfaceImageSegmentationAnnotationWriterInterface for writers for image segmentation annotations.interfaceImageSegmentationAnnotationWriterWithLayerNamesInterface for image segmentation writers that make use of layer names.interfaceImageWriter<T extends AbstractImageContainer>Interface for image writers.interfaceIncrementalSpreadSheetWriterInterface for writers that allow incremental writing.interfaceMultiSheetSpreadSheetWriterInterface for spreadsheet writers that can write multiple sheets into a single document.interfaceNestedFlowWriterInterface for flow writers that support the faster nested format.interfaceNoHeaderSpreadSheetWriterInterface for spreadsheet writers that support sheets with no headers.interfaceOutputStreamImageWriter<T extends AbstractImageContainer>Interface for image writers that can write to output streams.interfaceSpreadSheetWriterInterface for spreadsheet writers.Classes in adams.data.io.output that implement OptionHandler Modifier and Type Class Description classAbstractAdamsExperimentWriterAncestor for ADAMS Experiment writers.classAbstractDataContainerWriter<T extends DataContainer>Abstract ancestor for writers that write data containers to files in various formats.classAbstractEmailFileWriterAncestor for email writers that write to files.classAbstractEmailWriterAncestor for classes that write emails.classAbstractFlowWriterAncestor for classes that can write flow objects.classAbstractFormattedSpreadSheetWriterAncestor for writers that format the numbers.classAbstractImageSegmentationAnnotationWriterAncestor for writers for image segmentation annotations.classAbstractImageWriter<T extends AbstractImageContainer>Ancestor for image writers.classAbstractImplicitBackgroundPNGAnnotationImageSegmentationWriterAncestor for image segmentation annotation writers that store the annotations in a single PNG file and can use an implicit background.classAbstractIndexedSplitsRunsWriterAncestor for writers that writes files containing IndexedSplitsRuns.classAbstractMultiReportWriter<T extends Report>Ancestor for report writers that write multiple reports into a single file.classAbstractMultiSheetFormattedSpreadSheetWriterAncestor for writers that format the numbers.classAbstractMultiSheetSpreadSheetWriterAncestor for spreadsheet writers that can write multiple sheets into a single document.classAbstractMultiSheetSpreadSheetWriterWithMissingValueSupportAncestor for spreadsheet writers that support missing values.classAbstractNestedFlowWriterAncestor for flow writers that support the nested format.classAbstractObjectWriterAncestor for object writers.classAbstractParameterMapWriterAncestor for classes that write parameter maps.classAbstractPNGAnnotationImageSegmentationWriterAncestor for image segmentation annotation writers that store the annotations in a single PNG file.classAbstractReportWriter<T extends Report>Abstract ancestor for writers that write reports to files in various formats.classAbstractSimpleCSVReportWriter<T extends Report>Abstract ancestor for writing reports in CSV format.classAbstractSimpleJsonReportWriter<T extends Report>Abstract ancestor for writing reports in Json format.classAbstractSimpleReportWriter<T extends Report>Abstract ancestor for writing reports in properties format.classAbstractSpreadSheetWriterAncestor for classes that can write spreadsheet objects.classAbstractSpreadSheetWriterWithMissingValueSupportAncestor for spreadsheet writers that support a custom missing value string.classAbstractTextWriterAncestor for classes that can write text documents.classAbstractTextWriterWithEncodingAncestor of text writers that use an encoding.classAbstractTextWriterWithFilenameGeneratorAncestor for text writers that use anAbstractFilenameGeneratorto generate their filename.classAbstractTimeseriesWriterAncestor for timeseries writers.classAbstractWekaSpreadSheetWriterAncestor for WEKA file format readers.classAccessSpreadSheetWriterWrites spreadsheet data to a MS Access database.classApacheCommonsImageWriterApache Commons Imaging image writer for: bmp, gif, ico, pbm, pgm, png, pnm, ppm, tif, tiff
classArffSpreadSheetWriterWrites a spreadsheet in ARFF file format.classAutoWidthTabularSpreadSheetWriterOutputs the spreadsheet in a simple tabular format with column widths to fit the content in each row.classBlueChannelImageSegmentationWriterThe layers get stored in the blue channel, with 0 being the background.classBoofCVImageWriterBoofCV image writer for: bmp, gif, jpeg, jpg, pgm, png, ppm, wbmp
For more information see:
http://boofcv.org/
classCommandlineWriterWrites the commandline of objects to disk.classCsvSpreadSheetWriterWrites CSV files.classDeepLabCutCSVWriterWrites point annotations from multiple reports in DeepLabCut's CSV format.
Expects the filename to be stored in the 'File' report field.classDefaultFlowWriterWrites flows in the default format (nested).classDefaultSimpleCSVReportWriterDefault implementation of a report writer of the simple CSV format.classDefaultSimpleJsonReportWriterDefault implementation of a report writer of the simple Json format.classDefaultSimpleReportWriterDefault implementation of a report writer of the simple format.classExcelSpreadSheetWriterWrites MS Excel files.classExcelStreamingSpreadSheetWriterWrites OOXML MS Excel files in streaming mode (more memory efficient).classFixedTabularSpreadSheetWriterOutputs the spreadsheet in a simple tabular format with fixed column width, as used by dot matrix printers in days gone by.classGnumericSpreadSheetWriterWrites Gnumeric workbook files (GZIP compressed or uncompressed XML), version 1.10.13.classGrayOrIndexedImageWriterChanges the unique colors to the ones specified by the color provider.
Useful for generating human-viewable images from image segmentation annotations.
Uses adams.data.io.output.ApacheCommonsImageWriter for performing the actual writing after the conversion.
See also:
adams.data.io.output.ApacheCommonsImageWriter
classGrayscaleImageSegmentationWriterThe layers get stored as grayscale values, with 0 being the background.classIndexedPNGImageSegmentationWriterEach layer gets stored with a separate color in the palette.classIndividualImageSegmentationLayerWriterUses a JPG as base image and indexed PNG files for the individual layers (0 = background, 1 = annotation).classJAIImageWriterJava Advanced Imaging (JAI) image writer for: bmp, jpg, jpeg, wbmp, png, gif
classJavaInstantiationWriterGenerates Java code fromOptionHandlerobjects.classJsonAdamsExperimentWriterWrites ADAMS experiments in JSON format.classJsonFlowWriterWrites flows in JSON format.classJsonIndexedSplitsRunsWriterWrites runs of indexed splits as JSON.classJsonParameterMapWriterWrites parameters in JSON format.classJSONSpreadSheetWriterWrites a spreadsheet in JSON file format.classLibSVMSpreadSheetWriterWrites a spreadsheet in LibSVM file format.classMat5SpreadSheetWriterWrites Matlab .mat files (format 5)
classMatlabSpreadSheetWriterWrites a spreadsheet in ARFF file format.classNestedAdamsExperimentWriterWrites ADAMS experiments in nested format.classNestedCommandlineWriterWrites the commandline of objects to disk (in nested format).classNullWriterPerforms no writing at all.classObjectLocationsSpreadSheetWriter
classODFSpreadSheetWriterWrites ODF (Open Document Format) spreadsheet files.classOpenCVImageWriterWrites images using OpenCV.classOpexObjectLocationsWriterWrites polygon annotations in VGG Image Annotator JSON format.
For more information, see:
http://www.robots.ox.ac.uk/~vgg/software/via/
classPlainTextEmailFileWriterWrites emails to text files.
Handles only ASCII content.classPropertiesEmailFileWriterWrites emails to properties files.classPropertiesIndexedSplitsRunsWriterWrites runs of indexed splits as .props file.classPropertiesSpreadSheetWriterOutputs two columns (key and value) from a spreadsheet as Java properties file.classSerializableObjectWriterWrites objects that implementSerializableObject.classSerializedAdamsExperimentWriterWrites serialized ADAMS experiments.classSerializedObjectWriterWrites objects using Java serialization.classSerializedParameterMapWriterSerializes a parameter map to a file.classSimpleArffSpreadSheetWriterSimple writer for Weka ARFF files, only supports NUMERIC, NOMINAL, STRING and DATE attributes.classSimpleJavaInstantiationWriterGenerates Java code from objects, using their command-line options to instantiate them.classSimpleStreamSpreadSheetWriterSimple stream format for spreadsheets:
- one spreadsheet row per line in the output
- cells are separated by TAB
- cell format: '<1-based index>:<content-type ID>:<content>'
NB: tabs, new lines etc in the content get backquoted.classSimpleTimeseriesWriterWriter for the simply timeseries format, CSV-like with preceding comments.classSpreadSheetTimeseriesWriterWrites timeseries data using a spreadsheet writer.classSqlDumpSpreadSheetWriterGenerates an SQL dump from the spreadsheet, which can be imported into a database.classSVMLightSpreadSheetWriterWrites a spreadsheet in SVMLight file format.classTextFileWithLineNumbersWriterWrites the content to a text file, preceding each line with its line number.classTextFileWriterWrites the content to a text file.classTsvSpreadSheetWriterWrites TSV (tab-separated values) files,
classViaAnnotationsReportWriterWrites polygon annotations in VGG Image Annotator JSON format.
For more information, see:
http://www.robots.ox.ac.uk/~vgg/software/via/
classXrffSpreadSheetWriterWrites a spreadsheet in XRFF file format.classXStreamWriterUses XStream to serialze objects.classYamlParameterMapWriterReads the parameters in YAML format.classYoloAnnotationsReportWriterWrites text files with YOLO object annotations, one object definition per line:
BBox format:
- format: <object-class> <x> <y> <width> <height>
- object-class: 0-based index
- x/y: normalized center of annotation
- width/height: normalized width/height
- Normalization uses image width/height
Polygon format:
- format: <object-class> <x0> <y0> <x1> <y1>...
- object-class: 0-based index
- x/y: normalized polygon point
-
Uses of OptionHandler in adams.data.jai.features
Classes in adams.data.jai.features that implement OptionHandler Modifier and Type Class Description classDFTPerforms discrete fourier transform (DFT).classHistogramTurns an image into a histogram.
In case of an 8-bit histogram, the image must already be converted to a gray image.
The number of bins per channel can be chosen as well (1-256). -
Uses of OptionHandler in adams.data.jai.transformer
Classes in adams.data.jai.transformer that implement OptionHandler Modifier and Type Class Description classAbstractJAITransformerAbstract base class for JAI transformations.classAbstractScriptAncestor for JAI transformer scripts.classAbstractScriptedTransformerAbstract ancestor for transformers that execute external scripts.classBrightnessBrightens or darkens an image using the specified factor and offset.
factor: <0=darken image, >0=brighten image.classChangeOrientationEnsures that the image has the specified orientation.classDilateclassErodeclassFlipFlips an image.classGray8Transforms the image into an 8-bit gray image.classIndexedColorsTurns an RGB image into one with an indexed color palette.classInvertInverts the image.classResizeResizes the image to predefined width and height.classRotateRotates an image by a defined number of degrees.classScriptedAn image transformer that uses any scripting handler for processing the data with a script located in the specified file. -
Uses of OptionHandler in adams.data.lire.features
Classes in adams.data.lire.features that implement OptionHandler Modifier and Type Class Description classAutoColorCorrelogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.AutoColorCorrelogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
For more information see:
Huang, J.; Kumar, S.classBasicFeaturesGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.BasicFeatures.
For more information on the LIRE project, see:
http://www.lire-project.net/
classBinaryPatternsPyramidGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.BinaryPatternsPyramid.
Works the same way as PHOG, but instead of measuring the orientation of gradients, this class uses a histogram of rotation-invariant local binary patterns.
For more information on the LIRE project, see:
http://www.lire-project.net/
classCEDDGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.CEDD.
For more information, see:
Savvas A.classColorLayoutGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.ColorLayout.
For extracting & comparing MPEG-7 based CBIR descriptor ColorLayout.
For more information on the LIRE project, see:
http://www.lire-project.net/
classEdgeHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.EdgeHistogram.
Implements the EdgeHistogram descriptor from the MPEG-7 standard.
For more information on the LIRE project, see:
http://www.lire-project.net/
classFCTHGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.FCTH.
For more information, see:
Savvas A.classFuzzyColorHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.FuzzyColorHistogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
classFuzzyOpponentHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.FuzzyOpponentHistogram.
For more information, see:
van de Sande, K.E.A., Gevers, T., Snoek, C.G.M.classGaborGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.Gabor.
For more information on the LIRE project, see:
http://www.lire-project.net/
classJCDGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.JCD.
Joining CEDD and FCTH in one histogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
classJointHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.joint.JointHistogram.
For more information, see:
Mathias Lux, Savvas A.classJpegCoefficientHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.JpegCoefficientHistogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
classLocalBinaryPatternsGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.LocalBinaryPatterns.
For more information on the LIRE project, see:
http://www.lire-project.net/
classLocalBinaryPatternsAndOpponentGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.joint.LocalBinaryPatternsAndOpponent.
For more information, see:
Mathias Lux, Savvas A.classLuminanceLayoutGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.LuminanceLayout.
Intended for grayscale or B/W images.classOpponentHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.OpponentHistogram.
For more information, see:
van de Sande, K.E.A., Gevers, T., Snoek, C.G.M.classPHOGGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.PHOG.
For more information, see:
Anna Bosch, Andrew Zisserman & Xavier Munoz: Representing shape with a spatial pyramid kernel.classRankAndOpponentGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.joint.RankAndOpponent.
For more information, see:
Mathias Lux, Savvas A.classRotationInvariantLocalBinaryPatternsGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.RotationInvariantLocalBinaryPatterns.
For more information on the LIRE project, see:
http://www.lire-project.net/
classScalableColorGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.ScalableColor.
For more information on the LIRE project, see:
http://www.lire-project.net/
classSimpleCentristGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.centrist.SimpleCentrist.
For more information, see:
Jianxin Wu; Rehg, J.M.classSimpleColorHistogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.SimpleColorHistogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
classSpatialPyramidAutoColorCorrelogramGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.spatialpyramid.SPACC.
For more information, see:
Mathias Lux, Savvas A.classSpatialPyramidCEDDGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.spatialpyramid.SPCEDD.
For more information, see:
Savvas A.classSpatialPyramidCentristGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.centrist.SpatialPyramidCentrist.
For more information, see:
Jianxin Wu; Rehg, J.M.classSpatialPyramidFCTHGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.spatialpyramid.SPFCTH.
For more information, see:
Savvas A.classSpatialPyramidJCDGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.spatialpyramid.SPJCD.
Joining CEDD and FCTH in one histogram.
For more information on the LIRE project, see:
http://www.lire-project.net/
classSpatialPyramidLocalBinaryPatternsGenerates features using net.semanticmetadata.lire.imageanalysis.features.global.spatialpyramid.SPLBP.
For more information on the LIRE project, see:
http://www.lire-project.net/
classTamuraGenerates features using net.semanticmetadata.lire.imageanalysis.Tamura.
For more information on the LIRE project, see:
http://www.lire-project.net/
-
Uses of OptionHandler in adams.data.matlab
Subinterfaces of OptionHandler in adams.data.matlab Modifier and Type Interface Description interfaceMatlabArrayIndexSupporterInterface for classes that use an array index. -
Uses of OptionHandler in adams.data.matlab.multimatrixoperation
Classes in adams.data.matlab.multimatrixoperation that implement OptionHandler Modifier and Type Class Description classAbstractMultiMatrixOperationAbstract base class for operations that require multiple matrices.classAddPerforms element-wise addition and outputs the result as single matrix.classApplyMaskPerforms element-wise subtraction and outputs the result as single matrix.classCombineCombines the matrices into single one with additional dimension.classSubtractPerforms element-wise subtraction and outputs the result as single matrix. -
Uses of OptionHandler in adams.data.noise
Classes in adams.data.noise that implement OptionHandler Modifier and Type Class Description classAbstractDatabaseConnectionDenoiser<T extends DataContainer>Ancestor for denoisers that require database access.classAbstractDenoiser<T extends DataContainer>An abstract super class for algorithms that remove noise from data.classPassThroughA dummy denoiser, which removes no noise at all. -
Uses of OptionHandler in adams.data.objectfilter
Subinterfaces of OptionHandler in adams.data.objectfilter Modifier and Type Interface Description interfaceObjectFilterInterface for image object filters.Classes in adams.data.objectfilter that implement OptionHandler Modifier and Type Class Description classAbstractObjectFilterAncestor for image object filters.classAddDefaultLabelFor inserting a default label if missing.classAttachMetaDataAttaches the specified meta-data value.classAttachOverlappingMetaDataAttaches meta-data from the stored report
classClipBoundingBoxesEnsures that bounding boxes fall within the image boundaries.classMakeSquareGenerates a square bounding box around the current center of the bounding box.
Discards any polygon data.classMergeOverlapsMerges overlapping objects into single object.classOffsetIndexOffsets the object index.classPassThroughDummy, just returns the incoming object list.classRemoveDuplicatePolygonPointsRemoves duplicate points from polygons, e.g., introduced during scaling.classRemovePolygonsRemoves polygon information.classRenameLabelsFor renaming labels in the meta-data, stored under a specific key.
The rules for renaming are specified: old=new.classRotateRotates the objects using the specified degrees.
Requires the original image width before the image got rotated in order to rotate the objects correctly.classScaleScales the objects.classTransformMetaDataTransforms the specified meta-data using the referenced callable actor.classTranslateTranslates the objects by the specified X and Y.classUpdateBoundsFromPolygonIf polygon available, updates x//width/height with bounds of polygon. -
Uses of OptionHandler in adams.data.objectfinder
Subinterfaces of OptionHandler in adams.data.objectfinder Modifier and Type Interface Description interfaceObjectFinderInterface for finders that locate objects in the report of an image.Classes in adams.data.objectfinder that implement OptionHandler Modifier and Type Class Description classAbstractMetaObjectFinderAncestor for object finders that use a base finder.classAbstractObjectFinderAncestor for finders that locate objects in the report of an image.classAllFinderReturns all indices.classByMetaDataNumericValueReturns indices of objects which numeric meta-data value match the min/max.classByMetaDataStringValueOutputs the indices of objects where the specified regular expression matches the value associated with the given meta-data key.classHasMetaDataValueOutputs the indices of objects where the specified meta-data key is present.classInvertInverts the indices of the base object finder.classMultiObjectFinderApplies multiple object finding algorithms to the data.
The indices can be either joined or intersected.classNullFinderFinds no indices.classObjectsInRegionLocates the objects that fall into the defined region.
Partial hits can be considered as well.classPolygonPointsReturns the indices of objects which polygons satisfy specified min/max for number of points.classSizeApplies the minimum/maximum constraints to width/height (according to the chosen type). -
Uses of OptionHandler in adams.data.objectoverlap
Subinterfaces of OptionHandler in adams.data.objectoverlap Modifier and Type Interface Description interfaceBoundingBoxFallbackSupporterInterface for classes that can fall back on a bbox when the polygon is too small in relation to the bbox.interfaceLabelAwareObjectOverlapInterface forObjectOverlapclasses that can distinguish between correct/incorrect labels.interfaceObjectOverlapInterface for schemes that calculate image overlaps.interfaceOptionalBoundingBoxFallbackSupporterInterface for classes that can (optionally) fall back on a bbox when the polygon is too small in relation to the bbox.Classes in adams.data.objectoverlap that implement OptionHandler Modifier and Type Class Description classAbstractObjectOverlapAncestor for schemes that calculate image overlaps.classAreaRatioUses the area ratio between the annotated and predicted objects.classIntersectOverUnionRatioComputes the Intersect Over Union (IOU) between annotations and predictions.classNullDummy, does not calculate any overlaps. -
Uses of OptionHandler in adams.data.opencv.features
Classes in adams.data.opencv.features that implement OptionHandler Modifier and Type Class Description classAbstractOpenCVFeatureGeneratorAbstract base class for OpenCV feature generators.classAbstractScriptAncestor for OpenCV feature generator scripts.classAbstractScriptedFeatureGeneratorAbstract ancestor for OpenCV feature generator that execute external scripts.classHistogramComputes a histogram from the incoming image.classMultiOpenCVFeatureGeneratorApplies multiple generators to the same image and merges the generate a feature vectors side-by-side.classOtsuComputes the threshold using Otsu's method
classScriptedA feature generator that uses any scripting handler for processing the data with a script located in the specified file. -
Uses of OptionHandler in adams.data.opencv.multiimageoperation
Classes in adams.data.opencv.multiimageoperation that implement OptionHandler Modifier and Type Class Description classAbstractOpenCVMultiImageOperationAbstract base class for operations that require multiple images of type OpenCVImageContainer.classPassThroughDummy operation, simply passes on the input images.classReportFieldSubtractionFor each of the specified report fields, the difference between the value from the first report and the second is calculated. -
Uses of OptionHandler in adams.data.opencv.transformer
Classes in adams.data.opencv.transformer that implement OptionHandler Modifier and Type Class Description classAbstractOpenCVTransformerAbstract base class for OpenCV transformations.classAbstractScriptAncestor for OpenCV transformer scripts.classAbstractScriptedTransformerAbstract ancestor for transformers that execute external scripts.classBlurBlurs the image using the normalized box filter.
For more information see:
https://docs.opencv.org/4.6.0/d4/d86/group__imgproc__filter.html#ga8c45db9afe636703801b0b2e440fce37
classConvertTypeConverts the image according to the conversion code.classGaussianBlurApplies Gaussian blur to the image.
For more information see:
https://docs.opencv.org/4.6.0/d4/d86/group__imgproc__filter.html#gaabe8c836e97159a9193fb0b11ac52cf1
classMultiTransformerApplies the specified OpenCV transformers one after the other.classPassThroughA dummy transform that just passes the image through.classResizeResizes the image, either using absolute width/height or factors for x/y.classScriptedAn image transformer that uses any scripting handler for processing the data with a script located in the specified file.classSplitChannelsclassThresholdGenerates a binary image using the specified image. -
Uses of OptionHandler in adams.data.outlier
Subinterfaces of OptionHandler in adams.data.outlier Modifier and Type Interface Description interfaceOutlierDetector<T extends DataContainer>Interface for outlier detectors.interfaceTrainableOutlierDetector<T extends DataContainer>Interface for trainable outlier detectors.Classes in adams.data.outlier that implement OptionHandler Modifier and Type Class Description classAbstractDatabaseConnectionOutlierDetector<T extends DataContainer>Ancestor for outlier detectors that require a database connection.classAbstractOutlierDetector<T extends DataContainer>Abstract base class for outlier detectors.classAbstractScriptAncestor for outlier detector scripts.classAbstractScriptedOutlierDetectorAbstract ancestor for outlier detectors that execute external scripts.classExcludedChecks whether the 'Excluded' flag has been set in the report.classFieldRequiredChecks whether the specified field is present in the report.classFilteredOutlierDetector<T extends DataContainer>A meta detector that first filters the data through a filter before pushing it through the base detector.classGroovyAn outlier detector that uses a Groovy script for processing the data.classMinMaxDetects data containers where a report value is too high/low.classMultiOutlierDetector<T extends DataContainer>A meta-detector that runs multiple outlier detectors over the data.classPassThroughA dummy detector that detects nothing.classScriptedAn outlier detector that uses any scripting handler for processing the data with a script located in the specified file.classStringMatcherChecks whether the specified string field is available in the report and the value matches the specified regular expression.classTargetRequiredChecks whether the specified target field is available in the report.classTimeseriesMinPointsEnsures that a minimum number of points in the timeseries have the specified minimum value.classTimeseriesRangeEnsures that timeseries values lie within the defined range.classTimeseriesTimestampCheckChecks whether the timestamp with the specified index meets the condition (eg before or after the supplied timestamp). -
Uses of OptionHandler in adams.data.overlappingobjectremoval
Classes in adams.data.overlappingobjectremoval that implement OptionHandler Modifier and Type Class Description classAbstractOverlappingObjectRemovalAncestor for schemes that remove overlapping images objects.classKeepHighestMetaDataValueKeeps object with the highest (numeric) meta-data value.classMergeOverlapsMerges overlapping objects into single one.classPassThroughDoes nothing, just returns the image objects as is.classRemoveAllRemoves all objects that have overlaps.classRemoveLargerRectangleKeeps the smallest object, removes larger object(s).classRemoveSmallerRectangleKeeps the largest object, removes smaller object(s). -
Uses of OptionHandler in adams.data.random
Subinterfaces of OptionHandler in adams.data.random Modifier and Type Interface Description interfaceDistributionBasedRandomNumberGenerator<T extends Number>Interface for distribution-based random number generators.interfaceRandomDoubleRangeGenerator<T extends Number>Interface for random number generators that support returning random doubles within a certain range.interfaceRandomIntegerRangeGenerator<T extends Number>Interface for random number generators that support returning random integers within a certain range.interfaceRandomNumberGenerator<T extends Number>Interface for random number generators.interfaceSeededRandomNumberGenerator<T extends Number>Interface for seeded random number generators.Classes in adams.data.random that implement OptionHandler Modifier and Type Class Description classAbstractDistributionBasedRandomNumberGenerator<T extends Number>Ancestor for distribution-based random number generators.classAbstractRandomNumberGenerator<T extends Number>Ancestor for random number generators.classAbstractSeededRandomNumberGenerator<T extends Number>Ancestor for seeded random number generators.classJavaRandomByteRandom generator that generates random bytes using Java's java.util.Random class.classJavaRandomByteUnseededRandom generator that generates random integers using Java's java.util.Random class (unseeded).classJavaRandomDoubleRandom generator that generates random doubles (0-1) using Java's java.util.Random class.classJavaRandomDoubleUnseededRandom generator that generates random doubles (0-1) using Java's java.util.Random class (unseeded).classJavaRandomIntRandom generator that generates random integers using Java's java.util.Random class.classJavaRandomIntUnseededRandom generator that generates random integers using Java's java.util.Random class (unseeded). -
Uses of OptionHandler in adams.data.report
Classes in adams.data.report that implement OptionHandler Modifier and Type Class Description classAbstractDatabaseConnectionReportFilter<T extends DataContainer>Ancestor for report filters that require database access.classAbstractFilteredReportFilterAncestor for report filters that ensure that certain fields are retained in the output when applying a report filter.classAbstractReportFilter<T extends DataContainer>Abstract base class for filters that process Reports.classAbstractScriptAncestor for report filter scripts.classAbstractScriptedReportFilterAbstract ancestor for report filters that execute external scripts.classFilteredReportFilter<T extends DataContainer>This filter first pushes the data through the provided data filter before applying the actual report filter.classGroovyA report filter that uses a Groovy script for processing the data.classPassThroughA dummy filter that just passes the data through.classRemoveByDataTypeRemoves all fields from the report that match the defined data types.classRemoveByNameRemoves all fields from the report which names match the specified regular expression.classScriptedA report filter that uses any scripting handler for processing the data with a script located in the specified file. -
Uses of OptionHandler in adams.data.smoothing
Classes in adams.data.smoothing that implement OptionHandler Modifier and Type Class Description classAbstractDatabaseConnectionSmoother<T extends DataContainer>Ancestor for filters that require database access.classAbstractLOWESSBased<T extends DataContainer>Abstract ancestor for LOWESS-based smoothers.classAbstractSavitzkyGolayBased<T extends DataContainer>Abstract ancestor for Savitzky-Golay-based smoothers.classAbstractSlidingWindow<T extends DataContainer>Abstract sliding window smoother.classAbstractSmoother<T extends DataContainer>Abstract base class for smoothing schemes.classPassThroughA dummy smoother that just passes the data through.classTimeseriesLOWESSBasedA LOWESS based smoothing algorithm.
For more information on LOWESS see:
WikiPedia.classTimeseriesSavitzkyGolayBasedA Savitzky-Golay based smoothing algorithm.
It uses a Savitzky-Golay filter with derivative order 0 and adding of mass-spec data turned on.
For more information on Savitzky-Golay see:
A.classTimeseriesSlidingWindowUses a sliding window for determining the median/average inside the window. -
Uses of OptionHandler in adams.data.spc
Subinterfaces of OptionHandler in adams.data.spc Modifier and Type Interface Description interfaceControlChartInterface for all control charts.interfaceControlChartWithSampleSizeInterface for all control charts with sample sizes.interfaceIndividualsControlChartInterface for control charts that work on individuals rather than samples.interfaceMatrixControlChartInterface for control charts that work on a matrix.interfaceSamplesControlChartInterface for control charts that work on samples rather than individuals.interfaceViolationFinderInterface for algorithms that check for violations.Classes in adams.data.spc that implement OptionHandler Modifier and Type Class Description classAbstractControlChartAncestor for control charts.classAbstractControlChartWithSampleSizeAncestor for control charts.classAbstractViolationFinderAncestor for algorithms that check for violations.classBeyondLimitsViolationsFlags any data point as violation if below lower or above upper limit.classCChartGenerates data for a c chart.
For more information see:
QICacros.classMOACUSUMCUSUM (cumulative sum control chart) is a sequential analysis technique developed by E.classMOAPageHinkleyPage-Hinkley Test.
This version is based on MOA's drift detector:
https://github.com/apache/incubator-samoa/blob/9b178f63152e5b4c262e0f3ed28e77667832fc98/samoa-api/src/main/java/org/apache/samoa/moa/classifiers/core/driftdetection/PageHinkleyDM.java
classNPChartGenerates data for an np chart.
For more information see:
QICacros.classNullViolationsFlags nothing as violation.classOnOneSideViolationsFlags a data point as violation if it is the start of consecutive sequence (of specified minimum length) of points that are all on one side.classPChartGenerates data for a p chart.
For more information see:
QICacros.classUChartGenerates data for a u chart.
For more information see:
QICacros.classXBarRChartGenerates data for a XBar R chart.
For more information see:
QICacros.classXBarSChartGenerates data for an XBar S chart.
For more information see:
QICacros. -
Uses of OptionHandler in adams.data.splitgenerator
Subinterfaces of OptionHandler in adams.data.splitgenerator Modifier and Type Interface Description interfaceCrossValidationFoldGenerator<I,O>Interface for generating cross-validation folds.interfaceRandomSplitGenerator<I,O>Interface for generators of random splits of datasets.interfaceSplitGenerator<I,O>Interface for classes that generate dataset splits.interfaceStratifiableSplitGenerator<I,O>Interface for split generators that can stratify the randomized data. -
Uses of OptionHandler in adams.data.splitgenerator.generic.randomization
Classes in adams.data.splitgenerator.generic.randomization that implement OptionHandler Modifier and Type Class Description classAbstractRandomizationAncestor for randomization schemes.classDefaultRandomizationRandomizes the data using a random number generator initialized with the seed value.classPassThroughPerforms no randomization. -
Uses of OptionHandler in adams.data.splitgenerator.generic.splitter
Classes in adams.data.splitgenerator.generic.splitter that implement OptionHandler Modifier and Type Class Description classAbstractSplitterAncestor for splitter schemes.classDefaultSplitterSplits the data using the specified percentage for training and rest for testing. -
Uses of OptionHandler in adams.data.splitgenerator.generic.stratification
Classes in adams.data.splitgenerator.generic.stratification that implement OptionHandler Modifier and Type Class Description classAbstractStratificationAncestor for stratification schemes.classDefaultStratificationStratifies the data.classPassThroughPerforms no stratification. -
Uses of OptionHandler in adams.data.spreadsheet
Classes in adams.data.spreadsheet that implement OptionHandler Modifier and Type Class Description classAbstractObjectHandler<T>Ancestor for handlers that manage theCell.ContentType.OBJECTtype of cells.classJsonObjectHandlerHandler for JSON.classStringObjectHandlerDummy handler for strings. -
Uses of OptionHandler in adams.data.spreadsheet.cellfinder
Classes in adams.data.spreadsheet.cellfinder that implement OptionHandler Modifier and Type Class Description classAbstractCellFinderAncestor for schemes that locate cells of interest in a spreadsheet.classAbstractRowCellFinderAncestor for cell finders that operate on sheets or rows.classCellRangeLocator that locates cells using a rectangular range.classCellTypeRangeLocator that locates cells of a certain type using a rectangular range.classColumnFinderRangeUses a column finder to locate the interesting columns.classCorrespondingColumnRather than return a cell that was located using the given cell finder, you can return a corresponding cell (within the same row).
This allows you to locate cells with certain value but then update a different column in the same row.classRowFinderRangeUses a row finder to locate the interesting rows.classSingleCellSimple locator that just locates a single cell. -
Uses of OptionHandler in adams.data.spreadsheet.colstatistic
Classes in adams.data.spreadsheet.colstatistic that implement OptionHandler Modifier and Type Class Description classAbstractColumnStatisticAncestor for column statistic generators.classAbstractDoubleArrayColumnStatisticAncestor for statistics that just use all numeric values in the column.classArrayStatisticPushes the numeric column through the specified array statistic.classDistinctCounts the distinct numeric/string values.classIQRCalculates the IQR (interquartile range) for a numeric column.classLabelCountsCounts how often a label (ie string) occurs.classMaxCalculates the max for a numeric column.classMeanCalculates the mean for a numeric column.classMedianCalculates the median for a numeric column.classMinCalculates the min for a numeric column.classMissingCounts the missing cells.classMultiColumnStatisticCombines the statistics calculated from the specified statistic generators.classPercentileCalculates the specified percentile.classSignalToNoiseRatioCalculates the signal to noise ratio for a numeric column.
For more information, see:
WikiPedia.classStandardDeviationCalculates the standard deviation (population or sample).classSumCalculates the sum for a numeric column.classUniqueCounts the unique occurrences of numeric/string values. -
Uses of OptionHandler in adams.data.spreadsheet.columnfinder
Classes in adams.data.spreadsheet.columnfinder that implement OptionHandler Modifier and Type Class Description classAbstractColumnFinderAncestor for classes that find columns of interest in spreadsheets.classAbstractFilteredColumnFinderAncestor for column finders that pre-filter the columns.classAbstractTrainableColumnFinderAncestor forColumnFinderalgorithms that can be trained.classAllFinderDummy finder, finds all columns.classByContentTypeReturns indices of columns that satisfy the specified content types.classByExactNameReturns indices of columns which names match the exact name.classByIndexReturns indices of columns that fall in the defined range.classByNameReturns indices of columns which names match the regular expression.classDownSampleReturns the indices of every n-th column.classFilteredColumnFinderFilters the data first before applying the actual finder to locate the columns.classInvertInverts the selected columns of the provided sub-column-filter.classMultiColumnFinderApplies multiple column finding algorithms to the data.
The indices can be either joined or intersected.classNullFinderDummy finder, does not find any columns.classRowFilteredColumnFinderThis column finder first filters the rows before finding any columns on the subset of rows.classSubSampleReturns the indices of a subsample of columns. -
Uses of OptionHandler in adams.data.spreadsheet.filter
Classes in adams.data.spreadsheet.filter that implement OptionHandler Modifier and Type Class Description classAbstractSpreadSheetFilterAncestor for spreadsheet filters.classAbstractTrainableSpreadSheetFilterAncestor for trainable spreadsheet filters.classNormalizeNormalizes numeric columns to the specified lower and upper bound.classPassThroughDummy filter.classStandardizeStandardizes numeric columns to mean 0.0 and standard deviation 1.0.classWekaFilterApplies a Weka filter to the data. -
Uses of OptionHandler in adams.data.spreadsheet.matrixstatistic
Classes in adams.data.spreadsheet.matrixstatistic that implement OptionHandler Modifier and Type Class Description classAbstractMatrixStatisticAncestor for matrix statistic generators, i.e., ones that take the specified subset of the spreadsheet into account.classMaxDetermines the largest numeric value in the matrix, skips NaN and infinity values.classMeanDetermines the mean of the numeric values in the matrix, skips NaN and infinite values.classMedianDetermines the median of the numeric values in the matrix, skips NaN and infinite values.classMinDetermines the smallest numeric value in the matrix, skips NaN and infinite values.classMissingCounts the missing cells in the spreadsheet.classMultiMatrixStatisticCombines the statistics calculated from the specified statistic generators.classStandardDeviationDetermines the standard deviation of the numeric values in the matrix, skips NaN and infinite values. -
Uses of OptionHandler in adams.data.spreadsheet.rowfinder
Classes in adams.data.spreadsheet.rowfinder that implement OptionHandler Modifier and Type Class Description classAbstractFilteredRowFinderAncestor for row finders that pre-filter the rows.classAbstractRowFinderAncestor for classes that find rows of interest in datasets.classAbstractTrainableRowFinderAncestor forRowFinderalgorithms that can be trained.classAllFinderDummy finder, returns all rows.classByContentTypeReturns indices of rows which match the specified content type.classByDateValueReturns indices of rows which date/time type falls between the min/max.classByIndexReturns indices of rows that fall in the defined range.classByNumericRangeReturns indices of rows which numeric value fall into the specified intervals.classByNumericValueReturns indices of rows which numeric value match the min/max.classByStringComparisonReturns indices of rows which string value match the min/max.classByValueReturns indices of rows which label match the regular expression.classClosestNumericValueReturns the index of the row that comes closest to the provided numeric value.classDownSampleReturns the indices of every n-th row.classInvertInverts the selected rows of the provided sub-row-filter.classIsNumericReturns indices of rows that have numeric values in the specified column.classMissingValueReturns indices of rows which label match the regular expression.classMultiRowFinderApplies multiple row finding algorithms to the data.
The indices can be either joined or intersected.classNullFinderDummy finder, does not find any rows.classSubSampleReturns the indices of a subsample of rows. -
Uses of OptionHandler in adams.data.spreadsheet.rowscore
Classes in adams.data.spreadsheet.rowscore that implement OptionHandler Modifier and Type Class Description classAbstractMetaRowScoreAncestor for row score algorithms that use a base algorithm.classAbstractRowScoreAncestor for algorithms that calculate a score for a spreadsheet row.classArrayStatisticApplies the specified array statistic algorithm and returns the specified cell's value as score.
NB: Only collects numeric values from the rows.classColumnSubsetApplies the specified base row score algorithm to the specified subset of columns and returns the calculated score.classDistanceFromConstantCalculates the Euclidean distance to a timeseries that is basically a 'flat-liner' with a constant value.classEqualWidthBinsSplits the row into bins with (more or less) same size and applies the base score algorithm to each of the bins.classMathExpressionUses a mathematical expression to post-process or combine the score(s) returned from the base row score algorithm.
The individual scores of the base algorithm can be accessed using placeholders of the format: [n] with 'n' being the 1-based index in the score array.
'null' scores get interpreted as 'NaN'.classMultiRowScoreApplies the specified row score algorithms sequentially to the row and combines the output.classNonMissingComputes the percentage of non-missing values per row.classRowStatisticApplies the specified row statistic algorithm and returns the specified cell's value as score.classSAXDistanceFromBaselineApplies adams.data.filter.RowNorm to the timeseries before calculating the SAX distance of the timeseries to the baseline. -
Uses of OptionHandler in adams.data.spreadsheet.rowstatistic
Classes in adams.data.spreadsheet.rowstatistic that implement OptionHandler Modifier and Type Class Description classAbstractDoubleArrayRowStatisticAncestor for statistics that just use all numeric values in the row.classAbstractRowStatisticAncestor for row statistic generators.classArrayStatisticPushes the numeric row through the specified array statistic.classDistinctCounts the distinct numeric/string values.classIQRCalculates the IQR (interquartile range) for a numeric row.classLabelCountsCounts how often a label (ie string) occurs.classMaxCalculates the max for a numeric row.classMeanCalculates the mean for a numeric row.classMedianCalculates the median for a numeric row.classMinCalculates the min for a numeric row.classMissingCounts the missing cells.classMultiRowStatisticCombines the statistics calculated from the specified statistic generators.classPercentileCalculates the specified percentile.classSignalToNoiseRatioCalculates the signal to noise ratio for a numeric row.
For more information, see:
WikiPedia.classStandardDeviationCalculates the standard deviation (population or sample).classSumCalculates the sum for a numeric row.classUniqueCounts the unique occurrences of numeric/string values. -
Uses of OptionHandler in adams.data.spreadsheet.sql
Classes in adams.data.spreadsheet.sql that implement OptionHandler Modifier and Type Class Description classAbstractTypeMapperAncestor for type mappers (spreadsheet to/from SQL).classDefaultTypeMapperDefault type mapper, works with MySQL and PostgreSQL.classMSSQLServerTypeMapperMS SQL Server type mapper. -
Uses of OptionHandler in adams.data.statistics
Classes in adams.data.statistics that implement OptionHandler Modifier and Type Class Description classAbstractArrayDistance<T extends Number>Ancestor for distance measures.classAbstractArrayStatistic<T extends Serializable>Ancestor for classes that calculate statistics from arrays.classAbstractDataContainerStatistics<T extends DataContainer>Ancestor for all schemes that calculate statistics on data containers.classAbstractOptionalSampleArrayStatistic<T extends Serializable>Abstract super class for array statistics that can interprete the arrays either as samples or populations.classArrayAndrewsCurves<T extends Number>Generates Andrews Curves from array data.
César Ignacio GarcÃa Osorio, Colin Fyfe (2003).classArrayAngle<T extends Number>Calculates the angle between the first array and the remaining arrays.classArrayBinning<T extends Number>Bins the data from given array using the specified algorithm and post-processing approach.classArrayChebyshevDistanceCalculates the Chebyshev distance between the first array and the remaining arrays.classArrayCorrelationCoefficient<T extends Number>Calculates the correlation coefficient between the first array and the remaining arrays.classArrayCovariance<T extends Number>Calculates the covariance between the first array and the remaining arrays.classArrayDifference<T extends Number>Calculates the difference between the arrays.classArrayEuclideanDistanceCalculates the Euclidean distance between the first array and the remaining arrays.classArrayHistogram<T extends Number>Generates a histogram from the given array.
The formulas for the various width/#bin calculations can be found here:
WikiPedia (2010).classArrayKendallTheil<T extends Number>Calculates the Kendall-Theil robust slope (also called Theil-Sen estimator) between the first array and the remaining arrays.classArrayLength<T extends Serializable>Determines the length of an array.classArrayLinearRegression<T extends Number>Calculates the slope and intercept of linear regression between two arrays (x and y).
If more than two arrays supplied, then the linear regression is computed between the first (x) and all the other ones (y).classArrayManhattanDistanceCalculates the Manhattan distance between the first array and the remaining arrays.classArrayMax<T extends Number>Determines the max value in a numeric array.classArrayMean<T extends Number>Calculates the mean for a numeric array.classArrayMeanAbsoluteError<T extends Number>Calculates the mean absolute error (MAE) between the first array (actual) and the remaining arrays (predicted).classArrayMedian<T extends Number>Calculates the median for a numeric array.classArrayMin<T extends Number>Determines the min value in a numeric array.classArrayMinkowskiDistanceCalculates the Minkowski distance between the first array and the remaining arrays.classArrayNormalize<T extends Number>Normalizes the array(s), i.e., the sum of its/their values is 1.0.classArrayNormalizeRange<T extends Number>Normalizes the array(s) to the specified lower and upper bound.classArrayPercentile<T extends Number>Determines the percentile for an array.classArrayRelativeAbsoluteError<T extends Number>Calculates the relative absolute error (RAE) between the first array (actual) and the remaining arrays (predicted).classArrayRootMeanSquaredError<T extends Number>Calculates the root mean squared error (RMSE) between the first array (actual) and the remaining arrays (predicted).classArrayRootRelativeSquaredError<T extends Number>Calculates the root relative squared error (RRSE) between the first array (actual) and the remaining arrays (predicted).classArrayRSquared<T extends Number>Calculates the R^2 between the first array and the remaining arrays.classArrayStandardDeviation<T extends Number>Calculates the standard deviation for a numeric array.classArrayStandardize<T extends Number>Standardizes the values in the array(s) to have mean 0 and stdev 1.classArrayStandardScores<T extends Number>Calculates the standard scores (or z scores) of the provided arrays.The arrays must be numeric, of course.classArraySum<T extends Number>Determines the sum of all values in a numeric array.classMultiArrayStatistic<T extends Number>Merges the spreadsheets generated by its sub-statistics into a single one. -
Uses of OptionHandler in adams.data.textrenderer
Classes in adams.data.textrenderer that implement OptionHandler Modifier and Type Class Description classAbstractLimitedTextRendererAncestor for renderers that can limit the output.classAbstractLineNumberedLimitedTextRendererAncestor for text renderers that can output line numbers.classAbstractTextRendererAncestor for text renderer classes.classArrayTextRendererRenders arrays to the specified limit of elements.classCollectionTextRendererJust uses the object's toString() method.classDefaultTextRendererJust uses the object's toString() method.classIndexedSplitsRunsRendererRenders indexed splits runs as text.classJsonTextRendererRenders JSON objects.classListTextRendererJust uses the object's toString() method.classMapTextRendererRenders Map objects.classSetTextRendererRenderes Set objects.classSpreadSheetTextRendererRenders spreadsheet as CSV up to the specified maximum of rows.classTextSupporterTextRendererOutputs the text representation returned from TextSupporter classes. -
Uses of OptionHandler in adams.data.timeseries
Classes in adams.data.timeseries that implement OptionHandler Modifier and Type Class Description classAbstractMetaTimeseriesFeatureGeneratorAncestor for generators that use a base generator.classAbstractTimeseriesFeatureGenerator<T extends Timeseries>Abstract base class forTimeseriesfeature generation.classAddMetaDataMeta-generator that can add database ID and container ID.classFixedNumFeaturesMeta-feature-generator that ensures that the generated output has a fixed number of data points.
In case of filler type FIRST, the data gets inserted at the start, as opposed to at the end when using LAST.
NUMERIC/STRING/BOOLEAN use the appropriate filler value that the user specified.
The MISSING_* types just add a missing value of the appropriate data type.classValuesSimple feature generator that just outputs all the values of a timeseries. -
Uses of OptionHandler in adams.data.weka.classattribute
Classes in adams.data.weka.classattribute that implement OptionHandler Modifier and Type Class Description classAbstractClassAttributeHeuristicAncestor for heuristics that determine the class attribute for a dataset.classAttributeIndexUses the supplied attribute index to select the class attribute.classByExactNameReturns indices of columns which names match the exact name.classByNameThe first attribute name that matches the regular expression is used as class attribute.classLastAttributeSimply chooses the last attribute as class attribute.classNoClassAttributeNever returns a class attribute. -
Uses of OptionHandler in adams.data.weka.columnfinder
Subinterfaces of OptionHandler in adams.data.weka.columnfinder Modifier and Type Interface Description interfaceColumnFinderInterface for classes that "find" columns of interest in datasets.interfaceTrainableColumnFinderInterface forColumnFinderalgorithms that can be trained.Classes in adams.data.weka.columnfinder that implement OptionHandler Modifier and Type Class Description classAbstractColumnFinderAncestor for classes that find columns of interest in datasets.classAbstractColumnFinderWithCapabilitiesAncestor for classes that find columns of interest in datasets.classAbstractFilteredColumnFinderAncestor for column finders that pre-filter the columns.classAbstractTrainableColumnFinderAncestor forColumnFinderalgorithms that can be trained.classAllFinderDummy finder, finds all columns.classByExactNameReturns indices of columns which names match the exact name.classByNameReturns indices of attributes which names match the regular expression.classClassColumn finder which finds the class column (if one is set).classConstantColumn finder that finds a constant set of columns.classInvertInverts the selected columns of the provided sub-column-filter.classMultiColumnFinderApplies multiple column finding algorithms to the data.
The indices can be either joined or intersected.classNullFinderDummy finder, does not find any columns.classRowFilteredColumnFinderThis column finder first filters the rows before finding any columns on the subset of rows. -
Uses of OptionHandler in adams.data.weka.datasetsplitter
Classes in adams.data.weka.datasetsplitter that implement OptionHandler Modifier and Type Class Description classAbstractSplitterParent class for different methods of splitting a dataset into smaller datasets.classColumnSplitterSplits a dataset in two based on the columns selected by a column-finder.classRowSplitterSplits a dataset in two based on the rows selected by the row-finder. -
Uses of OptionHandler in adams.data.weka.evaluator
Classes in adams.data.weka.evaluator that implement OptionHandler Modifier and Type Class Description classAbstractCrossvalidatedInstanceEvaluator<T extends AbstractCrossvalidatedInstanceEvaluator.EvaluationContainer>Ancestor for evalutors that use cross-validation for initialization.classAbstractDatasetInstanceEvaluatorAncestor for evaluators that need a data set for initialization.classAbstractInstanceEvaluatorAncestor for evaluators that evaluate weka.core.Instance objects.classIntervalEstimatorBasedUses a classifier that produces confidence intervals.classPassThroughA dummy evaluator that OKs all data. -
Uses of OptionHandler in adams.data.weka.predictions
Classes in adams.data.weka.predictions that implement OptionHandler Modifier and Type Class Description classAbstractErrorScalerAncestor for classes that scale predictions.classAutoScalerApplies the specified numeric scaler to the data in case of a numeric class attribute, otherwise just passes on the data.classFixedSizeErrorScalerScales the errors to a fixed size.classNumericErrorScalerWithReferenceScales the errors for numeric class attributes, using an user-specified error as reference point for a specified size.classRelativeNumericErrorScalerScales the errors for numeric class attributes.classRoundErrorScalerPerforms no scaling at all, just rounds the error to the next integer. -
Uses of OptionHandler in adams.data.weka.relationname
Classes in adams.data.weka.relationname that implement OptionHandler Modifier and Type Class Description classAbstractRelationNameHeuristicAncestor for heuristics that determine the relation name for a dataset.classAttributeIndexUses the name of the specified attribute as relation name.classClassAttributeUses the class attribute name.classFileNameSuggests the file name (without extension) as the relation name.classNoChangeSimply returns the current relation name. -
Uses of OptionHandler in adams.data.weka.rowfinder
Subinterfaces of OptionHandler in adams.data.weka.rowfinder Modifier and Type Interface Description interfaceRowFinderInterface for classes that "find" rows of interest in datasets.interfaceTrainableRowFinderInterface forRowFinderalgorithms that can be trained.Classes in adams.data.weka.rowfinder that implement OptionHandler Modifier and Type Class Description classAbstractFilteredRowFinderAncestor for row finders that pre-filter the rows.classAbstractRowFinderAncestor for classes that find rows of interest in datasets.classAbstractRowFinderWithCapabilitiesAncestor for classes that find rows of interest in datasets.classAbstractTrainableRowFinderAncestor forRowFinderalgorithms that can be trained.classAllFinderDummy finder, finds all rows.classByLabelReturns the indices of rows which attributes labels match the provided regular expression.classByNumericRangeReturns indices of rows which numeric value match the min/max.classByNumericValueReturns indices of rows which numeric value match the min/max.classConstantRow finder that finds a constant set of rows.classFilteredIQRReturns indices of rows that got identified as outliers/extreme values.classInvertInverts the selected rows of the provided sub-row-filter.classMultiRowFinderApplies multiple row finding algorithms to the data.
The indices can be either joined or intersected.classNullFinderDummy finder, does not find any rows. -
Uses of OptionHandler in adams.db
Subinterfaces of OptionHandler in adams.db Modifier and Type Interface Description interfaceBackendManagerInterface for database backends.interfaceDbBackendInterface for classes that return actual implementations of the processing database interfaces.Classes in adams.db that implement OptionHandler Modifier and Type Class Description classAbstractConditionsAbstract ancestor for classes that encapsulate conditions for database retrieval.classAbstractDatabaseConnectionDatabaseConnection manages the interface to the database back-end.classAbstractDatabaseObjectWithOptionHandlingAbstract ancestor for classes that need to be able to change the database connection with commandline parameters.classAbstractDbBackendAncestor for classes that provide a processing backend.classAbstractLimitedConditionsAbstract ancestor for conditions that limit the number of records retrieved.classAbstractReconnectableDatabaseConnectionAncestor for database connection classes that offer reconnecting to another URL.classAbstractTableCleanUpAncestor of classes that clean up tables in some fashion.classAbstractTimeWindowTableCleanUpAncestor for clean up schemes that use a time window.classDatabaseConnectionDatabaseConnection manages the interface to the database back-end.classLogEntryConditionsConditions for retrieving log entries.classSQLTableCleanUpExecutes an SQL statement to clean up the table. -
Uses of OptionHandler in adams.db.autodetect
Classes in adams.db.autodetect that implement OptionHandler Modifier and Type Class Description classDbBackendAuto-detection database backend. -
Uses of OptionHandler in adams.db.datatype
Classes in adams.db.datatype that implement OptionHandler Modifier and Type Class Description classAbstractDataTypeSetupAncestor for classes that update a database connection, configuring additional data types.classDummySetupDummy setup, does nothing.classMultiSetupCombines (and executes) multiple setups. -
Uses of OptionHandler in adams.db.mirrored
Classes in adams.db.mirrored that implement OptionHandler Modifier and Type Class Description classDbBackendMySQL Spectral backend. -
Uses of OptionHandler in adams.db.mysql
Classes in adams.db.mysql that implement OptionHandler Modifier and Type Class Description classDbBackendMySQL database backend. -
Uses of OptionHandler in adams.db.postgresql
Classes in adams.db.postgresql that implement OptionHandler Modifier and Type Class Description classDbBackendPostgreSQL database backend. -
Uses of OptionHandler in adams.db.sqlite
Classes in adams.db.sqlite that implement OptionHandler Modifier and Type Class Description classDbBackendSQLite database backend. -
Uses of OptionHandler in adams.db.upgrade
Classes in adams.db.upgrade that implement OptionHandler Modifier and Type Class Description classAbstractTableUpgradeAbstract superclass for all helper classes that upgrade tables in one way or another.classPassThroughA dummy upgrader, does nothing. -
Uses of OptionHandler in adams.doc.javadoc
Classes in adams.doc.javadoc that implement OptionHandler Modifier and Type Class Description classAllJavadocApplies all known Javadoc-derived classes to a source file.classFlowJavadocGenerates Javadoc comments for the AbstractActor.classGlobalInfoJavadocGenerates Javadoc comments from the class's globalInfo method.classGrammarJavadocGenerates Javadoc comments for the GrammarSupplier.classJavadocAbstract superclass for classes that generate Javadoc comments and replace the content between certain comment tags.classOptionHandlerJavadocGenerates Javadoc comments from the OptionHandler's options.classScriptletJavadocGenerates Javadoc comments for an AbstractScriptlet.classTechnicalInformationHandlerJavadocGenerates Javadoc comments from the TechnicalInformationHandler's data. -
Uses of OptionHandler in adams.doc.listing
Classes in adams.doc.listing that implement OptionHandler Modifier and Type Class Description classAbstractFileBasedListingOutputAncestor for schemes that output the listings to a file.classAbstractFileBasedListingOutputWithEncodingAncestor for output schemes that support file encodings.classAbstractListingOutputAncestor for classes that output the generated lists.classConsoleOutputOutputs the listings in simple plain text in the console.classHtmlOutputOutputs the listing in HTML to the specified file.classListingGenerates class listings per module.classMarkdownOutputOutputs the listing in Markdown to the specified file.classOptionOutputCreates a sub-directory for each module and stores the generated output in there, one file per class. -
Uses of OptionHandler in adams.flow
Classes in adams.flow that implement OptionHandler Modifier and Type Class Description classFlowRunnerExecutes flows from command-line.
It is also possible to traverse a directory and execute all flows within that match a regular expression.
Using the 'no-execute' option, you can suppress the flow execution, but still test whether the flow loads and can be fully set up and wrapped up.classFlowSetupRunnerRuns a flow control center setup from commandline. -
Uses of OptionHandler in adams.flow.condition.bool
Classes in adams.flow.condition.bool that implement OptionHandler Modifier and Type Class Description classAbstractAttributeCapabilitiesAncestor for capabilities-based conditions.classAbstractBooleanConditionAncestor for conditions that get evaluated in, e.g., the IfThenElse control actor, deciding which branch to take.classAbstractBooleanDatabaseConditionAncestor for conditions that operate on a database.classAbstractExpressionAncestor for conditions that use a boolean expression.classAbstractMultiConditionAncestor for conditions that use multiple sub-conditions.classAbstractScriptAncestor for boolean script conditions.classAbstractScriptedConditionAbstract ancestor for actors that execute scripts.classAdamsInstanceCapabilitiesFilters adams.data.instance.Instance based on defined capabilities.classAndPerforms a logical AND over all its sub-conditions, i.e., it only evaluates to 'true' if all of the sub-conditions evaluate to 'true' as well.classBinaryFileEvaluates to 'true' if the file exists and is a binary file.
A heuristic is used to determine whether a file is binary, based on the first 1024 bytes.classBooleanReportValueReturns 'true' if the boolean field in the report is present and is 'true'.classBytesCompleteEvaluates to 'true' if the bytes from the token are considered a 'complete' file.classCountingCounts the tokens passing through and returns 'true' if min/max/interval are met.classDirectoriesMatchEvaluates to 'true' if at least one sub-directory matches the regular expression in the specified directory.classDirectoryExistsEvaluates to 'true' if the directory exists.classExpressionEvaluates to 'true' if the expression evaluates to 'true'.
In case of java.lang.Number tokens that arrive at the input, these can be accessed in the expression via 'X'; string tokens can be accessed via expression '"X"' (surrounding double quotes are required).
If the incoming token is either a Report or a ReportHandler, the contents of the report get added as values as well (boolean, numeric or string) and you can access them via their name instead of 'X'.
The following grammar is used for evaluating the boolean expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classFalseAlways evaluates to 'false'.classFileCompleteEvaluates to 'true' if the file (from option or token) is considered complete.classFileExistsEvaluates to 'true' if the file exists.
If a filename generator other than adams.core.io.NullFilenameGenerator is specified, then this takes precedence over the supplied filename (uses the token passing through).classFileInUseEvaluates to 'true' if the file is currently being used by another process.
If a filename generator other than adams.core.io.NullFilenameGenerator is specified, then this takes precedence over the supplied filename (uses the token passing through).classFilesMatchEvaluates to 'true' if at least one file matches the regular expression in the specified directory.classGroovyA boolean condition that uses the condition defined in a Groovy script.classHasClassEvaluates to 'true' if the specified class is available on the classpath.classHasColumnChecks whether the spreadsheet passing through has a certain column.classHasElementsChecks whether the array passing through has a at least the specified number of elements.classHasExifTagChecks whether the specified EXIF tag is present.classHashSetEvaluates to true if the payload of the current token or the specified string (if non-empty) is present in the specified hashset.
The value gets transformed using the specified conversion.
See also:
adams.flow.standalone.HashSetInit
adams.flow.transformer.HashSetInit
classHasInterfaceEvaluates to 'true' if the objects implement the specified interface.classHasLengthChecks whether the array passing through has the required number of elements.classHasMapValueEvaluates to true if the specified java.util.Map object is available in storage and a value is associated with the supplied key.classHasPropertyEvaluates to 'true' if the objects have the specified property path.classHasQueueEvaluates to true if the specified queue is available in storage.classHasRowsChecks whether the spreadsheet passing through has the required number of rows.classHasSizeChecks whether the collection passing through has the required number of elements.classHasStorageValueEvaluates to true if the specified storage value is present.classHasVariableEvaluates to true if the specified variable is set.classHasVariableValueEvaluates to true if the specified variable is present and its value is the same as the specified one.classInListChecks whether the incoming string is among the specified items.classIsAndroidEvaluates to 'true' if the operating system is Android.classIsArm64Evaluates to 'true' if the system architecture is Arm64.classIsArrayEvaluates to 'true' if the object passing through represents an array.classIsBooleanEvaluates to 'true' if the payload of the token is a boolean string (true|false).classIsByteEvaluates to 'true' if the payload of the token is a byte number/string.classIsBzip2CompressedChecks whether the file or byte array is Bzip2 compressed.classIsDoubleEvaluates to 'true' if the payload of the token is a double number/string.classIsFloatEvaluates to 'true' if the payload of the token is a float number/string.classIsGzipCompressedChecks whether the file or byte array is Gzip compressed.classIsIntegerEvaluates to 'true' if the payload of the token is an integer number/string.classIsLinuxEvaluates to 'true' if the operating system is Linux.classIsLongEvaluates to 'true' if the payload of the token is a long number/string.classIsMacEvaluates to 'true' if the operating system is a Mac.classIsMat5ArrayChecks whether the object represents a Matlab array.classIsMat5MatrixChecks whether the object represents a Matlab matrix.classIsMat5StructChecks whether the object represents a Matlab struct data structure.classIsNullEvaluates to 'true' if the payload of the token passing through is null.classIsNumericEvaluates to 'true' if the payload of the token is a number or a numeric string.classIsRarCompressedChecks whether the file or byte array is Rar compressed.classIsShortEvaluates to 'true' if the payload of the token is a short number/string.classIsSubClassEvaluates to 'true' if the objects are derived from the specified superclass.classIsWindowsEvaluates to 'true' if the operating system is a Windows variant.classIsXzCompressedChecks whether the file or byte array is Xz compressed.classIsZipCompressedChecks whether the file or byte array is Zip compressed.classIsZstdCompressedChecks whether the file or byte array is Zstd compressed.classNotNegates the output of the specified condition.classNotesErrorsEvaluates to true if the notes handler passing through has any errors recorded.classOrPerforms a logical OR over all its sub-conditions, i.e., it evaluates to 'true' if any of the sub-conditions evaluates to 'true' as well.classPromptUserPrompts the user to click on 'positive' or 'negative' button.
The actor's name can be used in the message using the following placeholders:
{SHORT} - the short name
{FULL} - the full name (incl path)
Variables get expanded as well.
Can be used in a headless environment as well.classRegExpReturns the result of the regular expression matching the incoming string.classReportValueExistsReturns 'true' if the field in the report is present.classScriptedA boolean condition that uses the condition defined in an external script.classStorageFlagSetEvaluates to true if the specified storage value is present, a boolean and true.classTableExistsChecks whether table(s) exist that match the given regular expression.classTrueAlways evaluates to 'true'.classVariableFlagSetEvaluates to true if the specified variable is present, a boolean and true.classWekaCapabilitiesFilters weka.core.Instance and weka.core.Instances objects based on defined capabilities.classWekaClassificationUses the index of the classification, i.e., the predicted label, as index of the switch
-
Uses of OptionHandler in adams.flow.control
Subinterfaces of OptionHandler in adams.flow.control Modifier and Type Interface Description interfaceAtomicExecutionInterface for actors that can be configured to finish execution first before attempting to be stopped.interfaceFlowStructureModifierInterface for actors that modify the flow structure somehow.interfaceLocalScopeHandlerInterface for actor handlers that provide a local scope for their sub-actors.interfaceScopeHandlerFor actors that define a scope like theFloworLocalScopeTriggeractor.interfaceStorageHandlerInterface for actors that allow the storing of temporary data.Classes in adams.flow.control that implement OptionHandler Modifier and Type Class Description classAbstractConnectedControlActorAncestor for all actors that control (connected) sub-actors in some way.classAbstractContainerUpdaterAncestor for control actors that update a specific value of a container using the defined sub-actors.classAbstractControlActorAncestor for all actors that control sub-actors in some way.classAbstractDataContainerFileChecker<T extends DataContainer>Abstract ancestor for transformers that check data container files whether they are consistents before passing on the file/file arrays.classAbstractDirectedControlActorAncestor for all actors that control sub-actors in some way.classAbstractTeeAbstract ancestor for actors that tee-off tokens.classArrayGenerateApplies all sub-actors to the input token and generates an array from the collected output.
Each of the branches is expected to produce at most one output token (ideally one per branch, otherwise there will be null elements in the output array).classArrayProcessApplies all sub-actors to each of the array elements.classBlockBlocks the propagation of tokens if the condition evaluates to 'true', therefore acts like the 'continue' control statement.
In case of integer or double tokens that arrive at the input, these can be accessed in the expression via 'X'.
The following grammar is used for evaluating the boolean expressions (depends on the selected condition):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| sin ( expr )
| cos ( expr )
| tan ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classBranchBranches off the flow into several sub-branches, each being supplied with a copy of the same object being passed into this meta-actor.classBreakpointAllows to pause the execution of the flow when this actor is reached and the condition evaluates to 'true'.classCallableActorScreenshotTakes a screenshot of a callable actor whenever a token passes through.
The screenshot can either be written to disk (and the input token is forwarded), or the screenshot is forwarded as adams.data.image.BufferedImageContainer (dropping the input token).classCastCasts the incoming data to the specified classname.classClearCallableDisplayClears the referenced callable graphical actor whenever a token passes through.classCloseCallableDisplayCloses the referenced callable graphical actor whenever a token passes through.classCollectionProcessApplies all sub-actors to each of the collection elements.classConditionalSequenceThe sequence gets only executed if the condition holds true.classConditionalSubProcessEncapsulates a sequence of flow items.classConditionalTeeTees off the tokens if the condition evaluates to 'true'.classConditionalTriggerExecutes the tee-actor whenever a token gets passed through.classContainerValuePickerPicks a named value from any container object and tees it off.
With the 'switch-outputs' option it is possible to forward the named value and teeing off the container instead.
If 'ignore missing' is turned off, any value that cannot be found will generate an error logging message and, in case of switched outputs, an actual error.classCountCounts the number of tokens that pass through and meet the condition and tees off the current count every n-th token.classDesktopScreenshotTakes a screenshot of the desktop whenever a token passes through.classFileProcessorclassFlowContainer object for actors, used for executing a flow.classForceFlushForces all actors that implement adams.flow.core.FlushSupporter
See also:
adams.flow.sink.DumpFile
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classFreeMemoryAttempts to free up memory of the sub-flow that it belongs to.
This actor is useful in case when sub-flows are only executed once, but still keep their data-structures and gobble up unnecessary memory.classGCCalls the garbage collector.classHeapDumpGenerates a heapdump and saves it to the specified file (with .hprof extension) whenever a token passes through.classIfStorageValueAn If-Then-Else source actor for storage values.classIfThenElseEmulates an If-Then-Else construct.classInjectorInjects a string token into the token sequence.
The string can be inject before or after the current token.classInputOutputListenerListens to the input/output tokens of the sub-actors, sending them to callable actors.classInspectAllows the user to inspect tokens with the specified viewer.
Inspection can be done interactively, allowing the user to drop tokens, or non-interactively, with the viewer updating whenever a token passes through.
Of course, this actor should only be used during development for debugging purposes as can slow down the execution significantly depending on how expensive the view generation is.classJDepsRuns jdeps on the classname arriving at the input.
The application's classpath is automatically added to the command-line if no classpath directories or jars are provided.
Classpath directories and jars get combined, but directories take precedence over jars.classJMapRuns jmap whenever a token gets passed through.classLoadBalancerRuns the specified 'load actor' in as many separate threads as specified with the 'num-threads' parameter.
Always uses a copy of the variables.
NB: no callable transformer or sink allowed.classLocalScopeTransformerProvides a local scope for the sub-actors.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classLocalScopeTriggerExecutes the sub-actors whenever a token gets passed through, just like the adams.flow.control.Trigger actor, but also provides its own scope for variables and internal storage.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classMissionControlDisplays a control panel for pausing/resuming/stopping the flow.
Useful when executing flows from command-line with the flow runner, offering a minimal control interface.classMutableConnectedControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classMutableControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classOnceTees off a token only once to its sub-actors.
However, this can be reset when the monitored variable changes.classPlotContainerUpdaterApplies all sub-actors to process either the selected value of the plot container.classPlotProcessorApplies the specified processing algorithm to the stream of plot containers passing through.classRaiseErrorRaises a java.lang.Error if the condition evaluates to 'true', using the provided error message.
See also:
adams.flow.control.TryCatch
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classRejectorRejects data containers with errors attached.classRemoteExecutionTriggerTransfers the actors below itself, the specified storage items and variables using the specified connection for remote execution.
Uses the adams.scripting.command.flow.RemoteFlowExecution remote command behind the scenes.classRemoveOutliersAllows the user to interactively remove outliers.classSequenceEncapsulates a sequence of flow items.classSetContainerValueUpdates a single item in the container passing through, using either the data obtained from a callable actor or a storage item.
Using the 'force' option, additional meta-data can be stored in the container as well.classSinkResetResets all sub-actors in case the monitored variable changed since the last execution.classSleepWaits for a fixed amount of milli-seconds.classSourceResetResets all sub-actors in case the monitored variable changed since the last execution.classStopStops the execution of the flow when triggered.classStorageValueSequenceAfter executing a sequence of actors, the stored item is forwarded in the flow.classSubProcessEncapsulates a sequence of flow items.classSwitchEmulates a Switch control statement.classTeeAllows to tap into the flow and tee-off tokens.classTimedSubProcessEncapsulates a sequence of flow items.classTimedTeeAllows to tap into the flow and tee-off tokens.
Times how long the sub-flow execution takes and sends the time in milli-seconds (as double) in a adams.flow.container.TimingContainer container to the specified callable actor.classTimedTriggerExecutes the subs-actors whenever a token gets passed through.classTransformerResetResets all sub-actors in case the monitored variable changed since the last execution.classTriggerExecutes the tee-actor whenever a token gets passed through.classTriggerEventTriggers the specified event.classTriggerOnceTriggers the sub-flow only once.
However, this can be reset when the monitored variable changes.classTryCatchSafe-guards the execution of the 'try' sequence of actors.classUpdateCallableDisplayUpdates callable display actors that implement adams.flow.core.DataPlotUpdaterHandler.classUpdateContainerValueApplies all sub-actors to process the specified value of the container passing through.classUpdatePropertiesUpdates the properties of the sub-actor using the values associated with the specfiied variables.classWhileLoopEmulates a while-loop. -
Uses of OptionHandler in adams.flow.control.errorpostprocessor
Classes in adams.flow.control.errorpostprocessor that implement OptionHandler Modifier and Type Class Description classAbstractErrorPostProcessorAncestor for post-processors for error messages.classNullDummy post-processor, does nothing.classOutOfMemoryIn case of an out of memory error, sends a log entry to the specified callable actor (if available). -
Uses of OptionHandler in adams.flow.control.flowrestart
Classes in adams.flow.control.flowrestart that implement OptionHandler Modifier and Type Class Description classAbstractFlowRestartManagerAncestor for schemes that can trigger a flow restart.classNotificationManagerApplies the specified action once the trigger fires.classNullManagerDoes nothing.classTriggerManagerApplies the specified action once the trigger fires. -
Uses of OptionHandler in adams.flow.control.flowrestart.notification
Classes in adams.flow.control.flowrestart.notification that implement OptionHandler Modifier and Type Class Description classAbstractNotificationAncestor for notification schemes.classNullDummy, does nothing.classTimestampFileUpdates the timestamp in the specified file. -
Uses of OptionHandler in adams.flow.control.flowrestart.operation
Classes in adams.flow.control.flowrestart.operation that implement OptionHandler Modifier and Type Class Description classAbstractRestartOperationAncestor for restart operations.classExternalCommandExecutes an external command, eg systemd or Windows service.classFlowFileStarts the specified flow.classMultiOperationExecutes multiple restart operations, one after the other.classNullDummy, does nothing.classRestartItselfRestarts the flow as defined in variableActorUtils.FLOW_FILENAME_LONG. -
Uses of OptionHandler in adams.flow.control.flowrestart.trigger
Classes in adams.flow.control.flowrestart.trigger that implement OptionHandler Modifier and Type Class Description classAbstractTriggerAncestor for restart triggers.classCronTriggers the restart according to the specified schedule.classFileMonitorMonitors a file using the specified file change monitor.classMetaCronExecutes the base trigger according to the specified schedule.classMonitorItselfMonitors its own flow file with the specified file change monitor.classMultiTriggerManages multiple triggers.classNullDummy, does nothing. -
Uses of OptionHandler in adams.flow.control.plotprocessor
Classes in adams.flow.control.plotprocessor that implement OptionHandler Modifier and Type Class Description classAbstractPlotProcessorAncestor for processors of plot containers.classAbstractPlotProcessorWithBuffer<T>Ancestor for post-processors that work on a buffer of plot containers.classExpressionApplies a mathematical function to the data (separately for X and Y).
Values can be accessed using 'xN' and 'yN' with 'N' being the 1-based index in the current window.classLOWESSA processor that applies LOWESS smoothing.
For more information see:
WikiPedia.classPassThroughDummy processor which never generates any new containers.classSavitzkyGolayA processor that applies SavitzkyGolay smoothing.
For more information see:
A.classSimpleSavitzkyGolayA processor that applies SimpleSavitzkyGolay smoothing.
For more information see:
A. -
Uses of OptionHandler in adams.flow.control.removeoutliers
Classes in adams.flow.control.removeoutliers that implement OptionHandler Modifier and Type Class Description classAbstractNumericOutlierDetectorAncestor for numeric outlier detection.classAbstractOutlierDetectorAncestor for outlier detectors of actual vs predicted.classIQRInterquartile range based detector.
If difference between actual/predicted is more than the factor of standard deviations away from the quartial 0.25/0.75, then the point gets flagged as outlier.classMeanAbsoluteErrorMean absolute error (MAE) based detector.
If difference between actual/predicted is more than MAE * FACTOR, then the point gets flagged as outlier.classMultiOutlierDetectorApplies the specified outlier detectors sequentially and combines the detected outliers either via union or intersect.classNullDummy outlier detector, detects no outliers at all.classStdDevStandard deviation based detector.
If difference between actual/predicted is more than the factor of standard deviations away from the mean, then the point gets flagged as outlier. -
Uses of OptionHandler in adams.flow.core
Subinterfaces of OptionHandler in adams.flow.core Modifier and Type Interface Description interfaceActorInterface for actors.interfaceActorHandlerFor actors that handle "sub-actors".interfaceActorReferenceHandlerInterface for actors that manage callable actors.interfaceActorWithConditionalEquivalentActors that have an conditional equivalent, i.e., one that implementsBooleanConditionSupporter.interfaceActorWithTimedEquivalentActors that have a timed equivalent, i.e., one that implementsTimedActor.interfaceArrayProviderFor actors that can output the items either as an array or one-by-one.interfaceAutogeneratedActorIndicator interface for actors that have been automatically generated.interfaceAutomatableInteractiveActorInterface for actors that interact with the user, but can also be automated, e.g., for testing purposes.interfaceAutoStartSupporterInterface for actors that support "auto-start" functionality.interfaceConnectionHandlerFor actors that handle "sub-actors" that are connected.interfaceControlActorIndicator interface for control actors.interfaceDaemonEventIndicator interface for events that run in the background and will get executed when the Events actor gets executed.interfaceDataInfoActorIndicator interface for actors that produce information on data structures.interfaceDataPlotUpdater<P extends DataContainerPanel,C>Interface for classes that determine when to update the data container panel, i.e., repaint all of it.interfaceDisplayTypeSupporterInterface for actors that allow how their graphical output is being displayed.interfaceDryRunSupporterInterface for actors that support dry runs.interfaceDynamicInitializerInterface for actors that can be initialized at runtime and files may not be present at startup time.interfaceDynamicModelLoaderSupporterInterface for classes that support model loading.interfaceErrorScopeRestrictorInterface for actors that restrict the error scope.interfaceEventIndicator interface for actors that can be used with the Events standalone.interfaceFixedNameActorHandlerInterface for actor handlers that use fixed names for their sub-actors, e.g., IfThenElse.interfaceFlushableInterface for actors that can be flushed, i.e., the execution stopped without actually stopping the actor.interfaceFlushSupporterInterface for actors that can be flushed.interfaceInactiveActorIndicator interface for actors that have been "put to sleep".interfaceInputConsumerInterface for flow actors that can process input tokens.interfaceInteractionDisplayLocationSupporterInterface for classes that allow the user to choose where to display their interaction.interfaceInteractiveActorInterface for actors that interact with the user.interfaceInteractiveActorWithCustomParentComponentInterface for interactive actors that allow the selection of a custom parent component using a callable actor; instead of just using the outer dialog/frame.interfaceKeyManagerFactoryProviderInterface for actors that provide an instance to aKeyManagerFactory.interfaceLazySetupSupporterInterface for actors that optionally perform aActor.setUp()call first time they get executed.interfaceMutableActorHandlerInterface for actors that allow to add/remove sub-actors as well.interfaceOptionalOneTimeInitializerInterface for actors that can be fixed to be only initialized once.interfaceOptionalPasswordPromptInterface for actors that prompt the user to enter a password in case no password currently provided.interfaceOptionalStopRestrictorInterface for stop restrictors that can turn on/off stop restrictions.interfaceOutputProducerInterface for flow actors that generate output.interfacePauseStateHandlerInterface for actors that manage the pause state in some sense.interfacePropertiesUpdaterInterface for actors that update one or more properties of a Java object using variables.interfacePyroCallInterface for Pyro4 method calls.interfacePyroInputConsumerInterface for Pyro calls that can process input.interfacePyroOutputProducerInterface for Pyro calls that generate output.interfaceRemoteExecutionHandlerInterface for actors that manage remote execution.interfaceRestorableActorInterface for actors that can save their state to disk and restore it again next time they are run.interfaceSortableActorHandlerInterface for actor handlers that can sort their child actors.interfaceSSLContextProviderInterface for actors that provide access to an instance ofSSLContext.interfaceStopModeSupporterInterface for actors that support a specific stop mode.interfaceStopRestrictorInterface for actors that can limit the scope of theStopcontrol actor or other actors that can stop the execution.interfaceSubFlowWrapUpInterface for actors that can wrap-up (i.e., save memory) their sub-actors and, if need be, re-initialize again.interfaceTimedActorInterface for actors that time their execution and send the timing data to a callable actor.interfaceTokenEventHandlerInterface for actors that supportTokenEvents and handleTokenListeners.interfaceTriggerableEventIndicator interface for events that can be triggered with the TriggerEvent actor.interfaceTrustManagerFactoryProviderInterface for actors that provide an instance to aTrustManagerFactory.interfaceWeakExternalActorIndicator interface for weak external actor handlers, which are only used at design time and deactivated at runtime.Classes in adams.flow.core that implement OptionHandler Modifier and Type Class Description classAbstractActorAbstract base class for actors.classAbstractBaseExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractCallableActorAbstract ancestor for all actors that access callable actors.classAbstractCallableActorPropertyUpdaterAbstract ancestor for actors that manipulate properties of callable actors, e.g., WEKA classes.classAbstractCopyCallableActorAncestor for actors that use a copy of a callable actor.classAbstractDataPlotUpdater<P extends DataContainerPanel,C>Ancestor for classes that determine when to update the data container panel, i.e., repaint all of it.classAbstractDisplayAncestor for actors that display stuff.classAbstractExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractGroovyActorAbstract ancestor for actors that execute Groovy scripts.classAbstractIncludeExternalActorAncestor for actors that get replaced with the externally stored actor.classAbstractModelLoader<T>Ancestor for model loaders.classAbstractPropertyUpdaterAbstract ancestor for actors that manipulate properties of objects.classAbstractPyroCallAncestor for Pyro4 method calls.classAbstractScriptedActorAbstract ancestor for actors that execute external scripts.classAbstractScriptingHandlerActorAbstract ancestor for actors that execute external scripts using a scripting handler.classAbstractTemplateAbstract ancestor for all actors that use a template to generate the actual actor/sub-flow to be executed.classActorUsageTraverses directories and loads all flows that it can locate for examination.classActorVariablesFinderLocates variables in actors.classErrorHandlerInstanceListerLists the hashcodes of the adams.flow.core.ErrorHandler objects in use by actors.classLagMakerOptionsOption group forTSLagMakerobjects.classObjectRetrieverFor retrieving objects from storage or source actors.classWekaClassifierModelLoaderManages classifier models.classWekaClustererModelLoaderManages clusterer models.classWekaFilterModelLoaderModel loader for Weka filters.Methods in adams.flow.core with parameters of type OptionHandler Modifier and Type Method Description static intActorUtils. replace(OptionHandler handler, Comparable find, Comparable replace, boolean recursive)Replaces any occurrence of the object to find with the replacement.static intActorUtils. replace(OptionHandler handler, Comparable find, Comparable replace, boolean recursive, HashSet<Class> excluded)Replaces any occurrence of the object to find with the replacement. -
Uses of OptionHandler in adams.flow.core.displaytype
Classes in adams.flow.core.displaytype that implement OptionHandler Modifier and Type Class Description classAbstractDisplayTypeAncestor.classBackgroundDisplays the frame in the background, behind all windows.classDefaultDisplays the frame on top of all windows.classDisplayInEditorShows the display in the Flow editor window rather than as standalone frame.classNoDisplayDoesn't do anything. -
Uses of OptionHandler in adams.flow.execution
Classes in adams.flow.execution that implement OptionHandler Modifier and Type Class Description classAbstractFlowExecutionListenerAncestor for execution listeners.classAbstractFlowExecutionListenerWithTableAncestor for graphical listeners that display their data in a table.classAbstractGraphicalFlowExecutionListenerAncestor for graphical listeners.classAbstractTimedFlowExecutionListenerWithTableAncestor for listeners that use tables and update them at regular intervals.classCurrentlyExecutedShows what actors are currently being executed.classDebugAllows the user to define breakpoints that suspend the execution of the flow, allowing the inspection of the current flow state.
Tokens can only inspected during 'preInput', 'preExecute' and 'postOutput' of Breakpoint control actors.classExecutionCounterCounts how often an actor was executed.
The final counts can be written to a log file in CSV format.classExecutionLogGenerates a trace file with all activity logged, uses stdout when the log file is pointing to a directory.classMultiListenerA meta-listener that executes all sub-listeners sequentially.classNullListenerDummy listener, does nothing.classRemoteFlowListenerListens on the specified port, returns the currently running flow setup.classTimeShows how much time actors are taking in their method calls (gets accumulated). -
Uses of OptionHandler in adams.flow.execution.debug
Classes in adams.flow.execution.debug that implement OptionHandler Modifier and Type Class Description classAbstractBreakpointAncestor for breakpoints for execution listeners.classAbstractScopeRestrictionAncestor for scope restrictions.classAnyActorBreakpointTriggers with any actor encountered during listening.classClassBreakpointTriggers when the specified (exact) class of actor is encountered during listening.classMultiScopeRestrictionCombines multiple scope restrictions.classNoScopeRestrictionDoes not restrict the scope.classPathBreakpointTriggers when the specified actor path (full path) is encountered during listening.classSubFlowRestrictionRestricts the scope to the sub-flow specified by the path (= root of subflow). -
Uses of OptionHandler in adams.flow.generator
Classes in adams.flow.generator that implement OptionHandler Modifier and Type Class Description classAbstractFlowGenerator<T extends Actor>Ancestor for generators that use model setups to generate flows.classTemplateUses the specified flow template to generate the sub-flow. -
Uses of OptionHandler in adams.flow.processor
Subinterfaces of OptionHandler in adams.flow.processor Modifier and Type Interface Description interfaceActorProcessorInterface for actor processors.interfaceActorProcessorWithFlowPanelContextInterface for actor processors that can have the FlowPanel context set.interfaceCleanUpProcessorIndicator interface for processors that clean up flows in some fashion.interfaceGraphicalOutputProducingProcessorInterface for processors that can generate graphical output.interfaceInteractiveProcessorInterface for processors that interact with the user.interfaceListingProcessorProcessors that generate a list.interfaceModifyingProcessorInterface for processors that potentially modify the actor.Classes in adams.flow.processor that implement OptionHandler Modifier and Type Class Description classAbstractActorListingProcessorAncestor for processors that list full actor names and allow jumping to them.classAbstractActorProcessorAbstract base class for schemes that process a flow/actor in some fashion.classAbstractListingProcessorAncestor for processors that list stuff.classAbstractListNameUsage<T>Ancestor for processors that locate usages of a certain name.classAbstractModifyingInteractiveProcessorAncestor for processors that interact with the user and potentially modify the flow.classAbstractModifyingProcessorAncestor for processors that potentially modify flows that they are processing.classAbstractNameUpdater<T>Ancestor for processors that update names of actors.classActorStatisticsGenerates statistics on actors, how many of what type etc.classChangeDatabaseConditionLimitProcessor that the limit of a database condition.classChangeDatabaseConnectionProcessor that updates database connections.classChangeDisplayTypeProcessor that updates the display type ofDisplayTypeSupporteractors.classChangeNumThreadsProcessor that changes the number of threads used for classes that implementThreadLimiter.classChangePathProcessor that updates paths of classes that are derived fromFile.classCheckActorReferenceUsagePerforms a 'soft' check on the usage of actor references, like callable actors.classCheckPlaceholdersChecks whether all placeholder files/dirs can be expanded, i.e., whether all placeholders are actually defined.classCheckStorageUsagePerforms a 'soft' check whether storage names in use are actually set somewhere in the flow.classCheckVariableUsagePerforms a 'soft' check whether variables in use are actually set somewhere in the flow.classFindTextLists all the actors where the specified text is found in one of the options (case-insensitive).classFlattenStructureTries to flatten the flow structure wherever possible.classForwardSlashSwitchProcessor that switches the flag of allForwardSlashSupporterobjects.classListActorReferenceUsageLists all the actors where the specified actor reference name is used.classListActorUsageLooks for all the occurrences of the specified actor class.classListAllStorageNamesLists all storage name occurrences in the flow whether being set or used.classListAllVariablesLists all variable occurrences in the flow whether being set or used.classListAnnotationTagsProcessor that lists tags in annotations.classListCallableActorUsageLists all the actors where the specified callable actor name is used.classListDatabaseConnectionsProcessor that lists database connections.classListObjectCommandlinesLists the command-lines of the objects of the specified superclass.classListPathsLists all the paths (files and directories) that are used in the flow.classListStorageUsageLists all the actors where the specified storage name is used.classListStructureModifyingActorsProcessor that lists (active) actors implementingFlowStructureModifier.classListTODOsLists all the actors with TODOs in either name or annotation.classListVariableUsageLists all the actors where the specified variable is used.classManageInteractiveActorsEnables/disables the interactive behaviour of actors implementing adams.flow.core.AutomatableInteraction.classManageTimedActorsEnables/disables the interactive behaviour of adams.flow.core.AutomatableInteractiveActor actors.classMultiProcessorA meta-processor that processes the actor sequentially with all sub-processors.classReactivateActorsActivates all actors implementing the adams.flow.core.InactiveActor.classRemoveAutogeneratedActorsRemoves all actors implementing the adams.flow.core.AutogeneratedActor.classRemoveBreakpointsA meta-processor that processes the actor sequentially with all sub-processors.classRemoveDisabledActorsA meta-processor that processes the actor sequentially with all sub-processors.classRemoveUnusedReferenceableActorsRemoves all referenceable actors (eg callable actors) that are not used.classSwapObjectsAllows replacing of objects using the specified object swap conversion.classUpdateCallableActorNameUpdates all occurrences of the old callable actor name with the new one.classUpdateEventNameUpdates all occurrences of the old event name with the new one.classUpdateStorageNameUpdates all occurrences of the old storage name with the new one.classUpdateVariableNameUpdates all occurrences of the old variable name with the new one.
Processes either attached variables or variables that are a part of an object that is derived from adams.core.base.BaseObject.Methods in adams.flow.processor with parameters of type OptionHandler Modifier and Type Method Description protected StringAbstractActorListingProcessor. createLocation(OptionHandler owner, Object obj, OptionTraversalPath path)Creates a location string used in the list.protected ActorAbstractActorListingProcessor. findEnclosingActor(OptionHandler owner, OptionTraversalPath path)Tries to locate the enclosing actor.protected ActorAbstractActorListingProcessor. findEnclosingActor(OptionHandler owner, OptionTraversalPath path, int index)Tries to locate the enclosing actor. -
Uses of OptionHandler in adams.flow.setup
Classes in adams.flow.setup that implement OptionHandler Modifier and Type Class Description classFlowSetupContainer object for a flow file with name and information about it. -
Uses of OptionHandler in adams.flow.sink
Subinterfaces of OptionHandler in adams.flow.sink Modifier and Type Interface Description interfaceDisplayPanelProviderInterface for graphical sinks that can also generate a panel from scratch for a new token.Classes in adams.flow.sink that implement OptionHandler Modifier and Type Class Description classAbstractAppendableFileWriterAncestor for file writers that allow appending to the file instead of just replacing any existing files.classAbstractDbSinkAncestor for sinks that use the database.classAbstractDisplayAncestor for actors that display stuff.classAbstractFileWriterAncestor for sinks that write to output files.classAbstractGraphicalDisplayAncestor for actors that display stuff.classAbstractGraphicsGeneratorAncestor for actors that generate graphics of some kind.classAbstractScriptAncestor for sink script actors.classAbstractSinkAncestor for all flow items that function as sink.classAbstractTextualDisplayAncestor for actors that display textual stuff.classAbstractWekaModelWriterAncestor for actors that serialize models.classActualVsPredictedPlotPlots actual vs predicted columns obtained from a spreadsheet.classArrayDisplayDisplays the array elements in a single panel.classAutogeneratedSinkEncapsulates a sequence of auto-generated actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classBinaryFileWriterWrites a byte array or adams.data.blob.BlobContainer to a binary file.classBoxPlot* Actor for displaying box plots.
*
* For more information, see:
* http://en.wikipedia.org/wiki/Box_plot *
Valid options are:classBrowserDisplays a URL in a webbrowser.
By default, the system's default browser is used.classCallableSinkLets a callable sink consume the input tokens.classCanvasGeneral purpose drawing canvas.classCloseInputStreamCloses the incoming input stream instance.
See also:
adams.flow.source.InputStreamGenerator
Input/output:
- accepts:
java.io.InputStream
classCloseReaderCloses the incoming reader instance.
See also:
adams.flow.source.ReaderGenerator
Input/output:
- accepts:
java.io.Reader
classConsoleNon-graphical actor that outputs any object that arrives at its input port via the 'toString()' method on stdout.classContainerDisplayActor for displaying a spreadsheet.classControlChartPlotActor for generating control chart plots.
The plot needs to be initialized with a class adams.flow.container.ControlChartContainer.classCopyCallableSinkCopies a callable sink to consume the tokens.classDisplayActor that outputs any object that arrives at its input port via the 'toString()' method.classDisplayPanelGridSink that places a panel in the grid for each each arriving token.
Uses the user-defined panel provider for creating the panels.classDisplayPanelManagerActor that displays a 'history' of panels created by the selected panel provider.classDOMDisplayDisplays a DOM node object as tree structure.classDownloadFileDownloads a file from a URL and saves it locally.
Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
java.net.URL
classDumpFileActor that just dumps any input token into a separate line of the specified output file.classEmailFileWriterActor that writes Email objects to files.classEmailViewerActor for displaying an email object.classEnQueueEnqueues the incoming data in the specified queue in internal storage.classExecPipes the incoming data, after converting it using the provided conversion scheme, into the started process.classExternalSinkSink that executes an external sink actor stored on disk.classFileBrowserDisplays the file or directory with the system's file browser.classFilePreviewActor for previewing file contents.classFlowDisplayDisplays an actor or flow.classFlowFileWriterWrites the incoming actor(s) to a file.
A custom flow writer can be specified.classFourInOneDisplayActor for displaying a four-in-one plot.classGroovyA sink that uses a Groovy script for processing the token(s).classHistogramGenerates a histogram based on the incoming data.classHistoryDisplayActor that outputs any object that arrives at its input port via the 'toString()' method in a separate 'history' entry.classHtml4DisplayViewer for HTML 4.classImageFileWriterWrites the image to disk using the specified writer.classImageHistogramDisplays a histogram of a gray image or histograms per channel for color image.classImageSegmentationFileWriterWrite image segmentation containers using the specified writer.classImageSegmentationViewerDisplays image segmentation containers.classImageViewerActor for displaying an image.classInactiveSinkEncapsulates a sequence of inactive actors.
Can be removed with the adams.flow.processor.ReactivateActors processor.classIncludeExternalSinkIncludes an external sink.classIndexedSplitsRunsWriterReads indexed splits runs from disk using the specified writer.classInformationDialogDisplays the incoming message in a message box.classJavaLoggingUses the Java logging framework to output the incoming data.
Simply uses an object's 'toString()' method.classJFreeChartFileWriterGenerates a JFreeChart plot and writes the bitmap to a file.classJFreeChartPlotGenerates and displays a plot using JFreeChart.classJsonDisplayDisplays a JSON object as tree structure.classJsonFileWriterWrites a JSON object/array to a file.classLargeObjectDbWriterAllows storing large objects in a SQL database.classLogDumperActor that stores LogEntry objects in a file (CSV format).classLoggerActor that stores LogEntry objects in the Log table.classLogViewerActor that displays LogEntry objects, but doesn't store them in the database.classMat5FileWriterWrites the Mat5File object to the specified file.classMatrixPlotActor for displaying a matrix of scatter plots
Valid options are:classMenuItemLaunches a menu item from the main menu.classMergeFilesCombines the incoming files in a single one.classNotesWriterSaves the notes attached to a data structure to a text file.classNullActor that gobbles up all tokens, like '/dev/null' in Unix.classObjectPreviewActor for previewing file contents.classObjectViewerAllows to inspect any object using ADAMS' inspection capabilities.classOpenFileOpens the incoming file with the appropriate platform-specific application.
Does nothing in a headless (non-graphical) environment.classPasteFilesGenerates a single file from combined lines from the input files.classPDFCloseDocumentCloses the incoming PDF document, writing out its content.
The PDF document can be generated with adams.flow.source.PDFNewDocument and appended using adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.source.PDFNewDocument
adams.flow.transformer.PDFAppendDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFViewerActor for displaying PDF files.classPlotContainerSinkActor that outputs the plot containers in various formats.classProbabilityPlotDisplayActor for displaying a probability plot
Valid options are:classProgrammaticSinkFor programmatically hooking into a flow and receive tokens.classProgressBarDisplays a progress bar.classPropertiesDisplayDisplays a Properties object as table.classPropertiesFileWriterWrites a Java properties object to a file.classPublishPublishes the incoming data using the specified publish/subscribe handler in storage.classPyroSinkConsumes data using a Pyro4 call.
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- accepts:
java.lang.Object
classRemoteCommandWriterSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classReportDisplayDisplays reports.classScatterDisplayActor for displaying a scatter plot of one attribute vs another.classScreenshotActor that takes screenshots of graphical components.classScriptedA sink that uses an exterrnal script for processing the token(s).classSendEmailActor for sending emails.classSendNotificationSends the incoming message string via the configured notification scheme.classSendRemoteCommandSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classSequencePlotterActor that plots sequences over time.
See also:
adams.flow.sink.SimplePlot
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSerializeSaves a Java object to a file using the specified object writer.classSideBySideDiffActor for displaying a side-by-side diff.classSimpleLoggingTurns the incoming objects into strings, formats them with the selected formatter and then outputs them with the specified output(s).classSimplePlotActor for generating simple plots.
See also:
adams.flow.sink.SequencePlotter
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSocketJust outputs the data to the specified socket.
Any incoming data that isn't a byte array gets converted to a string and its bytes (using the specified encoding) are then transmitted.
See also:
adams.flow.source.Socket
Input/output:
- accepts:
java.lang.Object
byte[]
java.lang.Byte[]
classSpreadSheetDbWriterTransfers a SpreadSheet object into a database.classSpreadSheetDisplayActor for displaying a spreadsheet.
Custom background for negative/positive values can be specified as well.classSpreadSheetFileWriterActor that writes SpreadSheet objects to files.classSpreadSheetRowViewerActor for displaying spreadsheet rows in a graphical way, like the 'Spreadsheet Explorer' tool.classStringTreeGenerates a tree from the strings arriving at the input, splitting them into parts using the specified separator.classTemplateSinkLets a sink generated from a template consume the input tokens.classTextWriterWrites incoming textual data to a text file.classTimeseriesDisplayActor that displays timeseries.classWebSocketClientSends the incoming data to a websocket server and forwards the received data.classWekaAttributeSummaryDisplays an attribute summary.classWekaClassifierErrorsActor for displaying classifier errors.classWekaCostBenefitAnalysisActor for displaying a cost benefit analysis dialog.classWekaCostCurveActor for displaying a cost curve.classWekaDatabaseWriterActor for saving a weka.core.Instances object in a database.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaExperimentFileWriterSaves an experiment file.classWekaExperimentGeneratorGenerates an experiment setup that can be used in conjunction with the Experiment transformer actor.classWekaFileWriterActor for saving a weka.core.Instances object as file.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaGraphVisualizerDisplays BayesNet graphs in XML or BIF notation
Either displays the contents of a file or an object that implements weka.core.Drawable and generates a BayesNet graph.classWekaInstancesDisplayActor for displaying a weka.core.Instances object in table format.classWekaInstancesPlotActor for plotting one attribute vs another.classWekaInstanceViewerActor for displaying adams.data.instance.Instance objects in a graphical way (using the internal format), like the 'Instance Explorer' tool.classWekaMarginCurveActor for displaying margin errors.classWekaModelWriterActor for saving a model (classifier or clusterer) alongside an optional header (i.e., weka.core.Instances object) as file.classWekaThresholdCurveActor for displaying threshold curves, like ROC or precision/recall.classWekaTreeVisualizerDisplays trees in dot notation.classXMLFileWriterWrites a org.w3c.dom.Document to an XML file.
In case of org.w3c.dom.Node objects, the owning document is written to disk.classYamlFileWriterWrites a Map object to a YAML file.
http://yaml.org/
Input/output:
- accepts:
java.util.Map
java.util.List
classZScoreDisplayActor for displaying a z score plot
Valid options are: -
Uses of OptionHandler in adams.flow.sink.canvas
Classes in adams.flow.sink.canvas that implement OptionHandler Modifier and Type Class Description classAbstractDataPoolPaintletAncestor for paintlets for the Canvas actor.classAbstractDataPoolPostProcessorFor post-processingDataPools, e.g., removing obsolete/expired elements.classPassThroughDummy post-processor, does nothing.classXYPaintletSimply paints ciircles for X and Y coordinates. -
Uses of OptionHandler in adams.flow.sink.controlchartplot
Classes in adams.flow.sink.controlchartplot that implement OptionHandler Modifier and Type Class Description classAbstractControlChartPaintletAncestor for control chart paintlets.classChartPaintletA paintlet for painting a line plot of a sequence.classLimitPaintletA paintlet for painting a line plot of a sequence. -
Uses of OptionHandler in adams.flow.sink.logview
Classes in adams.flow.sink.logview that implement OptionHandler Modifier and Type Class Description classAbstractLogEntryDialogAncestor for dialogs that view aLogEntry.classDefaultLogEntryDialogSimply shows the content of theLogEntryin a text area. -
Uses of OptionHandler in adams.flow.sink.pyrosink
Classes in adams.flow.sink.pyrosink that implement OptionHandler Modifier and Type Class Description classAbstractPyroSinkAncestor for Pyro calls that consume data but don't produce any output.classGenericGeneric call, just forwards any data to the remote object.classNullDummy, does nothing. -
Uses of OptionHandler in adams.flow.sink.sendnotification
Classes in adams.flow.sink.sendnotification that implement OptionHandler Modifier and Type Class Description classAbstractNotificationAncestor for notification schemes.classConsoleOutputs the message in the console (with optional prefix).classEmailUses the incoming message as body in the email being sent.classLogFileOutputs the message to a log file.classMessageBoxSimply pops up a message box with the notification.classMultiNotificationExecutes the notifications sequentially.classNullFor suppressing notifications. -
Uses of OptionHandler in adams.flow.sink.sequenceplotter
Classes in adams.flow.sink.sequenceplotter that implement OptionHandler Modifier and Type Class Description classAbstractErrorPaintletAncestor for error paintlets.classAbstractMarkerPaintletAncestor for marker paintlets.classAbstractMouseClickActionAncestor for classes that react to mouse clicks on the canvas.classAbstractPlotUpdaterAncestor for classes that determine when to update the sequence plotter, i.e., repaint all of it.classAbstractSequencePostProcessorAncestor for sequence post-processors for the SequencePlotter.classAligningSequencesAligns the sequences on the left.classByNameErrorPaintletA wrapper for error paintlets, plots only sequences if the ID matches the regular expression.classByNameMarkerPaintletA wrapper for marker paintlets, plots only sequences if the ID matches the regular expression.classErrorBandPaintletPlots a band around the values, using the Y errors to define the width of the band.classErrorCircleHitDetectorDetects selections of error circles.classErrorCirclePaintletPaintlet for painting circles with diameters based on the error at the specified X-Y position.classErrorCrossHitDetectorDetects selections of error crosses.classErrorCrossPaintletPaintlet for painting crosses with diameters based on the error at the specified X-Y position.classNamedPlotUpdaterUpdates the flow after the specified number of tokens per named plot have been processed.classNoErrorPaintletPerforms no painting at all.classNoMarkersDummy paintlet, since it doesn't draw anything.classNullClickActionDummy action, does nothing.classOutlierPaintletPaintlet for drawing crosses at the X-Y positions of the data points.classPassThroughPerforms no post-processing at all.classSimpleErrorPaintletSimple error plots: line, errorbar, box.classSimplePlotUpdaterUpdates the flow after the specified number of tokens have been processed.classSimplePruningSimply prunes the sequences at the head if they exceed a pre-defined size limit.classToggleOutlierToggles the outlier state of data points.classVerticalMarkersDraws vertical markers on the sequence plot panel.classViewDataClickActionDisplays the data that the user clicked on in a table. -
Uses of OptionHandler in adams.flow.sink.simplelogging.format
Classes in adams.flow.sink.simplelogging.format that implement OptionHandler Modifier and Type Class Description classAbstractSimpleFormatAncestor for simple formatting schemes.classNoFormatApplies no formatting, just forwards the message as is.classTimestampedFormatOutputs the message using the specified format. -
Uses of OptionHandler in adams.flow.sink.simplelogging.output
Classes in adams.flow.sink.simplelogging.output that implement OptionHandler Modifier and Type Class Description classAbstractSimpleOutputAncestor for output schemes.classConsoleOutputJust outputs the message via stdout.classFileOutputAppends the log messages to the specified file.classMultiOutputOutputs the log message with all the specified sub-outputs.classRotatingFileOutputAppends the log messages to the specified file, but also allows for rotating them. -
Uses of OptionHandler in adams.flow.sink.timeseriesdisplay
Classes in adams.flow.sink.timeseriesdisplay that implement OptionHandler Modifier and Type Class Description classAbstractPlotUpdaterAncestor for classes that determine when to update the timeseries display, i.e., repaint all of it.classSimplePlotUpdaterUpdates the display after the specified number of tokens have been processed. -
Uses of OptionHandler in adams.flow.source
Subinterfaces of OptionHandler in adams.flow.source Modifier and Type Interface Description interfaceConditionalIdSupplierInterface for ID suppliers that use a conditions object.Classes in adams.flow.source that implement OptionHandler Modifier and Type Class Description classAbstractArrayProviderAncestor for source actors that can output items one by one or as a single array.classAbstractBufferingSourceAncestor for queues that need to buffer output from eg another process.classAbstractConditionalIdSupplierAbstract ancestor for ID suppliers that use a conditions object.classAbstractDatabaseIdSupplierAbstract ancestor for ID suppliers.classAbstractDatabaseMetaDataAncestor for sources that output the database meta-data.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbSourceAncestor for sources that access the database..classAbstractForLoopAbstract ancestor for for-loops.classAbstractIdSupplierAbstract ancestor for ID suppliers.classAbstractInstrumentSupplierAbstract ancestor for instrument suppliers.classAbstractInteractiveArrayProviderAncestor for interactive sources that can provide the output as an array or one-by-one.classAbstractInteractiveSourceAncestor for source actors that interact with the user.classAbstractListTablesAncestor for sources that list tables from a database.classAbstractPythonExecutionAncestor for sources that execute a Python executable.classAbstractScriptAncestor for source script actors.classAbstractSelectObjectsAncestor for sources that promp the user to select a number of objects to be broadcasted as tokens.classAbstractSimpleDbSourceAncestor for simple sources that use the database.classAbstractSimpleSourceAncestor for sources that just output a single token.classAbstractSimpleSourceWithPropertiesUpdatingAncestor for simple sources that allow changing the object's properties using variables.classAbstractSourceAncestor of all flow items that act as sources of tokens.classAbstractSpreadSheetDbReaderAncestor for spreadsheet database readers.classAbstractWekaSetupGenerator<T>Abstract ancestor for setup generator sources.classAutogeneratedSourceEncapsulates a sequence of auto-generated actors, with the last one generating the output for this meta-source.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classCallableSourceBroadcasts the generated output tokens from the source.classColorProviderUses the configured color provider to generate a number of colors.classCombineArraysCombines the storage items representing arrays into a single array.
When not supplying an array class the type of the first array is used.classCombineCollectionsclassCombineStorageOutputs the expanded string generated from the specified combination expression (variables and storage placeholders).classCombineVariablesOutputs the expanded string generated from the specified combination expression.classCommandRuns an external system command and broadcasts the generated output (stdout and/or stderr) continuously, opposed to adams.flow.source.Exec which waits for the command to finish.
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classCopyCallableSourceBroadcasts the generated output tokens from the copied callable source.classCounterOutputs the specified counter as spreadsheet, with two columns: 'Key' and 'Count'.classCurrentFlowOutputs the current flow, i.e., itself.classCurrentTimeclassDatabaseMetaDataOutputs the meta-data of the current database connection.classDeQueuePolls the specified queue in internal storage for an item, blocks till an item is available.
NB: The user needs to stop the flow as the DeQueue source will never stop, as it assumes that there will be more data coming through.classDirectoryListerReturns the contents of a directory (files/dirs).classDirectorySupplierSupplies directories.classDumpStorageOutputs the storage names and the string representation of their associated values in the specified format.classDumpVariablesOutputs the variable names and their associated values in the specified format.classEnterManyValuesPops up a dialog, prompting the user to enter one or more values.classEnterValuePops up a dialog, prompting the user to enter a value.classExecRuns an external system command and broadcasts the generated output (stdout or stderr).
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classExternalSourceSource that executes an external source actor stored on disk.classFilenameGeneratorUses the specified filename generator to output a filename.
NB: Generators that require an object to pass through won't work with this source.
See also:
adams.flow.transformer.FilenameGenerator
Input/output:
- generates:
java.lang.String
classFileSupplierSupplies files.classFileSystemSearchUses the specified search algorithm to perform a file system search and returns the located items.classForLoopEmulates the following for-loop for integer IDs:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
The integers can be output as a single array as well.classFTPListerDeprecated.classGetEnvironmentVariableOutputs the value of the specified environment variable.classGetSystemPropertyOutputs the value of the specified Java system property.classGroovyA source that uses a Groovy script for generating the token(s).classHashSetOutputs the specified hashset as spreadsheet, with one column called 'Value' by default.classHttpRequestSubmits the (optional) form parameters to the specified URL and forwards the retrieved HTML as text.
Cookies can be retrieved and stored in internal storage, to be re-used with the next request.classIdleSimulates an endless loop, which only exits if the flow is stopped.
Essentially blocking any following actors, never outputs anything.classInactiveSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.
Can be removed with the adams.flow.processor.ReactivateActors processor.classIncludeExternalSourceIncludes an external source.classInputStreamGeneratorUses the specified generator to instantiate an input stream instance.
See also:
adams.flow.sink.CloseInputStream
Input/output:
- generates:
java.io.InputStream
classIntegerRangeOutputs the integers defined by the range expression.classLargeObjectDbReaderAllows reading of large objects from a SQL database.classListCallableActorsclassListEnvironmentVariablesOutputs the names of the currently set environment variables.classListStorageNamesOutputs the names of the currently available storage items.classListSystemPropertiesOutputs the names of the currently set Java system properties.classListTablesLists tables of the current database connection.classListVariablesOutputs the names of the currently available variables.classLookUpForwards the value associated with the given key, using the specified lookup table from internal storage.classLookUpTableOutputs the specified lookup table as spreadsheet, containing to columns: Key with the keys and Value with the associated values.classMakeContainerAssembles a container with data obtained from either callable actors or storage items.classMathExpressionEvaluates a mathematical expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classMemoryUsageOutputs the memory usage.
The generated map has the following keys:
- init_heap
- max_heap
- used_heap
- committed_heap
- init_non_heap
- max_non_heap
- used_non_heap
- committed_non_heap
Input/output:
- generates:
java.util.Map
classModuleInfoOutputs a spreadsheet with information about modules available.classNewArrayGenerates a new array of the specified class with the given dimensions.
Dimensions are given as follows: [x], with x being the number of elements.classNewCollectionGenerates a new (and empty) collection of the specified type.classNewDOMDocumentCreates a new DOM document, e.g., for assembling XML files.classNewFlowOutputs the flow generated by the specified template.classNewImageGenerates an empty image with the specified dimensions (Type: RGB or ARBG).classNewJsonStructureGenerates an empty JSON data structure of the specified type.classNewListGenerates a list string based on the items produced by the generator and the specified separator.classNewMapGenerates a new java.util.Map object using the specified implementation class.classNewMat5FileCreates an empty Mat5File object.classNewMat5MatrixCreates a new Matlab matrix.classNewMat5StructclassNewPropertiesGenerates a new Properties object.classNewRemoteCommandConfigures and forwards a remote command.classNewReportGenerates a new instance of the specified report class.classNewSpreadSheetGenerates an empty spreadsheet.classNewTempFileclassNullDummy source, generates no output.classOpenCVDeviceFrameGrabberGrabs frames from the specified device and forwards them as image containers.classOptionProducerGenerates string output from the current flow using the specified option producer.classOptionTraverserTraverses the options of the flow at run-time.
Used for debugging purposes.classPasteFromClipboardPops up a dialog, prompting the user to accept content from clipboard.classPDFNewDocumentCreates an empty PDF document.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
The output of this source can be processed by adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.transformer.PDFAppendDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPipExecExecutes pip with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPyroSourceGenerates data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- generates:
java.lang.Object
classPythonExecExecutes the specified Python script with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPythonVenvExecExecutes the specified executable in a Python virtual environment with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.
Fails if the specified environment does not contain any 'activate' scripts typically found in such directories.classRandomNumberGeneratorRandom number generator.classReaderGeneratorUses the specified generator to instantiate a reader instance.
See also:
adams.flow.sink.CloseReader
Input/output:
- generates:
java.io.InputStream
classRSyncSupports synchronization using rsync.
In case of an error, the stderr output is forwarded, otherwise stdout output.classRsync4jRsyncBinaryOutputs the rsync binary used by the rsync4j library.classRsync4jSshBinaryOutputs the ssh binary used by the rsync4j library.classScriptedA source that uses an external script for generating the token(s).classSelectCharsetPrompts the user to select a character set.classSelectDateTimePops up a dialog, prompting the user to select a date/time, date or time value.classSelectDirectoryPops up a directory chooser dialog, prompting the user to select a directory.classSelectFilePops up a file chooser dialog, prompting the user to select one or more files.classSelectObjectsAllows the user to select an arbitrary number of objects from the specified class hierarchy using the GenericObjectArray.
It is possible to use this dialog for other objects as well that don't belong to a class hierarchy, e.g., adams.core.base.BaseString.classSequenceSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.classSimpleRSyncAn rsync wrapper with a reduced set of options.classSocketListens on the specified port for incoming data.
Can either output raw byte arrays or strings (using the specified encoding).
See also:
adams.flow.sink.Socket
Input/output:
- generates:
byte[]
classSpecifiedActorOutputs the actor identified by the actor path.classSpreadSheetDbReaderReturns a spreadsheet object generated from an SQL query.
To optimize memory consumption, you can return the result of the query in chunks of a specified size.classSQLIdSupplierExecutes an SQL statement for generating the IDs.
Variables are automatically expanded.classSSHExecRuns a system command via ssh on a remote machine and broadcasts the generated output (stdout or stderr).
For more information see:
(2011).classStartOutputs merely a NullToken.classStorageForLoopEmulates the following for-loop:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
In each iteration, the specified variable gets updated with the current value of the for-loop variable.classStorageValueOutputs the value associated with the specified name from temporary storage.
Does nothing if the storage value isn't present.
By supplying a cache name, the value can be obtained from a LRU cache instead of the regular storage.classStorageValuesArrayOutputs the values associated with the specified names from temporary storage as an array.classStringConstantsA source for strings.classStringExpressionEvaluates a string expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSwitchedSourceclassTemplateSourceBroadcasts the generated output tokens from the (template) source.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classURLSupplierSupplies multiple URLs (uniform resource locators).classVariableOutputs the string value of the specified variable.
Does nothing if the variable hasn't been set.classVariablesArrayOutputs the values associated with the specified variable names as a string array.classWekaAssociatorSetupOutputs an instance of the specified associator.classWekaClassifierGeneratorGenerates multiple classifier setups.classWekaClassifierSetupOutputs an instance of the specified classifier.classWekaClustererGeneratorGenerates multiple clusterer setups.classWekaClustererSetupOutputs an instance of the specified clusterer.classWekaDatabaseReaderExecutes a query and returns the data either in batch or incremental mode.classWekaDataGeneratorGenerates artificial data using a Weka data generator.classWekaFilterGeneratorGenerates multiple filter setups.classWekaForecasterSetupOutputs a configured instance of a Weka Forecaster.classWekaForecastingUses a serialized model to perform predictions on the data being passed through.
The model can also be obtained from a callable actor, if the model file is pointing to a directory.classWekaNewExperimentGenerates a new ADAMS experiment setup.classWekaNewInstancesGenerates an empty dataset, based on the attribute types and names specified.
Nominal attributes are generated with an empty set of labels.classWekaSelectDatasetPops up a file chooser dialog, prompting the user to select one or more datasets.classWekaSelectObjectsAllows the user to select an arbitrary number of Weka objects from the specified class hierarchy using the GenericObjectArray.classZipArraysAligns the corresponding elements of the storage arrays into row-based arrays. -
Uses of OptionHandler in adams.flow.source.filesystemsearch
Classes in adams.flow.source.filesystemsearch that implement OptionHandler Modifier and Type Class Description classAbstractFileSystemSearchletAncestor for file-system search algorithms.classAbstractFtpDirectoryListerBasedSearchletAncestor for search algorithms that useFtpDirectoryListerunder the hood.classAbstractLocalDirectoryListerBasedSearchletAncestor for search algorithms that useLocalDirectoryListerunder the hood.classAbstractSftpDirectoryListerBasedSearchletAncestor for search algorithms that useSftpDirectoryListerunder the hood.classAbstractSmbDirectoryListerBasedSearchletAncestor for search algorithms that useSmbDirectoryListerunder the hood.classFtpDirectorySearchSearches only for directories (FTP).classFtpDirectorySearchWithComparatorSearches only for directories, but uses the comparator for sorting the directories (FTP).classFtpDirectorySearchWithCustomSortSearches only for directories, but uses a regular expression to reassemble the name and perform the sorting (FTP).classFtpFileSearchSearches only for files (FTP).classFtpFileSearchWithComparatorSearches only for files, but uses the comparator for sorting the files (FTP).classFtpFileSearchWithCustomSortSearches only for files, but uses a regular expression to reassemble the name and perform the sorting (FTP).classLocalDirectorySearchSearches only for directories.classLocalDirectorySearchWithComparatorSearches only for directories, but uses the comparator for sorting the directories.classLocalDirectorySearchWithCustomSortSearches only for directories, but uses a regular expression to reassemble the name and perform the sorting.classLocalDirectorySearchWithTimestampConstraintsSearches only for directories.
Allows to further restrict the search using a timestamp window ('last modified') that the directories must satisfy.classLocalFileSearchSearches only for files.classLocalFileSearchWithComparatorSearches only for files, but uses the comparator for sorting the files.classLocalFileSearchWithCustomSortSearches only for files, but uses a regular expression to reassemble the name and perform the sorting.classLocalFileSearchWithTimestampConstraintsSearches only for files.
Allows to further restrict the search using a timestamp window ('last modified') that the files must satisfy.classMultiSearchCombines the search results of multiple search algorithms.classSftpDirectorySearchSearches only for directories (SFTP).classSftpDirectorySearchWithComparatorSearches only for directories, but uses the comparator for sorting the directories (SFTP).classSftpDirectorySearchWithCustomSortSearches only for directories, but uses a regular expression to reassemble the name and perform the sorting (SFTP).classSftpFileSearchSearches only for files (SFTP).classSftpFileSearchWithComparatorSearches only for files, but uses the comparator for sorting the files (SFTP).classSftpFileSearchWithCustomSortSearches only for files, but uses a regular expression to reassemble the name and perform the sorting (SFTP).classSmbDirectorySearchSearches only for directories (SMB, Windows shares).classSmbDirectorySearchWithComparatorSearches only for directories, but uses the comparator for sorting the directories (SMB, Windows shares).classSmbDirectorySearchWithCustomSortSearches only for directories, but uses a regular expression to reassemble the name and perform the sorting (SMB, Windows shares).classSmbFileSearchSearches only for files (SMB, Windows shares).classSmbFileSearchWithComparatorSearches only for files, but uses the comparator for sorting the files (SMB, Windows shares).classSmbFileSearchWithCustomSortSearches only for files, but uses a regular expression to reassemble the name and perform the sorting (SMB, Windows shares). -
Uses of OptionHandler in adams.flow.source.inputstreamsource
Classes in adams.flow.source.inputstreamsource that implement OptionHandler Modifier and Type Class Description classAbstractInputStreamGeneratorAncestor for classes that construct input streams.classFromFileGenerates an input stream from the specified file.classFromResourceGenerates an input stream from the specified resource (eg from jar). -
Uses of OptionHandler in adams.flow.source.newlist
Classes in adams.flow.source.newlist that implement OptionHandler Modifier and Type Class Description classAbstractListGeneratorAncestor for list generators.classFixedListSimply outputs the supplied list elements.classForLoopEmulates the following for-loop for integer IDs:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
classWrapperWraps the list items produced by the specified generator with user-supplied prefix and suffix. -
Uses of OptionHandler in adams.flow.source.pyrosource
Classes in adams.flow.source.pyrosource that implement OptionHandler Modifier and Type Class Description classAbstractPyroSourceAncestor for Pyro calls that generate output.classGenericGeneric call, just retrieves any data from the remote object.classNullDummy, outputs nothing. -
Uses of OptionHandler in adams.flow.source.readersource
Classes in adams.flow.source.readersource that implement OptionHandler Modifier and Type Class Description classAbstractReaderGeneratorAncestor for classes that construct readers.classFromFileGenerates a reader from the specified file.classFromResourceGenerates a reader from the specified resource (eg from jar). -
Uses of OptionHandler in adams.flow.source.valuedefinition
Classes in adams.flow.source.valuedefinition that implement OptionHandler Modifier and Type Class Description classAbstractArrayValueDefinitionAncestor for array-based value definitions.classAbstractGOEValueDefinitionAncestor for GOE-based value definitions.classAbstractValueDefinitionCombines name, type and default value for a single value.classArrayValueDefinitionDefinition for generic array objects.classDefaultValueDefinitionCombines name, type and default value for a single value.classDirectoryValueDefinitionValue definition specifically for directories.classEnumValueDefinitionSpecialized definition for enums.classFileValueDefinitionValue definition specifically for files.classGOEValueDefinitionDefinition for generic GOE objects.classListSelectionValueDefinitionSpecialized definition for lists, allowing to define a default value.classRegExpConstrainedStringDefinitionDefinition for a string that is constrained by a regular expression.classWekaGOEValueDefinitionDefinition for generic WEKA GOE objects. -
Uses of OptionHandler in adams.flow.source.wekaforecastersetup
Classes in adams.flow.source.wekaforecastersetup that implement OptionHandler Modifier and Type Class Description classAbstractForecasterGeneratorAncestor for classes that generateAbstractForecasterinstances.classBaselineAdjustedForecasterGeneratorOutputs a configured instance of a baseline-adjusted Forecaster.classWekaForecasterGeneratorOutputs a configured instance of a Weka Forecaster. -
Uses of OptionHandler in adams.flow.standalone
Subinterfaces of OptionHandler in adams.flow.standalone Modifier and Type Interface Description interfaceAbstractDatabaseConnectionProviderInterface for database connection providers.interfaceDatabaseConnectionProviderInterface for database connection providers.interfaceStandaloneGroup<T extends Actor>Interface for a group of standalones.interfaceStandaloneGroupItem<T extends Actor>The element of a standalone group.interfaceStandaloneMutableGroup<T extends Actor>Interface for a mutable group of standalones.Classes in adams.flow.standalone that implement OptionHandler Modifier and Type Class Description classAbstractCallableDatabaseConnectionAncestor for callable database connection standalones.classAbstractDatabaseCheckAncestor for standalone actors that check project-specific database connections.classAbstractDatabaseConnectionAncestor for standalone actors providing a database connection different from the system-wide one.classAbstractDbStandaloneAncestor for standalones that use the database.classAbstractMultiViewAncestor for graphical actors that display multiple views.static classAbstractMultiView.ViewWrapperA wrapper for the actual actors.classAbstractMutableActorDaemonEvent<E,P>Ancestor for daemon events that handle sub-actors.classAbstractMutableStandaloneGroupItem<T extends Actor>Ancestor for group items that can contain other actors.classAbstractScriptAncestor for singleton script actors.classAbstractStandaloneAncestor for all flow items that neither generate nor process tokens.classAbstractStandaloneGroup<T extends Actor>Ancestor for fixed-sized groups.classAbstractStandaloneGroupItem<T extends StandaloneGroup>Ancestor of a standalone group item.classAbstractStandaloneGroupItemGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemMutableGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneMutableGroup<T extends Actor>Ancestor for mutable groups of standalones.classAutogeneratedStandaloneContainer for auto-generated standalone actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classCallableActorsContainer for actors that need to be accessed via their name.classCallableDatabaseConnectionReferences a database connection provider of type adams.flow.standalone.DatabaseConnectionProvider.classConditionalStandalonesExecutes the sub-actors only when the boolean condition evaluates to 'true'.classConsoleWindowDisplays the messages that are output in the system's 'Console window'.classCopyCallableStandaloneExecutes the copied callable standalone.classCounterInitCreates an empty counter in internal storage under the specified name.classCronExecutes an actor according to a pre-defined schedule.
Note: since the actor merely starts the cron scheduler in the background, the actor finishes the execution pretty much immediately.classDatabaseCheckFirst, the actor checks whether the connection to the database is established.classDatabaseConnectionFor initializing an ADAMS database connection that differs from the system-wide one.classDelayedEventExecutes its sub-flow after a predefined number of milli-seconds.classDeleteDirDeletes the dirs that match the regular expression below the specified directory.classDeleteFileDeletes the files that match the regular expression below the specified directory.classDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeToStorageDeserializes a model from a file with the specified object reader and stores it directly in storage.
It is also possible to define multiple storage name / file name pairs, to make the deserialization of large amounts of files more efficient.classDirWatchclassEventsContainer for event actors.classExecSQLExecutes a SQL statement, which does not return a result set, like INSERT, UPDATE, DELETE, CREATE.classExternalFlowAllows to execute a complete external Flow rather than just an external actor.classExternalStandaloneStandalone that executes an external standalone actor stored on disk.
For executing whole flows, use the adams.flow.standalone.ExternalFlow standalone actor instead.
See also:
adams.flow.standalone.ExternalFlow
classFTPConnectionProvides access to a FTP host.
If debugging is enabled, the FTP commands issued by other actors will get printed as debug output of this actor.classGridViewDisplays multiple graphical actors in a grid.classGroovyA standalone that executes a Groovy script.classHashSetInitCreates an empty hashset in internal storage under the specified name.
Initial string values can be supplied as well, which can be transformed using the specified conversion.
See also:
adams.flow.transformer.HashSetInit
adams.flow.transformer.HashSetAdd
adams.flow.source.HashSet
adams.flow.condition.bool.HashSet
classInactiveStandaloneContainer for inactive standalone actors.
Can be activated with the adams.flow.processor.ReactivateActors processor.classIncludeExternalStandaloneIncludes an external standalone.classInitPublishSubscribeInitializes a publish/subscribe data structure in internal storage.classInitStorageCacheAdds a LRU cache in the responsible storage handler (usually the Flow actor).classJavaCalls the main method of a Java class.classJavaExecForks off a new JVM with the same classpath by default.classJobRunnerInstanceActs as job execution pool for classes implementing adams.multiprocess.JobRunnerSupporter.
See also:
adams.multiprocess.JobRunnerSupporter
classJobRunnerSetupDefines the job runner setup to use for parallel/distributed computation.classLogEventListens to the global log record handler and processes records that passed the specified filter(s).
This allows, for instance, the output of log messages into a log file.
By default, log records are only processed if the sub-actors are not currently being executed.classLookUpInitInitializes an empty look up table in storage.
See also:
adams.flow.transformer.LookUpAdd
classMakeDirCreates the user-supplied directory if not already existing.classMemoryMonitorMonitors the memory (used/committed heap vs maximum heap).Every number of seconds ('sampleInterval'), the memory consumption, i.e., 'heap used', is sampled, keeping the specified number of latest samples ('numSamples').
Once the specified number of samples have been reached, it is checked whether the specified percentage of samples ('coverage') reaches or exceeds the threshold percentage of the maximum heap has been exceeded ('threshold').classNullDummy standalone, does nothing.classPyroNameServerDefines the Pyro nameserver to use.classPyroStandaloneTransforms data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
classPythonEnvironmentDefines what Python executables to use within this context.
On Linux, you can enforce using the system-wide Python 3 executables by supplying '3' as suffix, which gets appended to the executables.classQueueEventExecutes its sub-flow after a predefined number of milli-seconds.classQueueInitCreates an empty queue in internal storage under the specified name.classRegisterFlowSimply registers the flow with the running flows registry.classRemoteScriptingEngineStarts/stops a scripting engine for remote commands.classScriptedA standalone that executes an external script.classSetManyVariablesSets the values of the variables.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSetPropertyDeprecated.classSetVariableSets the value of a variable.
Optionally, the specified value can be expanded, in case it is made up of variables itself.
It is also possible to override the variable value with the value obtained from an environment variable.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSMBConnectionProvides access to a remote host via SMB.classSMTPConnectionSMTP server setup for overriding default parameters.classSSHConnectionProvides access to a remote host via SSH.
For more information see:
(2011).classStandalonesContainer for standalone actors.classStopwatchStops the execution time of the flow, till either the user stops the flow or the flow finishes by itself
Valid options are:classTableCleanUpRuns a table cleaner.classTabViewDisplays multiple graphical actors in a tabbed pane.classTemplateStandaloneGenerates a standalone actor/sub-flow from a template.classTesseractConfigurationSetup parameters for tesseract.
For more information see:
https://github.com/tesseract-ocr/tesseract
Valid options are:classToolRuns a tool.classVariableChangedEventListens to a any changes to the specified variable.
This allows, for instance, the monitoring of a variable.
Enable the 'noDiscard' property to process all change events - NB: this can slow down the system significantly.classWeakExternalStandaloneclassWebSocketServerStarts and runs a websocket server. -
Uses of OptionHandler in adams.flow.standalone.logevent
Classes in adams.flow.standalone.logevent that implement OptionHandler Modifier and Type Class Description classAbstractLogRecordFilterAncestor for log record filters.classAbstractLogRecordProcessor<O>Processes log records.classAbstractMultiFilterInverts the filtering result of the base filter.classAcceptAllFilterDummy filter that accepts all log records.classAndFilterCombines the filter results using a boolean AND.classLevelFilterFilters records based on their logging level, i.e., if the fall in the specified min/max (inclusive).classLogEntryProcessorTurns the log record into a simple string.classNameFilterFilters records based on regular expression applied to logger name.classNotFilterInverts the filtering result of the base filter.classOrFilterCombines the filter results using a boolean OR.classSimpleProcessorTurns the log record into a simple string.classTypeFilterFilters records based on their output type (INFO, DEBUG, ERROR). -
Uses of OptionHandler in adams.flow.standalone.pyrostandalone
Classes in adams.flow.standalone.pyrostandalone that implement OptionHandler Modifier and Type Class Description classAbstractPyroStandaloneAncestor for Pyro calls that neither take input nor produce output.classGenericGeneric call, just forwards any data to the remote object.classNullDummy, does nothing. -
Uses of OptionHandler in adams.flow.template
Subinterfaces of OptionHandler in adams.flow.template Modifier and Type Interface Description interfaceActorTemplateUserInterface for actors that make use for actor templates.Classes in adams.flow.template that implement OptionHandler Modifier and Type Class Description classAbstractActorTemplateAncestor for generators that use templates for generating Actor objects.classAbstractScriptAncestor for script-based templates.classAbstractScriptedTemplateAbstract ancestor for templates that execute external scripts.classDummySinkA dummy sink template, used as default by the TemplateSink actor.classDummySourceA dummy source template, used as default by the TemplateSource actor.classDummyStandaloneA dummy standalone template, used as default by the TemplateStandalone actor.classDummyTransformerA dummy transformer template, used as default by the TemplateTransformer actor.classEndlessLoopGenerates a simple while-loop that goes on forever.classFileProcessingWithProgressBarGenerates a Trigger with a FileSystemSearch which updates a progress bar.classFromFileMerely loads an actor from a file.classGroovyUses a Groovy script to generate a sub-flow.classInstanceDumperVariableGenerates a sub-flow that sets a variable for the adams.flow.transformer.WekaInstanceDumper transformer's outputPrefix property using a prefix based on the full flow name.classIterateFilesWithProgressBarGenerates a sub-flow that looks for files in a directory and then iterates those.classOptionTraverserGenerates a sub-flow that displays the result of the specified option traversal algorithm, e.g., for displaying currently attached variables.classOptionTraverserWithSpreadSheetDisplayGenerates a sub-flow that displays the result of the specified option traversal algorithm, e.g., for displaying currently attached variables.
Displays the results in a table.classProgressInConsoleGenerates a sub-flow that outputs the token count every X number of tokens, with X being the interval supplied to this template.classPromptUserGenerates a sub-flow that prompts the user with the specified parameters and stores the values in variables.classScriptedUses a Groovy script to generate a sub-flow.classSimpleMenuGenerates a sub-flow that displays a dialog with the choice strings as buttons.
If custom values are used, then these strings get stored in the variable rather than the choice strings.
When enabling looping, ensure you have an exit option in the menu that sets the loop_state variable to 'false' to avoid an endless loop menu.classStoreFilenameInVariableCreates a sub-flow that stores the filename passing through in a user-specified variable.classStoreReportValueInVariableGenerates a sub-flow (enlosed by a Tee) that sets the value of a variable with the associated value from the report.classStringReplaceReplaces strings that match the specified regular expressions in the file before instantiating an actor from it.classUpdateVariableGenerates a sub-flow (enlosed by a Trigger) that retrieves and sets a variable, with the user being able to add custom actors in between for updating the variable value. -
Uses of OptionHandler in adams.flow.transformer
Subinterfaces of OptionHandler in adams.flow.transformer Modifier and Type Interface Description interfaceDataContainerDbReader<T extends DataContainer>Interface for actors that read containers from the database.interfaceDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Interface for actors that import data containers into the database.interfaceFeatureGenerator<T>General interface for feature generating actors.interfaceSpreadSheetMergeActorIndicator interface for actors that merge spreadsheets.interfaceWekaMergeInstancesActorInterface for transformers that merge Weka Instances.Classes in adams.flow.transformer that implement OptionHandler Modifier and Type Class Description classAbstractArrayProviderAncestor for transformer actors that can output items one by one or as a single array.classAbstractCallableWekaClassifierEvaluatorAncestor for classifier evaluators that make use of a callable classifier.classAbstractCallableWekaClustererEvaluatorAncestor for clusterer evaluators that make use of a callable clusterer.classAbstractContainerValueExtractorAncestor for transformers that extract values from a container.classAbstractDataContainerAdd<T extends DataContainer>Ancestor for transformers that superimpose the incoming data container on one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerAppend<T extends DataContainer>Ancestor for transformers that append the incoming data container to one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerDbReader<T extends DataContainer>Ancestor for transformers that read containers from the database.classAbstractDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Abstract ancestor for actors that import data containers into the database.classAbstractDataContainerFileImport<T extends DataContainer>Abstract ancestor for actors that import data containers.classAbstractDataContainerFileReader<T extends DataContainer>Abstract ancestor for actors that read data containers from disk.classAbstractDataContainerFileWriter<T extends DataContainer>Abstract ancestor for transformer actors that write data containers to disk.classAbstractDataContainerTransformerAncestor for actors that transform data containers.classAbstractDataProcessorAbstract ancestor for classes that process data on disk.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbDataProcessorAbstract ancestor for data processors that use a database.classAbstractDbTransformerAbstract ancestor for transformers that query a database.classAbstractDeleteDataContainer<T extends DataContainer>Ancestor for transformers that delete containers from the database.classAbstractDeleteDbReportValue<T extends Report>Ancestor for transformers that delete values from a report in the database whenever a token passes through.classAbstractDeleteReportValueAncestor for transformers that delete values from a report.classAbstractDeleteReportValueByExpressionAncestor for transformers that delete field/value from a report if the boolean expression evaluates to true.classAbstractFilterAncestor for domain-specific filter transformers.classAbstractGetReportValueAncestor for transformers that retrieve a value from a report.classAbstractInPlaceSpreadSheetTransformerAncestor for spreadsheet transformers that allow the processing to happen in-place, rather than on a copy of the data.classAbstractInstanceGenerator<T extends DataContainer>Ancestor for transformers that turn data containers into WEKA Instance objects.classAbstractInteractiveTransformerAncestor for transformers that interact with the user.classAbstractInteractiveTransformerDialogAncestor for graphical actors that are interactive.classAbstractMultiCompressAbstract ancestor for compression algorithms that allow the compression of multiple files (incl directory structure).classAbstractMultiDecompressAncestor for compression schemes that manage archives with multiple files (incl directory structure) like zip archives.classAbstractProcessWekaInstanceWithModel<T>Ancestor for transformers that user models for processing Instance objects, e.g., classifiers making predictions.classAbstractReportDbReader<T extends Report,I>Abstract ancestor for actors that load reports from the database.classAbstractReportDbUpdaterAncestor for transformers that updateReportobjects or reports that are part of aMutableReportHandlerobject.classAbstractReportDbWriter<T extends Report,I>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByDBID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportFileImport<T extends Report>Abstract ancestor for report import actors.classAbstractReportFileReader<T extends Report>Abstract ancestor for report file reader transformers.classAbstractReportFileWriter<T extends Report>Abstract ancestor for actors that write reports to disk.classAbstractReportValueDbWriter<T extends Report>Abstract ancestor for actors that write report values to the database.classAbstractScriptAncestor for transformer script actors.classAbstractSetReportValueAncestor for transformers that update the value of field in a report.classAbstractSingleCompressAncestor for compression algorithms that only take a single file, like gzip.classAbstractSingleDecompressAncestor for decompression algorithms that only work with archives that consists of a single file, like gunzip.classAbstractSpreadSheetTransformerAncestor for transformers that work on spreadsheets and also output spreadsheets again.classAbstractStringOperationAncestor for transformers that perform operations on strings.classAbstractTransformerAncestor for all flow items that process an input token and generate an output token.classAbstractTransformerWithPropertiesUpdatingAncestor for transformers that allow changing the object's properties using variables.classAbstractWekaClassifierEvaluatorAncestor for transformers that evaluate classifiers.classAbstractWekaModelReaderAncestor for actors that deserialize models.classAbstractWekaPredictionsTransformerAncestor for transformers that convert the predictions stored in an Evaluation object into a different format.classAccessDatabaseInfoOutputs information on a MS Access database.classAddDOMAttributeAdds a new attribute to the incoming org.w3c.dom.Node and forwards the new updated node.classAddDOMNodeAdds a new node below the incoming org.w3c.dom.Node and forwards the new node.
In case of an incoming org.w3c.dom.Document, the node gets added below the root node.classAddNoteAdds a note to the notes handler passing through.
Pre-defined note types:
- ERROR:
- WARNING:
- PROCESS INFORMATION
Input/output:
- accepts:
adams.data.NotesHandler
- generates:
adams.data.NotesHandler
classAppendNameAppends the suffix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and suffix.classArrayCombinationsTurns an array of any type into a sequence of array combinations of given size.classArrayHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming double array or matrix.
In case of an array, the data-type and location are ignored.classArrayLengthDetermines the length of an array.classArrayReverseReverses the order of the elements in the array.classArrayStatisticGenerates statistics from a double array or matrix.classArraySubsetGenerates a subset of the array, using the specified array elements.classArraySubsetGenerationclassArrayToChunksSplits an array into chunks of a specified size.classArrayToCollectionTurns an array into a collection.classArrayToSequenceTurns an array of any type into a sequence of tokens.classArrayToVariablesclassAutogeneratedTransformerEncapsulates a sequence of auto-generated actors.classBaseNameExtracts the name of the file/directory passing through, i.e., any preceding directory gets stripped.classBinaryFileReaderReads a binary file and forwards the content byte by byte or as byte array.classBoofCVDetectLinesDetects lines in images (Hough line detector based on polar parametrization).classBoofCVDetectLineSegmentsDetects line segments in images (line RANSAC).classBoofCVFeatureGeneratorApplies a BoofCV feature generator to the incoming image and outputs the generated features.classBoofCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classBoofCVTransformerApplies a BoofCV transformation to the incoming image and outputs the generated image(s).classBufferedImageFeatureGeneratorApplies an JAI flattener to the incoming image and outputs the generated features.classBufferedImageMultiImageOperationApplies a BufferedImage multi-image operation to the incoming image(s) and outputs the generated image(s).classBufferedImageTransformerApplies a BufferedImage transformation to the incoming image and outputs the generated image(s).classBzip2Creates a bzip2 archive from a single file.classCallableTransformerFeeds tokens into a callable transformer and broadcasts the generated output tokens.classChangeImageObjectPrefixUses the specified object finder to locate objects and then applies the object filter to the located objects.classChangeReportFieldPrefixesReplaces the specified old prefixes with the new one.classClassSelectorSets (or unsets) the class index/indices.classCollectionAppendAppends the elements of the incoming collection to the one in storage.
If there is none in storage yet, a copy of the incoming collection will simply get stored in storage.
The combined collection is then forwarded.classCollectionInsertInserts an object in the collection using the specified position.
The object can be retrieved from a callable actor or from storage.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.StorageCollectionInsert
Input/output:
- accepts:
java.util.Collection
- generates:
java.util.Collection
classCollectionSizeclassCollectionSubsetGenerates a subset of the collection, using the specified elements.classCollectionToArrayTurns a collection of any type into an array.classCollectionToSequenceTurns a collection of any type into a sequence of tokens.classColorProviderOutputs a color for each token passing through.
If the color provider implements adams.gui.visualization.core.ColorProviderWithNameSupport then the color associated with the incoming string token is forwarded.
The color provider can be reset using the specified variable.classCompareObjectLocationsVisualizes object locations (annotations and predicted) for the incoming image side-by-side.
Only forwards the image container when accepted.classCompareObjectsCompares two objects using the specified compare algorithm and forwards the output of the comparison.classCompareObjectTypesCompares the object types between objects from the two reports.
The first report is considered 'ground truth'.classConfirmationDialogPops up a confirmation dialog, prompting the user to select 'yes', 'no' or 'cancel'.
If no custom tokens are used, the current token is only forwarded when the user selects 'yes'.classConfusionMatrixGenerates a confusion matrix from the specified actual and predicted columns containing class labels.
Can take a probability column (of prediction) into account for generating weighted counts.classContainerToStorageExtracts the specified values from the container passing through and makes them available as storage items.classContainerToVariablesExtracts the specified values from the container passing through and makes them available as variables.classControlChartApplies a control chart algorithm to the data.classConvertConverts data from one format into another.classConvertFeaturesTurns the raw features generated by a feature converter (stored in a adams.flow.container.FeatureConverterContainer) into a specific format using the user-defined feature converter.
If an array of containers is received, the get merged first, i.e., placed side-by-side.classCopyCreates copies of the tokens being passed through.classCopyCallableTransformerFeeds tokens into the copy of a callable transformer and broadcasts the generated output tokens.classCopyFileCopies the file received on its input port to the target directory if it matches the provided regular expression.
In case of a directory, the directory gets copied recursively.
If required, you can also provide a new filename (just the name, no path).
The generated target file/directory gets forwarded in the flow.classCopyToClipboardCopies the data in this token to the system's clipboard using the specified clipboard manager.classCounterAddPasses a value through the specified counter.classCounterInitCreates a counter from a column in a spreadsheet or an array.classCountObjectsInRegionCounts 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.classCreateEmailActor for creating emails to be sent.classDatasetFilterApplies the batch filter to the dataset.classDatasetRowFilterApplies the stream filter to the rows.classDateTimeTypeDifferenceComputes the difference between the two date/time types of the incoming array (of length 2) by subtracting the second element from the first one.classDecodeBarcodeDecodes the data in a barcode using the specified decoder.classDeleteFileDeletes the file/directory received on its input port if it matches the provided regular expression.
In case of directories, deletion is performed recursively (if a directory matches, then the content gets deleted regardless whether it matches the regular expression or not).classDeleteJsonValueclassDeleteMapValueDeletes the specified key/value pair from the map passing through.classDeleteOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classDeletePropertyValueDeletes the specified property from the Properties object passing through.classDeleteReportValueDeletes values from a report.classDeleteReportValueByExpressionclassDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage whenever a token passes through.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeDeserializes a previously serialized Java object from a file.classDetermineOverlappingAreasclassDetermineOverlappingObjectsComputes the overlap of objects with the specified report from storage (or itself) using the specified algorithm.classDiffCompares two files or two string arrays and generates a diff representation.
In case of BRIEF, the output is whether the two files/arrays are different.classDirNameExtracts the directory part of the file/directory passing through, i.e., any trailing name part gets stripped.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.BaseName
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classDownloadContentDownloads the raw, textual content from a URL and forwards it.Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
adams.core.base.BaseURL
java.net.URL
- generates:
java.lang.String
classDrawPerforms a draw operation on an image.classEmailFileReaderReads email(s) from a file.classExecuteActorExecutes the actor passing through and forwards it once finished.
If the actor is an instance of adams.flow.execution.FlowExecutionListeningSupporter and flow execution listening enabled, then the specified flow execution listener gets attached.classExecuteJobsExecutes the incoming jobs.classExecuteRemoteCommandExecutes the incoming commands.classExifTagOperationPerforms the specified EXIF operation on the incoming data.classExpandStorageExpands all the storage items (using their string representation) and variables in the string(s) passing through.
A string can consist of arbitrary strings and the following special placeholders:
- variables: @{...}
- storage placeholders: %{...}
Input/output:
- accepts:
java.lang.String
java.lang.String[]
- generates:
java.lang.String
java.lang.String[]
classExpandVariablesExpands all the variables in the string(s) passing through.A string can consist of arbitrary strings and the following special placeholder for variables:
@{...}
Input/output:
- accepts:
java.lang.String
java.lang.String[]
- generates:
java.lang.String
java.lang.String[]
classExternalTransformerTransformer that executes an external transformer actor stored on disk.classFileChangedChecks whether the input file has changed using the specified monitor.
Must be initialized once with the same file.classFileExtensionExtracts the file extension from the file (the part after the '.').
If no dot is in the file name, then an empty string gets forwarded.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.DirName
adams.flow.transformer.BaseName
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
classFileInfoOutputs information for a path (file/directory).classFilenameGeneratorPasses the incoming token through the generator to generate and forward a filename.
See also:
adams.flow.source.FilenameGenerator
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
java.lang.String
classFileTailerMonitors a text file for data being appended, e.g., log files.classFilterMapApplies the specified filter to the map object passing through.classFindInFileSearches the incoming (text) file for the specified search string, output the boolean search result.classFlowFileReaderReads the flow file and outputs the actor(s).
A custom reader can be specified in case of reading from files, but must be specified when reading from java.io.Reader or java.io.InputStream objects.classFTPDeleteDeletes a remote file and forwards the file name.classFTPDisconnectCloses the currently open FTP session.
Simply passes through any tokens.classFTPGetDownloads a remote file and forwards the local file name.classFTPNoOpSends a NOOP command to the FTP server whenever a token passes through.classFTPSendUploads a file to a remote directory.
The file name of a successful upload gets forwarded.classGenerateFileBasedDatasetApplies the specified generator to the incoming dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.PrepareFileBasedDataset
Input/output:
- accepts:
adams.flow.container.FileBasedDatasetContainer
- generates:
java.lang.String
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classGetArrayElementPicks an element from an array and forwards only this element.classGetDatabaseIDReturns the database ID of the database ID handler passing through.classGetIDReturns the ID of the ID handler passing through.classGetImageObjectIndicesUses the specified object finder to locate objects and forwards the indices.classGetImageObjectMetaDataRetrieves the meta-data of the incoming adams.flow.transformer.locateobjects.LocatedObject object.classGetImageObjectsUses the specified object finder to locate objects and forwards the objects.classGetJsonKeysOutputs all the keys of the JSON Object passing through.classGetJsonValueObtains the value associated with the specified key from the JSON object passing through.
Null values are only forwarded if requested.classGetListElementPicks an element from a list and forwards only this element.classGetMapKeysForwards all the sorted (string) keys of the map.classGetMapValueObtains the value associated with the specified key from Map object received as input and forwards it.classGetNotesReturns the notes of the notes handler passing through.classGetObjectPropertyRetrieves a value from an object's property using a bean property path.
A bean property consists usually of a get and set method, e.g.:
- setDebug(boolean)
- boolean getDebug()
The property name for this pair is:
debug
Input/output:
- accepts:
java.lang.Object
- generates:
adams.flow.core.Unknown
classGetPropertiesOutputs the names of all Java Bean properties of the incoming object.classGetPropertyObtains the current property value of the object passing through.classGetPropertyNamesOutputs all the keys of the properties object passing through.classGetPropertyValueObtains the value(s) associated with the keys that match the specified regular expression from the Properties object passing through.
Null values are only forwarded if requested.classGetRemoteCommandPayloadReturns the underlying payload objects (if any) from the incoming remote command.
Depending on request/response flag, it outputs the corresponding payload objects.
Does not forward anything if the array is empty.classGetReportReturns the report of the report handler passing through.classGetReportValueRetrieves a value from a report.classGetStorageValueRetrieves a value from internal storage using the incoming string token as name.classGroovyA transformer that uses a Groovy script for processing the token(s).classGroupByRegExpGroups the incoming strings into sub-groups.classGUNZIPDecompresses an archive that was compressed with gzip.classGZIPCreates a GZIP archive from a single file.classHashSetAddAdds a value to the specified hashset.classHashSetInitCreates a hashset from a column in a spreadsheet or an array.classHashSetRemoveRemoves a value from the specified hashset.classHexReplaceAllows to find and replace characters in hex notation.classHttpPostFileUploads the incoming file via HTTP POST to the specified URL as 'multipart/form-data'.
Additional form fields can be supplied as well.classHttpRequestSends the incoming text/bytes payload to the specified URL (with optional HTTP headers) and forwards the retrieved HTML as text.classIDGeneratorGenerates IDs from the objects it receives on its input and forwards the generated IDs.classImageAnnotatorAllows the user to label objects located on the image and pass on this enriched meta-data.classImageFileReaderReads any file format that the specified image reader supports.
If meta-data is associated with the image, then this can be loaded as well.classImageInfoObtains information from the picture passing through.classImageLabelerAllows the user to label images, setting a report field in the meta-data.
Any logged interaction will get added as JSON under interaction-log in the report.classImageMetaDataReturns any EXIF or IPTC and basic image information as a spreadsheet.classImageObjectAnnotatorUser interface for annotating objects in images.classImageObjectFilterUses the specified object finder to locate objects and then applies the object filter to the located objects (modifies the report).classImageObjectIndexOffsetOffsets the object index.classImageObjectInfoOutputs the requested type of information for either the incoming adams.flow.transformer.locateobjects.LocatedObject or the specified image object in the report.classImageObjectOverlapComputes the overlap of objects with the specified report from storage.
It stores the overlap percentage of the highest overlap found (overlap_highest) and the total number of overlaps greater than the specified minimum (overlap_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest overlap gets stored as well (overlap_label_highest) and whether the labels match (overlap_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classImageObjectOverlapMatrixGenerates a matrix of overlapping image objects (annotations vs predictions) and their labels.
When outputting not just overlaps, a separate column 'Overlap' is output as well, indicating whether this row represents an overlap ('yes') or not ('no')
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.spreadsheet.SpreadSheet
classImageObjectToVariablesConverts the parameters of an image object into variables.
Meta-data can be turned into variables as well.classImagePreparationPreprocesses an image.classImageSegmentationAnnotatorUser interface for annotating images for image segmentation.classImageSegmentationContainerFilterApplies a Image Segmentation container filter to the incoming container(s) and outputs the generated data.classImageSegmentationContainerOperationApplies a Image Segmentation container operation to the incoming container(s) and outputs the generated data.classImageSegmentationFileReaderReads image segmentation file formats using the specified reader and forwards a container with the data.classImageSharpnessDetermines whether images are in focus ('sharp') using the specified algorithm.classInactiveTransformerEncapsulates a sequence of inactive actors.classIncludeExternalTransformerIncludes an external transformer.classIncStorageValueIncrements the value of a storage value by either an integer or double increment.
If the storage value has not been set yet, it will get set to 0.
If the storage value contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated storage value (while discarding the input token).classIncVariableIncrements the value of a variable by either an integer or double increment.
If the variable has not been set yet, it will get set to 0.
If the variable contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated variable (while discarding the input token).classIndexedSplitsRunsEvaluationUses the specified evaluation for evaluating the incoming data.classIndexedSplitsRunsGeneratorUses the specified generator for generating indexed splits from the incoming data.classIndexedSplitsRunsPredictionsUses the specified generator for generating predictions from indexed splits for the incoming data.classIndexedSplitsRunsReaderReads indexed splits runs from disk using the specified reader.classIntersectOverUnionComputes the Intersect Over Union (IOU) of objects with the specified report from storage.
It stores the highest IOU found (iou_highest) and the total number of iou greater than the specified minimum (iou_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest iou gets stored as well (iou_label_highest) and whether the labels match (iou_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classJsonFileReaderReads a JSON file and forwards the parsed JSON object.
If it is know beforehand, whether the JSON file contains an object or an array, the output type can be specified.classLocateObjectsLocates objects in an image and forwards an image per located object, cropped around the object.classLookUpForwards the value associated with the key that the actor gets as input, using the specified lookup table from internal storage.classLookUpAddAdds key-value pairs to the specified lookup table.
The input can either an array or a spreadsheet.
If the input is an array, it must have length 2, with the first element the key and the second one the value.classLookUpInitCreates a lookup table from a spreadsheet, using one column as key and another one as value.classLookUpRemoveRemoves a key/value pair from the specified lookup table.classLookUpUpdateUpdates the lookup table (in form of a spreadsheet) that passes through using the specified rules.
The rules can contain variables.
The rules use the following grammar:
expr_list ::= expr_list expr_part | expr_part
expr_part ::= conditional | assignment
conditional ::= if expr then assignments end
| if expr then assignments else assignments end
assignments ::= assignments assignment | assignment
assignment ::=
VARIABLE := expr;
| all ( "regexp" ) := expr;
expr ::= ( expr )
| NUMBER
| STRING
| BOOLEAN
| VARIABLE
| true
| false
| -expr
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr
| not expr
| expr and expr
| expr or expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
Notes:
- Variables are either all alphanumeric and -/_ (e.g., "ABc_1-2") or any character
apart from "'" enclosed by "'" and "'" (e.g., "'Hello World'").
- The 'all' method applies the value to all the values in the lookup table
that match the regular expression.
- Variables starting with '_' are considered local and don't get transferred back out.
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet
classLzfCreates a LZF archive from a single file.classLzmaCreates a LZMA (7zip) archive from a single file.classMakeDirCreates the directory accepted on the input port if not already existing.classMakeForecastPlotContainerCreates a named containers for the SequencePlotter actor using the incoming forecasts.classMakeJFreeChartDatasetGenerates a JFreeChart dataset from the incoming spreadsheet.classMakeLogEntryCreates a log entry from the incoming token.classMakePlotContainerCreates a named container for the SequencePlotter actor.
In case of Double arrays arriving at the input, they must have length 2 for X and Y, 4 for X/Y/Y-Error (low/high) or 6 X/Y/X-Error (low-high)/Y-Error (low-high).
Integer arrays can only have the length 2.
It is also possible, depending on the plotter sink setup, to use strings for x and/or y.
In order to force an update of the plot, overriding the current plot-updater setup, you can create a special plot container of type UPDATE and send that to the plot (can be triggered with a null-token, e.g., from a adams.flow.source.Start source).classMapToStorageValuesStores the map content in internal storage.
Only the map keys that match the regular expression are turned into storage values.classMapToVariablesTurns the map content into variables.
Only the map keys that match the regular expression are turned into variables.classMapVariableIteratorIterates over the keys of the incoming map and sets variables for current key and variable.classMat5ArrayInfoProvides information on a Matlab5 array.classMat5ArraySubsetOutputs either a single value (all dimensions in index specified) from an array or a subset (if one or more dimensions left empty).
Only arrays of type us.hebi.matlab.mat.types.Matrix are currently supported.classMat5FileAddArrayAdds an array to the matlab file object using the specified name.
The array can be retrieved from a callable actor or from storage.classMat5FileAddMapAdds the elements of a map to the matlab file object using the names from the map.
The map can be retrieved from a callable actor or from storage.classMat5FileGetArrayRetrieves the specified array from the mat file object.classMat5FileInfoProvides information from a .mat file.classMat5FileReaderLoads a Matlab file in mat5 format.classMat5GetMatrixElementRetrieves the specified matrix element.classMat5GetStructFieldRetrieves the specified struct field.classMat5SetMatrixElementSets the specified element in the matrix passing through.
The value gets parsed automatically according to the element type.classMat5SetStructFieldSets obtained array under the specified field name.classMat5StructInfoProvides information from a Matlab struct object.classMatchReportFieldsOutputs all fields that match the regular expression.classMathExpressionEvaluates a mathematical expression.
The input value (double or integer) can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classMaxReturns the maximum value from a double/int array or the index of the maximum value.classMergeObjectLocationsMerges the object locations in the report of the container passing through with the one obtained from storage.
The 'overlap action' determines what to do if objects overlap.
With the 'check type' you can still trigger a 'skip' if the type values of the two overlapping objects differ.
For simply merging all objects, choose a minOverlapRatio of 0.0 and the OverlapAction of KEEP.classMergeReportAllows the report (or the report of a report handler) passing through to to be merged with another one.classMergeReportFromMapMerges the passing through report handler/report objects with the referenced map of report objects in storage.classMessageDigestGenerates a message digest and forwards that.classMimeTypeDetermines the mime type of a file.classMinReturns the minimum value from a double/int array or the index of the minimum value.classMoveFileMoves a file to a different location (or just renames it).
Source and target can be swapped as well.
Simply forwards the input token if moving was successful.classMultiMapOperationApplies the specified operation the incoming map array.classMultiMat5MatrixOperationApplies a multi-matrix operation to the incoming matrix(s) and outputs the generated matrix(s).classMultiSpreadSheetOperationApplies the specified operation the incoming spreadsheet array.classNegativeRegionsUses the specified generator for generating negative regions for the image passing through.classObjectArrayToPrimitiveArrayTurns an object array into an primitive one.classOpenCVFeatureGeneratorApplies a OpenCV feature generator to the incoming image and outputs the generated features.classOpenCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classOpenCVTransformerApplies a OpenCV transformation to the incoming image and outputs the generated image(s).classOptionProducerGenerates string output from the object passing through using the specified option producer.classOutlierDetectorApplies the outlier detector and either outputs the updated data container or a flow container with the data and the detection results.classPassThroughDummy transformer that passes tokens through.classPDFAppendDocumentModifies the incoming PDF document generated by adams.flow.source.PDFNewDocument using the PDF processors on either the specified input file or storage item.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
If a file name is received as input, it is assumed that this is an existing PDF file and gets appended.
See also:
adams.flow.source.PDFNewDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
java.lang.String
java.io.File
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFCreateActor for generating PDF files.classPDFExtractActor for extracting a range of pages from a PDF file.classPDFExtractImagesActor for extracting the images from a PDF file.classPDFExtractTextActor for extracting the text of a range of pages from a PDF file.classPDFGenerateclassPDFInfoOutputs information on a PDF file.classPDFMergeActor for merging multiple PDF files.
Forwards the name of the generated file.classPDFMetaDataActor for extracting the meta-data from a PDF.classPDFPageCountActor for extracting the page count from a PDF file.classPDFRenderPagesActor for rendering pages of a PDF file as images.classPDFStampActor for stamping pages in a PDF with a custom overlay.classPixelSelectorAllows the user to select pixels.classPredictionEccentricityTreats the predictions from a regressor as an image and computes the 'eccentricity' of the actual vs predicted plot.classPrepareFileBasedDatasetProcesses the incoming files and generates a dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.GenerateFileBasedDataset
Input/output:
- accepts:
java.lang.String[]
- generates:
adams.flow.container.FileBasedDatasetContainer
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classPrependDirPrepends the prefix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and prefix.classPrimitiveArrayToObjectArrayTurns a primitive array into an object one.classProcessActorApplies the specified processor to the incoming actor and forwards the result.
For processors implementing adams.flow.processor.ModifyingProcessor the modified actor is forwarded (or, if not modified, the original one), all others just forward the incoming actor.
If the processor should implement adams.flow.processor.ListingProcessor then any generated list gets stored as string array in the outgoing container as well.
Processors implementing adams.flow.processor.GraphicalOutputProducingProcessor can optionall display the graphical output as well (off by default).classProgrammaticTokenListenerTransformer that allows other, non-flow code to 'listen on the wire' of the data being processed.
Typically used for flows that are executed as background jobs in the user interface.
Listeners get removed once the flow finishes (wrapUp method).classPropertiesFileReaderReads a Java Properties file.classPropertiesToVariablesTurns the properties into variables.
Only the property keys that match the regular expression are turned into variables.classPyroTransformerTransforms data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- accepts:
java.lang.Object
- generates:
java.lang.Object
classPythonExpandScriptLoads the Python script received as input, expands any variables and placeholders, saves it to the specified output file and forwards the output file name.classRelativeDirRemoves the prefix from the file/directory being passed through to turn them into relative ones.
See also:
adams.flow.transformer.BaseName
adams.flow.transformer.DirName
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classRemoteCommandReaderLoads the remote command from the incoming file.classRemoveImageObjectRemoves the specified image object.classRemoveOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classReportDbUpdaterAdds all the data to the report (or reporthandler's report) passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current handler's ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.MutableReportHandler
- generates:
adams.data.report.Report
adams.data.report.MutableReportHandler
classReportFieldReturns all the fields in a report or the report from a report handling object that match the provided regular expression.classReportFileReaderLoads a file containing a report from disk with a specified reader and passes it on.classReportFileWriterSaves a report to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the report is used (below the specified output directory).classReportMathExpressionEvaluates a mathematical expression based on report values.
Either outputs the updated report or the report handler if that allows updating the report.classReportToStorageStores all report fields that match the provided regular expression in internal storage.classReportToVariablesTurns all report fields that match the provided regular expression into variables.classRoundPerforms 'round', 'ceiling' or 'floor' on double tokens and generates integers.classScaleReportObjectsScales the objects in the report using the provided scale factors.
Processes the following suffixes of all the report fields that match the provided prefix:
- .x
- .y
- .width
- .height
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.report.Report
adams.data.report.ReportHandler
classScpFromDownloads a remote file and forwards the local file name using secure copy (SCP).
For more information see:
(2011).classScpToUploads a file to a remote directory using secure copy (SCP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classScriptedA transformer that uses an external script for processing the token(s).classSelectArraySubsetAllows the user to select a subset of the incoming array to be forwarded in the flow.classSequenceToArrayTurns a sequence of tokens into arrays with a specified length.
In case of unspecified length (ie -1), an array containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.classSequenceToCollectionTurns a sequence of tokens into a collection.
In case of unspecified length (ie -1), a collection containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.classSetArrayElementSets an element of an array and forwards the updated array.classSetDatabaseIDUpdates the database ID of the database ID handler passing through with the provided 'ID' value.classSetIDUpdates the ID of the ID handler passing through with the provided 'ID' value.classSetImageObjectMetaDataSets meta-data in the incoming adams.flow.transformer.locateobjects.LocatedObject object.classSetJsonValueSets a value in a JSON object, using the specified path.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetManyVariablesSets the values of the variables whenever a token passes through, but does not use the token's value.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSetMapValueSets a value in a java.util.Map object.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetPlotContainerValueUpdates a value of a plot container before it is being displayed in the SequencePlotter sink.classSetPropertySets the property of a callable actor whenever a token passes through.
Note: this actor just sets the value, but performs no re-initialization or similar of the modified object.
The transformer just forwards tokens that it receives after the property has been set.classSetPropertyValueSets a property in a properties object.classSetReportFromFileLoads a report from disk and replaces the current one in the token passing through.classSetReportFromSourceObtains a report from a callable source and replaces the current one in the token passing through.classSetReportValueSets a value in a report.classSetStorageFlagStores the flag value in storage using the specified name whenever a token passes through.classSetStorageValueStores the payload of the token passing through under the specified name in temporary storage.classSetSystemPropertySets a Java system property when it is executed.classSetVariableSets the value of a variable.classSFTPDeleteDeletes a remote file via secure FTP (SFTP) and forwards the deleted file name.
For more information see:
(2011).classSFTPGetDownloads a remote file and forwards the local file name via secure FTP (SFTP).
For more information see:
(2011).classSFTPSendUploads a file to a remote directory using secure FTP (SFTP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classSimpleStringReplacePerforms a string replacement, using String.replace(.., ...).
If the 'replace' string contains both, variables and placeholders, then first all variables are expanded and then the placeholders.classSMBGetDownloads a remote file and forwards the local file name (SMB, Windows share).
Host and remote directory can be left empty if the incoming filename consists of a fully qualified URL, e.g.: smb://host/share/dir/file.txt
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSMBSendUploads a file to a remote directory (SMB, Windows share).
The file name of a successful upload gets forwarded.
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSortActor for sorting arrays.classSplitFileSplits the file into several smaller files using the specified splitter algorithm.classSpreadSheetAggregateAggregates rows (min, max, avg, etc) in a spreadsheet using key columns.
All numeric columns in the specified aggregrate range (excluding the key columns) get aggregated.classSpreadSheetAnonymizeAnonymizes a range of columns in a spreadsheet.classSpreadSheetAppendAppends the incoming spreadsheet to one in storage.
If there is none in storage yet, the incoming spreadsheet will simply get stored in storage.
The spreadsheets need not have the same structure, but it is assumed that column names are unique within a spreadsheet.
The combined spreadsheet is then forwarded.classSpreadSheetAppendCommentsAppends the comments of the spreadsheet.classSpreadSheetCellFinderOutputs the cell locations that the cell finder located.classSpreadSheetCellSelectorLets the user highlight cells in a spreadsheet which get output:
- spreadsheet with coordinates (1-based row and column) and the associated value of the selected cell
- spreadsheet with all un-selected cells set to missing
Usage:
You select cells by left-clicking on them and/or holding the left mouse button and moving the mouse over the cells that you want to select.
You can unselect cells in the same fashion, by holding the shift key in addition.classSpreadSheetCollapseUses the specified key columns to identify groups of rows.classSpreadSheetColumnFilterFilters spreadsheets using the specified column finder.
The output contains all the columns that the specified finder selected.classSpreadSheetColumnIteratorIterates through all columns of a spreadsheet and outputs the names.
The columns can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classSpreadSheetColumnsByNameCreates a new spreadsheet with the columns that matched the regular expression.classSpreadSheetColumnStatisticGenerates statistics for a chosen colunm.classSpreadSheetCommonIDsExtracts the common IDs from two or more spreadsheets.
Matching sense can be inverted, i.e., the IDs not in common are output.classSpreadSheetConvertCellsFinds cells in a spreadsheet and converts them with a conversion scheme.
If the conversion scheme generates a adams.data.spreadsheet.SpreadSheet object itself, this will get merged with the enclosing one: any additional columns get added and the content of the first row gets added to the row the converted cell belongs to.classSpreadSheetConvertHeaderCellsConverts the header cells of a spreadsheet with a conversion scheme.classSpreadSheetCopyColumnsCopies a range of columns to a specific position in the spreadsheets coming through.classSpreadSheetCopyRowsCopies a range of columnrows to a specific position in the spreadsheets coming through.classSpreadSheetDifferenceComputes the difference of the numeric cells between two spreadsheets.
The values of the second spreadsheet are subtracted from the first one.
If no 'key' columns are defined, the current order of rows is used for comparison.classSpreadSheetExtractArrayExtracts a column or row of data from a SpreadSheet object.classSpreadSheetFileReaderReads a spreadsheet file and forwards the content.classSpreadSheetFilterApplies the specified spreadsheet filter to the data.classSpreadSheetGetCellExtracts one or more values from a spreadsheet.classSpreadSheetGetColumnIndexObtain the 1-based indices of columns that match a user-specified regular expression.classSpreadSheetGetHeaderCellExtracts a single value from a spreadsheet's header.classSpreadSheetHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming adams.data.spreadsheet.SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetInfoOutputs statistics of a SpreadSheet object.classSpreadSheetInsertColumnInserts a column at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowInserts a row at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowScoreInserts a score column at a specific position into spreadsheets coming through.classSpreadSheetMatrixStatisticGenerates statistics for the spreadsheet.classSpreadSheetMergeMerges two or more spreadsheets.classSpreadSheetMethodMergeMerges 2 or more spreadsheets into a single spreadsheet, using a selectable merge method.classSpreadSheetPlotGeneratorOutputs plot containers generated from a spreadsheet.classSpreadSheetQueryApplies a query (SELECT, UPDATE, DELETE) on a spreadsheet.
Variables are supported as well, e.g., : SELECT * WHERE Blah = @{val} with 'val' being a variable available at execution time.
The following grammar is used for the query:
expr_list ::= expr_list expr_part | expr_part;
expr_part ::= select | update | delete;
select ::= SELECT col_list [limit]
| SELECT col_list WHERE cond_list [limit]
| SELECT col_list ORDER BY order_list [limit]
| SELECT col_list WHERE cond_list ORDER BY order_list [limit]
| SELECT agg_list
| SELECT agg_list GROUP BY col_list
| SELECT agg_list HAVING cond_list
| SELECT agg_list GROUP BY col_list HAVING cond_list
;
update ::= UPDATE SET upd_list
| UPDATE SET upd_list WHERE cond_list
;
delete ::= DELETE WHERE cond_list
;
col_list ::= col_list COMMA col
| col
| SELECT NUMBER [subsample: <1 = percent; >= 1 number of rows]
;
col ::= *
| COLUMN
| COLUMN AS COLUMN
;
upd_list ::= upd_list COMMA upd | upd;
upd ::= COLUMN = value
;
order_list::= order_list COMMA order | order;
order ::= COLUMN
| COLUMN ASC
| COLUMN DESC
;
cond_list ::= cond_list cond
| cond
;
cond ::= COLUMN < value
| COLUMN <= value
| COLUMN = value
| COLUMN <> value
| COLUMN >= value
| COLUMN > value
| COLUMN REGEXP STRING
| COLUMN IS NULL
| CELLTYPE ( COLUMN ) = "numeric|long|double|boolean|string|time|date|datetime|timestamp|object|missing"
| ( cond )
| cond:c1 AND cond:c2
| cond:c1 OR cond:c2
| NOT cond
;
value ::= NUMBER
| STRING
| PARSE ( "number" , STRING )
| PARSE ( "date" , STRING )
| PARSE ( "time" , STRING )
| PARSE ( "timestamp" , STRING )
;
limit ::= LIMIT NUMBER:max
| LIMIT NUMBER:offset , NUMBER:max
;
agg_list ::= agg_list COMMA agg
| agg
;
agg ::= COUNT [(*)] [AS COLUMN]
| MIN ( COLUMN ) [AS COLUMN]
| MAX ( COLUMN ) [AS COLUMN]
| RANGE ( COLUMN ) [AS COLUMN] (= MIN - MAX)
| MEAN ( COLUMN ) [AS COLUMN]
| AVERAGE ( COLUMN ) [AS COLUMN]
| STDEV ( COLUMN ) [AS COLUMN]
| STDEVP ( COLUMN ) [AS COLUMN]
| SUM ( COLUMN ) [AS COLUMN]
| IQR ( COLUMN ) [AS COLUMN]
| INTERQUARTILE ( COLUMN ) [AS COLUMN]
Notes:
- time format: 'HH:mm'
- date format: 'yyyy-MM-dd'
- timestamp format: 'yyyy-MM-dd HH:mm'
- STRING is referring to characters enclosed by double quotes
- COLUMN is either a string with no blanks (consisting of letters, numbers, hyphen or underscore; eg 'MyCol-1') or a bracket enclosed string when containing blanks (eg '[Some other col]')
- columns used in the ORDER BY clause must be present in the SELECT part; also, any alias given to them in SELECT must be used instead of original column name
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet
classSpreadSheetRandomSystematicSamplePerforms random systematic sampling on the rows of the incoming spreadsheet.
Divides the rows into N blocks with N being the sample size.classSpreadSheetRemoveColumnRemoves the column(s) at the specific position from spreadsheets coming through.classSpreadSheetRemoveRowRemoves one or more rows at the specific position from spreadsheets coming through.classSpreadSheetReorderColumnsReorders the columns in a spreadsheet according to a user-supplied order.classSpreadSheetReorderRowsReorders the rows in a spreadsheet according to a user-supplied order.classSpreadSheetReplaceCellValueReplaces cell values that match a regular expression with a predefined value.classSpreadSheetRowBinningApplies a binning algorithm to the values from the specified binning column to filter the rows into specific bins.
A new column is then added containing the corresponding bin index.classSpreadSheetRowBufferCan act in two different ways:
1.classSpreadSheetRowFilterFilters spreadsheets using the specified row finder.
The output contains all the rows that the specified finder selected.classSpreadSheetRowStatisticGenerates statistics for a chosen row.classSpreadSheetRowToTimeseriesTurns a spreadsheet row into a timeseries.
Columns for timestamps and values are extracted using the regular expressions, the timestamp columns are optional.classSpreadSheetSelectSubsetAllows the user to select a subset of the incoming spreadsheet to be forwarded in the flow.classSpreadSheetSetCellSets the value of the specified cells in a spreadsheet.classSpreadSheetSetHeaderCellSets a single header cell value in a spreadsheet.classSpreadSheetSortSorts the rows of the spreadsheet according to the selected column indices and sort order (ascending/descending).classSpreadSheetSortColumnsReorders a user-defined subset of columns by name using the specified comparator.classSpreadSheetStatisticGenerates statistics from a SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetStorageRowIteratorIterates through a defined range of rows.classSpreadSheetSubsetExtracts a subset of rows/columns from a spreadsheet.classSpreadSheetSubsetByValueGenerates subsets from a spreadsheet, grouped by the same string value in the specified column.
For instance, if a spreadsheet has 3 unique values (A, B, C) in column 2, then 3 subsheets will generated, each containing the rows that have the value A, B or C.classSpreadSheetSubsetFromGroupSplits the spreadsheet into subsets using the supplied column and then returns the specified range of rows from each generated subset.
The spreadsheet is expected to be sorted on the grouping column.classSpreadSheetToTimeseriesExtracts one or more timeseries from a spreadsheet.
It uses one column ('ID') to identify all the rows that belong to a single timeseries.classSpreadSheetTransformCellsFinds cells in a spreadsheet and transforms them with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetTransformHeaderCellsTransforms header cells with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetVariableRowIteratorIterates through a defined range of rows.classStorageCollectionInsertInserts the object passing through to the collection in storage at the specified position.
After inserting the object successfully, just forwards the object.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.CollectionInsert
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classStorageJFreeChartAddSeriesGenerates a series from the incoming spreadsheet and adds it to the specified JFreeChart dataset in storage.
After inserting the object successfully, just forwards the object.classStringArraySplitUses a regular expression to identify the string that triggers one or more splits in a string array, resulting in smaller arrays being output.
What is done with the string triggering the split, is defined in the split handling option, e.g., discard it.
Useful actor for splitting a log file into individual entry chunks.classStringCutCuts out a part of a string.classStringExpressionEvaluates a string expression.
The input string can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classStringIndentIndents the string with the specified character.
Splits multi-line strings first and processes each line separately.classStringIndexOfDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classStringInsertInserts a user-specified string at a specific position into tokens coming through.
The actor is most useful when attaching a variable to the 'value' option, which allows the value to change dynamically then.classStringJoinCreates a single string out of an array of strings.classStringLengthDetermines the length of a string.classStringMatcherLets string tokens only pass if they match the regular expression.classStringRangeCutCuts out a parts of a string.classStringReplacePerforms a string replacement, using either String.replaceFirst(...) or String.replaceAll(...).classStringSanitizerRemoves all characters that haven't been specified as 'acceptable' characters.classStringSplitSplits a string using a regular expression.classStringTrimTrims strings, i.e., removes leading/trailing whitespaces.classSubStringCountDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classSummaryStatisticsCalculates the selected summary statistics and outputs a spreadsheet.classSwapVariablesSwaps the values of the two variables around, whenever a token passes through.classTarCreates a Tar file containing one or more files.classTemplateTransformerFeeds tokens into an actor generated from a template and broadcasts the generated output tokens.classTesseractOCRApplies OCR to the incoming image file using Tesseract.
In case of successful OCR, either the file names of the generated files are broadcast or the combined text of the files.
NB: The actor deletes all files that have the same prefix as the specified output base.classTextFileReaderReads a text file and forwards the content.
This actor takes the file to read as input.classTextRendererTurns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.classTimeseriesAddAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesAppendAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classTimeseriesFeatureGeneratorApplies a timeseries feature generator to the incoming timeseries and outputs the generated features.classTimeseriesFileReaderLoads a file/directory containing spectrums from disk with a specified reader and passes them on.classTimeseriesFileWriterSaves a spectrum to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the spectrum is used (below the specified output directory).classTimeseriesFilterFilters data using the specified filter.classTimeseriesInfoOutputs information for a timeseries.classTimeseriesReportDbUpdaterAdds all the data to the report of the timeseries passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current timeseries' ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.timeseries.Timeseries
- generates:
adams.data.timeseries.Timeseries
classTimeseriesSplitSplits the incoming timeseries into sub-series using the specified splitter algorithm.classTimestampCreates a timestamp string whenever it receives an input token.classToolRuns a tool.classTouchLike the Unix 'touch' command, updates the 'last modified' timestamp of the file coming through.
By default, it creates the file if it doesn't exist.classUnBzip2Decompresses an archive that was compressed with bzip2.classUniqueIDEnsures that all passing through tokens that implement adams.data.id.MutableIDHandler have a unique ID.
All other tokens are just forwarded as is.classUnLzfDecompresses an archive that was compressed with LZF.classUnLzmaDecompresses an archive that was compressed with LZMA (7zip).classUnRARUnrars a RAR archive and broadcasts the full file names of the extracted files.classUnTarDecompresses a Tar archive and broadcasts the full file names of the extracted files.classUnXzDecompresses an archive that was compressed with XZ.classUnZIPUnzips a ZIP archive and broadcasts the full file names of the extracted files.classUnZstdDecompresses an archive that was compressed with Zstd.classUpdatePropertyUpdates the property of the object passing through with the specified value.classViaAnnotationsToReportsConverts the JSON object passing through to Reports.classWaitForFileWaits for the file passing through to become available, i.e., not in use by another process.classWekaAccumulatedErrorGenerates plot containers from an evaluation object's predictions.classWekaAggregateEvaluationsAggregates incoming weka.classifiers.Evaluation objects and forwards the current aggregated state.classWekaAttributeIteratorIterates through all attributes of a dataset and outputs the names.
The attributes can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classWekaAttributeSelectionPerforms attribute selection on the incoming data.
In case of input in form of a class adams.flow.container.WekaTrainTestSetContainer object, the train and test sets stored in the container are being used.
NB: In case of cross-validation no reduced or transformed data can get generated!
Input/output:
- accepts:
weka.core.Instances
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaAttributeSelectionContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount, Train original indices, Test original indices
- adams.flow.container.WekaAttributeSelectionContainer: Train, Reduced, Transformed, Test, Test reduced, Test transformed, Evaluation, Statistics, Selected attributes, Seed, FoldCount
classWekaAttributeSelectionSummaryOutputs a summary string of the attribute selection.classWekaBootstrappingPerforms bootstrapping on the incoming evaluation and outputs a spreadsheet where each row represents the results from bootstrapping sub-sample.classWekaChooseAttributesLets the user select attributes interactively to use down the track.
Internally, a weka.filters.unsupervised.attribute.Remove WEKA filter is constructed from the selection, to remove the attributes that the user didn't select.classWekaClassifierInfoOutputs information of a trained weka.classifiers.Classifier object.classWekaClassifierOptimizerEvaluates a classifier optimizer on an incoming dataset.classWekaClassifierRankerPerforms a quick evaluation using cross-validation on a single dataset (or evaluation on a separate test set if the number of folds is less than 2) to rank the classifiers received on the input and forwarding the x best ones.classWekaClassifierSetupProcessorApplies the specified processor to the incoming array of classifiers, e.g., for generating new or filtered setups.classWekaClassifyingUses a serialized model to perform predictions on the data being passed through.
The following order is used to obtain the model (when using AUTO):
1.classWekaClassSelectorSets the class index.classWekaClusterAssignmentsOutputs the cluster assignments from the evaluation.classWekaClustererInfoOutputs information of a trained weka.clusterers.Clusterer object.classWekaClustererPostProcessorApplies the specified post-processor to the cluster container (adams.flow.container.WekaModelContainer)
See also:
adams.flow.transformer.WekaTrainClusterer
Input/output:
- accepts:
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaModelContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaClusterEvaluationSummaryGenerates a summary string of the weka.clusterers.ClusterEvaluation objects that it receives.classWekaClusteringUses a serialized model to cluster data being passed through.
The following order is used to obtain the model (when using AUTO):
1.classWekaCrossValidationClustererEvaluatorCross-validates a clusterer on an incoming dataset.classWekaCrossValidationEvaluatorCross-validates a classifier on an incoming dataset.classWekaCrossValidationSplitGenerates train/test pairs like during a cross-validation run.classWekaDatasetsMergeMerges 2 or more datasets into a single dataset, under a selectable merge method.classWekaDatasetSplitSplits the incoming dataset into sub-sets using the specified splitter.classWekaEnsembleGeneratorUses the specified generator to create ensembles from the incoming data.classWekaEvaluationInfoOutputs information about a Weka weka.classifiers.Evaluation object.classWekaEvaluationPostProcessorApplies the specified post-processor to the incoming Evaluation data.classWekaEvaluationSummaryGenerates a summary string of the weka.classifiers.Evaluation objects that it receives.classWekaEvaluationValuePickerPicks a specific value from an evaluation object.classWekaEvaluationValuesGenerates a spreadsheet from statistics of an Evaluation object.classWekaExperimentRepresents a Weka experiment, stored in a file.classWekaExperimentEvaluationGenerates evaluation output of an experiment that was run previously.classWekaExperimentExecutionExecutes an experiment.classWekaExperimentFileReaderLoads an experiment file.classWekaExtractArrayExtracts a column or row of data from a weka.core.Instances or SpreadSheet object.
Only numeric columns can be returned.classWekaExtractPLSMatrixTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.classWekaFileReaderReads any file format that Weka's converters can handle and returns the full dataset or single weka.core.Instance objects.classWekaFilterFilters Instances/Instance objects using the specified filter.
When re-using a trained filter, ensure that 'initializeOnce' is checked.
The following order is used to obtain the model (when using AUTO):
1.classWekaGenericPLSMatrixAccessTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.
See the respective PLS implementation for details on available matrix names (derived from: weka.filters.supervised.attribute.pls.AbstractPLS)
Input/output:
- accepts:
weka.classifiers.Classifier
weka.filters.Filter
weka.core.GenericPLSMatrixAccess
adams.flow.container.WekaModelContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaGeneticAlgorithmApplies the genetic algorithm to the incoming dataset.
Forwards the best setup(s) after the algorithm finishes.
A callable sink can be specified for receiving intermediate performance results.classWekaGeneticAlgorithmInitializerPopulates a adams.flow.container.WekaGeneticAlgorithmInitializationContainer container from the data obtained from the incoming setup (in properties format, can be gzip compressed).classWekaGetCapabilitiesRetrieves the capabilities of a weka.core.CapabilitiesHandler (eg filter or classifier) and forwards them.classWekaGetInstancesValueRetrieves a value from a WEKA Instances object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?' (without the single quotes)
Input/output:
- accepts:
weka.core.Instances
- generates:
java.lang.Double
java.lang.String
classWekaGetInstanceValueRetrieves a value from a WEKA Instance object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?' (without the single quotes)
- the 'attribute name' option overrides the 'index' option
Input/output:
- accepts:
weka.core.Instance
- generates:
java.lang.Double
java.lang.String
Valid options are:classWekaInstanceBufferCan act in two different ways:
1.classWekaInstanceDumperDumps weka.core.Instance objects into an ARFF file.classWekaInstanceEvaluatorAdds a new attribute to the data being passed through (normally 'evaluation') and sets the value to the evaluation value returned by the chosen evaluator scheme.classWekaInstanceFileReaderLoads a WEKA dataset from disk with a specified reader and passes on the adams.core.instance.Instance objects.classWekaInstancesAppendCreates one large dataset by appending all one after the other.classWekaInstancesHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstancesInfoOutputs statistics of a weka.core.Instances object.
FULL_ATTRIBUTE and FULL_CLASS output a spreadsheet with detailed attribute statistics.classWekaInstancesMergeMerges multiple datasets, either from file or using Instances/Instance objects.
If no 'ID' attribute is named, then all datasets must contain the same number of rows.
Attributes can be excluded from ending up in the final dataset via a regular expression.classWekaInstancesStatisticGenerates statistics from a weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstanceStreamPlotGeneratorGenerates plot containers from a range of attributes of the weka.core.Instance objects being passed through.
The generator merely uses the internal data representation for generating the Y value of the plot container.classWekaModelReaderActor for loading a model (classifier or clusterer).classWekaMultiLabelSplitterSplits a dataset containing multiple class attributes ('multi-label') into separate datasets with only a single class attribute.classWekaNearestNeighborSearchOutputs the specified number of nearest neighbors for the incoming Weka Instance.
The data used for the nearest neighbor search is either obtained from storage.classWekaNewInstanceCreates a new weka.core.Instance-derived object, with all values marked as missing.
The class implementing the weka.core.Instance interface needs to have a constructor that takes the number of attributes as sole parameter.classWekaPredictionsToInstancesGenerates weka.core.Instances from the predictions of an Evaluation object.classWekaPredictionsToSpreadSheetGenerates a SpreadSheet object from the predictions of an Evaluation object.
See also:
adams.flow.transformer.WekaSpreadSheetToPredictions
Input/output:
- accepts:
weka.classifiers.Evaluation
adams.flow.container.WekaEvaluationContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output, Original indices
classWekaPrimeForecasterPrimes a forecaster with the incoming data and outputs the updated forecaster alongside the training header (in a model container).classWekaPrincipalComponentsPerforms principal components analysis on the incoming data and outputs the loadings and the transformed data as spreadsheet array.
Automatically filters out attributes that cannot be handled by PCA.classWekaRandomSplitSplits a dataset into a training and test set according to a specified split percentage.classWekaRegexToRangeProduces a range string from a regular expression describing attributes.classWekaRelationNameDeprecated.classWekaRenameRelationModifies relation names.classWekaReorderAttributesToReferenceReorders the attributes of the Instance/Instances passing through according to the provided reference dataset (callable actor or reference file).
This ensures that the generated data always has the same structure as the reference dataset.classWekaSetInstancesValueSets a value in a WEKA Instances object.
Notes:
- relational values cannot be set
- '?' (without single quotes) is interpreted as missing value
Input/output:
- accepts:
weka.core.Instances
- generates:
weka.core.Instances
classWekaSetInstanceValueSets a value in a WEKA Instance.
Notes:
- relational values cannot be set
- '?' (without single quotes) is interpreted as missing value
Input/output:
- accepts:
weka.core.Instance
- generates:
weka.core.Instance
Valid options are:classWekaSplitGeneratorclassWekaSpreadSheetToPredictionsTurns the predictions stored in the incoming spreadsheet (actual and predicted) into a Weka weka.classifiers.Evaluation object.
For recreating the predictions of a nominal class, the class distributions must be present in the spreadsheet as well.
See also:
adams.flow.transformer.WekaPredictionsToSpreadSheet
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
weka.classifiers.Evaluation
classWekaStoreInstanceAppends the incoming weka.core.Instance to the dataset in storage.classWekaStreamEvaluatorEvaluates an incremental classifier on a data stream using prequential evaluation (first evaluate, then train).classWekaStreamFilterFilters Instance objects using the specified filter.classWekaSubsetsSplits the dataset based on the unique values of the specified attribute: all rows with the same unique value form a subset.classWekaTestSetClustererEvaluatorEvaluates a trained clusterer (obtained from input) on the dataset obtained from the callable actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
weka.clusterers.Clusterer
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTestSetEvaluatorEvaluates a trained classifier (obtained from input) on the dataset obtained from the callable actor.classWekaTextDirectoryReaderLoads all text files in a directory and uses the subdirectory names as class labels.classWekaTrainAssociatorTrains an associator based on the incoming dataset and outputs the built associator alongside the training header and rules (in a model container)..classWekaTrainClassifierTrains a classifier based on the incoming dataset and outputs the built classifier alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the classifier implements weka.classifiers.UpdateableClassifier.classWekaTrainClustererTrains a clusterer based on the incoming dataset and output the built clusterer alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the clusterer implements weka.clusterers.UpdateableClusterer.classWekaTrainForecasterTrains a forecaster based on the incoming dataset and outputs the built model alongside the training header (in a model container).classWekaTrainTestSetClustererEvaluatorTrains a clusterer on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The clusterer setup being used in the evaluation is a callable 'Clusterer' actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTrainTestSetEvaluatorTrains a classifier on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The classifier setup being used in the evaluation is a callable 'Classifier' actor.classXMLFileReaderReads an XML file and forwards the parsed org.w3c.dom.Document object.classXPathApplies XPath to the DOM document object.classXSLTApplies an XSLT stylesheet to the DOM document object.classXzCreates a XZ archive from a single file.classYamlFileReaderReads a YAML file and forwards the generated Map object.
http://yaml.org/
Input/output:
- accepts:
java.lang.String
java.io.File
- generates:
java.util.Map
classZIPCreates a ZIP file containing one or more files.classZstdCreates a Zstd archive from a single file. -
Uses of OptionHandler in adams.flow.transformer.arraysubsetgeneration
Classes in adams.flow.transformer.arraysubsetgeneration that implement OptionHandler Modifier and Type Class Description classAbstractArraySubsetGeneratorAncestor for schemes that generate array subsets.classEveryNthPicks every nth element to be used in the new array.classPercentageUses the specified percentage to determine which nth elements to be used in the new array.classRangeSubsetGenerates a subset of the array, using the specified array elements.classSimplePercentageUses the specified percentage to determine which first n elements are to be used in the new array. -
Uses of OptionHandler in adams.flow.transformer.compareobjectlocations
Classes in adams.flow.transformer.compareobjectlocations that implement OptionHandler Modifier and Type Class Description classAbstractComparisonAncestor for comparison panel generators.classCombinedDisplays the annotations and predictions with different colors.classSideBySideGenerates a side-by-side comparison. -
Uses of OptionHandler in adams.flow.transformer.datacontainer
Classes in adams.flow.transformer.datacontainer that implement OptionHandler Modifier and Type Class Description classAbstractDataContainerPostProcessor<T extends DataContainer>Ancestor forDataContainerpost-processors.classAbstractDataContainerPreProcessor<T extends DataContainer>Ancestor forDataContainerpre-processors.classNoPostProcessing<T extends DataContainer>Dummy, performs no post-processing at all.classNoPreProcessing<T extends DataContainer>Dummy, performs no pre-processing at all. -
Uses of OptionHandler in adams.flow.transformer.draw
Classes in adams.flow.transformer.draw that implement OptionHandler Modifier and Type Class Description classAbstractColorDrawOperationAncestor for operations that use a color.classAbstractColorStrokeDrawOperationAncestor for operations that use a colored, variable stroke.classAbstractDrawObjectsFromReportAncestor for overlays that use object locations from a report.classAbstractDrawOperationAncestor to all draw operations.classAnnotationsAndPredictionsOverlays the image with annotations and predictions from storage with their respective draw operations.classBarcode* Draws a barcode with the specified color and dimensions at the given location.classFloodFillPerforms a flood-fill starting at the given position.classImageDraws the image obtained from a callable actor at the specified location.classLineDraws a line between the given start and end coordinates.classObjectAnnotationsFromReportOverlays object annotations from the report.classObjectCentersFromReportDisplays the centers of objects in the image, using data from the attached report.
Suffixes:
.x
.y
.width
.height
Optionally, if type information is available per object, the locations can be displayed in distinct colors per type.classObjectLocationsFromReportDisplays the locations of objects in the image, using data from the attached report.
Suffixes:
.x
.y
.width
.height
Optionally, if type information is available per object, the locations can be displayed in distinct colors per type.classOvalDraws an oval with the specified color and dimensions at the given location.classPixelDraws a pixel with the specified color at the specified location.classRectangleDraws a rectangle with the specified color and dimensions at the given location.classTextDraws text with a specified font at the given location. -
Uses of OptionHandler in adams.flow.transformer.exiftagoperation
Subinterfaces of OptionHandler in adams.flow.transformer.exiftagoperation Modifier and Type Interface Description interfaceExifTagExistsOperation<I>Interface for EXIF tag exists operations.interfaceExifTagOperation<I,O>Interface for EXIF tag operations.interfaceExifTagReadOperation<I,O>Interface for EXIF tag read operations.interfaceExifTagRemoveOperation<I,O>Interface for EXIF tag removal operations.interfaceExifTagWriteOperation<I,O>Interface for EXIF tag write operations.Classes in adams.flow.transformer.exiftagoperation that implement OptionHandler Modifier and Type Class Description classAbstractApacheCommonsExifTagOperation<I,O>Ancestor for EXIF tag operations using the Apache Commons Imaging library.classAbstractExifTagOperation<I,O>Ancestor for operations on EXIF data.classApacheCommonsExifTagExistsChecks whether the specified tag is present in the the file.classApacheCommonsExifTagReadReads the specified tag from the file and forwards the information.classApacheCommonsExifTagRemoveRemoves the specified tag from the file.classApacheCommonsExifTagWriteSets the specified tag value in the file. -
Uses of OptionHandler in adams.flow.transformer.generatefilebaseddataset
Classes in adams.flow.transformer.generatefilebaseddataset that implement OptionHandler Modifier and Type Class Description classAbstractFileBasedDatasetGeneration<T>Ancestor for schemes that generate datasets.classSimpleFileListSimply outputs the specified list of files in the container as a text file. -
Uses of OptionHandler in adams.flow.transformer.imagepreparation
Classes in adams.flow.transformer.imagepreparation that implement OptionHandler Modifier and Type Class Description classAbstractImagePreparationAncestor for algorithms that preprocess images.classPassThroughDummy, performs no preparation. -
Uses of OptionHandler in adams.flow.transformer.indexedsplitsrunsevaluation
Subinterfaces of OptionHandler in adams.flow.transformer.indexedsplitsrunsevaluation Modifier and Type Interface Description interfaceIndexedSplitsRunsEvaluation<I,O>Interface for performing evaluations on indexed splits runs.Classes in adams.flow.transformer.indexedsplitsrunsevaluation that implement OptionHandler Modifier and Type Class Description classAbstractIndexedSplitsRunsEvaluation<I,O>Ancestor for performing evaluations on indexed splits runs.classInstancesIndexedSplitsRunsEvaluationEvaluates the specified classifier on the indexed splits runs applied to the incoming data.classNullEvaluationDummy, does nothing. -
Uses of OptionHandler in adams.flow.transformer.indexedsplitsrunsgenerator
Subinterfaces of OptionHandler in adams.flow.transformer.indexedsplitsrunsgenerator Modifier and Type Interface Description interfaceIndexedSplitsRunsGeneratorInterface for schemes that generate indexed splits runs.interfaceInstancesIndexedSplitsRunsGeneratorIndicator interface for generators that process Instances objects.interfaceSpreadSheetIndexedSplitsRunsGeneratorIndicator interface for generators that process Instances objects.Classes in adams.flow.transformer.indexedsplitsrunsgenerator that implement OptionHandler Modifier and Type Class Description classAbstractIndexedSplitsRunsGeneratorAncestor for schemes that generate indexed splits runs.classAbstractInstancesIndexedSplitsRunsGeneratorAncestor for generators that process Instances objects.classAbstractSpreadSheetIndexedSplitsRunsGeneratorAncestor for generators that process SpreadSheet objects.classInstancesCrossValidationFoldGeneratorSplit generator that generates folds for cross-validation for Instances objects.classInstancesGroupedCrossValidationFoldGeneratorSplit generator that generates folds for cross-validation for Instances objects.classInstancesGroupedRandomSplitGeneratorRandom split generator that works on Instances objects (groups instances).classInstancesRandomSplitGeneratorRandom split generator that works on Instances objects.classManualSplitGeneratorUses the manually defined split ranges to generate the splits.classMultiRunGeneratorGenerates the specified number of runs using the configured base generator.classSpreadSheetRandomSplitGeneratorRandom split generator that works on spreadsheets. -
Uses of OptionHandler in adams.flow.transformer.indexedsplitsrunspredictions
Subinterfaces of OptionHandler in adams.flow.transformer.indexedsplitsrunspredictions Modifier and Type Interface Description interfaceIndexedSplitsRunsPredictions<T>Interface for generating predictions on indexed splits runs.Classes in adams.flow.transformer.indexedsplitsrunspredictions that implement OptionHandler Modifier and Type Class Description classAbstractIndexedSplitsRunsPredictions<T>Ancestor for generates predictions on indexed splits runs.classInstancesIndexedSplitsRunsPredictionsTrains the referenced classifier on the training splits and generates predictions for the test splits.classNullPredictionsDummy, does nothing. -
Uses of OptionHandler in adams.flow.transformer.locateobjects
Classes in adams.flow.transformer.locateobjects that implement OptionHandler Modifier and Type Class Description classAbstractMetaObjectLocatorAncestor for object locators that enhance a base locator.classAbstractObjectLocatorAncestor for algorithms that locate objects in images.classBinaryContoursUses the BoofCV contour-finding algorithm to locate objects.classCannyBinaryUses the BoofCV canny binary algorithm to locate objects.classCannyEdgesUses the BoofCV canny edges algorithm to locate objects.classChangeCanvasSizePlaces the located objects obtained from the base locator on a canvas of specified size at the specified position.classCroppedLocatorUses the defined crop algorithm to first crop the image before locating objects.classPassThroughDummy, just forwards container with input image.classSizeFilterAllows filtering the located objects based on the min/max width/height.classXScreenMaskLocatorUsing the XScreenMask, this locator masks out the background plate (similar to a green screening process)then proceeds to find blobs in the resultant image. -
Uses of OptionHandler in adams.flow.transformer.mapfilter
Classes in adams.flow.transformer.mapfilter that implement OptionHandler Modifier and Type Class Description classAbstractMapFilterAncestor for map filters.classPassThroughDummy, performs no filtering.classRemoveByNameFilters the map by removing values which keys match the regular expression. -
Uses of OptionHandler in adams.flow.transformer.metadata
Classes in adams.flow.transformer.metadata that implement OptionHandler Modifier and Type Class Description classAbstractMetaDataExtractorAncestor for algorithms that extract meta-data from image files.classApacheCommonsUses the Apache Commons Imaging library to extract the meta-data.
For more information see:
https://commons.apache.org/proper/commons-imaging/
classMetaDataExtractorUses the MetaDataExtractor library to extract the meta-data.
For more information see:
http://code.google.com/p/metadata-extractor/
-
Uses of OptionHandler in adams.flow.transformer.multimapoperation
Classes in adams.flow.transformer.multimapoperation that implement OptionHandler Modifier and Type Class Description classAbstractMultiMapOperation<O>Abstract base class for operations that require multiple maps.classCommonKeysOutputs the common keys among the maps.classMergeMerges the maps.classPassThroughDummy, just passes through the data. -
Uses of OptionHandler in adams.flow.transformer.multispreadsheetoperation
Classes in adams.flow.transformer.multispreadsheetoperation that implement OptionHandler Modifier and Type Class Description classAbstractIndentifiableRowOperationIdentifies rows and then applies the actual operation to them.classAbstractMultiSpreadSheetOperation<O>Abstract base class for operations that require multiple spreadsheets.classCommonIDsExtracts the common IDs from two or more spreadsheets.
Matching sense can be inverted, i.e., the IDs not in common are output.classDifferenceComputes the difference of the numeric cells between two spreadsheets.
The values of the second spreadsheet are subtracted from the first one.
If no 'key' columns are defined, the current order of rows is used for comparison.classMergeMerges 2 or more spreadsheets into a single spreadsheet, using a selectable merge method.classPassThroughDummy, just passes through the data.classSumComputes the sum of the numeric cells between two spreadsheets.
The values of the second spreadsheet are added to the first one.
If no 'key' columns are defined, the current order of rows is used for comparison. -
Uses of OptionHandler in adams.flow.transformer.negativeregions
Classes in adams.flow.transformer.negativeregions that implement OptionHandler Modifier and Type Class Description classAbstractMetaNegativeRegionsGeneratorAncestor for meta-algorithms.classAbstractNegativeRegionsGeneratorAncestor for algorithms for generating negative regions.classLargestRegionsReturns only the top X largest regions from the base generator.classMaxDimensionsEnforces the specified maximum dimensions.classMinDimensionsEnforces the specified minimum dimensions.classNullDummy, generates no regions.classRandomRegionsGenerates specified number of random regions and then prunes ones that overlap with other regions or annotations.classSimpleBlockFillFinds largest blocks from starting points on grid. -
Uses of OptionHandler in adams.flow.transformer.pdfgenerate
Classes in adams.flow.transformer.pdfgenerate that implement OptionHandler Modifier and Type Class Description classAbstractPDFGeneratorAncestor for schemes to generate PDFs.classAbstractScriptAncestor for PDF generator scripts.classAbstractScriptedPDFGeneratorAbstract ancestor for PDF generators that execute external scripts.classProcletsProcesses an array of files using the specified PDF proclets.classScriptedA PDF generator that uses any scripting handler for processing the objects with a script located in the specified file. -
Uses of OptionHandler in adams.flow.transformer.pdfproclet
Subinterfaces of OptionHandler in adams.flow.transformer.pdfproclet Modifier and Type Interface Description interfacePdfProcletInterface for PDF proclets.interfacePdfProcletWithAbsolutePositionInterface for PDF proclets that allow absolute positioning.interfacePdfProcletWithFilenameOutputInterface for PDF proclets that allow absolute positioning.interfacePdfProcletWithOptionalAbsolutePositionInterface for PDF proclets that allow absolute positioning.interfacePdfProcletWithPageBreaksInterface for PDF proclets that allow absolute positioning.interfacePdfProcletWithVariableFileExtensionInterface for PDF proclets that allow the user to modify the file extensions to work on.Classes in adams.flow.transformer.pdfproclet that implement OptionHandler Modifier and Type Class Description classAbstractMetaPdfProcletAncestor for proclets that wrap another base-proclet.classAbstractPdfProcletAbstract ancestor for processors that add the content of files to a PDF document.classAbstractPdfProcletWithFilenameOutputAbstract ancestor for processors that can add the filename as well.classAbstractPdfProcletWithPageBreaksAncestor for processors handle page breaks.classAbstractSpreadSheetPdfProcletAncestor for proclets that use spreadsheets.classCircleDraws a circle.classConfusionMatrixAdds CSV files (or any spreadsheet files that is supported) as table.classFixedTextAdds the fixed text line by line, variables get expanded automatically.classHeadlineAdds a simple headline, but no file content.classImageAdds GIF, JPEG and PNG image files.classLineDraws a line.classMetaHeadlineAdds a simple headline before applying the base proclet.classNewPageAdds a new page whenever a file with the specified extension is processed.classPlainTextAdds plain-text files line by line.classRectangleDraws a rectangle.classSpreadSheetAdds CSV files (or any spreadsheet files that is supported) as table. -
Uses of OptionHandler in adams.flow.transformer.pdfstamp
Classes in adams.flow.transformer.pdfstamp that implement OptionHandler Modifier and Type Class Description classAbstractPageRangeStamperAncestor for stampers that work on a range of pages.classAbstractStamperAncestor for stampers.classImagePlaces the image at the specified location.classPassThroughDummy, performs no stamping at all.classTextSimple text stamper.
You can use placeholders for the page index:
- 0-based: #
- 1-based: @
Variables in the template get expanded as well. -
Uses of OptionHandler in adams.flow.transformer.pixelselector
Classes in adams.flow.transformer.pixelselector that implement OptionHandler Modifier and Type Class Description classAbstractColorProviderPixelSelectorOverlayOverlay that uses a color provider for the painting the various elements of the overlay.classAbstractPixelSelectorActionAncestor for actions for thePixelSelectorinteractive transformer.classAbstractPixelSelectorOverlayAncestor for overlays in the pixel selector GUI, making use of the data stored in the report.classAbstractSingleColorPixelSelectorOverlayOverlay that uses a single, user-defined color.classAddClassificationAllows the user to select a pixel location and add a corresponding classification for it.
Stores the location with prefix 'Pixel.X.' and 'Pixel.Y.' and the classification using 'Classification.' as prefix.classBottomRightCornerAllows the user to select a pixel location of the bottom-right corner.
Stores the location in 'Pixel.Right' and 'Pixel.Bottom'.classClassificationOverlayHighlights the chosen classifications.
Some actions that generate data for this overlay:
adams.flow.transformer.pixelselector.AddClassification
Valid options are:classRectangleOverlaySimply highlights the selected pixel
Some actions that generate data for this overlay:
adams.flow.transformer.pixelselector.TopLeftCorner
adams.flow.transformer.pixelselector.BottomRightCorner
Valid options are:classSimpleOverlaySimply highlights the selected pixel
Some actions that generate data for this overlay:
adams.flow.transformer.pixelselector.SimpleSelect
Valid options are:classSimpleSelectAllows the user to select a pixel location.
Stores the location in 'Pixel.X' and 'Pixel.Y'.classTopLeftCornerAllows the user to select a pixel location of the top-left corner.
Stores the location in 'Pixel.Left' and 'Pixel.Top'. -
Uses of OptionHandler in adams.flow.transformer.plotgenerator
Classes in adams.flow.transformer.plotgenerator that implement OptionHandler Modifier and Type Class Description classAbstractPlotGeneratorAncestor for generators that use data from a spreadsheet to create plot containers for theSequencePlottersink.classAndrewsCurvesGeneratorGenerates plot containers from row-based data for Andrews Curves.
César Ignacio GarcÃa Osorio, Colin Fyfe (2003).classNamedPlotGeneratorPlots the numeric data of two columns, X and Y with the plot name from a separate column.classRowWisePlotGeneratorGenerates a separate plot per row in the spreadsheet, using the specified columns as data points.classSimplePlotGeneratorPlots the numeric data from one or more columns.classXYPlotGeneratorUses one column for the X value and one or more other columns as Y to plot against.classXYWithErrorsPlotGeneratorGenerator for X/Y plots (with X optional) that attaches error information for Y and optionally X as well. -
Uses of OptionHandler in adams.flow.transformer.preparefilebaseddataset
Classes in adams.flow.transformer.preparefilebaseddataset that implement OptionHandler Modifier and Type Class Description classAbstractFileBasedDatasetPreparation<T>Ancestor for schemes that prepare file-based datasets.classAbstractRandomizableFileBasedDatasetPreparation<T>Ancestor for schemes that randomize the files.classCrossValidationGenerates cross-validation folds.classGroupedCrossValidationGenerates grouped cross-validation folds.classGroupedTrainTestSplitGenerates a train/test split using the specified grouping.classGroupedTrainValidateTestSplitGenerates a train/validate/test split using the specified grouping.classSelectedGenerates a container from the selected elements of the array.classTrainTestSplitGenerates a train/test split.classTrainValidateTestSplitGenerates a train/validate/test split. -
Uses of OptionHandler in adams.flow.transformer.pyrotransformer
Classes in adams.flow.transformer.pyrotransformer that implement OptionHandler Modifier and Type Class Description classAbstractPyroTransformerAncestor for Pyro calls that transform data.classExampleGreetingUses the call described here: https://pythonhosted.org/Pyro4/intro.html#with-a-name-serverclassGenericGeneric call, just forwards any data to the remote object.classNullDummy, does nothing. -
Uses of OptionHandler in adams.flow.transformer.report
Classes in adams.flow.transformer.report that implement OptionHandler Modifier and Type Class Description classAbstractReportPostProcessor<T extends Report>Ancestor forReportpost-processors.classAbstractReportPreProcessor<T extends Report>Ancestor forReportpre-processors.classNoPostProcessing<T extends Report>Dummy, performs no post-processing at all.classNoPreProcessing<T extends Report>Dummy, performs no pre-processing at all. -
Uses of OptionHandler in adams.flow.transformer.splitfile
Classes in adams.flow.transformer.splitfile that implement OptionHandler Modifier and Type Class Description classAbstractFileSplitterAncestor for file splitters.classSplitByLineCountSplits the text file into chunks with the specified maximum of lines.classSplitByNumberSplits the file into a number of equally sized files.classSplitBySizeSplits the file into chunks with the specified maximum size. -
Uses of OptionHandler in adams.flow.transformer.spreadsheetmethodmerge
Classes in adams.flow.transformer.spreadsheetmethodmerge that implement OptionHandler Modifier and Type Class Description classAbstractMergeBase class for all spreadsheet merge methods.classJoinOnIDJoins the spreadsheets by concatenating rows that share a unique ID.classSimpleJust merges the spreadsheets side by side. -
Uses of OptionHandler in adams.flow.transformer.summarystatistics
Classes in adams.flow.transformer.summarystatistics that implement OptionHandler Modifier and Type Class Description classAbstractCategoricalSummaryStatisticAncestor for summary statistics that work with numeric predictions.classAbstractGeneralSummaryStatisticAncestor for statistics that can be applied to numeric and categorical predictions.classAbstractNumericSummaryStatisticAncestor for summary statistics that work with numeric predictions.classAbstractSummaryStatisticAncestor for summary statistics.classAccuracyCalculates the accuracy (aka correct percentage).classCorrelationCoefficientCalculates the correlation coefficient.classMeanAbsoluteErrorCalculates the MAE.classNoPredictionCalculates the rows with no prediction.classRootMeanSquaredErrorCalculates the RMSE. -
Uses of OptionHandler in adams.flow.transformer.timeseriessplit
Classes in adams.flow.transformer.timeseriessplit that implement OptionHandler Modifier and Type Class Description classAbstractSplitOnDateAncestor for splitters that split on a date.classAbstractTimeseriesSplitterAncestor for timeseries splitters.classFixedDateSplits the timeseries using the specified date.classFixedLengthSegmentsSplits the timeseries into segements of a fixed length, i.e., number of data points.classFixedNumSegmentsSplits the timeseries into a fixed number of same-sized segements.classPassThroughPerforms no splitting, just passes through the original timeseries.classReportDateSplits the timeseries using a field from its report.
Accepted date formats:
yyyy-MM-dd HH:mm:ss
yyyy-MM-dd HH:mm:ss.S
yyyy-MM-dd
-
Uses of OptionHandler in adams.flow.transformer.wekaclassifiersetupprocessor
Classes in adams.flow.transformer.wekaclassifiersetupprocessor that implement OptionHandler Modifier and Type Class Description classAbstractClassifierSetupProcessorAncestor for schemes that preprocess classifier arrays.classPassThroughSimply returns the same setups.classVotedPairsGenerates an array of classifiers that contains the original ones, but also all possible classifier pairs encapsulated in the Vote meta-classifier. -
Uses of OptionHandler in adams.flow.transformer.wekaclusterer
Classes in adams.flow.transformer.wekaclusterer that implement OptionHandler Modifier and Type Class Description classAbstractClustererPostProcessorAncestor for post-processors for output that the WekaClusterer transformer produces.classAbstractClusterMembershipPostProcessorAncestor for post-processors that require a built clusterer and the dataset that was used to build the clusterer to be present in the model container.classAddClusterJust adds the predicted cluster (or distribution) to the original dataset.
Stored in container under: Clustered dataset
classAverageSilhouetteCoefficientComputes the average Silhouette coefficient for the clusters.classClusterCentersComputes the cluster centers for the provided dataset.classClusterCountsCreates an overview of how many instances get clustered into each cluster.
Stored in container under: Clustered dataset
classClusterStatisticsComputes cluster statistics (min/max/mean/stdev) for the provided dataset.classMultiClustererPostProcessorApplies the specified post-processors sequentially.classPassThroughDummy post-processor that just returns the model container as it is. -
Uses of OptionHandler in adams.flow.transformer.wekadatasetsmerge
Classes in adams.flow.transformer.wekadatasetsmerge that implement OptionHandler Modifier and Type Class Description classAbstractMergeclassJoinOnIDJoins the datasets by concatenating rows that share a unique ID.classSimpleJust merges the datasets side by side. -
Uses of OptionHandler in adams.flow.transformer.wekaensemblegenerator
Classes in adams.flow.transformer.wekaensemblegenerator that implement OptionHandler Modifier and Type Class Description classAbstractWekaEnsembleGeneratorAncestor for schemes that generate ensembles.classMultiClassifiersCombinerModelsGenerates a MultipleClassifiersCombiner meta-classifier from the incoming pre-built classifier models.classVotedModelsGenerates a Vote meta-classifier from the incoming pre-built classifier models. -
Uses of OptionHandler in adams.flow.transformer.wekaevaluationpostprocessor
Classes in adams.flow.transformer.wekaevaluationpostprocessor that implement OptionHandler Modifier and Type Class Description classAbstractNumericClassPostProcessorAncestor for numeric class post-processors.classAbstractWekaEvaluationPostProcessorAncestor for classes that post-process Evaluation objects.classMultiPostProcessorApplies the specified post-processors sequentially to the input data and combines their output.classPassThroughDoes nothing, just passes through the input data.classRemoveWorstRemoves the worst predictions, which are considered outliers that detract from the actual model performance.classRemoveWorstStdDevRemoves the worst predictions, which are considered outliers that detract from the actual model performance.classSimpleSubRangeGenerates an Evaluation object based on the actual class values that fall within the specified interval ranges.classSubRangeGenerates an Evaluation object based on the actual class values that fall within the specified interval ranges. -
Uses of OptionHandler in adams.flow.websocket.client
Subinterfaces of OptionHandler in adams.flow.websocket.client Modifier and Type Interface Description interfaceWebSocketClientGeneratorInterface for client generators.Classes in adams.flow.websocket.client that implement OptionHandler Modifier and Type Class Description classAbstractWebSocketClientGeneratorAncestor for client generators.classSimpleSendGeneratorGenerates the SimpleSend client.classSimpleSendWithQueueGeneratorGenerates the SimpleSendWithQueue client. -
Uses of OptionHandler in adams.flow.websocket.server
Subinterfaces of OptionHandler in adams.flow.websocket.server Modifier and Type Interface Description interfaceWebSocketServerGeneratorInterface for server generators.Classes in adams.flow.websocket.server that implement OptionHandler Modifier and Type Class Description classAbstractWebSocketServerGeneratorAncestor for server generators.classEchoServerGeneratorGenerates a simple echo server. -
Uses of OptionHandler in adams.gui
Classes in adams.gui that implement OptionHandler Modifier and Type Class Description classInstanceCompareStand-alone version of the Instance Compare utility.classMainGUI for ADAMS. -
Uses of OptionHandler in adams.gui.application
Classes in adams.gui.application that implement OptionHandler Modifier and Type Class Description classAbstractApplicationFrameAbstract frame class for applications. -
Uses of OptionHandler in adams.gui.chooser
Subinterfaces of OptionHandler in adams.gui.chooser Modifier and Type Interface Description interfaceRemoteDirectorySetupInterface for setup classes that define access to remote directories.Classes in adams.gui.chooser that implement OptionHandler Modifier and Type Class Description classFtpRemoteDirectorySetupFor configuring an SSH connection and remote directory.classSftpRemoteDirectorySetupFor configuring an SSH connection and remote directory.classSmbRemoteDirectorySetupFor configuring an SMB connection and remote directory. -
Uses of OptionHandler in adams.gui.clipboard
Classes in adams.gui.clipboard that implement OptionHandler Modifier and Type Class Description classAbstractClipboardData<T>Ancestor for classes that copy to and paste from the system's clipboard.classBufferedImageCopies/pastes buffered images.classStringCopies/pastes strings. -
Uses of OptionHandler in adams.gui.core
Classes in adams.gui.core that implement OptionHandler Modifier and Type Class Description classAbstractFrameWithOptionHandlingAncestor to all frames that handle command-line options.Methods in adams.gui.core that return OptionHandler Modifier and Type Method Description static OptionHandlerGUIHelper. getOptionHandler(Class cls, String key, OptionHandler defValue)Returns the OptionHandler value listed in the props file, or the default value if not found.static OptionHandlerGUIHelper. getOptionHandler(String key, OptionHandler defValue)Returns the OptionHandler value listed in the props file, or the default value if not found.Methods in adams.gui.core with parameters of type OptionHandler Modifier and Type Method Description static OptionHandlerGUIHelper. getOptionHandler(Class cls, String key, OptionHandler defValue)Returns the OptionHandler value listed in the props file, or the default value if not found.static OptionHandlerGUIHelper. getOptionHandler(String key, OptionHandler defValue)Returns the OptionHandler value listed in the props file, or the default value if not found. -
Uses of OptionHandler in adams.gui.core.spreadsheetpreview
Classes in adams.gui.core.spreadsheetpreview that implement OptionHandler Modifier and Type Class Description classAbstractSpreadSheetPreviewAncestor for spreadsheet previews.classNullPreviewDummy, does not generate a preview.classSimpleHTMLSimply displays the specified columns as HTML.classSimpleTextSimply displays the specified columns as text. -
Uses of OptionHandler in adams.gui.core.spreadsheettable
Subinterfaces of OptionHandler in adams.gui.core.spreadsheettable Modifier and Type Interface Description interfaceCellRenderingCustomizerInterface for classes that customize the rendering of a cell.Classes in adams.gui.core.spreadsheettable that implement OptionHandler Modifier and Type Class Description classAbstractCellRenderingCustomizerAncestor for cell rendering customizers.classAbstractColoredCellRenderingCustomizerAncestor for cell rendering customizers with predefined foreground/background colors.classAbstractPlotColumnAncestor for plugins that plot a column.classAbstractPlotRowAncestor for plugins that plot a row.classAbstractPlotSelectedRowsAncestor for plugins that plot rows.classAbstractProcessCellAncestor for plugins that process a cell.classAbstractProcessColumnAncestor for plugins that process a column.classAbstractProcessRowAncestor for plugins that process a row.classAbstractProcessSelectedRowsAncestor for plugins that process a row.classArrayStatisticAllows the calculation of row statistics.classBinningAllows to perform binning of the values from a column or row.classChangeColumnTypeAllows the conversion of a column to a different type.classColumnStatisticAllows the calculation of column statistics.classConfusionMatrixCellRenderingCustomizerUses the specified color to highlight the cells on the diagonal.classCopySelectedFilesAllows copying of the selected files to a target directory.classDataSortAllows sorting the data using multiple columns.classDefaultCellRenderingCustomizerDefault cell rendering customizer.classDistinctValueCellRenderingCustomizerEach distinct value in the spreadsheet gets its own color.classHeatmapCellRenderingCustomizerDetermines the min/max of numeric values in the table and colors the background using the specified generator.classHistogramAllows to generate a histogram from a column or row.classJFreeChartAllows to create a JFreeChart plot of a column or row.classMultiCellRenderingCustomizerApplies the sub-renderers sequentially.classNumericRangeCellRenderingCustomizerUses the defined ranges to determine whether a numeric cells gets highlighted with the specified color.classPreviewSelectedFileAllows preview of the selected file in separate dialog.classRowStatisticAllows the calculation of row statistics.classSimplePlotAllows to perform a simple plot of a column or row.classUniqueValuesDisplays all the unique values in the column.classViewCellFor viewing the cell content. -
Uses of OptionHandler in adams.gui.flow.tree
Classes in adams.gui.flow.tree that implement OptionHandler Modifier and Type Class Description classClipboardActorContainerA simple container for multiple actors, for easy copying to and retrieving from the clipboard. -
Uses of OptionHandler in adams.gui.flow.tree.actorswap
Classes in adams.gui.flow.tree.actorswap that implement OptionHandler Modifier and Type Class Description classAbstractActorSwapSuggestionAncestor for classes the return potential swaps for an actor.classActorHandlerSuggestionFinds potential swap partners forActorHandler.classSimpleSuggestionSuggests actors based on theSimpleSuggestion.PROPERTIES_FILENAMErules. -
Uses of OptionHandler in adams.gui.flow.tree.annotations
Classes in adams.gui.flow.tree.annotations that implement OptionHandler Modifier and Type Class Description classAbstractAnnotationProcessorAncestor for annotation processors.classPlainTextDefault processor, turns plain text into HTML. -
Uses of OptionHandler in adams.gui.flow.tree.enclose
Classes in adams.gui.flow.tree.enclose that implement OptionHandler Modifier and Type Class Description classAbstractEncloseActorAncestor for classes that can enclose actors somehow.classArrayDisplayEnclosureEncloses theDisplayPanelProviderin aArrayDisplay.classDisplayPanelManagerEnclosureEncloses theDisplayPanelProviderin aDisplayPanelManager.classTryCatchEnclosureEncloses the selected actors in aTryCatch. -
Uses of OptionHandler in adams.gui.flow.tree.keyboardaction
Classes in adams.gui.flow.tree.keyboardaction that implement OptionHandler Modifier and Type Class Description classAbstractAddActorAncestor for actions that add an actor.classAbstractAddTemplateAncestor for actions that add a template.classAbstractFavoriteActorAncestor for actions that add a favorite actor.classAbstractKeyboardActionAncestor for flow tree actions that are associated with .classAbstractKeyboardActionWithActorAncestor for actions that do something with a specified actor.classAbstractQuickSearchActorAncestor for actions that add an actor via a quick search list.classAbstractSearchActorAncestor for actions that add an actor.classActionQuickSearchAllows the user to search for actions in menu items for editor and tree popup.classAddActorAfterAdds an actor after the current location.classAddActorBeneathAdds an actor beneath the current location.classAddActorHereAdds an actor at the current location.classAddTemplateAfterAdds an actor generated from a template after the current location.classAddTemplateBeneathAdds an actor generated from a template at the current location.classAddTemplateHereAdds an actor generated from a template at the current location.classEncloseActorEncloses the selected actor(s) with the specified actor.classFavoriteActorAfterAllows the user to select a favorite actor to be inserted after the current location.classFavoriteActorBeneathAllows the user to select a favorite actor to be inserted beneath the current location.classFavoriteActorHereAllows the user to select a favorite actor to be inserted at the current location.classPullUpActorAdds an actor at the current location.classQuickSearchActorAfterAllows the user to search for an actor to be inserted after the current location.classQuickSearchActorBeneathAllows the user to search for an actor to be inserted beneath the current location.classQuickSearchActorHereAllows the user to search for an actor to be inserted at the current location.classSearchActorAfterAllows the user to search for an actor to be inserted after the current location.classSearchActorBeneathAllows the user to search for an actor to be inserted beneath the current location.classSearchActorHereAllows the user to search for an actor to be inserted at the current location. -
Uses of OptionHandler in adams.gui.print
Classes in adams.gui.print that implement OptionHandler Modifier and Type Class Description classBMPWriterOutputs Bitmap images.classBufferedImageBasedWriterAncestor for writers that write a BufferedImage to disk.classJComponentWriterThis class takes any JComponent and outputs it to a file.classJPEGWriterOutputs JPEG images.classNullWriterDummy - generates no output.classPDFWriterOutputs PDF documents.classPNGWriterOutputs PNG images.classPostscriptWriterOutputs EPS files.classScalableComponentWriterAbstract ancestor for scalable writers.classTIFFWriterOutputs TIFF images. -
Uses of OptionHandler in adams.gui.scripting
Methods in adams.gui.scripting with parameters of type OptionHandler Modifier and Type Method Description protected voidAbstractFileReaderScriptlet. storeReaderData(List<DataContainer> data, OptionHandler reader)Adds the reader setup and the file to the report. -
Uses of OptionHandler in adams.gui.tools.previewbrowser
Subinterfaces of OptionHandler in adams.gui.tools.previewbrowser Modifier and Type Interface Description interfaceArchiveHandlerInterface of archive handlers.interfaceContentHandlerInterface for content handlers.interfaceObjectContentHandlerInterface for content handlers that can generate previews from objects as well, not just files.Classes in adams.gui.tools.previewbrowser that implement OptionHandler Modifier and Type Class Description classAbstractArchiveHandlerAncestor of all archive handlers.classAbstractContentHandlerAncestor for all content handlers.classAbstractObjectContentHandlerAncestor for content handlers that handle files and objects.classAbstractReportHandlerAncestor for handlers that display reports.classAbstractSerializedObjectViewerAncestor for all serialized object viewers.classAbstractSpreadSheetHandlerAncestor for handlers that display spreadsheets.classActualVsPredictedHandlerFor displaying an actual vs predicted plot.classAnnotateImageAllows annotating images and/or modifying their meta-data.classAnnotationsAndPredictionsFromReportDisplays the following image types with an overlay for the annotations and predictions stored in the report with the same name: jpg,bmp,gif,png,wbmp,jpeg
Annotations have to have the prefix 'Object.' and predictions 'Prediction.'.
The color for annotations is red and for predictions green.classApacheCommonsImageHandlerDisplays the following image types: bmp,gif,ico,pbm,pgm,png,pnm,ppm,psd,tif,tiff
classApacheCommonsImageMetaDataHandlerDisplays meta-data for the following image types: bmp,gif,ico,pbm,pgm,png,pnm,ppm,psd,tif,tiff
classBlueChannelImageHandlerInterprets the values in the blue channel as color indices, corresponding to colors generated by the color provider.
Supported image types: bmp,dcx,gif,hdr,icns,ico,jpg,pcx,png,pnm,psd,tif,tiff,wbmp,xbm,xpm
classBoofCVImageHandlerDisplays the following image types: bmp,gif,jpeg,jpg,pgm,png,ppm,wbmp
classCocoAnnotationsHandlerDisplays the following image types with an overlay for the objects stored in the COCO JSON files: jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
Loads all JSON files in either the directory of the image or the alternative location.classColorDistributionHandlerDisplays the color distribution for images.classConfusionMatrixHandlerFor displaying a confusion matrix.classConsoleOutputHandlerDisplays the following plain text file types: txt,log
Valid options are:classCsvSpreadSheetHandlerDisplays the following spreadsheet types: csv,csv.gz
Valid options are:classDeepLabCutCSVHandlerclassDefaultSerializedObjectViewerDefault viewer that just uses the Object's toString() method to display it.classDetectronAnnotationsHandlerDisplays the following image types with an overlay for the objects stored in the Detectron annotations JSON file (using object prefix 'Object.'): jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
classExcelSpreadSheetHandlerDisplays the following spreadsheet types: xls,xlsx
Valid options are:classFileInfoHandlerDisplays basic information about files.classFlowHandlerDisplays the following plain text file types: txt,xml,props
Valid options are:classFromFileHandlerDisplays files using the preview handler configuration (command-line or nested format) stored in the specified file.classGraphSourceDisplays the source of a weka.core.Drawable graph.classGraphVisualizerDisplaysBayesNetgraphs.classGrayOrIndexedImageHandlerChanges the unique colors to the ones specified by the color provider for the following image types: bmp,dcx,gif,hdr,icns,ico,jpg,pcx,png,pnm,psd,tif,tiff,wbmp,xbm,xpm
classGroovyHandlerDisplays the following plain text file types: groovy
Valid options are:classHexaDecimalHandlerDisplays any file in hexadecimal notation
classImageClassificationHandlerOverlays the annotations onto the image.classImageHandlerDisplays the following image types: jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
classImageMetaDataExtractorHandlerDisplays meta-data for the following image types: bmp,gif,jpg,jpeg,png,psd,tif,tiff
classImageSegmentationAnnotationsHandlerOverlays image segmentation annotations obtained from the specified reader over the original JPG image.classIndexedPNGImageHandlerChanges the indexed colors to the ones specified by the color provider for PNG files.classInstanceExplorerHandlerDisplays the following WEKA dataset types in the Instance Explorer: csv,arff,arff.gz,xrff,xrff.gz
Valid options are:classInterQuartileRangeViewerDisplays internal values of theInterquartileRangefilter.classJsonPrettyPrintHandlerDisplays JSON files in pretty print format: json
classJsonTreeViewHandlerDisplays JSON files as hierarchical tree: json
classObjectAnnotationsHandlerOverlays the annotations onto the image.classObjectAnnotationsReportHandlerOverlays the annotations onto the image.classObjectCentersFromReportDisplays the following image types with an overlay for the objects stored in the report with the same name (using object prefix 'Object.'): jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
classObjectInspectionViewerAllows to inspect objects like in the flow.classObjectLocationsFromReportDisplays the following image types with an overlay for the objects stored in the report with the same name (using object prefix 'Object.'): report,report.gz
classObjectLocationsFromSpreadSheetDisplays the following image types with an overlay for the objects stored in the spreadsheet with the same name (using the spreadsheet reader's default extension) or with the specified alternative file suffix to the name (eg '-rois'): *
classODFSpreadSheetHandlerDisplays the following spreadsheet types: ods
Valid options are:classPDFHandlerDisplays the content of PDF files as plain text.classPDFTextHandlerDisplays the content of PDF files as plain text.classPlainTextHandlerDisplays the following plain text file types: *
classPointsFromReportHandlerclassPropertiesHandlerDisplays properties files: props,props.gz,properties
Valid options are:classReportHandlerDisplays report files (depends on selected reader): *
classScriptHandlerDisplays the following plain text file types: txt,xml,props
Valid options are:classSerializedFileHandlerDisplays serialized Java objects: model,model.gz,ser
Valid options are:classSimpleImageSegmentationAnnotationsHandlerOverlays image segmentation annotations from a PNG over the original JPG image.classTarArchiveHandlerOffers access to tar files.classTreeVisualizerDisplays trees in dot notation.classTrimapImageHandlerDisplays the following image types as trimaps: jpg,tif,tiff,bmp,gif,png,wbmp,jpeg
If VGG XML annotation file with the same name exists, then an object overlay is added.classTsvSpreadSheetHandlerDisplays the following spreadsheet types: tsv
Valid options are:classVggXmlAnnotationHandlerDisplays the following image types with an overlay for the objects stored in the VGG XML file with the same name (using object prefix 'Object.'): jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
classViaAnnotationsHandlerDisplays the following image types with an overlay for the objects stored in the JSON file with the same name (using object prefix 'Object.'): jpg,tif,tiff,bmp,gif,png,jpeg,wbmp
classWekaDatasetHandlerDisplays the following WEKA dataset types: csv,arff,arff.gz,xrff,xrff.gz
Valid options are:classXMLHandlerDisplays XML files: xml,xsl
Valid options are:classYamlHandlerDisplays YAML files: yaml,yml
classYoloAnnotationsHandlerDisplays the following image types with an overlay for the objects stored in the .txt file with the same name (using object prefix 'Object.'): tif,jpg,tiff,bmp,gif,png,jpeg,wbmp
classZipArchiveHandlerOffers access to ZIP files. -
Uses of OptionHandler in adams.gui.tools.previewbrowser.notes
Classes in adams.gui.tools.previewbrowser.notes that implement OptionHandler Modifier and Type Class Description classAbstractNotesReaderAncestor for notes readers.classAbstractNotesWriterAncestor for notes writers.classCsvNotesReaderReads notes in CSV format.classCsvNotesWriterWrites the notes in CSV format.classJsonNotesReaderReads notes in JSON format.classJsonNotesWriterWrites the notes in JSON format.classPropertiesNotesReaderReads notes in Java properties format.classPropertiesNotesWriterWrites the notes in Java properties format.classYamlNotesReaderReads notes in YAML format.classYamlNotesWriterWrites the notes in JSON format. -
Uses of OptionHandler in adams.gui.tools.remotecontrolcenter.panels
Classes in adams.gui.tools.remotecontrolcenter.panels that implement OptionHandler Modifier and Type Class Description static classAbstractRemoteFlowTab.FlowListResponseHandlerCustom handler for intercepting the responses from theListFlowsremote command.classAbstractTabResponseHandler<T extends AbstractRemoteControlCenterTab>Custom handler for intercepting the responses from theListFlowsremote command.static classAdvancedTab.InspectionResponseHandlerSpecialized response handler that populates anInspectionPanel.static classRemoteLoggingTab.LoggingResponseHandlerUpdates the buttons accordingly and displays error messages.classSimpleTabResponseHandlerOnly displays errors. -
Uses of OptionHandler in adams.gui.tools.spreadsheetviewer
Classes in adams.gui.tools.spreadsheetviewer that implement OptionHandler Modifier and Type Class Description classAbstractDataPluginAncestor for "processing" plugins in the spreadsheet viewer.classAbstractDataPluginWithGOEAncestor for plugins that present a GOE dialog.classAbstractSelectedSheetsDataPluginAncestor for plugins that operate on multiple panels.classAbstractSelectedSheetsDataPluginWithGOEAncestor for plugins that use a GOE setup on all the panels.classAbstractSelectedSheetsViewPluginAncestor for plugins that operate on multiple panels.classAbstractSelectedSheetsViewPluginWithGOEAncestor for plugins that use a GOE setup on all the panels.classAbstractViewPluginAncestor for "information" plugins in the spreadsheet viewer.classAbstractViewPluginWithGOEAncestor for plugins that present a GOE dialog.classAppendAppends all the selected spreadsheets.classBoxPlotGenerates box plots for the data.classMatrixPlotGenerates a matrix plot for the data.classMergeMerges multiple spreadsheets into a single one.classStatisticsGenerates a table with some simple statistics. -
Uses of OptionHandler in adams.gui.tools.spreadsheetviewer.chart
Classes in adams.gui.tools.spreadsheetviewer.chart that implement OptionHandler Modifier and Type Class Description classAbstractChartGeneratorAncestor for classes that generate/display charts using a flow as backend.classAbstractRowBasedChartGeneratorAncestor for row-based plot generators.classAbstractXYChartGeneratorAncestor for X/Y (or just Y) plot generators.classBarPlotGenerates a bar plot by plotting the X column against the Y column.classControlChartGenerates the specified control chart from the data.classGenericPlotFlexible chart generator.classHistogramGenerates histograms by plotting the X column against the Y column.classJFreeChartUses JFreeChart to display the data.classLinePlotGenerates a line plot by plotting the X column against one or more Y columns.classScatterPlotGenerates a scatter plot by plotting the X column against one or more Y columns. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.output
Classes in adams.gui.tools.wekainvestigator.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputGenerator<T extends AbstractResultItem>Ancestor for output generators. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.tab.associatetab.output
Classes in adams.gui.tools.wekainvestigator.tab.associatetab.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputGeneratorAncestor for output generators using t.classModelOutputOutputs the model if available.classRulesOutputs the rules if availableAssociationRulesProducer.classRunInformationGenerates run information. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.tab.attseltab.output
Classes in adams.gui.tools.wekainvestigator.tab.attseltab.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputGeneratorAncestor for output generators using t.classReducedDataGenerates the reduced dataset.classRunInformationGenerates run information.classTextStatisticsGenerates basic text statistic. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.tab.classifytab.evaluation.finalmodel
Classes in adams.gui.tools.wekainvestigator.tab.classifytab.evaluation.finalmodel that implement OptionHandler Modifier and Type Class Description classAbstractFinalModelGenerator.classNullDoes not generate a final model.classSimpleSimply builds the classifier on the full dataset.classVotedFoldsGenerates a Vote meta-classifier from the models from the cross-validation folds. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.tab.classifytab.output
Classes in adams.gui.tools.wekainvestigator.tab.classifytab.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputGeneratorAncestor for output generators using the data from the per-fold pane.classAbstractOutputGeneratorWithSeparateFoldsSupport<T extends JComponent>Ancestor for output generators that can generate output for separate folds just using the Evaluation objects.classClassifierErrorsGenerates classifier errors plot.classConfusionMatrixDisplays the confusion matrix.classFourInOnePlotGenerates the 4-in-1 plot: normal plot, histogram, residuals vs fit and vs order.classGraphSourceDisplays the source code of the graph (dot or XML BIF).classLegacyClassifierErrorsGenerates classifier errors plot (legacy Weka output).classLegacyCostBenefitAnalysisGenerates cost benefit analysis (legacy Weka output).classLegacyCostCurveGenerates cost curve (legacy Weka output).classLegacyGraphVisualizerDisplays the graph that the model generated (legacy Weka output).classLegacyMarginCurveGenerates margin curve (legacy Weka output).classLegacyThresholdCurveGenerates margin curve (legacy Weka output).classLegacyTreeVisualizerDisplays the tree that the model generated (legacy Weka output).classModelOutputOutputs the model if available.classPredictionEccentricityGenerates classifier prediction eccentricity.classPredictionsDisplays the predictions.classPredictionTrendGenerates a 'prediction trend' for classifier errors: sorts the predictions on the actual value and plots actual and predicted side-by-side.classResidualsVsFittedPlots the residuals vs the fitted values (= predictions).classResidualsVsPredictorPlots the residuals vs the predictor.classRunInformationGenerates run information.classSourceCodeOutputs source code from the model (if classifier implementsSourcable).classTextStatisticsGenerates basic text statistic.classTreeGraphMLDisplays the GraphML source code of the tree graph.classTreeVisualizerDisplays the tree that the model generated. -
Uses of OptionHandler in adams.gui.tools.wekainvestigator.tab.clustertab.output
Classes in adams.gui.tools.wekainvestigator.tab.clustertab.output that implement OptionHandler Modifier and Type Class Description classAbstractOutputGeneratorAncestor for output generators using t.classClusterAssignmentsDisplays the cluster assignments.classGraphSourceDisplays the source code of the graph (dot or XML BIF).classLegacyTreeVisualizerDisplays the tree that the model generated (legacy Weka output).classModelOutputOutputs the model if available.classRunInformationGenerates run information.classSupplementaryOutputs the supplementary data if available.classTextStatisticsGenerates basic text statistic. -
Uses of OptionHandler in adams.gui.tools.wekamultiexperimenter.experiment
Classes in adams.gui.tools.wekamultiexperimenter.experiment that implement OptionHandler Modifier and Type Class Description classAbstractExperimentAncestor for simple experiments.classAbstractResultsHandlerAncestor for classes that store the results from an experiment run.classCrossValidationExperimentPerforms cross-validation.classFileResultsHandlerWrites the experiment results to a file.classTrainTestSplitExperimentPerforms train-test splits. -
Uses of OptionHandler in adams.gui.tools.wekamultiexperimenter.io
Classes in adams.gui.tools.wekamultiexperimenter.io that implement OptionHandler Modifier and Type Class Description classAbstractAdamsExperimentIO<T extends AbstractExperiment>Ancestor for classes that handle loading/saving of experiments.classAbstractExperimentIO<T>Ancestor for classes that handle loading/saving of experiments.classAbstractWekaExperimentIO<T extends weka.experiment.Experiment>Ancestor for classes that handle loading/saving of experiments.classDefaultAdamsExperimentIODefault IO handler for experiments.classDefaultWekaExperimentIODefault IO handler for experiments.classRemoteWekaExperimentIOIO handler for remote experiments. -
Uses of OptionHandler in adams.gui.visualization.container
Classes in adams.gui.visualization.container that implement OptionHandler Modifier and Type Class Description classAbstractDataContainerPaintletA specialized paintlet for data container panels.classAbstractDataContainerZoomOverviewPaintlet<P extends DataContainerPanel>Highlights the current zoom in the data container panel. -
Uses of OptionHandler in adams.gui.visualization.core
Subinterfaces of OptionHandler in adams.gui.visualization.core Modifier and Type Interface Description interfaceColorGradientGeneratorInterface for classes that generate color gradients.interfaceColorGradientGeneratorWithFixedNumberOfColorsInterface for color gradient generators that use a user-defined, fixed number of colors.interfaceColorProviderInterface for color providing classes.interfaceColorProviderWithNameSupportInterface for color providers that can act on a name to provide the next color.interfacePlotPanelAxisOptionsInterface for schemes that configure axes of aPlotPanel.Classes in adams.gui.visualization.core that implement OptionHandler Modifier and Type Class Description classAbstractColorGradientGeneratorAncestor for classes that generate color gradients.classAbstractColorProviderA class for providing colors.classAbstractCustomColorProviderAncestor for custom color providers.classAbstractMouseMovementTrackerAn abstract superclass for mouse movement trackers.classAbstractPaintletAn abstract superclass for paint engines that can be plugged into panels.classAbstractStrokePaintletAncestor for paintlets that paint lines of some sort.classAbstractStrokePaintletWithContainerIDMatchingAncestor for paintlets that restrict painting to containers which ID matches a regular expression.classAxisPanelOptionsEncapsulates options for an axis in a plot.classBackgroundImagePaintletPaintlet for painting a background image.classBiColorGeneratorGenerates gradient colors between two colors.classColorBlind12ProviderColor provider for color blind people, using 12 colors.
See:
http://mkweb.bcgsc.ca/colorblind/palettes.mhtml
http://mkweb.bcgsc.ca/colorblind/palettes/12.color.blindness.palette.txt
classColorBlind15ProviderColor provider for color blind people, using 15 colors.
See:
http://mkweb.bcgsc.ca/colorblind/palettes.mhtml
http://mkweb.bcgsc.ca/colorblind/palettes/15.color.blindness.palette.txt
classColorBlind24ProviderColor provider for color blind people, using 24 colors.
See:
http://mkweb.bcgsc.ca/colorblind/palettes.mhtml
http://mkweb.bcgsc.ca/colorblind/palettes/24.color.blindness.palette.txt
classColorBlind8ProviderColor provider for color blind people, using 8 colors.
See:
http://mkweb.bcgsc.ca/colorblind/palettes.mhtml
http://mkweb.bcgsc.ca/colorblind/palettes/8.color.blindness.palette.txt
classColorProviderBasedColorGradientGeneratorUses the specified color provider to generate the colors.
Mainly used for having control over colors when generating images.classConfusionMatrixColorGeneratorGenerates gradient colors between two colors, with default values suitable for a confusion matrix.classCoordinatesPaintletPaintlet for painting the coordinates.classCrossHairTrackerA cross-hair mouse movement tracker.classCustomColorProviderAllows the user to define colors.classDefaultColorProviderThe default color provider, which is used in various plots.classGradientColorProviderUses a color gradient generator to generate the colors.classHorizontalIndicatorPaintletPaintlet for painting a horizontal indicator line.classMultiColorGeneratorGenerates gradient colors between multiple colors.classMultiMouseMovementTrackerApplies multiple trackers sequentially.classMultiPaintletPaintlet that combines multiple paintlets.classNullTrackerDummy tracker that does nothing.classRegExpColorProviderUses the provided regular expressions to determine the colors.classRgbInNameColorProviderLooks for an RGB color definition in the name, eg #ff0000.classTextOverlayPaintletSimply paints the specified text at a certain location.classTrackMousePositionInConsoleSimply outputs the mouse position in the console.classTranslucentColorProviderAllows the user to add translucency to the colors generated by the base color provider.classX11ColorProviderColor provider using a subset of colors from the X11 RGB text file.
For more information, see:
Jim Gettys, Paul Ravelling, John C. -
Uses of OptionHandler in adams.gui.visualization.core.axis
Subinterfaces of OptionHandler in adams.gui.visualization.core.axis Modifier and Type Interface Description interfaceFixedLabelTickGeneratorInterface for tick generators that use a fixed list of string labels.interfaceTickGeneratorInterface for tick generators.Classes in adams.gui.visualization.core.axis that implement OptionHandler Modifier and Type Class Description classAbstractLimitedTickGeneratorAncestor for tick generators that only generate a limited number of ticks.classAbstractTickGeneratorAn abstract class of a tick generator.classFancyTickGeneratorA fancy tick generator based on code from the flotcharts project.classPeriodicityTickGeneratorA periodicity tick generator.classSimpleFixedLabelTickGeneratorA simple tick generator that uses a fixed list of labels.classSimpleTickGeneratorA simple tick generator. -
Uses of OptionHandler in adams.gui.visualization.core.plot
Classes in adams.gui.visualization.core.plot that implement OptionHandler Modifier and Type Class Description classAbstractDistanceBasedHitDetector<H,P>Detects hits based on the difference between two points in the plot, based on their 2-dim coordinates.classAbstractHitDetector<H,P>Abstract ancestor for classes that detect hits in in the plot panel. -
Uses of OptionHandler in adams.gui.visualization.debug.objectexport
Classes in adams.gui.visualization.debug.objectexport that implement OptionHandler Modifier and Type Class Description classAbstractObjectExporterAncestor for classes that can export certain objects to files.classImageExporterExports image objects (BufferedImage or derived from AbstractImageContainer).classPlainTextExporterUses text renderers (auto or custom) to turn the object into text.classPropertiesExporterExports Properties objects in the simple report format.classRenderedPlainTextExporterUses an AbstractObjectPlainTextRenderer to generated the string to export.classReportExporterExports Report objects in the simple report format.classSerializableObjectExporterExports serializable objects.classSpreadSheetExporterExports spreadsheet objects.classTimeseriesExporterExports Timeseries objects.classWekaInstancesExporterExports Weka Instances/Instance objects. -
Uses of OptionHandler in adams.gui.visualization.image
Subinterfaces of OptionHandler in adams.gui.visualization.image Modifier and Type Interface Description interfaceImageOverlayInterface for classes that put overlays over an image.interfaceTypeColorProviderInterface for image overlays that give access to colors per type (aka label).Classes in adams.gui.visualization.image that implement OptionHandler Modifier and Type Class Description classAbstractImageOverlayAbstract ancestor for image overlays.classAbstractObjectOverlayFromReportAncestor for overlays that use object locations from a report.classAbstractPointOverlayFromReportAncestor for overlays that use object locations from a report.classAbstractReportBasedOverlayHelperAncestor for overlay helper classes that use object locations from a report.classBoofCVDetectLineSegmentsImageOverlayOverlays the image with lines detected byBoofCVDetectLineSegments.classBoofCVDetectLinesImageOverlayOverlays the image with lines detected byBoofCVDetectLines.classHighlightLocationsOverlay for highlighting points on an image.classMetaDataTextOverlay for text from the image's meta-data.classMultiImageOverlayCombines multiple overlays, applies them sequentially.classNullOverlayDummy overlay, does nothing.classObjectAnnotationsOverlays object annotations from the report.classObjectCentersOverlayFromReportDisplays the centers of objects in the image, using data from the attached report.
Suffixes:
.x
.y
.width
.height
Optionally, if type information is available per object, the locations can be displayed in distinct colors per type.classObjectLocationsOverlayFromReportDisplays the locations of objects in the image, using data from the attached report.
Suffixes:
.x
.y
.width
.height
Optionally, if type information is available per object, the locations can be displayed in distinct colors per type.classReportObjectOverlayAncestor for overlays that use object locations from a report.classReportPointOverlayAncestor for overlays that use point locations from a report.classSimplePointOverlayFromReport -
Uses of OptionHandler in adams.gui.visualization.image.interactionlogging
Subinterfaces of OptionHandler in adams.gui.visualization.image.interactionlogging Modifier and Type Interface Description interfaceInteractionLoggingFilterInterface for classes that filter interaction logging in the ImagePanel.Classes in adams.gui.visualization.image.interactionlogging that implement OptionHandler Modifier and Type Class Description classAbstractInteractionLoggingFilterAncestor for interaction logging filters.classAllLogs all events.classIDFilterLogs all events.classNullSuppresses all events. -
Uses of OptionHandler in adams.gui.visualization.image.leftclick
Classes in adams.gui.visualization.image.leftclick that implement OptionHandler Modifier and Type Class Description classAbstractLeftClickProcessorAncestor for classes that react to selection in an image.classAbstractSelectionRectangleBasedLeftClickProcessorAncestor for left-click processors that make use ofSelectionRectangle.classAddMetaDataAllows the user to add meta-data to the selected objects.classDeleteObjectsDisplays the objects at the click position and deletes the selected ones.classFixedBoundingBoxAllows the user to create fixed-sized bounding boxes around the left-click position (<ctrl> left-click in box removes it).classMultiProcessorForwards the click event to all specified sub-processors.classNullProcessorDummy processor, does nothing.classRandomBoundingBoxAllows the user to create randomly sized bounding boxes around the left-click position.classViewObjectsDisplays the annotated objects in a dialog that contain the click position. -
Uses of OptionHandler in adams.gui.visualization.image.paintlet
Classes in adams.gui.visualization.image.paintlet that implement OptionHandler Modifier and Type Class Description classAbstractPaintletAn abstract superclass for paint engines that can be plugged into panels.classNullDummy paintlet. -
Uses of OptionHandler in adams.gui.visualization.image.selection
Subinterfaces of OptionHandler in adams.gui.visualization.image.selection Modifier and Type Interface Description interfaceSelectionProcessorInterface for selection processors.interfaceSelectionProcessorWithLabelSupportInterface for selection processors that support labels.Classes in adams.gui.visualization.image.selection that implement OptionHandler Modifier and Type Class Description classAbstractPaintingSelectionProcessorAncestor for processors that paint with a certain color and stroke thickness.classAbstractSelectionProcessorAncestor for classes that react to selection in an image.classAbstractSelectionRectangleBasedSelectionProcessorAncestor for selection processors that make use of theSelectionRectangleclass.classCopyToClipboardCopies the selection to the system's clipboard.classCropCrops the image to the current selection and stores crop information in the report (prefix: Crop.).classMultiSelectionProcessorApplies all the sub-processors sequentially.classNullProcessorDummy processor, does nothing.classPaintSelectionPaints the selection in the specified color.classSelectObjectsAllows the user to select objects in the image.
The locations get stored in the attached report.
If the <ctrl> key is pressed while drawing a selection rectangle, all enclosed locations get removed.classShowCoordinatesShows the coordination of the selection. -
Uses of OptionHandler in adams.gui.visualization.image.selectionshape
Subinterfaces of OptionHandler in adams.gui.visualization.image.selectionshape Modifier and Type Interface Description interfaceColorSelectionShapePainterInterface for selection shape painters that use a single color.interfaceSelectionShapePainterInterface for classes that can paint the selection.interfaceStrokeSelectionShapePainterFor selection shape painters that use a stroke.Classes in adams.gui.visualization.image.selectionshape that implement OptionHandler Modifier and Type Class Description classAbstractSelectionShapePainterAncestor for shape painters.classAbstractStrokeSelectionShapePainterFor selection shape painters that use a stroke.classPolygonPainterPaints a polygon from the mouse point trace.classRectanglePainterPaints a simple rectangle, using the top-left and bottom-right coordinates. -
Uses of OptionHandler in adams.gui.visualization.instance
Classes in adams.gui.visualization.instance that implement OptionHandler Modifier and Type Class Description classAbstractInstancePaintletAncestor for Instance paintlets.classAbstractInstancePanelUpdaterAncestor for classes that determine when to update the instance panel, i.e., repaint all of it.classInstanceLinePaintletPaintlet for generating a line plot for Instance objects.classInstancePointHitDetectorDetects selections of instance points in the instance panel.classInstanceZoomOverviewPaintletHighlights the current zoom in the instance panel.classReportColorInstancePaintletPaintlet for generating a line plot using the color stored in the report.classSimpleInstanceLinePaintletPaintlet for generating a line plot for Instance objects (no markers).classSimpleInstancePanelUpdaterUpdates the flow after the specified number of tokens have been processed. -
Uses of OptionHandler in adams.gui.visualization.instances.instancestable
Classes in adams.gui.visualization.instances.instancestable that implement OptionHandler Modifier and Type Class Description classAbstractPlotColumnAncestor for plugins that plot a column.classAbstractPlotRowAncestor for plugins that plot a row.classAbstractPlotSelectedRowsAncestor for plugins that plot rows.classAbstractProcessCellAncestor for plugins that process a cell.classAbstractProcessColumnAncestor for plugins that process a column.classAbstractProcessRowAncestor for plugins that process a row.classAbstractProcessSelectedRowsAncestor for plugins that process a row.classArrayStatisticAllows the calculation of row statistics.classAttributeStatisticsDisplays statistics for the selected attribute.classBinningAllows to perform binning of the values from a column or row.classChangeAttributeWeightAllows the user to change the weight of the selected attribute.classChangeInstanceWeightsAllows the user to change the weight of the selected attribute.classColumnStatisticAllows the calculation of column statistics.classDataSortAllows sorting the data using multiple columns.classHistogramAllows to generate a histogram from a column or row.classInvestigatorAsNewDatasetAllows the user to add the selected rows as new dataset in the Investigator.classJFreeChartAllows to perform a simple plot of a column or row.classRowStatisticAllows the calculation of row statistics.classSimplePlotAllows to perform a simple plot of a column or row.classViewCellFor viewing the cell content. -
Uses of OptionHandler in adams.gui.visualization.jfreechart.chart
Classes in adams.gui.visualization.jfreechart.chart that implement OptionHandler Modifier and Type Class Description classAbstractChartGenerator<T extends org.jfree.data.general.Dataset>Ancestor for chart generators.classAbstractChartGeneratorWithAxisLabels<T extends org.jfree.data.general.Dataset>Ancestor for chart generators that support axis labels.classBarChartGenerates bar chart from category data.classBubbleChartGenerates bubble chart from XYZ data (Z is size of bubble).classScatterPlotGenerates a scatter plot from XY data.classXYLineChartGenerates line chart from XY data. -
Uses of OptionHandler in adams.gui.visualization.jfreechart.dataset
Classes in adams.gui.visualization.jfreechart.dataset that implement OptionHandler Modifier and Type Class Description classAbstractDatasetGenerator<T extends org.jfree.data.general.Dataset>Ancestor for dataset generators.classDefaultCategoryFor each of the Y columns, a separate series is generated.classDefaultXYGeneratesDefaultXYDatasetdatasets.classDefaultXYZGeneratesDefaultXYZDatasetdatasets. -
Uses of OptionHandler in adams.gui.visualization.jfreechart.shape
Classes in adams.gui.visualization.jfreechart.shape that implement OptionHandler Modifier and Type Class Description classAbstractShapeGeneratorGenerates a shape to be used for marking data points (eg in a scatter plot).classCircleGenerates a circle.classCrossGenerates a cross.classDefaultGenerates no shape, ie leaves the default one intact.classDiamondGenerates a diamond.classTriangleGenerates a triangle. -
Uses of OptionHandler in adams.gui.visualization.multiobjectexport
Classes in adams.gui.visualization.multiobjectexport that implement OptionHandler Modifier and Type Class Description classAbstractMultiObjectExportAncestor for schemes that can export multiple objects.classAbstractMultiObjectExportWithPreferredExtensionsAncestor for exporters that have preferred extensions in order to locate anAbstractObjectExporter.classDirectoryExportExports the objects to a directory.classEmailExportSends the outputs via email.classPDFExportGenerates a PDF from the exported objects (first get turned into files).classZipExportExports the objects to a zip file. -
Uses of OptionHandler in adams.gui.visualization.object.annotationsdisplay
Classes in adams.gui.visualization.object.annotationsdisplay that implement OptionHandler Modifier and Type Class Description classAbstractAnnotationsDisplayGeneratorAncestor for classes that create AbstractAnnotationsPanel implementations.classDefaultAnnotationsDisplayGeneratorAncestor for classes that create AbstractAnnotationsPanel implementations. -
Uses of OptionHandler in adams.gui.visualization.object.annotator
Classes in adams.gui.visualization.object.annotator that implement OptionHandler Modifier and Type Class Description classAbstractAnnotatorAncestor for annotation handlers.classAbstractPointAnnotatorAncestor for point annotators.classAbstractRectangleBasedAnnotatorAnnotators that use a rectangle based approach.classAbstractReportBasedAnnotatorAncestor for annotators that use reports to store the annotations in.classBoundingBoxAnnotatorFor annotating objects with bounding boxes.classClassificationLabelAnnotatorSimply sets the chosen label in the report.classNullAnnotatorDummy, offers no annotation support.classPolygonAnnotatorFor annotating object shapes with polygons boxes.classPolygonPointAnnotatorFor annotating polygons by left-clicking on each vertex.classSimplePointAnnotatorFor annotating single points. -
Uses of OptionHandler in adams.gui.visualization.object.labelselector
Classes in adams.gui.visualization.object.labelselector that implement OptionHandler Modifier and Type Class Description classAbstractLabelSelectorGeneratorAncestor for classes that generate label selector panels.classButtonSelectorGeneratorGenerates a panel with the labels as buttons and an 'Unset' button.classButtonSelectorWithColorGeneratorGenerates a panel with the labels as buttons (containing color hint) and an 'Unset' button.classComboBoxSelectorGeneratorGenerates a panel with a combobox with the labels and an 'Unset' button.classNoPanelGeneratorGenerates no panel. -
Uses of OptionHandler in adams.gui.visualization.object.mouseclick
Classes in adams.gui.visualization.object.mouseclick that implement OptionHandler Modifier and Type Class Description classAbstractMouseClickProcessorAncestor for schemes that react to mouse clicks.classAddMetaDataAllows the user to add meta-data to the selected objects.classDeleteObjectsDisplays the objects at the click position and deletes the selected ones.classMultiProcessorCombines multiple click processors, iterates through them until event consumed.classNullProcessorDummy, does nothing.classSetLabelSets/unsets the current label.classViewObjectsDisplays the annotated objects in a dialog that contain the click position. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.check
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.check Modifier and Type Interface Description interfaceAnnotationCheckInterface for annotation checks.Classes in adams.gui.visualization.object.objectannotations.check that implement OptionHandler Modifier and Type Class Description classAbstractAnnotationCheckAncestor for annotation checks.classMultiCheckApplies the specified checks sequentially.classPassThroughDummy, performs no checks.classRequireMetaDataRequires the specified meta-data key to be present in all objects. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.cleaning
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.cleaning Modifier and Type Interface Description interfaceAnnotationCleanerInterface for annotation cleaners.Classes in adams.gui.visualization.object.objectannotations.cleaning that implement OptionHandler Modifier and Type Class Description classAbstractAnnotationCleanerAncestor for annotation cleaners.classFilterApplies the object finder to clean the annotations.classOverlapRemovalApplies the overlapping object removal algorithm to clean the annotations.classPassThroughPerforms no cleaning, just passes through the annotations. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.colors
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.colors Modifier and Type Interface Description interfaceAnnotationColorsInterface for classes that generate colors for annotations.Classes in adams.gui.visualization.object.objectannotations.colors that implement OptionHandler Modifier and Type Class Description classAbstractAnnotationColorsAncestor for annotation colorizers.classFixedColorUses a single, fixed color.classPerTypeUses a color per object type.classTypeColorMappingUses the colors defined for each type.classVaryByObjectVaries the color per object, useful when just a single type of object is annotated. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.label
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.label Modifier and Type Interface Description interfaceLabelPlotterInterface for classes that plot labels.Classes in adams.gui.visualization.object.objectannotations.label that implement OptionHandler Modifier and Type Class Description classAbstractLabelPlotterAncestor for label plotters.classAnchoredPlots the label relative to the anchor.classMultiLabelPlotterApplies the specified plotters subsequently.classNoLabelDoes not plot a label. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.outline
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.outline Modifier and Type Interface Description interfaceOutlinePlotterInterface for classes that plot the outlines of shapes.interfaceSubsetPlotSupporterInterface for plotters that allow limiting the objects to be plotted.Classes in adams.gui.visualization.object.objectannotations.outline that implement OptionHandler Modifier and Type Class Description classAbstractOutlinePlotterAncestor for outline plotters.classAbstractStrokeOutlinePlotterAncestor for plotters that define a stroke width.classMultiOutlinePlotterApplies the specified plotters subsequently.classNoOutlineOmits plotting an outline.classPolygonOutlinePlots the polygon.classPolygonVerticesPlots the polygon vertices.classRectangleOutlinePlots the bounding box.classRectangleVerticesPlots the vertices of the bounding box. -
Uses of OptionHandler in adams.gui.visualization.object.objectannotations.shape
Subinterfaces of OptionHandler in adams.gui.visualization.object.objectannotations.shape Modifier and Type Interface Description interfaceShapePlotterInterface for classes that plot shapes.Classes in adams.gui.visualization.object.objectannotations.shape that implement OptionHandler Modifier and Type Class Description classAbstractShapePlotterAncestor for outline plotters.classCenterPlots a circle in the center of the object.classFilledPolygonPlots a filled polygon.classFilledRectanglePlots a filled rectangle.classMultiShapePlotterApplies the specified plotters subsequently.classNoShapeOmits plotting the shape. -
Uses of OptionHandler in adams.gui.visualization.object.overlay
Subinterfaces of OptionHandler in adams.gui.visualization.object.overlay Modifier and Type Interface Description interfaceOverlayInterface for overlays.interfaceOverlayWithCustomAlphaSupportInterface for overlays that allow alpha values of their color generators to be overwritten.Classes in adams.gui.visualization.object.overlay that implement OptionHandler Modifier and Type Class Description classAbstractObjectOverlayFromReportAncestor for overlays that use object locations from a report.classAbstractOverlayAncestor for overlays.classAbstractPointOverlayFromReportAncestor for overlays that use point locations from a report.classClassificationLabelTextOverlayDisplays the classification label retrieved from the field in the report and overlays it as text on the image.classMultiOverlayCombines multiple overlays.classNullOverlayDummy, paints nothing.classObjectAnnotationsFlexible overlay for object annotations.classObjectCentersOverlayFromReportclassObjectLocationsOverlayFromReportclassSimplePointOverlayFromReport -
Uses of OptionHandler in adams.gui.visualization.report
Classes in adams.gui.visualization.report that implement OptionHandler Modifier and Type Class Description classReportDateFieldPaintletPaintlet for painting an indicator based on the date(s) stored in the report.
For more details on the date format, see:
Javadoc.classReportDateFieldRangePaintletPaintlet for painting a background region based on the date stored in a report.
For more details on the date format, see:
Javadoc. -
Uses of OptionHandler in adams.gui.visualization.segmentation.paintoperation
Subinterfaces of OptionHandler in adams.gui.visualization.segmentation.paintoperation Modifier and Type Interface Description interfacePaintOperationInterface for additional paint operations in the segmentation panel.Classes in adams.gui.visualization.segmentation.paintoperation that implement OptionHandler Modifier and Type Class Description classAbstractPaintOperationAncestor for additional paint operations in the segmentation panel.classNullOperationDummy, paints nothing.classPolygonOverlayPaints an overlay. -
Uses of OptionHandler in adams.gui.visualization.sequence
Classes in adams.gui.visualization.sequence that implement OptionHandler Modifier and Type Class Description classAbstractXYSequenceMetaDataColorPaintletAncestor for paintlets that can make use of the meta-data and extract color information.classAbstractXYSequencePaintletAbstract superclass for paintlets for X-Y sequences.classAbstractXYSequencePointHitDetectorAncestor for XY sequence point hit detectors.classBarHitDetectorDetects selections of sequence points in the sequence panel.classBarPaintletPaintlet for painting a bar plot for a sequence.classByNamePaintletA wrapper for XY-sequence paintlets, plots only sequences if the ID matches the regular expression.classCircleHitDetectorDetects selections of sequence points in the sequence panel.classCirclePaintletPaintlet for simply painting circles at the specified X-Y position.classCrossHitDetectorDetects selections of crosses.classCrossPaintletPaintlet for simply painting crosses at the specified X-Y position.classDiagonalOverlayPaintletDraws a diagonal (bottom-left to top-right).classDotHitDetectorDetects selections of dots.classDotPaintletPaintlet for simply painting dots at the specified X-Y position.classHorizontalIndicatorPaints a horizontal indicator (ie a line).classIncrementalSumPaintletA paintlet for painting a line plot of a sequence.classKendallTheilOverlayPaintletDraws a straight line, using slope and intercept determined by Theil-Sen estimator using all the data points in the plot(s).
For more information, see:
Wikipedia.classLinearRegressionOverlayPaintletDraws a straight line, using slope and intercept determine by linear regression using all the data points in the plot(s).classLineHitDetectorDetects selections of lines.classLinePaintletA paintlet for painting a line plot of a sequence.classLOWESSOverlayPaintletOverlay that applies LOWESS smoothing over all the data points in the plot(s).
For more information see:
WikiPedia.classMathExpressionOverlayPaintletCalculates data points using the provided mathematical expression and paints them using the specified paintlet.
If the expression generates a NaN ('not a number') the x/y pair gets ignored.classMeanOverlayPaintletDraws the mean as straight line.classMedianOverlayPaintletDraws the median as straight line.classMetaDataValuePaintletPaintlet for painting a meta-data value as text, centered at the specified X-Y position.classMultiPaintletPaintlet that combines multiple XYSequence paintlets.classNullPaintletDummy paintlet that performs nor painting at all.classPaintletWithFixedXRangeA wrapper for XY-sequence paintlets, in order to use fixed a X range.classPaintletWithFixedXYRangeA wrapper for XY-sequence paintlets, in order to use fixed X and Y ranges.classPaintletWithFixedYRangeA wrapper for XY-sequence paintlets, in order to use fixed a Y range.classPercentileOverlayPaintletDraws the specified percentile as straight line.classSquarePaintletclassStdDevOverlayPaintletDraws the standard deviation as straight line.classStickHitDetectorDetects selections of sticks.classStickPaintletPaintlet for painting a stick plot for a sequence.classStraightLineOverlayPaintletDraws a straight line.classTextOverlayPaintletOutputs the supplied text at the specified location.classTrianglePaintletPaintlet for simply painting triangles at the specified X-Y position. -
Uses of OptionHandler in adams.gui.visualization.sequence.metadatacolor
Classes in adams.gui.visualization.sequence.metadatacolor that implement OptionHandler Modifier and Type Class Description classAbstractMetaDataColor<T extends XYSequencePoint>Ancestor for schemes extracting the color from a sequence point's meta-data.classColorPerLabelMaintains an internal mapping between labels obtained from the meta-data (using the specified key) and colors obtained from the color provider.
Makes use of color providers that implement the adams.gui.visualization.core.ColorProviderWithNameSupport interface, supplying it with the label obtained from the meta-data.classColorPerRegExpGroupMaintains an internal mapping between groups obtained from the meta-data via the regular expression extraction (using the specified key) and colors obtained from the color provider.
Makes use of color providers that implement the adams.gui.visualization.core.ColorProviderWithNameSupport interface, supplying it with the label obtained from the meta-data.classDummyJust outputs the default color. -
Uses of OptionHandler in adams.gui.visualization.spreadsheet
Classes in adams.gui.visualization.spreadsheet that implement OptionHandler Modifier and Type Class Description classAbstractSpreadSheetRowPaintletAncestor for Row paintlets.classAbstractSpreadSheetRowPanelUpdaterAncestor for classes that determine when to update the instance panel, i.e., repaint all of it.classSimpleSpreadSheetRowLinePaintletPaintlet for generating a line plot for Instance objects (no markers).classSimpleSpreadSheetRowPanelUpdaterUpdates the flow after the specified number of tokens have been processed.classSpreadSheetRowLinePaintletPaintlet for generating a line plot for Instance objects.classSpreadSheetRowPointHitDetectorDetects selections of row points in the row panel.classSpreadSheetRowZoomOverviewPaintletHighlights the current zoom in the row panel. -
Uses of OptionHandler in adams.gui.visualization.stats.core
Classes in adams.gui.visualization.stats.core that implement OptionHandler Modifier and Type Class Description classAbstractPlotOptionGroupAncestor for option groups for plots. -
Uses of OptionHandler in adams.gui.visualization.stats.fourinone
Classes in adams.gui.visualization.stats.fourinone that implement OptionHandler Modifier and Type Class Description classVersusFitOptionsClass that contains options for the versusfit plot
Valid options are:classVersusOrderOptionsClass containing the options for the versus order plot
Valid options are: -
Uses of OptionHandler in adams.gui.visualization.stats.histogram
Classes in adams.gui.visualization.stats.histogram that implement OptionHandler Modifier and Type Class Description classHistogramOptionsClass containing options for the histogram plot
Valid options are: -
Uses of OptionHandler in adams.gui.visualization.stats.paintlet
Classes in adams.gui.visualization.stats.paintlet that implement OptionHandler Modifier and Type Class Description classAbstractColorPaintletAbstract class for paintlets with a stroke color option and instances member, all paintlets will use this.classAbstractOverlayPaintletAbstract class for paintlets that draw the overlays.classAbstractProbabilityPaintletAbstract class for paintlets that plot the regression in the probability plot.classAbstractScatterPlotHitDetectorAncestor for scatter plot hit detectors.classAbstractScatterPlotPaintletAbstract class for creating scatterplot paintlets.classAbstractZOverlayPaintletabstract class for creating z score overlay paintlets.classAbstractZScorePaintletAbstract class for creating z score paintlets.classCoordinatesPaintletPaintlet for painting the coordinates.classDiagonalPaintletPaintlet for displaying the diagonal overlay on the scatter plot.classExponentialPaints the transformed exponential distribution
Valid options are:classGammaPaints the transformed gamma distribution
Valid options are:classHistogramPaintletPaints the histogram
Valid options are:classLogisticpaints the transformed logistic distribution
Valid options are:classLoglogisticpaints the transformed loglogistic distribution
Valid options are:classLognormalpaints the transformed lognormal distribution
Valid options are:classLowessPaintletPaintlet for drawing the lowess overlay.classMeanPaintletpaintlet for displaying mean overlay on the ZScore graph
Valid options are:classNormalPaints the transformed normal distribution on the panel
Valid options are:classScatterPaintletCirclePaintlet for displaying points on the scatter point as circles.classScatterPaintletCrossClass for plotting data on a scatter plot as crosses.classScatterPaintletErrorsPaintlet that draws data on the scatter plot as crosses whose size depends on the error between x and y values.classScatterPaintletMetaDataValuePaintlet for displaying points on the scatter point as circles.classScatterPlotCircleHitDetectorDetects selections of sequence points in the sequence panel.classStdDevPaintletpaintlet for displaying stddev overlay on the Z score graph
Valid options are:classVsFitPaintletPaints the data for the versus fit graph
Valid options are:classVsOrderPaintletPaints the data for the versus order graph
Valid options are:classZScoreCirclepaintlet for plotting cirle points on the z score visualisation
Valid options are:classZScoreCrosspaintlet for plotting cross error points on the z score graph whose size depends on the difference between x and y values
Valid options are: -
Uses of OptionHandler in adams.gui.visualization.stats.probabilityplot
Classes in adams.gui.visualization.stats.probabilityplot that implement OptionHandler Modifier and Type Class Description classNormalPlotOptionsClass for setting the options for the normal probability plot
Valid options are: -
Uses of OptionHandler in adams.gui.visualization.stats.scatterplot
Classes in adams.gui.visualization.stats.scatterplot that implement OptionHandler Modifier and Type Class Description classAbstractScatterPlotOverlayAbstract superclass for overlays on the scatterplot graph.classCoordinatesDisplay a diagonal line overlay
classDiagonalDisplay a diagonal line overlay
Valid options are:classLowessDisplay a lowess curve as an overlay. -
Uses of OptionHandler in adams.gui.visualization.stats.scatterplot.action
Classes in adams.gui.visualization.stats.scatterplot.action that implement OptionHandler Modifier and Type Class Description classAbstractMouseClickActionAncestor for classes that react to mouse clicks on the canvas.classNullClickActionDummy action, does nothing.classViewDataClickActionDisplays the data that the user clicked on in a table. -
Uses of OptionHandler in adams.gui.visualization.stats.zscore
Classes in adams.gui.visualization.stats.zscore that implement OptionHandler Modifier and Type Class Description classAbstractZScoreOverlayAbstract superclass for overlays on the z score graph.classMeanPlot a mean line as an overlay on the z score graph
Valid options are:classStdDevDisplay a standard deviation line on the z score above and below the mean
Valid options are:classZScoreHitDetectorHit detector for the zscore visualisation. -
Uses of OptionHandler in adams.gui.visualization.timeseries
Subinterfaces of OptionHandler in adams.gui.visualization.timeseries Modifier and Type Interface Description interfaceTimeseriesXAxisPanelOptionsInterface for axis panel options for X axes of timeseries panels.interfaceTimeseriesYAxisPanelOptionsInterface for axis panel options for Y axes of timeseries panels.Classes in adams.gui.visualization.timeseries that implement OptionHandler Modifier and Type Class Description classAbstractTimeseriesPaintletA specialized paintlet for timeseries panels.classAbstractTimeseriesXAxisPanelOptionsAncestor for axis panel option classes for timeseries X axes.classAbstractTimeseriesYAxisPanelOptionsAncestor for axis panel option classes for timeseries Y axes.classDefaultTimeseriesXAxisPanelOptionsEncapsulates options for the X axis in a timeseries plot.classDefaultTimeseriesYAxisPanelOptionsEncapsulates options for the Y axis in a timeseries plot.classFixedTimestampPaintletPaintlet for highlighting a specific timestamp with a vertical indicator line.classFixedTimestampRangePaintletPaintlet for highlighting a specific timestamp range with a background color.classPaintletWithFixedXRangeA wrapper for XY-sequence paintlets, in order to use fixed a X range.classPaintletWithFixedXYRangeA wrapper for XY-sequence paintlets, in order to use fixed X and Y ranges.classPaintletWithFixedYRangeA wrapper for XY-sequence paintlets, in order to use fixed a Y range.classPeriodicityColorProviderSimple color provider to highlight periodicity.classPeriodicityPaintletPaintlet for painting the spectral graph.classReportColorTimeseriesPaintletPaintlet for painting the timeseries data using the color stored in the report.classSelectedTimestampPaintletPaintlet for highlighting a selected timeseries data point point on a panel.classTimeseriesPaintletPaintlet for painting the timeseries data.classTimeseriesPointHitDetectorDetects selections of timeseries points in the timeseries panel.classTimeseriesZoomOverviewPaintletHighlights the current zoom in the timeseries panel. -
Uses of OptionHandler in adams.ml.evaluation
Classes in adams.ml.evaluation that implement OptionHandler Modifier and Type Class Description classAbstractSplitGeneratorAncestor for helper classes that generates dataset splits.classDefaultCrossValidationFoldGeneratorHelper class for generating cross-validation folds.classDefaultRandomSplitGeneratorGenerates random splits of datasets. -
Uses of OptionHandler in adams.ml.model
Subinterfaces of OptionHandler in adams.ml.model Modifier and Type Interface Description interfaceAlgorithm<T extends Model>Interface for machine learning algorithms.interfaceIncrementalAlgorithm<T extends Model>Interface for incremental algorithms. -
Uses of OptionHandler in adams.ml.model.classification
Subinterfaces of OptionHandler in adams.ml.model.classification Modifier and Type Interface Description interfaceClassifierInterface for classification algorithms.interfaceIncrementalClassifierInterface for incremental classification algorithms.interfaceIncrementalMultiTargetClassifierInterface for incremental multi-target classification algorithms.interfaceMultiTargetClassifierInterface for multi-target classification algorithms.Classes in adams.ml.model.classification that implement OptionHandler Modifier and Type Class Description classAbstractClassifierAncestor for classification algorithms.classAbstractMultiTargetClassifierAncestor for multi-target classification algorithms.classWekaClassifierWraps around a Weka classifier that handles nominal classes (= classification). -
Uses of OptionHandler in adams.ml.model.clustering
Subinterfaces of OptionHandler in adams.ml.model.clustering Modifier and Type Interface Description interfaceClustererInterface for clustering algorithms.interfaceIncrementalClustererInterface for incremental cluster algorithms.Classes in adams.ml.model.clustering that implement OptionHandler Modifier and Type Class Description classAbstractClustererAncestor for clustering algorithms.classWekaClustererWraps around a Weka clusterer. -
Uses of OptionHandler in adams.ml.model.regression
Subinterfaces of OptionHandler in adams.ml.model.regression Modifier and Type Interface Description interfaceIncrementalMultiTargetRegressorInterface for incremental multi-target regression algorithms.interfaceIncrementalRegressorInterface for incremental regression algorithms.interfaceMultiTargetRegressorInterface for multi-target regression algorithms.interfaceRegressorInterface for regression algorithms.Classes in adams.ml.model.regression that implement OptionHandler Modifier and Type Class Description classAbstractMultiTargetRegressorAncestor for regression algorithms.classAbstractRegressorAncestor for regression algorithms.classWekaRegressorWraps around a Weka classifier that handles numeric classes (= regression). -
Uses of OptionHandler in adams.ml.preprocessing
Classes in adams.ml.preprocessing that implement OptionHandler Modifier and Type Class Description classAbstractBatchFilterAncestor for batch filters.classAbstractColumnSubsetBatchFilterAncestor for batch filters with column subset handling.classAbstractColumnSubsetFilterAncestor for filters.classAbstractColumnSubsetStreamFilterAncestor for stream filters with column subset handling.classAbstractFilterAncestor for filters.classAbstractStreamFilterAncestor for stream filters. -
Uses of OptionHandler in adams.ml.preprocessing.supervised
Classes in adams.ml.preprocessing.supervised that implement OptionHandler Modifier and Type Class Description classPLS -
Uses of OptionHandler in adams.ml.preprocessing.unsupervised
Classes in adams.ml.preprocessing.unsupervised that implement OptionHandler Modifier and Type Class Description classMultiBatchApplies the specified filters sequentially.classMultiStreamApplies the specified filters sequentially.classPassThroughDummy, just passes through the data.classPCAPerforms principal components analysis.classSavitzkyGolayA filter that applies Savitzky-Golay smoothing.
For more information see:
A. -
Uses of OptionHandler in adams.multiprocess
Subinterfaces of OptionHandler in adams.multiprocess Modifier and Type Interface Description interfaceJobRunner<T extends Job>Interface for runners that execute jobs.Classes in adams.multiprocess that implement OptionHandler Modifier and Type Class Description classAbstractJobRunner<T extends Job>Ancestor for jobrunner classes.classAbstractMetaJobRunnerAncestor for meta-jobrunners, that wrap around a base jobrunner.classLocalJobRunner<T extends Job>Executes the jobs on the local machine.classRemoteCommandJobRunnerUtilizes the remote command framework for sending jobs to a remote machine.static classRemoteCommandJobRunner.RemoteCommandGrabberHandles the job response.classScpJobRunnerWraps another jobrunner and serializes it, scp's it to the specified remote file and then waits for the specified import file (containing the serialized, executed jobs) to appear.
Requires a adams.flow.standalone.SSHConnection standalone for defining the SSH connection.protected static classScpJobRunner.RemoteJobRunnerclassSerializingJobRunnerWraps another jobrunner and serializes it to the specified export file and then waits for the specified import file (containing the serialized, executed jobs) to appear. -
Uses of OptionHandler in adams.opt.genetic
Classes in adams.opt.genetic that implement OptionHandler Modifier and Type Class Description classAbstractClassifierBasedGeneticAlgorithmAncestor for genetic algorithms that evaluate classifiers.classAbstractClassifierBasedGeneticAlgorithmWithSecondEvaluationAncestor for genetic algorithms that offer a second evaluation using a different seed value.classAbstractGeneticAlgorithmBase class for genetic algorithms.classDarkLordclassHermioneHermione.classPackDataGeneticAlgorithm??? -
Uses of OptionHandler in adams.opt.genetic.initialsetups
Classes in adams.opt.genetic.initialsetups that implement OptionHandler Modifier and Type Class Description classAbstractInitialSetupsProvider<T extends AbstractGeneticAlgorithm>Ancestor for providers for initial gene setups.classEmptyInitialSetupsProvider<T extends AbstractGeneticAlgorithm>classPackDataInitialSetupsProvider<T extends PackDataGeneticAlgorithm> -
Uses of OptionHandler in adams.opt.genetic.setupupload
Classes in adams.opt.genetic.setupupload that implement OptionHandler Modifier and Type Class Description classAbstractSetupUploadAncestor for schemes that upload the setup of a genetic algorithm.classMySQLStores the setup information in the specified MySQL table.classNullDummy, does not nothing. -
Uses of OptionHandler in adams.opt.genetic.stopping
Classes in adams.opt.genetic.stopping that implement OptionHandler Modifier and Type Class Description classAbstractStoppingCriterionAncestor for stopping criteria.classMaxIterationsStops after the maximum number of iterations have been reached.classMaxIterationsWithoutImprovementStops after the maximum number of seconds since last improvement has been reached.classMaxTrainTimeStops after the maximum number of seconds have been reached.classMaxTrainTimeWithoutImprovementStops after the maximum number of seconds since last improvement has been reached.classMultiStoppingCriterionApplies its sub-criteria, one after the other. -
Uses of OptionHandler in adams.opt.optimise
Classes in adams.opt.optimise that implement OptionHandler Modifier and Type Class Description classAbstractFitnessFunctionAbstract ancestor for fitness functions.classAbstractOptimiserAbstract ancestor for optimization schemes.classGeneticAlgorithmMorticia (GEX).classGridSearchGrid Search searches the parameter hyper-grid space.classRandomOptimiserGenerate random parameter values.classRefineRangeGrid Search searches the parameter hyper-grid space.classSplitSearchGrid Search searches the parameter hyper-grid space. -
Uses of OptionHandler in adams.opt.optimise.genetic
Classes in adams.opt.optimise.genetic that implement OptionHandler Modifier and Type Class Description classAbstractGeneticAlgorithmBase class for genetic algorithms.classPackDataGeneticAlgorithm??? -
Uses of OptionHandler in adams.opt.optimise.genetic.fitnessfunctions
Classes in adams.opt.optimise.genetic.fitnessfunctions that implement OptionHandler Modifier and Type Class Description classAbstractWEKAFitnessFunctionPerform attribute selection using WEKA classification.classAttributeSelectionPerform attribute selection using WEKA classification. -
Uses of OptionHandler in adams.parser
Classes in adams.parser that implement OptionHandler Modifier and Type Class Description classAbstractExpressionEvaluator<T>Abstract ancestor for classes that evaluate expressions.classAbstractSymbolEvaluator<T>Abstract ancestor for classes that evaluate expressions with a parser generated by JFlex/CUP.classActorSuggestionEvaluates rules for suggesting actors.
It uses the following grammar:
expr_list ::= expr_list expr_part | expr_part ;
expr_part ::= IF boolexpr THEN cmdexpr ;
boolexpr ::= ( boolean )
| boolean
| boolexpr AND boolexpr
| boolexpr OR boolexpr
| TRUE
| FALSE
| NOT boolexpr
| ISFIRST
| ISLAST
| PARENT IS classexpr
| PARENT LIKE classexpr
| PARENT ALLOWS STANDALONE
| PARENT ALLOWS SOURCE
| ANYPARENT IS classexpr
| ANYPARENT LIKE classexpr
| PRECEDING GENERATES classexpr
| FOLLOWING ACCEPTS classexpr
| BEFORE STANDALONE
| AFTER STANDALONE
| BEFORE SOURCE
| AFTER SOURCE
| BEFORE TRANSFORMER
| AFTER TRANSFORMER
| BEFORE SINK
| AFTER SINK
| BEFORE classexpr
| AFTER classexpr
;
classexpr ::= "classname (interface or class)"
;
cmdexpr ::= classname
| "classname + options"
;
Notes:
- 'ANYPARENT' tests any parent to the root until successful or no more parents
- 'IS' uses exact classname testing
- 'LIKE' tests whether the class is either a subclass of a class or implements a class
- A 'cmdexpr' string surrounded by double quotes can also contain placeholders:
classname: ${PARENT.CLASS}, ${PRECEDING.CLASS}, ${FOLLOWING.CLASS}
actor's name: ${PARENT.NAME}, ${PRECEDING.NAME}, ${FOLLOWING.NAME}
actor's fullname: ${PARENT.FULL}, ${PRECEDING.FULL}, ${FOLLOWING.FULL}
- '${PARENT.X}' refers to the last parent that was located, e.g., using 'IF ANYPARENT...'
or 'IF PARENT...'.classActorTemplateSuggestionEvaluates rules for suggesting actor templates.
It uses the following grammar:
expr_list ::= expr_list expr_part | expr_part ;
expr_part ::= boolexpr : <classname | "classname+options">;
boolexpr ::= ( boolean )
| boolean
| boolexpr AND boolexpr
| boolexpr OR boolexpr
| TRUE
| FALSE
| NOT boolexpr
| ISFIRST
| ISLAST
| PARENT IS <classname|interface>
| BEFORE STANDALONE
| AFTER STANDALONE
| BEFORE SOURCE
| AFTER SOURCE
| BEFORE TRANSFORMER
| AFTER TRANSFORMER
| BEFORE SINK
| AFTER SINK
| BEFORE <classname|interface>
| AFTER <classname|interface>
;
Valid options are:classBaseDateExpressionEvaluates date expressions.
Format:
(<date>|NOW|TODAY|TOMORROW|YESTERDAY|-INF|+INF|START|END) [expr (DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
Note:
TODAY/TOMORROW/YESTERDAY generate a date at the start of the day.
Examples:
1999-12-31
1999-12-31 +1 DAY
NOW
+INF
NOW +1 YEAR
NOW +14 DAY
NOW +(2*3) DAY
Amounts can be chained as well:
NOW -1 MONTH +1 DAY
START and END can only be set programmatically; by default they are equal to -INF and +INF.classBaseDateTimeExpressionEvaluates date/time expressions.
Format:
(<date>|NOW|TODAY|TOMORROW|YESTERDAY|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
Note:
TODAY/TOMORROW/YESTERDAY generate a date at the start of the day.
Examples:
1999-12-31 01:02:03
1999-12-31 01:02:03 +1 MINUTE
NOW
+INF
NOW +1 YEAR
NOW +14 DAY
NOW +(2*3) DAY
Amounts can be chained as well:
NOW -1 MONTH +1 DAY
START and END can only be set programmatically; by default they are equal to -INF and +INF.classBaseDateTimeMsecExpressionEvaluates date/time (with msec) expressions.
Format:
(<date>|NOW|TODAY|TOMORROW|YESTERDAY|-INF|+INF|START|END) [expr (MILLISECOND|SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
Note:
TODAY/TOMORROW/YESTERDAY generate a date at the start of the day.
Examples:
1999-12-31 01:02:03.123
1999-12-31 01:02:03.123 +1 MINUTE
NOW
+INF
NOW +1 YEAR
NOW +14 DAY
NOW +(2*3) DAY
Amounts can be chained as well:
NOW -1 MONTH +1 DAY
START and END can only be set programmatically; by default they are equal to -INF and +INF.classBaseTimeExpressionEvaluates time expressions.
Format:
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
Examples:
01:02:03
01:02:03 +1 MINUTE
NOW
+INF
NOW +1 HOUR
NOW +14 MINUTE
NOW +(2*3) MINUTE
Amounts can be chained as well:
NOW -1 MINUTE +1 HOUR
START and END can only be set programmatically; by default they are equal to -INF and +INF.classBaseTimeMsecExpressionEvaluates time expressions.
Format:
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
Examples:
01:02:03
01:02:03 +1 MINUTE
NOW
+INF
NOW +1 HOUR
NOW +14 MINUTE
NOW +(2*3) MINUTE
Amounts can be chained as well:
NOW -1 MINUTE +1 HOUR
START and END can only be set programmatically; by default they are equal to -INF and +INF.classBooleanExpressionEvaluates boolean expressions.
It uses the following grammar:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| rand () (unseeded double, 0-1)
| rand ( seed ) (seeded double, 0-1)
| randint ( bound ) (unseeded int from 0 to bound-1)
| randint ( seed, bound ) (seeded int from 0 to bound-1)
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| startswith ( str , find ) (checks whether 'str' string starts with 'find' string)
| endswith ( str , find ) (checks whether 'str' string ends with 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classExternalActorSuggestionEvaluates rules for suggesting actors.
It uses the following grammar:
expr_list ::= expr_list expr_part | expr_part ;
expr_part ::= IF boolexpr THEN cmdexpr ;
boolexpr ::= ( boolean )
| boolean
| boolexpr AND boolexpr
| boolexpr OR boolexpr
| TRUE
| FALSE
| NOT boolexpr
| ISFIRST
| ISLAST
| PARENT IS classexpr
| PARENT LIKE classexpr
| PARENT ALLOWS STANDALONE
| PARENT ALLOWS SOURCE
| ANYPARENT IS classexpr
| ANYPARENT LIKE classexpr
| PRECEDING GENERATES classexpr
| FOLLOWING ACCEPTS classexpr
| BEFORE STANDALONE
| BEFORE SOURCE
| BEFORE TRANSFORMER
| BEFORE SINK
| BEFORE classexpr
| AFTER STANDALONE
| AFTER SOURCE
| AFTER TRANSFORMER
| AFTER SINK
| AFTER classexpr
| THIS IS STANDALONE
| THIS IS SOURCE
| THIS IS TRANSFORMER
| THIS IS SINK
| THIS IS classexpr
| FIRST IS STANDALONE
| FIRST IS SOURCE
| FIRST IS TRANSFORMER
| FIRST IS SINK
| FIRST IS classexpr
| LAST IS STANDALONE
| LAST IS SOURCE
| LAST IS TRANSFORMER
| LAST IS SINK
| LAST IS classexpr
;
classexpr ::= "classname (interface or class)"
;
cmdexpr ::= classname
| "classname + options"
;
Notes:
- 'ANYPARENT' tests any parent to the root until successful or no more parents
- 'IS' uses exact classname testing
- 'LIKE' tests whether the class is either a subclass of a class or implements a class
- A 'cmdexpr' string surrounded by double quotes can also contain placeholders:
classname: ${PARENT.CLASS}, ${LASTPARENT.CLASS}, ${PRECEDING.CLASS}, ${FOLLOWING.CLASS}
actor's name: ${PARENT.NAME}, ${LASTPARENT.NAME}, ${PRECEDING.NAME}, ${FOLLOWING.NAME}
actor's fullname: ${PARENT.FULL}, ${LASTPARENT.FULL}, ${PRECEDING.FULL}, ${FOLLOWING.FULL}
- '${LASTPARENT.X}' refers to the last parent that was located, e.g., using 'IF ANYPARENT...'
or 'IF PARENT...'.classLookUpUpdateEvaluates lookup update rules updating the spreadsheet.
The following grammar is used:
expr_list ::= expr_list expr_part | expr_part
expr_part ::= conditional | assignment
conditional ::= if expr then assignments end
| if expr then assignments else assignments end
assignments ::= assignments assignment | assignment
assignment ::=
VARIABLE := expr;
| all ( "regexp" ) := expr;
expr ::= ( expr )
| NUMBER
| STRING
| BOOLEAN
| VARIABLE
| true
| false
| -expr
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr
| not expr
| expr and expr
| expr or expr
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| has ( variable )
Notes:
- Variables are either all alphanumeric and -/_ (e.g., "ABc_1-2"), any character
apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- The 'all' method applies the value to all the values in the lookup table
that match the regular expression.
- Positions are 1-based.
- 'str' uses java.text.DecimalFormat when supplying a format string
- Variables starting with '_' (inside the [] or '') are considered local and don't get transferred back out.
- The 'has' function checks whether a variable/symbol is present.
classMathematicalExpressionEvaluates mathematical expressions.
The following grammar is used:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| rand () (unseeded double, 0-1)
| rand ( seed ) (seeded double, 0-1)
| randint ( bound ) (unseeded int from 0 to bound-1)
| randint ( seed, bound ) (seeded int from 0 to bound-1)
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| startswith ( str , find ) (checks whether 'str' string starts with 'find' string)
| endswith ( str , find ) (checks whether 'str' string ends with 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classReportMathExpressionEvaluates mathematical expressions on report values.
The following grammar is used:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| rand () (unseeded double, 0-1)
| rand ( seed ) (seeded double, 0-1)
| randint ( bound ) (unseeded int from 0 to bound-1)
| randint ( seed, bound ) (seeded int from 0 to bound-1)
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| startswith ( str , find ) (checks whether 'str' string starts with 'find' string)
| endswith ( str , find ) (checks whether 'str' string ends with 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSpreadSheetFormulaEvaluates mathematical expressions.
The following grammar is used:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
| cell
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr | cell )
| sqrt ( expr | cell )
| log ( expr | cell )
| exp ( expr | cell )
| sin ( expr | cell )
| cos ( expr | cell )
| tan ( expr | cell )
| rint ( expr | cell )
| floor ( expr | cell )
| pow[er] ( expr | cell , expr | cell )
| ceil ( expr | cell )
| sum ( cell1 : cell2 )
| min ( cell1 : cell2 )
| max ( cell1 : cell2 )
| average ( cell1 : cell2 )
| stdev ( cell1 : cell2 )
| stdevp ( cell1 : cell2 )
| countif ( cell1 : cell2 ; expr )
| sumif ( cell1 : cell2 ; expr )
| sumif ( cell1 : cell2 ; expr : sumCell1 : sumCell2 )
| intercept ( cellY1 : cellY2 ; cellX1 : cellX2 )
| slope ( cellY1 : cellY2 ; cellX1 : cellX2 )
| countblank ( cell1 : cell2 )
| year ( expr | cell )
| month ( expr | cell )
| day ( expr | cell )
| hour ( expr | cell )
| minute ( expr | cell )
| second ( expr | cell )
| weekday ( expr | cell )
| weeknum ( expr | cell )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| startswith ( str , find ) (checks whether 'str' string starts with 'find' string)
| endswith ( str , find ) (checks whether 'str' string ends with 'find' string)
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] )
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
;
# obtaining native cell content
| cellobj ( cell )
# obtaining cell content as string
| cellstr ( cell )
Notes:
- Cells are denoted by column in letter and row in digit, e.g., 'C12'.
- 'start' and 'end' for function 'substr' are indices that start at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'.
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g.classSpreadSheetQueryEvaluates spreadsheet subset queries.
The following grammar is used:
expr_list ::= expr_list expr_part | expr_part;
expr_part ::= select | update | delete;
select ::= SELECT col_list [limit]
| SELECT col_list WHERE cond_list [limit]
| SELECT col_list ORDER BY order_list [limit]
| SELECT col_list WHERE cond_list ORDER BY order_list [limit]
| SELECT agg_list
| SELECT agg_list GROUP BY col_list
| SELECT agg_list HAVING cond_list
| SELECT agg_list GROUP BY col_list HAVING cond_list
;
update ::= UPDATE SET upd_list
| UPDATE SET upd_list WHERE cond_list
;
delete ::= DELETE WHERE cond_list
;
col_list ::= col_list COMMA col
| col
| SELECT NUMBER [subsample: <1 = percent; >= 1 number of rows]
;
col ::= *
| COLUMN
| COLUMN AS COLUMN
;
upd_list ::= upd_list COMMA upd | upd;
upd ::= COLUMN = value
;
order_list::= order_list COMMA order | order;
order ::= COLUMN
| COLUMN ASC
| COLUMN DESC
;
cond_list ::= cond_list cond
| cond
;
cond ::= COLUMN < value
| COLUMN <= value
| COLUMN = value
| COLUMN <> value
| COLUMN >= value
| COLUMN > value
| COLUMN REGEXP STRING
| COLUMN IS NULL
| CELLTYPE ( COLUMN ) = "numeric|long|double|boolean|string|time|date|datetime|timestamp|object|missing"
| ( cond )
| cond:c1 AND cond:c2
| cond:c1 OR cond:c2
| NOT cond
;
value ::= NUMBER
| STRING
| PARSE ( "number" , STRING )
| PARSE ( "date" , STRING )
| PARSE ( "time" , STRING )
| PARSE ( "timestamp" , STRING )
;
limit ::= LIMIT NUMBER:max
| LIMIT NUMBER:offset , NUMBER:max
;
agg_list ::= agg_list COMMA agg
| agg
;
agg ::= COUNT [(*)|(COLUMN)] [AS COLUMN]
| MIN ( COLUMN ) [AS COLUMN]
| MAX ( COLUMN ) [AS COLUMN]
| RANGE ( COLUMN ) [AS COLUMN] (= MIN - MAX)
| MEAN ( COLUMN ) [AS COLUMN]
| AVERAGE ( COLUMN ) [AS COLUMN]
| STDEV ( COLUMN ) [AS COLUMN]
| STDEVP ( COLUMN ) [AS COLUMN]
| SUM ( COLUMN ) [AS COLUMN]
| IQR ( COLUMN ) [AS COLUMN]
| INTERQUARTILE ( COLUMN ) [AS COLUMN]
Notes:
- time format: 'HH:mm'
- date format: 'yyyy-MM-dd'
- timestamp format: 'yyyy-MM-dd HH:mm'
- STRING is referring to characters enclosed by double quotes
- COLUMN is either a string with no blanks (consisting of letters, numbers, hyphen or underscore; eg 'MyCol-1') or a bracket enclosed string when containing blanks (eg '[Some other col]')
- columns used in the ORDER BY clause must be present in the SELECT part; also, any alias given to them in SELECT must be used instead of original column name
classStringExpressionEvaluates string expressions.
It uses the following grammar:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr (or: expr <> expr)
# boolean operations
| ! expr (or: not expr)
| expr & expr (or: expr and expr)
| expr | expr (or: expr or expr)
| if[else] ( expr , expr (if true) , expr (if false) )
| ifmissing ( variable , expr (default value if variable is missing) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| year ( expr )
| month ( expr )
| day ( expr )
| hour ( expr )
| minute ( expr )
| second ( expr )
| weekday ( expr )
| weeknum ( expr )
# string functions
| substr ( expr , start [, end] )
| left ( expr , len )
| mid ( expr , start , len )
| right ( expr , len )
| rept ( expr , count )
| concatenate ( expr1 , expr2 [, expr3-5] )
| lower[case] ( expr )
| upper[case] ( expr )
| trim ( expr )
| matches ( expr , regexp )
| trim ( expr )
| len[gth] ( str )
| find ( search , expr [, pos] ) (find 'search' in 'expr', return 1-based position)
| contains ( str , find ) (checks whether 'str' string contains 'find' string)
| startswith ( str , find ) (checks whether 'str' string starts with 'find' string)
| endswith ( str , find ) (checks whether 'str' string ends with 'find' string)
| replace ( str , pos , len , newstr )
| replaceall ( str , regexp , replace ) (applies regular expression to 'str' and replaces all matches with 'replace')
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
# array functions
| len[gth] ( array )
| get ( array , index )
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (e.g., "'Hello World'").
- 'start' and 'end' for function 'substr' are indices that start at 1.
- 'index' for function 'get' starts at 1.
- Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method)
- Line comments start with '#'
- Semi-colons (';') or commas (',') can be used as separator in the formulas,
e.g., 'pow(2,2)' is equivalent to 'pow(2;2)'
- dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss'
- times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss'
- the characters in square brackets in function names are optional:
e.g. -
Uses of OptionHandler in adams.run
Classes in adams.run that implement OptionHandler Modifier and Type Class Description classRunDatabaseSchemeAbstract ancestor for RunSchemes that need to access the database.classRunSchemeAbstract class for running non-commandline schemes from commandline. -
Uses of OptionHandler in adams.scripting
Classes in adams.scripting that implement OptionHandler Modifier and Type Class Description classCommandRunnerExecutes scripting commands. -
Uses of OptionHandler in adams.scripting.command
Subinterfaces of OptionHandler in adams.scripting.command Modifier and Type Interface Description interfaceFlowAwareRemoteCommandInterface for commands that can utilize a flow that is sending this command.interfaceRemoteCommandInterface for remote commands.interfaceRemoteCommandOnFlowInterface for remote commands that operate on a specific flow, identified by its ID.interfaceRemoteCommandWithErrorMessageInterface for commands that support error message.interfaceRemoteCommandWithResponseInterface for remote commands that send a response back to a host.Classes in adams.scripting.command that implement OptionHandler Modifier and Type Class Description classAbstractCommandAncestor for remote commands.classAbstractCommandWithResponseAncestor for commands that send a response.classAbstractFlowAwareCommandAncestor for commands that have a flow context..classAbstractFlowAwareCommandWithResponseAncestor for commands with a response that have flow context.classAbstractRemoteCommandOnFlowWithResponseAncestor for commands that work on flows. -
Uses of OptionHandler in adams.scripting.command.basic
Classes in adams.scripting.command.basic that implement OptionHandler Modifier and Type Class Description classAbstractCommandWithFlowStoppingAncestor for commands that stop flows.classKillKills the remote ADAMS instance.classPingRequests an 'am alive' signal from the remote host.classRestartAttempts to restart the remote ADAMS instance.classRetrieveFileRetrieves a file as binary blob.classSendFileSends a file as binary blob.classStartRemoteLoggingStarts remote logging.classStopAttempts to stop the remote ADAMS instance.classStopEngineSimply stops the scripting engine, either the one handling the request or the response.classStopRemoteLoggingStops remote logging.classSystemInfoSends the system info of the remote host back.classTextJust sends some text. -
Uses of OptionHandler in adams.scripting.command.distributed
Classes in adams.scripting.command.distributed that implement OptionHandler Modifier and Type Class Description classDeregisterWorkerDeregisters aWorkerScriptingEnginefrom a main.classJobRunnerEncapsulates a JobRunner.classKillWorkersKills allWorkerScriptingEnginethat are registered with the main engine receiving this message.classRegisterWorkerRegisters aWorkerScriptingEnginewith a main engine. -
Uses of OptionHandler in adams.scripting.command.flow
Classes in adams.scripting.command.flow that implement OptionHandler Modifier and Type Class Description classGetFlowRetrieves a running/registered flow using its ID.classListFlowsSends a list of registered running flows back.classRemoteFlowExecutionAllows the remote execution of flows, including the transfer of storage items from the flow triggering the remote execution.classRestartFlowRestarts a registered flow via its ID.classRunRemoteFlowLoads and runs a flow on a remote server.classSendFlowControlCommandSends a control command to a flow (pause/resume/stop/start). -
Uses of OptionHandler in adams.scripting.command.gui
Classes in adams.scripting.command.gui that implement OptionHandler Modifier and Type Class Description classMenuItemLaunches the specified menu item on the remote machine. -
Uses of OptionHandler in adams.scripting.connection
Subinterfaces of OptionHandler in adams.scripting.connection Modifier and Type Interface Description interfaceConnectionInterface for class that handle connections for remote commands.Classes in adams.scripting.connection that implement OptionHandler Modifier and Type Class Description classAbstractConnectionAncestor for connections.classAbstractConnectionEnhancerAncestor connections that enhance a base connection.classAbstractMultiConnectionAncestor for connection classes that manage multiple base connections.classAbstractSSHConnectionAncestor of connection schemes that use an SSH tunnel to connect to the remote scripting engine.classAbstractSSHConnectionWithPortForwardingAncestor of connection schemes that use an SSH tunnel to connect to the remote scripting engine.classDefaultConnectionSends the command to the specified host:port.classFTPConnectionUses FTP to send commands.classLoadBalancerBalances the handling of commands among several connections.classMulticastSends the same command to all connections.classScpConnectionCopies the command as file to the remote host into the specified directory.classSSHConnectionUses an SSH tunnel to connect to the remote scripting engine. -
Uses of OptionHandler in adams.scripting.engine
Subinterfaces of OptionHandler in adams.scripting.engine Modifier and Type Interface Description interfaceJobQueueHandlerInterface for scripting engines that manage a job queue.interfaceMainScriptingEngineInterface for scripting engines that manage worker scripting engines and sending them jobs for execution.interfaceRemoteScriptingEngineScripting engine for remote commands.Classes in adams.scripting.engine that implement OptionHandler Modifier and Type Class Description classAbstractRemoteCommandHandlerAncestor for classes that handle remote commands within a scripting engine.classAbstractScriptingEngineAncestor of scripting engine for remote commands.classAbstractScriptingEngineEnhancerAncestor for scripting engines that enhance a base one.classAbstractScriptingEngineWithJobQueueAncestor for scripting engines that manage a job queue to restrict executions.classDefaultMainScriptingEngineManages worker scripting engines and sends them jobs for execution.static classDefaultMainScriptingEngine.RemoteCommandGrabberHandles the registering/deregistering of workers.classDefaultRemoteCommandHandlerDefault handler for remote commands.classDefaultScriptingEngineDefault implementation of scripting engine for remote commands.classDefaultWorkerScriptingEngineRegisters itself with a main engine for executing jobs.classFileBasedScriptingEngineScripting engine that reads remote commands from disk.classForwardingScriptingEngineSimply forwards incoming commands to the specified connection.static classForwardingScriptingEngine.RemoteCommandGrabberSimply used to grab the remote commands from the base scripting engine.classManualFeedScriptingEngineScripting engine that gets commands fed programmatically.classMultiScriptingEngineManages multiple scripting engines. -
Uses of OptionHandler in adams.scripting.permissionhandler
Classes in adams.scripting.permissionhandler that implement OptionHandler Modifier and Type Class Description classAbstractPermissionHandlerAncestor for permission handlers.classAllowAllAllows all commands.classRejectAllRejects all commands. -
Uses of OptionHandler in adams.scripting.processor
Classes in adams.scripting.processor that implement OptionHandler Modifier and Type Class Description classAbstractRemoteCommandProcessorAncestor for processors for remote commands.classDefaultProcessorProcessors for simple remote command format.classJsonProcessorProcessor for remote commands in JSON format. -
Uses of OptionHandler in adams.scripting.requesthandler
Classes in adams.scripting.requesthandler that implement OptionHandler Modifier and Type Class Description classAbstractRequestHandlerAncestor for request handlers.classCallableActorsHandlerForwards the requests to the specified (optional) callable actor..classCommandDumperHandlerSaves requests as command files.classLoggingHandlerOutputs request using the logger.classMultiHandlerCombines multiple handlers.classNullHandlerDoes nothing.classSimpleLogPanelRequestHandlerFor logging requests. -
Uses of OptionHandler in adams.scripting.responsehandler
Classes in adams.scripting.responsehandler that implement OptionHandler Modifier and Type Class Description classAbstractResponseHandlerAncestor for response handlers.classCallableActorsHandlerForwards the responses to the specified (optional) callable actor..classCommandDumperHandlerSaves the responses as command files.classLoggingHandlerOutputs the responses using the logger.classMultiHandlerCombines multiple handlers.classNullHandlerDoes nothing.classSimpleLogPanelResponseHandlerFor logging responses. -
Uses of OptionHandler in adams.terminal.application
Classes in adams.terminal.application that implement OptionHandler Modifier and Type Class Description classAbstractTerminalApplicationAncestor for terminal-based applications. -
Uses of OptionHandler in adams.tools
Classes in adams.tools that implement OptionHandler Modifier and Type Class Description classAbstractAddRemoveTimeWindowDatabaseToolAncestor for tools that add or remove stuff in the database.classAbstractDatabaseToolAbstract ancestor for tools that need database access.classAbstractScriptAncestor for tool scripts.classAbstractScriptedToolAbstract ancestor for filters that execute external scripts.classAbstractTimeWindowDatabaseToolAbstract ancestor for database tools that act within a time frame.classAbstractToolAn abstract class for general commandline-handling classes.classCompareDatasetsCompares two datasets, either row-by-row or using a row attribute listing a unique ID for matching the rows, outputting the correlation coefficient of the numeric attributes found in the ranges defined by the user.
In order to trim down the number of generated rows, a threshold can be specified.classDropTablesDrops all tables that match a regular expression (matching sense can be inverted).classGroovyA report filter that uses a Groovy script for processing the data.classInitializeTablesMakes sure that all tables exist and are initialized.classRunToolRuns a tool from commandline.classScriptedA tool that uses any scripting handler for processing the data with a script located in the specified file.classTableUpgradeTool for running a specific table upgrade.classTruncateTablesTruncates all tables that match a regular expression (matching sense can be inverted).classZipPasswordAttempts to determine the password of a password protected ZIP file.
If no dictionary file has been provided, a brute force attack is carried out.
The brute force attack can be run in parallel, default is two threads.
The dictionary approach also tests lower/upper case version of the passwords and the reverse of them. -
Uses of OptionHandler in weka.classifiers
Subinterfaces of OptionHandler in weka.classifiers Modifier and Type Interface Description interfaceCrossValidationFoldGeneratorInterface for generating cross-validation folds.interfaceRandomSplitGeneratorInterface for generators of random splits of datasets.interfaceSplitGeneratorInterface for helper classes that generate dataset splits.Classes in weka.classifiers that implement OptionHandler Modifier and Type Class Description classAbstractSplitGeneratorAncestor for helper classes that generates dataset splits.classBestBinnedNumericClassRandomSplitGeneratorPicks the best binning algorithm from the provided ones.classBinnedNumericClassCrossValidationFoldGeneratorHelper class for generating cross-validation folds.classBinnedNumericClassRandomSplitGeneratorGenerates random splits of datasets with numeric classes using a binning algorithm.classDefaultCrossValidationFoldGeneratorHelper class for generating cross-validation folds.classDefaultRandomSplitGeneratorGenerates random splits of datasets.classGroupedBinnedNumericClassCrossValidationFoldGeneratorHelper class for generating cross-validation folds.classGroupedBinnedNumericClassRandomSplitGeneratorGenerates random splits of datasets with numeric classes using a binning algorithm.classGroupedCrossValidationFoldGeneratorHelper class for generating cross-validation folds.classGroupedCrossValidationFoldGeneratorUsingNumericClassValuesHelper class for generating cross-validation folds.
Uses the string representation of the numeric class values as grouping.classGroupedRandomSplitGeneratorGenerates random splits of datasets, making sure that groups of instances stay together (identified via a regexp).classLeaveOneOutByValueGeneratorGenerates train/test split pairs using the unique values from the specified attribute.classMultiLevelSplitGeneratorGenerates splits based on groups extracted via regular expressions. -
Uses of OptionHandler in weka.classifiers.functions
Classes in weka.classifiers.functions that implement OptionHandler Modifier and Type Class Description classFromPredictionsEncapsulates predictions from a spreadsheet. -
Uses of OptionHandler in weka.classifiers.meta.socketfacade
Classes in weka.classifiers.meta.socketfacade that implement OptionHandler Modifier and Type Class Description classAbstractDataPreparationAncestor for classes that prepare data for theSocketFacadeclassifier.classSimpleSimple preparation scheme, using JSON with the actual data in CSV format. -
Uses of OptionHandler in weka.classifiers.simple
Classes in weka.classifiers.simple that implement OptionHandler Modifier and Type Class Description classAbstractSimpleClassifierAncestor for classifiers using ADAMS option handling. -
Uses of OptionHandler in weka.classifiers.trees
Classes in weka.classifiers.trees that implement OptionHandler Modifier and Type Class Description classXGBoostClassifier implementing XGBoost. -
Uses of OptionHandler in weka.core
Classes in weka.core that implement OptionHandler Modifier and Type Class Description classAbstractSimpleOptionHandlerAncestor for Weka classes that use the ADAMS option handling framework.Methods in weka.core that return OptionHandler Modifier and Type Method Description static OptionHandlerWekaOptionUtils. parse(String[] options, char option, OptionHandler defValue)Parses an adams.core.option.OptionHandler option, uses default if option is missing.static OptionHandlerWekaOptionUtils. parse(String[] options, String option, OptionHandler defValue)Parses an adams.core.option.OptionHandler option, uses default if option is missing.Methods in weka.core with parameters of type OptionHandler Modifier and Type Method Description static voidWekaOptionUtils. add(List<String> options, char option, OptionHandler value)Adds the adams.core.option.OptionHandler to the options.static voidWekaOptionUtils. add(List<String> options, String option, OptionHandler value)Adds the adams.core.option.OptionHandler to the options.static OptionHandlerWekaOptionUtils. parse(String[] options, char option, OptionHandler defValue)Parses an adams.core.option.OptionHandler option, uses default if option is missing.static ObjectWekaOptionUtils. parse(String[] options, char option, OptionHandler[] defValue, Class cls)Parses an adams.core.option.OptionHandler array option, uses default if option is missing.static OptionHandlerWekaOptionUtils. parse(String[] options, String option, OptionHandler defValue)Parses an adams.core.option.OptionHandler option, uses default if option is missing.static ObjectWekaOptionUtils. parse(String[] options, String option, OptionHandler[] defValue, Class cls)Parses an adams.core.option.OptionHandler array option, uses default if option is missing. -
Uses of OptionHandler in weka.filters.unsupervised.attribute.detrend
Classes in weka.filters.unsupervised.attribute.detrend that implement OptionHandler Modifier and Type Class Description classAbstractDetrendAncestor for schemes that perform detrend.classMeanPerforms the correction using simply the mean.classRangeBasedPerforms the correction using slopes/intercepts calculated for the defined ranges. -
Uses of OptionHandler in weka.filters.unsupervised.attribute.multiplicativescattercorrection
Classes in weka.filters.unsupervised.attribute.multiplicativescattercorrection that implement OptionHandler Modifier and Type Class Description classAbstractMultiplicativeScatterCorrectionAncestor for correction schemes.classRangeBasedPerforms the correction using slopes/intercepts calculated for the defined ranges.
-