Skip to content
  • API documentation
  • careamics
  • config
  • likelihood_model

likelihood_model

Likelihood model.

Tensor = Annotated[Union[np.ndarray, torch.Tensor], PlainSerializer(_array_to_json, return_type=str), PlainValidator(_to_torch)] module-attribute #

Annotated tensor type, used to serialize arrays or tensors to JSON strings and deserialize them back to tensors.

GaussianLikelihoodConfig #

Bases: BaseModel

Gaussian likelihood configuration.

Source code in src/careamics/config/likelihood_model.py 
29
30
31
32
33
34
35
36
37
38
39
class GaussianLikelihoodConfig(BaseModel):
    """Gaussian likelihood configuration."""

    model_config = ConfigDict(validate_assignment=True)

    predict_logvar: Literal["pixelwise"] | None = None
    """If `pixelwise`, log-variance is computed for each pixel, else log-variance
    is not computed."""

    logvar_lowerbound: Union[float, None] = None
    """The lowerbound value for log-variance."""

logvar_lowerbound = None class-attribute instance-attribute #

The lowerbound value for log-variance.

predict_logvar = None class-attribute instance-attribute #

If pixelwise, log-variance is computed for each pixel, else log-variance is not computed.

NMLikelihoodConfig #

Bases: BaseModel

Noise model likelihood configuration.

NOTE: we need to define the data mean and std here because the noise model is trained on not-normalized data. Hence, we need to unnormalize the model output to compute the noise model likelihood.

Source code in src/careamics/config/likelihood_model.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
class NMLikelihoodConfig(BaseModel):
    """Noise model likelihood configuration.

    NOTE: we need to define the data mean and std here because the noise model
    is trained on not-normalized data. Hence, we need to unnormalize the model
    output to compute the noise model likelihood.
    """

    model_config = ConfigDict(validate_assignment=True, arbitrary_types_allowed=True)

    # TODO remove and use as parameters to the likelihood functions?
    data_mean: Tensor | None = None
    """The mean of the data, used to unnormalize data for noise model evaluation.
    Shape is (target_ch,) (or (1, target_ch, [1], 1, 1))."""

    # TODO remove and use as parameters to the likelihood functions?
    data_std: Tensor | None = None
    """The standard deviation of the data, used to unnormalize data for noise
    model evaluation. Shape is (target_ch,) (or (1, target_ch, [1], 1, 1))."""

data_mean = None class-attribute instance-attribute #

The mean of the data, used to unnormalize data for noise model evaluation. Shape is (target_ch,) (or (1, target_ch, [1], 1, 1)).

data_std = None class-attribute instance-attribute #

The standard deviation of the data, used to unnormalize data for noise model evaluation. Shape is (target_ch,) (or (1, target_ch, [1], 1, 1)).