Package pulse.input

Class ExperimentalData

  • All Implemented Interfaces:
    Serializable, DiscreteInput, Descriptive
    public class ExperimentalData
extends AbstractData
implements DiscreteInput

    An ExperimentalData object is essentially a AbstractData with adjustable range and linked Metadata. It is used to store experimental data points loaded with one of the available CurveReaders. Any manipulation (e.g. truncation) of the data triggers an event associated with this ExperimentalData.

    See Also:
    Serialized Form

    • Field Detail

      • CUTOFF_FACTOR

        public static final double CUTOFF_FACTOR
        This is the cutoff factor which is used as a criterion for data truncation. Described in Lunev, A., & Heymer, R. (2020). Review of Scientific Instruments, 91(6), 064902.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ExperimentalData

        public ExperimentalData()
        Constructs an ExperimentalData object using the superclass constructor and creating a new list of data listeners. The number of points is set to zero by default, and a new IndexRange is initialized.

    • Method Detail

      • addDataListener

        public final void addDataListener​(DataListener listener)

      • clearDataListener

        public final void clearDataListener()

      • fireDataChanged

        public final void fireDataChanged​(DataEvent dataEvent)

      • resetRanges

        public final void resetRanges()
        Calls reset for both the IndexRange and Range objects using the current time sequence.

      • addPoint

        public void addPoint​(double time,
                     double signal)
        Adds time and temperature to the respective Lists. Increments the counter of points. Note that no baseline correction is performed.
        Overrides:
        addPoint in class AbstractData
        Parameters:
        time - the next time value
        signal - the next signal value

      • getMetadata

        public Metadata getMetadata()
        Retrieves the Metadata object for this ExperimentalData.
        Returns:
        the linked Metadata

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class AbstractData
        Returns:
        true only if o is an AbstractData containing all the elements of the time and signal lists of this object.

      • isAcquisitionTimeSensible

        public boolean isAcquisitionTimeSensible()
        Checks if the acquisition time used to collect this ExperimentalData is sensible.

        The acquisition time is essentially the last element in the time List. By default, it is deemed sensible if that last element is less than 7.2*halfRiseTime.

        Returns:
        true if the acquisition time is below the truncation threshold, false otherwise.

      • truncate

        public void truncate()
        Truncates the range and indexRange of this ExperimentalData above a certain threshold, NOT removing any data elements.

        The threshold is calculated based on the halfRiseTime value and is set by default to 7.2*halfRiseTime. A DataEvent will be created and passed to the dataListeners (if any) with the DataEventType.TRUNCATED as argument.

        See Also:
        halfRiseTime, DataEvent, fireDataChanged(pulse.input.listeners.DataEvent)

      • setMetadata

        public void setMetadata​(Metadata metadata)
        Sets a new Metadata object for this ExperimentalData.

        The pulseWidth property recorded in Metadata will be used to set the time range for the reverse problem solution. Whenever this property is changed in the metadata, a listener will ensure an updated range is used.

        Parameters:
        metadata - the new Metadata object
        See Also:
        PropertyHolderListener

      • getEffectiveStartTime

        public double getEffectiveStartTime()
        Gets the time sequence element corresponding to the lower bound of the index range
        Returns:
        the time (in seconds) associated with indexRange.getLowerBound()

      • getEffectiveEndTime

        public double getEffectiveEndTime()
        Gets the time sequence element corresponding to the upper bound of the index range
        Returns:
        the time (in seconds) associated with indexRange.getUpperBound()

      • getRange

        public Range getRange()
        Gets the dimensional time Range of this data.
        Returns:
        the range

      • setRange

        public void setRange​(Range range)
        Sets the range, assigning this to its parent, and forcing changes to the indexRange.
        Parameters:
        range - the range

      • timeLimit

        public double timeLimit()
        Retrieves the time limit.
        Overrides:
        timeLimit in class AbstractData
        Returns:
        a double, equal to the last element of the time List.
        See Also:
        DifferenceScheme

      • preprocess

        public void preprocess()