UserLab CreateFeature: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
(Created page with "{{Docnav |New Simulation |SeismicLab Workbench |UserLab |IconL=UserLab_CreateSimulation.svg |IconR=Workbench_SeismicLab.svg |IconC=Workbench_UserLab.svg }} {{GuiCommand |Name=UserLab Features |MenuLocation=UserLab → UserLab Features.. |Phenomena=UserLab |SeeAlso=UserLab tutorial }} ==Description== The UserLab Features command allows to create new U...")
 
No edit summary
 
Line 1: Line 1:
{{Docnav
{{Docnav
|[[UserLab_CreateSimulation|New Simulation]]
|[[UserLab_CreateSimulation|New Simulation]]
|[[SeismicLab_Workbench|SeismicLab Workbench]]
|[[UserLab_Simulation_Start|Start]]
|[[UserLab_Workbench|UserLab]]
|[[UserLab_Workbench|UserLab]]
|IconL=UserLab_CreateSimulation.svg
|IconL=UserLab_CreateSimulation.svg
|IconR=Workbench_SeismicLab.svg
|IconR=UserLab_Simulation_Start.svg
|IconC=Workbench_UserLab.svg
|IconC=Workbench_UserLab.svg
}}
}}
Line 62: Line 62:
{{Docnav
{{Docnav
|[[UserLab_CreateSimulation|New Simulation]]
|[[UserLab_CreateSimulation|New Simulation]]
|[[SeismicLab_Workbench|SeismicLab Workbench]]
|[[UserLab_Simulation_Start|Start]]
|[[UserLab_Workbench|UserLab]]
|[[UserLab_Workbench|UserLab]]
|IconL=UserLab_CreateSimulation.svg
|IconL=UserLab_CreateSimulation.svg
|IconR=Workbench_SeismicLab.svg
|IconR=UserLab_Simulation_Start.svg
|IconC=Workbench_UserLab.svg
|IconC=Workbench_UserLab.svg
}}
}}

Latest revision as of 17:00, 22 December 2024

Arrow-left.svg Previous: UserLab CreateSimulation.svg New Simulation
Next: Start UserLab Simulation Start.svg Arrow-right.svg

UserLab Features

Menu location
UserLab → UserLab Features..
Phenomena
UserLab
Default shortcut
None
Introduced in version
-
See also
UserLab tutorial

Description

The UserLab Features command allows to create new UserLab Feature and add it to a simulatiion.

Usage

  1. There are several ways to invoke the command:
    • Press the UserLab CreateFeature.svg Create Feature button.
    • Select the UserLab → UserLab CreateFeature.svg Create Feature option from the menu.
  2. A new feature is created and added to its parent simulation.

Properties

Every UserLab Feature has the following properties:

  • DataIsActive: Whether this feature is active or not.
  • DataAuthor: The name of the person that implements the feature.
  • DataVersion: The version of this feature.
  • DataAPIVersion: The version of the API used to implement this feature.
  • DataReleaseDate: The date when this feature has been release for the first time.
  • DataFeatureType: The feature type this feature belongs to.
  • DataFeatureGroup: The feature group this feature belongs to.
  • DataPublicationAuthor: The name of the author that publishes this feature.
  • DataPublicationTopic: The publication topic of the article in which this feature was published.
  • DataPublicationDate: The publication date of the article in which this feature was published.
  • DataLinkToPublication: The internet link to the article in which this feature was published.
  • DataPluginVersion: The version of the plugin in which the feature is implemented.
  • DataPluginName: The name of the plugin in which the feature is implemented.
  • DataSimulation: The name of the simulation where the feature is created.
  • DataIsStationary: Whether this feature is stationary or not (time dependent).
  • DataIsUniformlyModulated: Whether this feature should be uniformly modulated or not. This is useful in case of non-stationarity.

Scripting

  • Create new feature and add it to an existing simulation.
import UserLabObjects
import LabRPS
doc = LabRPS.newDocument()
sim = UserLabObjects.makeSimulation(doc, "MySimulation")
newFeature = UserLabObjects.makeFeature("MyNewFeatureName", "MySimulation",  "FeatureType", "FeatureGroup")


Arrow-left.svg Previous: UserLab CreateSimulation.svg New Simulation
Next: Start UserLab Simulation Start.svg Arrow-right.svg