LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | List of all members
lsst::meas::modelfit::TruncatedGaussianSampler Class Reference

Helper class for drawing samples from a TruncatedGaussian. More...

#include <TruncatedGaussian.h>

Public Member Functions

 TruncatedGaussianSampler (TruncatedGaussian const &parent, TruncatedGaussian::SampleStrategy strategy)
 
Scalar operator() (afw::math::Random &rng, ndarray::Array< Scalar, 1, 1 > const &alpha) const
 Draw a single sample from a TruncatedGaussian. More...
 
void operator() (afw::math::Random &rng, ndarray::Array< Scalar, 2, 1 > const &alpha, ndarray::Array< Scalar, 1, 1 > const &weights, bool multiplyWeights=false) const
 Draw multiple samples from a TruncatedGaussian. More...
 
 ~TruncatedGaussianSampler ()
 

Detailed Description

Helper class for drawing samples from a TruncatedGaussian.

Definition at line 300 of file TruncatedGaussian.h.

Constructor & Destructor Documentation

◆ TruncatedGaussianSampler()

lsst::meas::modelfit::TruncatedGaussianSampler::TruncatedGaussianSampler ( TruncatedGaussian const &  parent,
TruncatedGaussian::SampleStrategy  strategy 
)
explicit

◆ ~TruncatedGaussianSampler()

lsst::meas::modelfit::TruncatedGaussianSampler::~TruncatedGaussianSampler ( )

Member Function Documentation

◆ operator()() [1/2]

Scalar lsst::meas::modelfit::TruncatedGaussianSampler::operator() ( afw::math::Random rng,
ndarray::Array< Scalar, 1, 1 > const &  alpha 
) const

Draw a single sample from a TruncatedGaussian.

Parameters
[in]rngRandom number generator
[out]alphaOutput sample vector to fill
Returns
the weight of the sample (always betweeen 0 and 1)

◆ operator()() [2/2]

void lsst::meas::modelfit::TruncatedGaussianSampler::operator() ( afw::math::Random rng,
ndarray::Array< Scalar, 2, 1 > const &  alpha,
ndarray::Array< Scalar, 1, 1 > const &  weights,
bool  multiplyWeights = false 
) const

Draw multiple samples from a TruncatedGaussian.

Parameters
[in]rngRandom number generator
[out]alphaOutput sample vector to fill; first dimension sets the number of samples
[out]weightsOutput weight vector to fill
[in]multiplyWeightsIf true, multiply the weights vector by the weights rather than fill it.

The documentation for this class was generated from the following file: