Class NoiseBudget

Initialise this NoiseBudget. Arguments should be NoiseTerms to add to the
NoiseBudget.

Keyword arguments:

    name : str
        name for this NoiseBudget
    

Returns: new empty list

Overrides: object.__init__

append object to end

Overrides: list.append

(inherited documentation)

stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1

Overrides: list.sort

(inherited documentation)

Set the target of this NoiseBudget to be the noiseterm. Argument should be a NoiseTerm object.

Returns the target of this NoiseBudget. Returns NoneType if no target has been set.

Calculate the quadrature sum of terms in the NoiseBudget. All terms whose sum attribute evaluates to True will be included.

Calculate the deficit of thise NoiseBudget as the normalised quadrature
difference ratio the sum of the NoiseTerms and the target. Defaults to:

deficit = $\sqrt{1 - \left(rac{target}{sum of terms}
ight)^2}

Keyword arguments:

    func : callable
        any callable function that accepts noise sum and target arrays
    

Calculate the deficit of thise NoiseBudget as the ratio of the sum of the NoiseTerms and the target.

ratio_deficit = $rac{target}{sum of terms}

typemap

Value:

{'name': str, 'numTerms': int, 'target': NoiseTerm, 'noise_sum': Noise Term}