AssessmentDatums

AssessmentDatums

Class representing datums for an assessment type

Constructor

new AssessmentDatums(datums, assessment)

Source:
Parameters:
Name Type Description
datums Array.<ProtocolDatum> Array of ProtocolDatum instances
assessment string Assessment type, e.g. AssessmentType.NECK_AXIAL

Members

assessment :string

Description:
  • Assessment type
Source:
Assessment type
Type:
  • string

datums :Array.<ProtocolDatum>

Description:
  • Array of ProtocolDatum instances
Source:
Array of ProtocolDatum instances
Type:

Methods

(static) Colour(colour) → (nullable) {number}

Description:
  • Converts the string or array of RGB numbers to a Colour
Source:
Parameters:
Name Type Description
colour string | Array.<number>
Returns:
Type
number

(static) ReadFromFile(regulation, crash_test, version, assessment_type, filename) → (nullable) {AssessmentDatums}

Description:
  • Reads assessment datums from a JSON file from the 'datums' directory
Source:
Example
let assessment_datums = AssessmentDatums.ReadFromFile(Regulation.CNCAP,
                                                      CrashTest.ODB,
                                                      "7.1.2",
                                                      AssessmentType.NECK_SHEAR_EXCEEDENCE,
                                                      JSPath.WorkflowsDirectory(JSPath.POST),
                                                      "default");
Parameters:
Name Type Description
regulation string Regulation, e.g. Regulation.CNCAP
crash_test string Crash test type, e.g. CrashTest.ODB
version string Protocol version, e.g. "7.1.2"
assessment_type string Assessment type, e.g. AssessmentType.NECK_AXIAL
filename string Filename to read from, e.g. "default"
Returns:
Type
AssessmentDatums

ExtendLastYValueToX(x)

Description:
  • Extends the last point on the datums to the specified X value
Source:
Parameters:
Name Type Description
x number X value to extend the datum to

MaxX() → {number}

Description:
  • Return the maximum X value for the assessment datums
Source:
Returns:
Type
number

MaxY() → {number}

Description:
  • Return the maximum Y value for the assessment datums
Source:
Returns:
Type
number

MinX() → {number}

Description:
  • Return the minimum X value for the assessment datums
Source:
Returns:
Type
number

MinY() → {number}

Description:
  • Return the minimum Y value for the assessment datums
Source:
Returns:
Type
number

Plot(graphopt)

Description:
  • Plot all the datums on a graph
Source:
Parameters:
Name Type Attributes Description
graph number <optional>
Index of graph to plot on. If not specified, it's plotted on all graphs