statsmodels.tsa.statespace.simulation_smoother.SimulationSmoother.get_simulation_output¶

SimulationSmoother.get_simulation_output(simulation_output=None, simulate_state=None, simulate_disturbance=None, simulate_all=None, **kwargs)[source]¶

Get simulation output bitmask

Helper method to get final simulation output bitmask from a set of optional arguments including the bitmask itself and possibly boolean flags.

Parameters:¶

simulation_outputint, optional

Simulation output bitmask. If this is specified, it is simply returned and the other arguments are ignored.

simulate_statebool, optional

Whether or not to include the state in the simulation output.

simulate_disturbancebool, optional

Whether or not to include the state and observation disturbances in the simulation output.

simulate_allbool, optional

Whether or not to include all simulation output.

**kwargs

Additional keyword arguments. Present so that calls to this method can use **kwargs without clearing out additional arguments.