lsst::meas::modelfit::MixtureComponent Class Reference

A weighted Student's T or Gaussian distribution used as a component in a Mixture. More...

#include <Mixture.h>

Public Member Functions
int	getDimension () const
	Return the number of dimensions. More...
Vector	getMu () const
	Get/set the location parameter (mean/median/mode) of this component. More...
void	setMu (Vector const &mu)
Matrix	getSigma () const
	Get/set the shape/size parameter. More...
void	setSigma (Matrix const &sigma)
MixtureComponent	project (int dim) const
	Project the distribution onto the given dimension (marginalize over all others) More...
MixtureComponent	project (int dim1, int dim2) const
	Project the distribution onto the given dimensions (marginalize over all others) More...
	MixtureComponent (int dim)
	Default-construct a mixture component with weight=1, mu=0, sigma=identity. More...
	MixtureComponent (Scalar weight_, Vector const &mu, Matrix const &sigma)
	Default-construct a mixture component with the given parameters. More...
MixtureComponent &	operator= (MixtureComponent const &other)

Public Attributes
Scalar	weight
	Weight of this distribution in the mixture. More...

Friends
class	Mixture
std::ostream &	operator<< (std::ostream &os, MixtureComponent const &self)

Detailed Description

A weighted Student's T or Gaussian distribution used as a component in a Mixture.

Definition at line 47 of file Mixture.h.

Constructor & Destructor Documentation

MixtureComponent() [1/2]

lsst::meas::modelfit::MixtureComponent::MixtureComponent ( int  dim )

explicit

Default-construct a mixture component with weight=1, mu=0, sigma=identity.

MixtureComponent() [2/2]

lsst::meas::modelfit::MixtureComponent::MixtureComponent	(	Scalar	weight_,
		Vector const &	mu,
		Matrix const &	sigma
	)

Default-construct a mixture component with the given parameters.

Member Function Documentation

getDimension()

int lsst::meas::modelfit::MixtureComponent::getDimension ( ) const

inline

Return the number of dimensions.

Definition at line 51 of file Mixture.h.

{ return _mu.size(); }

getMu()

Vector lsst::meas::modelfit::MixtureComponent::getMu ( ) const

inline

Get/set the location parameter (mean/median/mode) of this component.

Definition at line 58 of file Mixture.h.

{ return _mu; }

getSigma()

Matrix lsst::meas::modelfit::MixtureComponent::getSigma ( ) const

inline

Get/set the shape/size parameter.

For the Gaussian distribution, this is simply the covariance matrix. For the Student's T distribution with df > 2, covariance = sigma * df / (df - 2); for df <= 2, the Student's T distribution has infinite variance, but is still a valid distribution.

Definition at line 71 of file Mixture.h.

{ return _sigmaLLT.reconstructedMatrix(); }

operator=()

MixtureComponent& lsst::meas::modelfit::MixtureComponent::operator=

(

MixtureComponent const &

other

)

project() [1/2]

MixtureComponent lsst::meas::modelfit::MixtureComponent::project

(

int

dim

)

const

Project the distribution onto the given dimension (marginalize over all others)

project() [2/2]

MixtureComponent lsst::meas::modelfit::MixtureComponent::project	(	int	dim1,
		int	dim2
	)		const

Project the distribution onto the given dimensions (marginalize over all others)

setMu()

void lsst::meas::modelfit::MixtureComponent::setMu ( Vector const &  mu )

inline

Definition at line 59 of file Mixture.h.

{ _mu = mu; }

setSigma()

void lsst::meas::modelfit::MixtureComponent::setSigma

(

Matrix const &

sigma

)

Friends And Related Function Documentation

Mixture

friend class Mixture

friend

Definition at line 96 of file Mixture.h.

operator<<

std::ostream& operator<< ( std::ostream &  os, MixtureComponent const &  self  )

friend

Definition at line 89 of file Mixture.h.

                                                                                   {
        self._stream(os);
        return os;
    }

Member Data Documentation

weight

Scalar lsst::meas::modelfit::MixtureComponent::weight

Weight of this distribution in the mixture.

Definition at line 54 of file Mixture.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_modelfit/22.0.1-4-g44f2e3d+9e4ab0f4fa/include/lsst/meas/modelfit/Mixture.h