# sf.utils.vacuum_state¶

vacuum_state(basis='fock', fock_dim=5, hbar=2.0)[source]

Returns the vacuum state

Parameters
• basis (str) – If ‘fock’, calculates the initial state in the Fock basis. If ‘gaussian’, returns the vector of means and the covariance matrix.

• fock_dim (int) – the size of the truncated Fock basis if using the Fock basis representation

• hbar (float) – (default 2) the value of $$\hbar$$ in the commutation relation $$[\x,\p]=i\hbar$$

Returns

the vacuum state

Return type

array