Measurement: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
VisualWikitext
m (Nathalie moved page Measurements to Measurement)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
Measurements can either be standard or enumerated. The process to create/edit the two types is slightly different. This page describes both.
== Creating & Editing Measurements ==
== Creating & Editing Measurements ==
To create a Measurement, select Measurement under the Create > Logical dropdown menu.
To create a Measurement, select the corresponding option from the Create > Logical dropdown menu.


[[File:Phenom-data model-details meas create.png|1200px|border]]
[[File:Phenom-data model-details meas create.png|1200px|border]]


There are a few requirements for a Measurement, it needs to have:
There are a few requirements to create a Measurement, it needs to have:
* A unique name
* A unique name
* An observable
* An observable
* A Measurement system
* A Measurement system
* At least one Measurement Axis
* At least one Measurement Axis
When filling in the creation form, the user needs to choose:
=== Enumerated Measurement ===
Is this Measurement an Enumeration? If this toggle is set to "Yes", the Measurement is automatically set to "AbstractDiscreteSetMeasurementSystem".
[[File:Phenom-data model-details meas create enum.png|1000px|border]]


=== Observable ===
=== Observable ===
Line 34: Line 28:
A Measurement must have as many Measurement Axes as are included in the selected Measurement System. This constraint is only applied on save so while editing, the block to the right of the dropdown provides an indication as to how the user is doing.
A Measurement must have as many Measurement Axes as are included in the selected Measurement System. This constraint is only applied on save so while editing, the block to the right of the dropdown provides an indication as to how the user is doing.


The user can either select an existing Measurement Axis or select <New> to create a new one. In either case, once a selection has been made, a new collapsible block will be displayed. The user can then create/edit the Measurement Axis directly from there, more details on this panel is provided below. The user can also open the Measurement Axis details page and remove it from the list.
The user can either select an existing Measurement Axis or select <New> to create a new one. In either case, once a selection has been made, a new collapsible block will be displayed. The user can also open the Measurement Axis details page and remove it from the list.


[[File:Phenom-data model-details meas create meas axis.png|1000px|border]]
[[File:Phenom-data model-details meas create meas axis.png|1000px|border]]


=== Platform Types ===
==== New Measurement Axis ====
This section is not editable. Once the Measurement is created, the table will be filled in with Platform Types realizing the Measurement.
After selecting <New> from the Measurement Axis dropdown, the user can fill in the creation form. The user must provide a unique name and a Measurement System Axis, the other fiels are optional.
 
[[File:Phenom-data model-details meas create ptf types.png|1000px|border]]
 
=== Conversions ===
This section is not editable. Once the Measurement is created, the table will be filled in with Conversions which source or target is the selected Measurement.


== Creating & Editing Measurement Axes ==
[[File:Phenom-data model-details meas create new meas axis.png|1000px|border]]
Requirements for Measurement Axis:


Unique name,
==== Measurement System Axis ====
Measurement system axis
The user must select a Measurement System Axis. Only Measurement System Axes referenced by the Measurement System selected above on the Measurement page are available in the dropdown.
Value Type,
If the user selects an existing System Axis that includes a Measurement System Axis not referenced by the Measurement System, an error will be displayed.
Unit
Adding a Measurement Axis:
On the Measurement page, you can:


add an existing Measurement Axis.
[[File:Phenom-data model-details meas create meas syst axis mismatch.png|1000px|border]]
create a new Measurement Axis
or do a combination of both.
(Note: the number of Measurement Axes must match the number of Measurement System Axes)


==== Value Type Unit ====
The user may add one or more Value Type Unit(s) to the Measurement Axis. To create a Value Type Unit, the user must select a Value Type and a Unit. Constraints are optional and the user may choose and existing one or create a new one. Constraint creation is detailed [[Constraints|here]].


[[File:Phenom-data model-details meas constraint.png|1000px|border]]


Removing a Measurement Axis:
=== Platform Types ===
You can remove a Measurement Axis by clicking the X. You will need to click SAVE in the upper right to commit this change.
This section is not editable. Once the Measurement is created, the table will be filled in with Platform Types realizing the Measurement.


[[File:Phenom-data model-details meas create ptf types.png|1000px|border]]


=== Conversions ===
This section is not editable. Once the Measurement is created, the table will be filled with Conversions which source or target is the selected Measurement.


Toggling Value Type Unit:
[[File:Phenom-data model-details meas create conversions.png|1000px|border]]
The Value Type Unit can be toggled on and off by clicking its name.
 
 
 
Removing Value Type Unit:
Clicking on the circled-X (blue circle) will remove the Value Type Unit. You will need to click SAVE in the upper right to commit this change.
 
 
 
Choosing a Constraint:
As you select a Value Type and a Unit, the Constraint list will be populated with existing constraints that match the value type and unit combination.
 
 
 
Adding a new Constraint
When creating a new Constraint, it will be added to the other constraint lists as well.
 
 
 
Saving
When all desired fields are filled in, click on SAVE in the upper right corner
 
 


== Creating & Editing Enumerated Measurements ==
== Creating & Editing Enumerated Measurements ==
Requirements for Enumerated Measurement:
The process for creating and editing an Enumerated Measurement is similar to that of a standard Measurement. Below are detailed the differences.


Unique name for measurement
=== Measurement System ===
Unique name for measurement axis
The Measurement System is automatically set to "AbstractDiscreteSetMeasurementSystem".
Observable
At least one EnumerationLabel (or allowed value)
Cannot change Measurement System:
When creating an Enumerated Measurement, AbstractDiscreteSetMeasurementSystem will be selected. Currently phenom does not support a different measurement system for enumerated measurements.


[[File:Phenom-data model-details meas create enum.png|1000px|border]]


=== Enumerated Measurement Axis ===
The user needs to create a new Enumerated Measurement Axis. This new Measurement Axis has an extra field: LDM Measurement Labels.


Editing allowed values (Enumeration Label):
[[File:Phenom-data model-details meas create enum meas axis.png|1000px|border]]
 
The values that appear in the list display the realized Enumeration Labels. The values can be edited but the SAVE button must be clicked to fully commit the change.
 
The pencil icon will allow editing.
The check icon will lock the row from editing.
The X icon will remove the corresponding value from the list.
Selecting unrealized values (Enumeration Label):
 


If an unrealized value exist, it will appear in this list. You can click any of these values to add it.
An Enumerated Measurement Axis must have a Value Type Unit. Selecting a Value Type and a Constraint add the measurement labels specified by the Constraint and populate the list of existing labels with the remaining ones from the Value Type.


Creating a new value (Enumeration Label):
The user can add either a new label or an existing one from the list. If a new label is added with the same name as an existing label, a dialog will pop up warning that a name collision has been detected.


[[File:Phenom-data model-details meas create enum meas axis name collision.png|1000px|border]]


Clicking Add New Value will create an empty row. This will create a new Enumeration Label and add an additional value to Allowed Values.
A label can be reordered by dragging and dropping its row to a different position.


Saving
If the user doesn't specify a Value Type and/or a Constraint, they will be automatically created upon save using the list of labels the user added.
When all desired fields are filled in, click on SAVE in the upper right corner

Latest revision as of 13:35, 26 September 2022

Measurements can either be standard or enumerated. The process to create/edit the two types is slightly different. This page describes both.

Creating & Editing Measurements

To create a Measurement, select the corresponding option from the Create > Logical dropdown menu.

There are a few requirements to create a Measurement, it needs to have:

  • A unique name
  • An observable
  • A Measurement system
  • At least one Measurement Axis

Observable

The user must choose an Observable from the dropdown. Once selected, its characteristics will be displayed. Clicking the icon in the top right corner of the box will redirect the user to the details page of the element. By clicking on the link, the user will be redirected to the new page and lose all unsaved changes.

To reset the field, the user can click on the round arrow on the right of the drop down field.

Measurement System

A Measurement must have a Measurement System. When the user selects a Measurement System from the dropdown, its characteristics will be displayed: Measurement System Axis/Axes, Coordinate System, and Coordinate System Axis/Axes. Clicking the icon in the top right corner of each box will redirect the user to the details page of the element. By clicking on the link, the user will be redirected to the new page and lose all unsaved changes.

To reset the field, the user can click on the round arrow on the right of the drop down field.

Measurement Axis

A Measurement must have as many Measurement Axes as are included in the selected Measurement System. This constraint is only applied on save so while editing, the block to the right of the dropdown provides an indication as to how the user is doing.

The user can either select an existing Measurement Axis or select <New> to create a new one. In either case, once a selection has been made, a new collapsible block will be displayed. The user can also open the Measurement Axis details page and remove it from the list.

New Measurement Axis

After selecting <New> from the Measurement Axis dropdown, the user can fill in the creation form. The user must provide a unique name and a Measurement System Axis, the other fiels are optional.

Measurement System Axis

The user must select a Measurement System Axis. Only Measurement System Axes referenced by the Measurement System selected above on the Measurement page are available in the dropdown. If the user selects an existing System Axis that includes a Measurement System Axis not referenced by the Measurement System, an error will be displayed.

Value Type Unit

The user may add one or more Value Type Unit(s) to the Measurement Axis. To create a Value Type Unit, the user must select a Value Type and a Unit. Constraints are optional and the user may choose and existing one or create a new one. Constraint creation is detailed here.

Platform Types

This section is not editable. Once the Measurement is created, the table will be filled in with Platform Types realizing the Measurement.

Conversions

This section is not editable. Once the Measurement is created, the table will be filled with Conversions which source or target is the selected Measurement.

Creating & Editing Enumerated Measurements

The process for creating and editing an Enumerated Measurement is similar to that of a standard Measurement. Below are detailed the differences.

Measurement System

The Measurement System is automatically set to "AbstractDiscreteSetMeasurementSystem".

Enumerated Measurement Axis

The user needs to create a new Enumerated Measurement Axis. This new Measurement Axis has an extra field: LDM Measurement Labels.

An Enumerated Measurement Axis must have a Value Type Unit. Selecting a Value Type and a Constraint add the measurement labels specified by the Constraint and populate the list of existing labels with the remaining ones from the Value Type.

The user can add either a new label or an existing one from the list. If a new label is added with the same name as an existing label, a dialog will pop up warning that a name collision has been detected.

A label can be reordered by dragging and dropping its row to a different position.

If the user doesn't specify a Value Type and/or a Constraint, they will be automatically created upon save using the list of labels the user added.

Retrieved from "https://kb.phenomportal.com/index.php?title=Measurement&oldid=822"