OIFITS Rules

Rules

NameDescriptionParagraphStandard
ARRNAME_REFcheck if an OI_ARRAY table matches the ARRNAME keywordV2.6.1§3
  • VERSION_1
ARRNAME_UNIQcheck if a single OI_ARRAY table corresponds to the ARRNAME keywordV2.5.2§1
  • VERSION_1

Apply To

FILE_EXISTcheck if the file existJMMC
  • VERSION_1

Apply To

FILE
FILE_LOADcheck if the OIFITS file is loaded properly (IO error)JMMC
  • VERSION_1

Apply To

FILE
INSNAME_REFcheck if an OI_WAVELENGTH table matches the INSNAME keywordV2.6.1§3
  • VERSION_1

Apply To

INSNAME_UNIQcheck if a single OI_WAVELENGTH table corresponds to the INSNAME keywordV1.6.3.1
  • VERSION_1

Apply To

GENERIC_COL_DIMcheck if the dimension of column values >= 1JMMC
  • VERSION_1
GENERIC_COL_ERR_FIXfix the UNFLAGGED *ERR column invalid values (negative values set to NaN)JMMC
  • VERSION_1
GENERIC_COL_FORMATcheck if the column format matches the expected format (data type and dimensions)V2.4§1
  • VERSION_1
GENERIC_COL_MANDATORYcheck if the required column is presentV1-V2.Tables
  • VERSION_1
GENERIC_COL_NBROWScheck if the column length matches the expected number of rowsJMMC
  • VERSION_1
GENERIC_COL_UNITcheck if the column unit matches the expected unitV2.4§2
  • VERSION_1
GENERIC_COL_UNIT_EXISTcheck if the column unit existsV2.4§2
  • VERSION_1
GENERIC_COL_VAL_ACCEPTED_INTcheck if column values match the 'accepted' values (integer)V1-V2.Tables
  • VERSION_1
GENERIC_COL_VAL_ACCEPTED_STRcheck if column values match the 'accepted' values (string)V1-V2.Tables
  • VERSION_1
GENERIC_COL_VAL_POSITIVEcheck if column values are finite and positiveJMMC
  • VERSION_1
GENERIC_DATE_OBS_RANGEcheck if the DATE_OBS value is within 'normal' range (1933 - 2150)V2.6.1§1
  • VERSION_1
GENERIC_DATE_OBS_STANDARDcheck if the DATE_OBS keyword is in the format 'YYYY-MM-DD'V2.6.1§1
  • VERSION_1
GENERIC_KEYWORD_FORMATcheck if the keyword format matches the expected format (data type)V2.4§2
  • VERSION_1
GENERIC_KEYWORD_MANDATORYcheck if the required keyword is presentV1-V2.Tables
  • VERSION_1
GENERIC_KEYWORD_VAL_ACCEPTED_INTcheck if the keyword value matches the 'accepted' values (integer)V1-V2.Tables
  • VERSION_1
GENERIC_KEYWORD_VAL_ACCEPTED_STRcheck if the keyword value matches the 'accepted' values (string)V1-V2.Tables
  • VERSION_1
GENERIC_MJD_RANGEcheck if the MJD value is within 'normal' range (1933 - 2150)V2.6.1§1
  • VERSION_1

Apply To

GENERIC_OIREV_FIXFix the OI_REV keyword when the table is not in the proper OIFITS versionJMMC
  • VERSION_1

Apply To

OI_ARRAY
OI_T3
OI_TARGET
OI_VIS
OI_VIS2
OI_WAVELENGTH
GENERIC_STA_INDEX_UNIQcheck duplicated indexes inside each STA_INDEX column values (data table)V1.6.1.4
  • VERSION_1
OI_ARRAY_ARRNAMEcheck the ARRNAME keyword has a not null or empty valueV2.5.2§1
  • VERSION_1

Apply To

OI_ARRAY_STA_NAMEcheck if the STA_NAME column values have a not null or empty valueJMMC
  • VERSION_1

Apply To

OI_ARRAY_STA_NAME_UNIQcheck duplicated values in the STA_NAME column of the OI_ARRAY tableJMMC
  • VERSION_1

Apply To

OI_ARRAY_STA_INDEX_MINcheck if the STA_INDEX values >= 1V1.6.1.4
  • VERSION_1

Apply To

OI_ARRAY_STA_INDEX_UNIQcheck duplicated indexes in the STA_INDEX column of the OI_ARRAY tableV1.6.1.4
  • VERSION_1

Apply To

OI_ARRAY_XYZcheck if the ARRAY_XYZ keyword values corresponds to a proper coordinate on earthV1.6.1.3
  • VERSION_1
OI_ARRAY_XYZ_FIXfix the ARRAY_XYZ keyword values (to VLTI or CHARA according to the ARRNAME keyword) when the ARRAY_XYZ keyword values are incorrectJMMC
  • VERSION_1

Apply To

OI_ARRAY
OI_TARGET_COORDcheck if the TARGET RA and DEC values are not 0.0JMMC
  • VERSION_1
OI_TARGET_COORD_EXISTcheck if the TARGET RA or DEC value is not undefinedJMMC
  • VERSION_1
OI_TARGET_TARGETcheck if the TARGET column values have a not null or empty valueJMMC
  • VERSION_1

Apply To

OI_TARGET_TARGET_EXISTcheck if the OI_TARGET table has at least one targetJMMC
  • VERSION_1

Apply To

OI_TARGET
OI_TARGET_TARGET_UNIQcheck duplicated values in the TARGET column of the OI_TARGET tableJMMC
  • VERSION_1

Apply To

OI_TARGET_TARGETID_MINcheck if the TARGET_ID values >= 1V2.OI_TARGET_Table
  • VERSION_1

Apply To

OI_TARGET_TARGETID_UNIQcheck duplicated indexes in the TARGET_ID column of the OI_TARGET tableJMMC
  • VERSION_1

Apply To

OI_WAVELENGTH_EFF_WAVEcheck the EFF_WAVE column values are within range [0.1E-6 ... 20.0E-6]JMMC
  • VERSION_1

Apply To

OI_WAVELENGTH_INSNAMEcheck the INSNAME keyword has a not null or empty valueV2.5.3§3
  • VERSION_1

Apply To

OIFITS_OIDATAcheck if at least one data table exists in the OIFITS fileV2.4.2§1
  • VERSION_1

Apply To

FILE
OIFITS_OI_TARGET_EXISTcheck if only one OI_TARGET table exists in the OIFITS fileV2.4.2§1
  • VERSION_1

Apply To

FILE
OIFITS_OI_WAVELENGTH_EXISTcheck if at least one OI_WAVELENGTH table exists in the OIFITS fileV2.4.2§1
  • VERSION_1

Apply To

FILE
OIFITS_TABLE_NOT_V2check if any OIFITS 2 specific table (OI_CORR, OI_INSPOL or OI_FLUX) is present in an OIFITS 1 fileJMMC
  • VERSION_1

Apply To

OI_CORR
OI_INSPOL
UNKNOWN_COLUMNcheck if the column belongs to the OIFITS standard and versionJMMC
  • VERSION_1

Apply To

OI_ARRAY
OI_T3
OI_TARGET
OI_VIS
OI_VIS2
OI_WAVELENGTH
UNKNOWN_TABLEcheck if the table belongs to the OIFITS standard and versionV2.4.2§3-4
  • VERSION_1

Apply To

FILE

OIFITS DataModel

Table OI_TARGET

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1

Columns

NameData typeDimsMandatory(Unit)Description(Values)Rules
TARGET_IDSHORT1Yindex number
TARGETCHAR16Ytarget name
RAEP0DBL1YDEGREERA at mean equinox
DECEP0DBL1YDEGREEDEC at mean equinox
EQUINOXREAL1YYEARequinox
RA_ERRDBL1YDEGREEerror in RA at mean equinox
DEC_ERRDBL1YDEGREEerror in DEC at mean equinox
SYSVELDBL1YMETER_PER_SECONDsystemic radial velocity
VELTYPCHAR8Yreference for radial velocity
  • LSR
  • HELIOCEN
  • BARYCENT
  • GEOCENTR
  • TOPOCENT
  • UNKNOWN
VELDEFCHAR8Ydefinition of radial velocity
  • RADIO
  • OPTICAL
PMRADBL1YDEGREE_PER_YEARproper motion in RA
PMDECDBL1YDEGREE_PER_YEARproper motion in DEC
PMRA_ERRDBL1YDEGREE_PER_YEARerror of proper motion in RA
PMDEC_ERRDBL1YDEGREE_PER_YEARerror of proper motion in DEC
PARALLAXREAL1YDEGREEparallax
PARA_ERRREAL1YDEGREEerror in parallax
SPECTYPCHAR16Yspectral type

Table OI_ARRAY

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1
ARRNAMECHARYarray name for cross-referencing
FRAMECHARYcoordinate frame
  • GEOCENTRIC
  • SKY
ARRAYXDBLYMETER[m] array center X-coordinate
ARRAYYDBLYMETER[m] array center Y-coordinate
ARRAYZDBLYMETER[m] array center Z-coordinate

Table OI_WAVELENGTH

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1
INSNAMECHARYname of detector for cross-referencing

Table OI_VIS

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1
ARRNAMECHARNname of corresponding array
  • [[ARRNAME]]
DATE-OBSCHARYUTC start date of observations
INSNAMECHARYname of corresponding detector
  • [[INSNAME]]

Columns

NameData typeDimsMandatory(Unit)Description(Values)Rules
TARGET_IDSHORT1Ytarget number as index into OI_TARGET table
  • [[REF::OI_TARGET.TARGET_ID]
TIMEDBL1YSECONDUTC start time of observation
MJDDBL1YDAYSModified Julian Day (start date of observation)
INT_TIMEDBL1YSECONDIntegration time
VISAMPDBL[[NWAVE]]Yvisibility amplitude
VISAMPERRDBL[[NWAVE]]Yerror in visibility amplitude
VISPHIDBL[[NWAVE]]YDEGREEvisibility phase
VISPHIERRDBL[[NWAVE]]YDEGREEerror in visibility phase
UCOORDDBL1YMETERU coordinate of the data
VCOORDDBL1YMETERV coordinate of the data
STA_INDEXSHORT2Ystation numbers contributing to the data
  • [[REF::OI_ARRAY.STA_INDEX]
FLAGLOGICAL[[NWAVE]]Yflag

Table OI_VIS2

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1
ARRNAMECHARNname of corresponding array
  • [[ARRNAME]]
DATE-OBSCHARYUTC start date of observations
INSNAMECHARYname of corresponding detector
  • [[INSNAME]]

Columns

NameData typeDimsMandatory(Unit)Description(Values)Rules
TARGET_IDSHORT1Ytarget number as index into OI_TARGET table
  • [[REF::OI_TARGET.TARGET_ID]
TIMEDBL1YSECONDUTC start time of observation
MJDDBL1YDAYSModified Julian Day (start date of observation)
INT_TIMEDBL1YSECONDIntegration time
VIS2DATADBL[[NWAVE]]Ysquared visibility
VIS2ERRDBL[[NWAVE]]Yerror in squared visibility
UCOORDDBL1YMETERU coordinate of the data
VCOORDDBL1YMETERV coordinate of the data
STA_INDEXSHORT2Ystation numbers contributing to the data
  • [[REF::OI_ARRAY.STA_INDEX]
FLAGLOGICAL[[NWAVE]]Yflag

Table OI_T3

Keywords

NameData typeMandatory(Unit)Description(Values)Rules
EXTNAMECHARYextension name
  • OI_ARRAY
  • OI_TARGET
  • OI_WAVELENGTH
  • OI_VIS
  • OI_VIS2
  • OI_T3
NAXIS2INTYnumber of table rows
EXTVERINTNextension version
OI_REVNINTYrevision number of the table definition
  • 1
ARRNAMECHARNname of corresponding array
  • [[ARRNAME]]
DATE-OBSCHARYUTC start date of observations
INSNAMECHARYname of corresponding detector
  • [[INSNAME]]

Columns

NameData typeDimsMandatory(Unit)Description(Values)Rules
TARGET_IDSHORT1Ytarget number as index into OI_TARGET table
  • [[REF::OI_TARGET.TARGET_ID]
TIMEDBL1YSECONDUTC start time of observation
MJDDBL1YDAYSModified Julian Day (start date of observation)
INT_TIMEDBL1YSECONDIntegration time
T3AMPDBL[[NWAVE]]Ytriple product amplitude
T3AMPERRDBL[[NWAVE]]Yerror in triple product amplitude
T3PHIDBL[[NWAVE]]YDEGREEtriple product phase
T3PHIERRDBL[[NWAVE]]YDEGREEerror in triple product phase
U1COORDDBL1YMETERU coordinate of baseline AB of the triangle
V1COORDDBL1YMETERV coordinate of baseline AB of the triangle
U2COORDDBL1YMETERU coordinate of baseline BC of the triangle
V2COORDDBL1YMETERV coordinate of baseline BC of the triangle
STA_INDEXSHORT3Ystation numbers contributing to the data
  • [[REF::OI_ARRAY.STA_INDEX]
FLAGLOGICAL[[NWAVE]]Yflag