Parameters for a sparse Gaussian field coupling (fixed projection). More...

#include <gauss_field_coupling.h>

Inheritance diagram for dnf_composer::element::GaussFieldCouplingParameters:

Collaboration diagram for dnf_composer::element::GaussFieldCouplingParameters:

Public Member Functions
void	addCoupling (const GaussCoupling &coupling)
	Append a coupling to the list.

	GaussFieldCouplingParameters (const ElementDimensions &inputFieldDimensions=ElementDimensions{}, bool normalized=true, bool circular=false, const std::vector< GaussCoupling > &couplings={})
	Construct GaussFieldCoupling parameters.

std::string	toString () const override

Public Member Functions inherited from dnf_composer::element::ElementSpecificParameters
	ElementSpecificParameters ()=default

void	print () const

virtual	~ElementSpecificParameters ()=default

Public Attributes
bool	circular
	If true, convolution wraps at field boundaries.

std::vector< GaussCoupling >	couplings
	List of explicit point-to-point Gaussian couplings.

ElementDimensions	inputFieldDimensions
	Spatial dimensions of the source field.

bool	normalized
	If true, each coupling Gaussian is area-normalised.

Detailed Description

Parameters for a sparse Gaussian field coupling (fixed projection).

Constructor & Destructor Documentation

◆ GaussFieldCouplingParameters()

dnf_composer::element::GaussFieldCouplingParameters::GaussFieldCouplingParameters	(	const ElementDimensions &	inputFieldDimensions = `ElementDimensions{}`,
		bool	normalized = `true`,
		bool	circular = `false`,
		const std::vector< GaussCoupling > &	couplings = `{}`
	)

inlineexplicit

Construct GaussFieldCoupling parameters.

Parameters

inputFieldDimensions	Source field dimensions.
normalized	Normalise individual Gaussians (default true).
circular	Circular boundary (default false).
couplings	Initial coupling list (default empty).

Member Function Documentation

◆ addCoupling()

void dnf_composer::element::GaussFieldCouplingParameters::addCoupling ( const GaussCoupling & coupling )

inline

Append a coupling to the list.

◆ toString()

std::string dnf_composer::element::GaussFieldCouplingParameters::toString ( ) const

inlineoverridevirtual

Implements dnf_composer::element::ElementSpecificParameters.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ circular

bool dnf_composer::element::GaussFieldCouplingParameters::circular

If true, convolution wraps at field boundaries.

◆ couplings

std::vector<GaussCoupling> dnf_composer::element::GaussFieldCouplingParameters::couplings

List of explicit point-to-point Gaussian couplings.

◆ inputFieldDimensions

ElementDimensions dnf_composer::element::GaussFieldCouplingParameters::inputFieldDimensions

Spatial dimensions of the source field.

◆ normalized

bool dnf_composer::element::GaussFieldCouplingParameters::normalized

If true, each coupling Gaussian is area-normalised.

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

include/elements/gauss_field_coupling.h

Public Member Functions

Public Attributes