This is the class used to calculate a likelihood score based on survey data compiled from the stocks caught by government surveys, including some form of a survey index calculation. More...

#include <surveydistribution.h>

Inheritance diagram for SurveyDistribution:

Collaboration diagram for SurveyDistribution:

Public Member Functions
	SurveyDistribution (CommentStream &infile, const AreaClass const Area, const TimeClass const TimeInfo, Keeper const keeper, double weight, const char name)
	This is the SurveyDistribution constructor. More...

virtual	~SurveyDistribution ()
	This is the default SurveyDistribution destructor. More...

virtual void	addLikelihood (const TimeClass *const TimeInfo)
	This function will calculate the likelihood score for the SurveyDistribution component. More...

virtual void	Reset (const Keeper *const keeper)
	This function will reset the SurveyDistribution likelihood information. More...

virtual void	Print (ofstream &outfile) const
	This function will print the summary SurveyDistribution likelihood information. More...

void	setFleetsAndStocks (FleetPtrVector &Fleets, StockPtrVector &Stocks)
	This will select the fleets and stocks required to calculate the SurveyDistribution likelihood score. More...

virtual void	printLikelihood (ofstream &outfile, const TimeClass *const TimeInfo)
	This function will print information from each SurveyDistribution calculation. More...

virtual void	printSummary (ofstream &outfile)
	This function will print summary information from each SurveyDistribution likelihood calculation. More...

Public Member Functions inherited from Likelihood
	Likelihood (LikelihoodType T, double w, const char *givenname)
	This is the default Likelihood constructor. More...

virtual	~Likelihood ()
	This is the default Likelihood destructor. More...

virtual void	addLikelihoodKeeper (const TimeClass const TimeInfo, Keeper const keeper)
	This function will calculate the likelihood score for the current model after adjusting the parameters. More...

virtual void	Reset (const TimeClass *const TimeInfo)
	This function will reset the likelihood information. More...

double	getLikelihood () const
	This will return the weighted likelihood score for the likelihood component. More...

LikelihoodType	getType () const
	This will return the type of likelihood class. More...

double	getUnweightedLikelihood () const
	This will return the unweighted likelihood score for the likelihood component. More...

double	getWeight () const
	This will return the weight applied to the likelihood component. More...

Public Member Functions inherited from HasName
	HasName ()
	This is the default HasName constructor. More...

virtual	~HasName ()
	This is the default HasName destructor. More...

	HasName (const char *givenname)
	This is the HasName constructor for a specified name. More...

const char *	getName () const
	This will return a null terminated text string containing the name of the object. More...

Additional Inherited Members
Protected Attributes inherited from Likelihood
double	likelihood
	This stores the calculated score for the likelihood component. More...

double	weight
	This stores the weight to be applied to the likelihood component. More...

Detailed Description

This is the class used to calculate a likelihood score based on survey data compiled from the stocks caught by government surveys, including some form of a survey index calculation.

This class calculates a likelihood score based on the difference between survey data sampled from stocks caught according to the model and that caught by government surveys. The model will calculate the survey data for the stock that is caught according to the model parameters, and aggregate this into the specified age and length groups. This survey data is then compared to the corresponding data calculated from the observed data.

Note: This likelihood component assumes that catch-at-age data is available, and is used in the survey index calculations; This likelihood component is based on the current population, where as most likelihood components are based on the population at the beginning of the timestep. It would be better if this likelihood component was changed to be based on the population at the beginning of the timestep.

Constructor & Destructor Documentation

◆ SurveyDistribution()

SurveyDistribution::SurveyDistribution	(	CommentStream &	infile,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper,
		double	weight,
		const char *	name
	)

This is the SurveyDistribution constructor.

Parameters

infile	is the CommentStream to read the SurveyDistribution data from
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model
weight	is the weight for the likelihood component
name	is the name for the likelihood component

◆ ~SurveyDistribution()

SurveyDistribution::~SurveyDistribution ( )

virtual

This is the default SurveyDistribution destructor.

Member Function Documentation

◆ addLikelihood()

void SurveyDistribution::addLikelihood ( const TimeClass *const TimeInfo )

virtual

This function will calculate the likelihood score for the SurveyDistribution component.

Parameters

TimeInfo is the TimeClass for the current model

Implements Likelihood.

◆ Print()

void SurveyDistribution::Print ( ofstream & outfile ) const

virtual

This function will print the summary SurveyDistribution likelihood information.

Parameters

outfile is the ofstream that all the model information gets sent to

Implements Likelihood.

◆ printLikelihood()

void SurveyDistribution::printLikelihood	(	ofstream &	outfile,
		const TimeClass *const	TimeInfo
	)

virtual

This function will print information from each SurveyDistribution calculation.

Parameters

outfile	is the ofstream that all the model likelihood information gets sent to
TimeInfo	is the TimeClass for the current model

Reimplemented from Likelihood.

◆ printSummary()

void SurveyDistribution::printSummary ( ofstream & outfile )

virtual

This function will print summary information from each SurveyDistribution likelihood calculation.

Parameters

outfile is the ofstream that all the model likelihood information gets sent to

Reimplemented from Likelihood.

◆ Reset()

void SurveyDistribution::Reset ( const Keeper *const keeper )

virtual

This function will reset the SurveyDistribution likelihood information.

Parameters

keeper is the Keeper for the current model

Reimplemented from Likelihood.

◆ setFleetsAndStocks()

void SurveyDistribution::setFleetsAndStocks	(	FleetPtrVector &	Fleets,
		StockPtrVector &	Stocks
	)

virtual

This will select the fleets and stocks required to calculate the SurveyDistribution likelihood score.

Parameters

Fleets	is the FleetPtrVector of all the available fleets
Stocks	is the StockPtrVector of all the available stocks

Reimplemented from Likelihood.

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

src/include/surveydistribution.h
src/surveydistribution.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SurveyDistribution()

◆ ~SurveyDistribution()

Member Function Documentation

◆ addLikelihood()

◆ Print()

◆ printLikelihood()

◆ printSummary()

◆ Reset()

◆ setFleetsAndStocks()