sigplot-ts
Options
All
  • Public
  • Public/Protected
  • All
Menu

Sometimes called 'hdrmod' and 'overrides' for various sigplot.Plot() methods, in each case, these are just BlueFile Header interface elements for either type 1000, 2000, etc. signals.

See SigPlot for more information.

preferred

Hierarchy

  • BlueHeaderOptions

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new BlueHeaderOptions(type: number, formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform, formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64, xAxis: AxisData, yAxis?: AxisData, subsize?: number, timecode?: number): BlueHeaderOptions

  • Parameters

    • type: number

      The numeric type (1000, 2000)

    • formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform

      The size of the data values (int8, etc.)

    • formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64

      Ordering of the data (x, x+y, x+y+z, etc.)

    • xAxis: AxisData

      Data settings for the X axis

    • Default value yAxis: AxisData = {}

      Data settings for the Y axis

    • Optional subsize: number

      The subsize of the data (matrices, etc.)

    • Optional timecode: number

      The time code associated with the data.

    Returns BlueHeaderOptions

Properties

Private _formatSize

_formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform

Private _formatType

_formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64

pipesize

pipesize: number

Controls the size of the ArrayBuffer (default is 1 Mbyte)

subsize

subsize: number

timecode

timecode: number

type

type: number

version

version: string

xdelta

xdelta: number

xstart

xstart: number

xunits

xunits: Units.None | Units.Time | Units.Delay | Units.Frequency | Units.TimeCode | Units.Distance | Units.Speed | Units.Acceleration | Units.JerkMSec3 | Units.Doppler | Units.DopplerRate | Units.Energy | Units.Power | Units.Mass | Units.Volume | Units.AngularPower | Units.IntegratedPowerWrad | Units.SpatialPower | Units.IntegratedPowerWm | Units.SpectralPower | Units.Amplitude | Units.Real | Units.Imaginary | Units.PhaseRad | Units.PhaseDeg | Units.PhaseCyc | Units.Log10 | Units.Log20 | Units.Magnitude | Units.Unknown1 | Units.Unknown2 | Units.General | Units.Counts | Units.AngleRad | Units.AngleDeg | Units.RelativePowerdB | Units.RelativePowerdBm | Units.RelativePowerdBW | Units.SolidAngle | Units.DistanceFt | Units.DistanceNmi | Units.SpeedFtSec | Units.SpeedNmiSec | Units.SpeedNmiHr | Units.AccelerationFtSec2 | Units.AccelerationNmiSec2 | Units.AccelerationKnotsSec | Units.AccelerationG | Units.JerkGSec | Units.RotationRPS | Units.RotationRPM | Units.AngularVelocityRadSec | Units.AngularVelocityDegSec | Units.AngularAccelerationRadSec2 | Units.AngularAccelerationDegSec2 | Units.Latitude | Units.Longitude | Units.AltitudeFt | Units.AltitudeM

ydelta

ydelta: number

ystart

ystart: number

yunits

yunits: Units.None | Units.Time | Units.Delay | Units.Frequency | Units.TimeCode | Units.Distance | Units.Speed | Units.Acceleration | Units.JerkMSec3 | Units.Doppler | Units.DopplerRate | Units.Energy | Units.Power | Units.Mass | Units.Volume | Units.AngularPower | Units.IntegratedPowerWrad | Units.SpatialPower | Units.IntegratedPowerWm | Units.SpectralPower | Units.Amplitude | Units.Real | Units.Imaginary | Units.PhaseRad | Units.PhaseDeg | Units.PhaseCyc | Units.Log10 | Units.Log20 | Units.Magnitude | Units.Unknown1 | Units.Unknown2 | Units.General | Units.Counts | Units.AngleRad | Units.AngleDeg | Units.RelativePowerdB | Units.RelativePowerdBm | Units.RelativePowerdBW | Units.SolidAngle | Units.DistanceFt | Units.DistanceNmi | Units.SpeedFtSec | Units.SpeedNmiSec | Units.SpeedNmiHr | Units.AccelerationFtSec2 | Units.AccelerationNmiSec2 | Units.AccelerationKnotsSec | Units.AccelerationG | Units.JerkGSec | Units.RotationRPS | Units.RotationRPM | Units.AngularVelocityRadSec | Units.AngularVelocityDegSec | Units.AngularAccelerationRadSec2 | Units.AngularAccelerationDegSec2 | Units.Latitude | Units.Longitude | Units.AltitudeFt | Units.AltitudeM

Accessors

class

class:

format

format:

Methods

Static type1000

  • type1000(formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform, formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64, xAxis: AxisData, timecode?: number): IBlueHeaderOptions

  • 1-D Data, like raw signal data

    Parameters

    • formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform
    • formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64
    • xAxis: AxisData
    • Optional timecode: number

    Returns IBlueHeaderOptions

Static type2000

  • type2000(formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform, formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64, xAxis: AxisData, yAxis: AxisData, subsize?: number, timecode?: number): IBlueHeaderOptions

  • 2-D Data, like falling rasters, etc.

    Parameters

    • formatSize: FormatSize.Scalar | FormatSize.Complex | FormatSize.Vector | FormatSize.Quad | FormatSize.Matrix | FormatSize.Transform
    • formatType: FormatType.Int8 | FormatType.Int16 | FormatType.Int32 | FormatType.Int64 | FormatType.Float32 | FormatType.Float64
    • xAxis: AxisData
    • yAxis: AxisData
    • Optional subsize: number
    • Optional timecode: number

    Returns IBlueHeaderOptions

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc