STIXCore idb#

The idb submodule contains IDB (definition of TM/TC packet structures) specific routines.

stixcore.idb Package#

stixcore.idb.manager Module#

Classes#

IDBManager(data_root[, force_version])

Manages IDB (definition of TM/TC packet structures) Versions and provides a IDB reader.

Class Inheritance Diagram#

digraph inheritance427338f0a7 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "IDBManager" [URL="../api/stixcore.idb.manager.IDBManager.html#stixcore.idb.manager.IDBManager",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Manages IDB (definition of TM/TC packet structures) Versions and provides a IDB reader."]; }

stixcore.idb.idb Module#

Classes#

IDB(filename)

Class provides reading functionality to a IDB (definition of TM/TC packet structures).

IDBPacketTypeInfo(*, PID_SPID, PID_DESCR, ...)

A class to represent descriptive information for a idb packet type.

IDBParameter(*, PID_SPID, PID_DESCR, ...[, ...])

A base class to represent a parameter of a SCOS-2000 Telemetry Packet.

IDBStaticParameter(*, PLF_OFFBY, PLF_OFFBI, ...)

A class to represent a parameter of a static SCOS-2000 Telemetry Packet.

IDBVariableParameter(*, VPD_POS, VPD_OFFSET, ...)

A class to represent a parameter of a variable SCOS-2000 Telemetry Packet.

IDBPacketTree(*[, children, counter, name, ...])

Class representing a dynamic telemetry packet of variable length in a tree structure with nested repeaters.

IDBPi1ValPosition(*, PIC_PI1_OFF, PIC_PI1_WID)

A class to represent parsing information for optional PI1_Val identifier.

IDBPolynomialCalibration(rows)

A class to represent a 4th order polynomial calibration defined in the IDB.

IDBCalibrationCurve(rows, param)

A class to represent a calibration curve for a LUT based interpolation defined in the IDB.

IDBCalibrationParameter(*, PCF_CATEG, ...)

A class to represent a parameter for calibration.

Class Inheritance Diagram#

digraph inheritance99fc844e24 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "IDB" [URL="../api/stixcore.idb.idb.IDB.html#stixcore.idb.idb.IDB",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class provides reading functionality to a IDB (definition of TM/TC packet structures)."]; "IDBCalibrationCurve" [URL="../api/stixcore.idb.idb.IDBCalibrationCurve.html#stixcore.idb.idb.IDBCalibrationCurve",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent a calibration curve for a LUT based interpolation defined in the IDB."]; "IDBCalibrationParameter" [URL="../api/stixcore.idb.idb.IDBCalibrationParameter.html#stixcore.idb.idb.IDBCalibrationParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent a parameter for calibration."]; "IDBParameter" -> "IDBCalibrationParameter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IDBPacketTree" [URL="../api/stixcore.idb.idb.IDBPacketTree.html#stixcore.idb.idb.IDBPacketTree",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class representing a dynamic telemetry packet of variable length in a tree structure"]; "IDBPacketTypeInfo" [URL="../api/stixcore.idb.idb.IDBPacketTypeInfo.html#stixcore.idb.idb.IDBPacketTypeInfo",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent descriptive information for a idb packet type."]; "SimpleNamespace" -> "IDBPacketTypeInfo" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IDBParameter" [URL="../api/stixcore.idb.idb.IDBParameter.html#stixcore.idb.idb.IDBParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A base class to represent a parameter of a SCOS-2000 Telemetry Packet."]; "IDBPacketTypeInfo" -> "IDBParameter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IDBPi1ValPosition" [URL="../api/stixcore.idb.idb.IDBPi1ValPosition.html#stixcore.idb.idb.IDBPi1ValPosition",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent parsing information for optional PI1_Val identifier."]; "SimpleNamespace" -> "IDBPi1ValPosition" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IDBPolynomialCalibration" [URL="../api/stixcore.idb.idb.IDBPolynomialCalibration.html#stixcore.idb.idb.IDBPolynomialCalibration",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent a 4th order polynomial calibration defined in the IDB."]; "IDBStaticParameter" [URL="../api/stixcore.idb.idb.IDBStaticParameter.html#stixcore.idb.idb.IDBStaticParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent a parameter of a static SCOS-2000 Telemetry Packet."]; "IDBParameter" -> "IDBStaticParameter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "IDBVariableParameter" [URL="../api/stixcore.idb.idb.IDBVariableParameter.html#stixcore.idb.idb.IDBVariableParameter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class to represent a parameter of a variable SCOS-2000 Telemetry Packet."]; "IDBParameter" -> "IDBVariableParameter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "SimpleNamespace" [URL="https://docs.python.org/3/library/types.html#types.SimpleNamespace",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple attribute-based namespace."]; }