Package pulse.tasks

Class SearchTask

  • All Implemented Interfaces:
    Serializable, Runnable, Descriptive
    public class SearchTask
extends GeneralTask
    A SearchTask is the most important class in PULsE. It combines access to all other bits and can be executed by the TaskManager. The execution consists in solving the reverse problem of heat conduction, which is done using the PathSolver. A SearchTask has an associated ExperimentalData object linked to it.
    See Also:
    TaskManager, Serialized Form

    • Constructor Detail

      • SearchTask

        public SearchTask​(ExperimentalData curve)

        Creates a new SearchTask from curve. Generates a new Identifier, sets the parent of curve to this, and invokes clear(). If any changes to the ExperimentalData occur, a listener will ensure the DifferenceScheme is modified accordingly.

        Parameters:
        curve - the ExperimentalData

    • Method Detail

      • clear

        public void clear()

        Resets everything to default values (for a list of default values please see the .xml document. Sets the status of this task to INCOMPLETE. curve.addDataListener(dataEvent -> { var scheme = current.getScheme(); if (scheme != null) { var curve = current.getProblem().getHeatingCurve(); var startTime = (double) curve.getTimeShift().getValue(); scheme.setTimeLimit(derive(TIME_LIMIT, RELATIVE_TIME_MARGIN * curve.timeLimit() - startTime)); } });

      • removeTaskListeners

        public void removeTaskListeners()

      • removeStatusChangeListeners

        public void removeStatusChangeListeners()

      • setExperimentalCurve

        public void setExperimentalCurve​(ExperimentalData curve)
        Adopts the curve by this SearchTask.
        Parameters:
        curve - the ExperimentalData.

      • checkProblems

        public void checkProblems()

        Checks if this SearchTask is ready to be run.Performs basic check to see whether the user has uploaded all necessary data. If not, will create a status update with information about the missing data.

        Status will be set to READY if the task is ready to be run, DONE if has already been done previously, INCOMPLETE if some problems exist. For the latter, additional details will be available using the status.getDetails() method.

      • getIdentifier

        public Identifier getIdentifier()

      • getLog

        public Log getLog()

      • run

        public void run()
        Description copied from class: GeneralTask

        Runs this task if is either READY or QUEUED. Otherwise, will do nothing. After making some preparatory steps, will initiate a loop with successive calls to PathSolver.iteration(this), filling the buffer and notifying any data change listeners in parallel. This loop will go on until either converging results are obtained, or a timeout is reached, or if an execution error happens. Whether the run has been successful will be determined by comparing the associated R2 value with the SUCCESS_CUTOFF.

        Specified by:
        run in interface Runnable
        Overrides:
        run in class GeneralTask

      • terminate

        public void terminate()
        If the current task is either IN_PROGRESS, QUEUED, or READY, terminates it by setting its status to TERMINATED. This change of status will then force the run() loop to stop (if running).

      • initNormalityTest

        public void initNormalityTest()

      • initCorrelationTest

        public void initCorrelationTest()

      • storeCalculation

        public void storeCalculation()

      • switchTo

        public void switchTo​(Calculation calc)

      • findBestCalculation

        public Calculation findBestCalculation()
        Finds the best calculation by comparing those already stored by their model selection statistics.
        Returns:
        the calculation showing the optimal value of the model selection statistic.

      • switchToBestModel

        public void switchToBestModel()

      • intermediateProcessing

        public void intermediateProcessing()
        Description copied from class: GeneralTask
        Override this to add intermediate processing of results e.g. with a correlation test.
        Overrides:
        intermediateProcessing in class GeneralTask

      • onSolverException

        public void onSolverException​(SolverException e)
        Description copied from class: GeneralTask
        Specifies what should be done when a solver exception is encountered. Empty by default
        Overrides:
        onSolverException in class GeneralTask
        Parameters:
        e - a solver exception

      • searchVector

        public ParameterVector searchVector()
        Generates a search vector (= optimisation vector) using the search flags set by the PathSolver.
        Specified by:
        searchVector in class GeneralTask
        Returns:
        an IndexedVector with search parameters of this SearchTaks

      • assign

        public void assign​(ParameterVector searchParameters)
            throws SolverException
        Assigns the values of the parameters of this SearchTask to searchParameters.
        Specified by:
        assign in class GeneralTask
        Parameters:
        searchParameters - an IndexedVector with relevant search parameters
        Throws:
        SolverException

      • postProcessing

        public void postProcessing()
        Description copied from class: GeneralTask
        Override this to add post-processing checks e.g. normality tests or range checking.
        Overrides:
        postProcessing in class GeneralTask

      • activeParameters

        public List<NumericPropertyKeyword> activeParameters()
        Finds what properties are being altered in the search of this SearchTask.
        Specified by:
        activeParameters in class GeneralTask
        Returns:
        a List of property types represented by NumericPropertyKeywords

      • setStatus

        public boolean setStatus​(Status status)
        Will return true if status could be updated.
        Parameters:
        status - the status of the task
        Returns:
        true if status has been updated. false if the status was already set to status previously, or if it could not be updated at this time.

      • getStatus

        public Status getStatus()

      • set

        public void set​(NumericPropertyKeyword type,
                NumericProperty property)
        Description copied from class: Accessible

        An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

        Specified by:
        set in class Accessible
        Parameters:
        type - the type, which must be equal by definition to property.getType().
        property - the property, which contains new information.

      • equals

        public boolean equals​(Object o)
        A SearchTask is deemed equal to another one if it has the same ExperimentalData.
        Overrides:
        equals in class Object

      • describe

        public String describe()
        Description copied from class: UpwardsNavigable
        Uses the SearchTask id (if present) to describe this UpwardsNavigable.
        Specified by:
        describe in interface Descriptive
        Overrides:
        describe in class UpwardsNavigable
        Returns:
        by default, this will return the name of the implementing class and the date of the calculation.