LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
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: