Mentor Edits

A mentor edit is a correction applied to data based on station mentor decisions about data quality. The types corrections that can be applied this way is limited and defined below. Generally mentor edits are corrections that occur frequently enough that it doesn't make sense to require a massive number of lines in the corr.conf file but that are sufficiently varied that they cannot be detected (or at least verified) without human intervention.

Structure

All mentor edits have a start and an end time. The edit is applied from the start up until, but not including, the end. Either or both of the start and end can be set to positive or negative infinity, denoting that data should be corrected up until the end, always after the start, or for all time.

Additionally mentor edits have an author and notes field attached to them. These are not used in processing but are stored as meta-data attached to the edit. The author field is generally the initials of the person who created the edit and the notes field is generally the reason for the edit having been created.

Edits have may have a record field attached to them. If they do not then the edit is applied to all data. If they do then the edit is only applied to data contained in that record. Some edit types operate on a variable scope, so the record should be where all those variables are found if it is defined, or it should be set to apply to all records (recommended).

Edit Types

All edits have a type field associated with them and a parameter's field who's interpretation depends on the edit type.

invalidate

Invalidate (set to MVC) variables, if no variables are defined then invalidate all variables in the record. Parameters are:

variables=var1,var2...

List of variables to invalidate.

contaminate

Set the contamination flag for the record.

polynomial

Apply the given polynomial to the given variables, or all variables if none are specified. Parameters consist of an optional list of variables followed by the polynomial coefficients in ascending order:

variables=var1,var2...

List of variables to apply to.

X0 X1 X2 ... XN

Polynomial coefficients.

bitmask

Apply a bitmask to the given variables, or all variables if none are specified. Parameters are:

variables=var1,var2...

List of variables to apply to.

source=HEX

Hex value of the input bits. 0x0010 will cause the operation only to affect that bit.

target=HEX

Value to bitwise OR into the output. Setting 0x0010 will force that bit to always be on.