ProgPy API Reference

• CompositeModel
  • CompositeModel
• DataModel
  • Training DataModels
    • From Data
    • From Another PrognosticsModel (i.e., Surrogate)
    • Using Constructor
  • Included DataModels
    • DMDModel
      • DMDModel
        • DMDModel.from_data()
          • DMDModel.dmd_matrix
          • DMDModel.dt
        • DMDModel.from_model()
    • LSTMStateTransitionModel
      • LSTMStateTransitionModel
        • LSTMStateTransitionModel.model
        • LSTMStateTransitionModel.from_data()
        • LSTMStateTransitionModel.from_model()
    • PolynomialChaosExpansion
      • PolynomialChaosExpansion
        • PolynomialChaosExpansion.from_data()
        • PolynomialChaosExpansion.from_model()
  • DataModel Interface
    • DataModel
      • DataModel.calc_error()
      • DataModel.estimate_params()
      • DataModel.from_data()
      • DataModel.from_json()
      • DataModel.from_model()
      • DataModel.generate_surrogate()
      • DataModel.is_continuous
      • DataModel.is_direct
      • DataModel.is_discrete
      • DataModel.is_state_transition_model
      • DataModel.simulate_to()
      • DataModel.simulate_to_threshold()
      • DataModel.state_at_event()
      • DataModel.summary()
      • DataModel.time_of_event()
      • DataModel.to_json()
• Datasets
  • Variable Load Battery Data (nasa_battery)
    • load_data()
  • CMAPSS Jet Engine Data (nasa_cmapss)
    • load_data()
• Discrete States
  • create_discrete_state()
• EnsembleModel
  • EnsembleModel
• Included Models
  • Battery Model
    • BatteryElectroChemEOD
    • BatteryElectroChemEOL
    • BatteryElectroChem
    • BatteryElectroChemEODEOL
    • SimplifiedBattery
    • BatteryCircuit
  • Pump Model
    • CentrifugalPumpBase
    • CentrifugalPump
    • CentrifugalPumpWithWear
  • Pneumatic Valve
    • PneumaticValveBase
    • PneumaticValve
    • PneumaticValveWithWear
  • DC Motor
    • DCMotorSP
    • DCMotor
  • ESC
    • ESC
  • Powertrain
    • Powertrain
  • PropellerLoad
    • PropellerLoad
  • Aircraft Models
    • SmallRotorcraft
  • ThrownObject
    • ThrownObject
• LinearModel
  • LinearModel
    • LinearModel.apply_limits()
    • LinearModel.apply_measurement_noise()
    • LinearModel.apply_process_noise()
    • LinearModel.calc_error()
    • LinearModel.dx()
    • LinearModel.estimate_params()
    • LinearModel.event_state()
    • LinearModel.from_json()
    • LinearModel.generate_surrogate()
    • LinearModel.initialize()
    • LinearModel.is_continuous
    • LinearModel.is_direct
    • LinearModel.is_discrete
    • LinearModel.is_state_transition_model
    • LinearModel.matrixCheck()
    • LinearModel.next_state()
    • LinearModel.output()
    • LinearModel.performance_metrics()
    • LinearModel.simulate_to()
    • LinearModel.simulate_to_threshold()
    • LinearModel.state_at_event()
    • LinearModel.threshold_met()
    • LinearModel.time_of_event()
    • LinearModel.to_json()
• Loading
  • Load Estimator Class interface
  • Load Estimator Classes
    • Piecewise
    • MovingAverage
    • GaussianNoiseWrapper
  • Controllers
    • LQR
    • LQR_I
• MixtureOfExperts
  • MixtureOfExpertsModel
• Prediction
  • Prediction
    • Prediction.from_json()
    • Prediction.mean
    • Prediction.monotonicity()
    • Prediction.snapshot()
    • Prediction.to_dict()
    • Prediction.to_json()
  • UnweightedSamplesPrediction
    • UnweightedSamplesPrediction.count()
    • UnweightedSamplesPrediction.from_dict()
    • UnweightedSamplesPrediction.from_json()
    • UnweightedSamplesPrediction.index()
    • UnweightedSamplesPrediction.mean
    • UnweightedSamplesPrediction.monotonicity()
    • UnweightedSamplesPrediction.snapshot()
    • UnweightedSamplesPrediction.to_dict()
    • UnweightedSamplesPrediction.to_json()
• Predictors
  • Included Predictors
    • MonteCarlo
    • UnscentedTransformPredictor
  • Predictor Interface
    • Predictor
      • Predictor.predict()
• PrognosticsModel
  • PrognosticsModel
    • PrognosticsModel.is_vectorized
    • PrognosticsModel.default_parameters
    • PrognosticsModel.parameters
    • PrognosticsModel.state_limits
    • PrognosticsModel.param_callbacks
    • PrognosticsModel.inputs
    • PrognosticsModel.states
    • PrognosticsModel.outputs
    • PrognosticsModel.performance_metric_keys
    • PrognosticsModel.events
    • PrognosticsModel.StateContainer
    • PrognosticsModel.OutputContainer
    • PrognosticsModel.InputContainer
    • PrognosticsModel.apply_limits()
    • PrognosticsModel.apply_measurement_noise()
    • PrognosticsModel.apply_process_noise()
    • PrognosticsModel.calc_error()
    • PrognosticsModel.dx()
    • PrognosticsModel.estimate_params()
    • PrognosticsModel.event_state()
    • PrognosticsModel.from_json()
    • PrognosticsModel.generate_surrogate()
    • PrognosticsModel.initialize()
    • PrognosticsModel.is_continuous
    • PrognosticsModel.is_direct
    • PrognosticsModel.is_discrete
    • PrognosticsModel.is_state_transition_model
    • PrognosticsModel.next_state()
    • PrognosticsModel.output()
    • PrognosticsModel.performance_metrics()
    • PrognosticsModel.simulate_to()
    • PrognosticsModel.simulate_to_threshold()
    • PrognosticsModel.state_at_event()
    • PrognosticsModel.threshold_met()
    • PrognosticsModel.time_of_event()
    • PrognosticsModel.to_json()
• SimResult
  • SimResult
    • SimResult.clear()
    • SimResult.equals()
    • SimResult.extend()
    • SimResult.frame
    • SimResult.frame_is_empty()
    • SimResult.from_dict()
    • SimResult.from_json()
    • SimResult.iloc
    • SimResult.index()
    • SimResult.index_of_data()
    • SimResult.iterrows()
    • SimResult.monotonicity()
    • SimResult.plot()
    • SimResult.pop()
    • SimResult.pop_by_index()
    • SimResult.remove()
    • SimResult.time()
    • SimResult.to_dict()
    • SimResult.to_json()
    • SimResult.to_numpy()
• State Estimators
  • Included State Estimators
    • ParticleFilter
    • UnscentedKalmanFilter
    • KalmanFilter
  • State Estimator Interface
    • StateEstimator
      • StateEstimator.estimate()
      • StateEstimator.x
• ToEPredictionProfile
  • ToEPredictionProfile
    • ToEPredictionProfile.add_prediction()
    • ToEPredictionProfile.alpha_lambda()
    • ToEPredictionProfile.clear()
    • ToEPredictionProfile.cumulative_relative_accuracy()
    • ToEPredictionProfile.get()
    • ToEPredictionProfile.items()
    • ToEPredictionProfile.keys()
    • ToEPredictionProfile.monotonicity()
    • ToEPredictionProfile.plot()
    • ToEPredictionProfile.pop()
    • ToEPredictionProfile.popitem()
    • ToEPredictionProfile.prognostic_horizon()
    • ToEPredictionProfile.update()
    • ToEPredictionProfile.values()
• Uncertain Data
  • Interface
    • UncertainData
      • UncertainData.cov
      • UncertainData.describe()
      • UncertainData.keys()
      • UncertainData.mean
      • UncertainData.median
      • UncertainData.metrics()
      • UncertainData.percentage_in_bounds()
      • UncertainData.plot_hist()
      • UncertainData.plot_scatter()
      • UncertainData.relative_accuracy()
      • UncertainData.sample()
      • UncertainData.to_json()
  • Implemented UncertainData Types
    • UnweightedSamples
      • UnweightedSamples.key()
    • MultivariateNormalDist
    • ScalarData
• Utils
  • Trajectory
    • Trajectory
      • Trajectory.generate()