LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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: