Package pulse.input

Class Metadata

  • All Implemented Interfaces:
    Serializable, Descriptive, Reflexive
    public class Metadata
extends PropertyHolder
implements Reflexive

    Metadata is the information relating to a specific experiment, which can be used by a SearchTask to process an instance of ExperimentalData. It is used to populate the associated Problem, DifferenceScheme, and Range of the ExperimentalData.

    See Also:
    Serialized Form

    • Constructor Detail

      • Metadata

        public Metadata​(NumericProperty temperature,
                int externalId)
        Creates a Metadata with the specified parameters and a default rectangular pulse shape. Properties are stored in a TreeSet.
        Parameters:
        temperature - the NumericProperty of the type NumericPropertyKeyword.TEST_TEMPERATURE
        externalId - an integer, specifying the external ID recorded by the experimental setup.

    • Method Detail

      • getExternalID

        public int getExternalID()
        Gets the external ID usually specified in the experimental files. Note this is not a NumericProperty
        Returns:
        an integer, representing the external ID

      • getPulseDescriptor

        public InstanceDescriptor<? extends PulseTemporalShape> getPulseDescriptor()
        Retrieves the pulse shape recorded in this Metadata
        Returns:
        a PulseShape object

      • getSampleName

        public SampleName getSampleName()
        Retrieves the sample name. This name is used to create directories when exporting the data and also to fill the legend when plotting.
        Returns:
        the sample name

      • setSampleName

        public void setSampleName​(SampleName sampleName)
        Sets the sample name property.
        Parameters:
        sampleName - the sample name

      • getPulseData

        public final NumericPulseData getPulseData()
        If a Numerical Pulse has been loaded (for example, when importing from Proteus), this will return an object describing this data.
        Returns:

      • set

        public void set​(NumericPropertyKeyword type,
                NumericProperty property)
        If type is listed by this Metadata, will attempt to either set a value to the property belonging to this Metadata and identified by type or add property to the internal repository of this Metadata. Triggers firePropertyChanged upon successful completion.
        Specified by:
        set in class Accessible
        Parameters:
        type - the type to be searched for
        property - a property with the type specified by its first argument. The value of this property will be used to update its counterpart in this Metadata. The signature of this method is dictated by the use of Reflection API.
        Throws:
        IllegalArgumentException - if the types of the arguments do not match or if property is not a listed parameter

      • listedTypes

        public List<Property> listedTypes()
        The listed types include TEST_TEMPERATURE, THICKNESS, DIAMETER, PULSE_WIDTH, SPOT_DIAMETER, LASER_ENERGY, DETECTOR_GAIN, DETECTOR_IRIS, sample name and the types listed by the pulse descriptor.
        Overrides:
        listedTypes in class PropertyHolder
        Returns:
        a list of Property instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

      • listedKeywords

        public Set<NumericPropertyKeyword> listedKeywords()
        Description copied from class: PropertyHolder

        By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

        Overrides:
        listedKeywords in class PropertyHolder
        Returns:
        a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

      • data

        public List<Property> data()
        Creates a list of data that contain all NumericProperty objects belonging to this Metadata and an InstanceDescriptor relating to the pulse shape.
        Overrides:
        data in class PropertyHolder
        Returns:
        a list of data, which combines generic and numeric properties.

      • identify

        public Identifier identify()
        Description copied from class: UpwardsNavigable
        Retrieves the Identifier of the SearchTaks this UpwardsNavigable belongs to.
        Overrides:
        identify in class UpwardsNavigable
        Returns:
        If this Metadata is NOT assigned to a SearchTask, returns a new Identifier based on the externalID. Otherwise, calls super.identify().