nifty7.operators.scaling_operator module

class ScalingOperator(domain, factor)[source]

Bases: nifty7.operators.endomorphic_operator.EndomorphicOperator

Operator which multiplies a Field with a scalar.

Parameters
  • domain (Domain or tuple of Domain or DomainTuple) – The domain on which the Operator’s input Field is defined.

  • factor (scalar) – The multiplication factor

Notes

Operator supports the multiplication with a scalar. So one does not need instantiate ScalingOperator explicitly in most cases.

Formally, this operator always supports all operation modes (times, adjoint_times, inverse_times and inverse_adjoint_times), even if factor is 0 or infinity. It is the user’s responsibility to apply the operator only in appropriate ways (e.g. call inverse_times only if factor is nonzero).

Along with this behaviour comes the feature that it is possible to draw an inverse sample from a ScalingOperator (which is a zero-field). This occurs if one draws an inverse sample of a positive definite sum of two operators each of which are only positive semi-definite. However, it is unclear whether this beviour does not lead to unwanted effects somewhere else.

__call__(other)[source]

Same as times()

__repr__()[source]

Return repr(self).

apply(x, mode)[source]

Applies the Operator to a given x, in a specified mode.

Parameters
  • x (Field) – The input Field, defined on the Operator’s domain or target, depending on mode.

  • mode (int) –

    • TIMES: normal application

    • ADJOINT_TIMES: adjoint application

    • INVERSE_TIMES: inverse application

    • ADJOINT_INVERSE_TIMES or INVERSE_ADJOINT_TIMES: adjoint inverse application

Returns

The processed Field defined on the Operator’s target or domain, depending on mode.

Return type

Field

draw_sample_with_dtype(dtype, from_inverse=False)[source]

Generates a sample from a Gaussian distribution with zero mean, covariance given by the operator and specified data type.

This method is implemented only for operators which actually draw samples (e.g. DiagonalOperator). Operators which process the sample (like SandwichOperator) implement only draw_sample().

May or may not be implemented. Only optional.

Parameters
  • dtype (numpy.dtype or dict of numpy.dtype) – Dtype used for sampling from this operator. If the domain of op is a MultiDomain, the dtype can either be specified as one value for all components of the MultiDomain or in form of a dictionary whose keys need to conincide the with keys of the MultiDomain.

  • from_inverse (bool (default : False)) – if True, the sample is drawn from the inverse of the operator

Returns

A sample from the Gaussian of given covariance.

Return type

Field or MultiField

get_sqrt()[source]

Return operator op which obeys self == op.adjoint @ op.

Note that this function is only implemented for operators with real spectrum.

Returns

Operator which is the square root of self

Return type

EndomorphicOperator