Parameters for a Collapse (2D -> 1D) element. More...

#include <collapse.h>

Inheritance diagram for dnf_composer::element::CollapseParameters:

Collaboration diagram for dnf_composer::element::CollapseParameters:

Public Member Functions
	CollapseParameters (const CompressionType compression=CompressionType::SUM, const ProjectionAxis keepAxis=ProjectionAxis::X, const ElementDimensions &inputDimensions=ElementDimensions{ 100, 100, 1.0, 1.0 })
	Construct Collapse parameters.

bool	operator== (const CollapseParameters &other) const

std::string	toString () const override

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

void	print () const

virtual	~ElementSpecificParameters ()=default

Public Attributes
CompressionType	compression
	Reduction applied along the collapsed axis.

ElementDimensions	inputDimensions
	Spatial dimensions of the 2D source field.

ProjectionAxis	keepAxis
	Axis kept in the 1D output (the other is collapsed).

Detailed Description

Parameters for a Collapse (2D -> 1D) element.

Constructor & Destructor Documentation

dnf_composer::element::CollapseParameters::CollapseParameters	(	const CompressionType	compression = `CompressionType::SUM`,
		const ProjectionAxis	keepAxis = `ProjectionAxis::X`,
		const ElementDimensions &	inputDimensions = `ElementDimensions{ 100, 100, 1.0, 1.0 }`
	)

inlineexplicit

Construct Collapse parameters.

Parameters

compression	Reduction along the collapsed axis (default SUM).
keepAxis	Axis kept in the output (default X -> collapse over Y).
inputDimensions	Dimensions of the 2D source field.

bool dnf_composer::element::CollapseParameters::operator== ( const CollapseParameters & other ) const

inline

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

inlineoverridevirtual

Here is the call graph for this function:

Here is the caller graph for this function:

CompressionType dnf_composer::element::CollapseParameters::compression

Reduction applied along the collapsed axis.

ElementDimensions dnf_composer::element::CollapseParameters::inputDimensions

Spatial dimensions of the 2D source field.

ProjectionAxis dnf_composer::element::CollapseParameters::keepAxis

Axis kept in the 1D output (the other is collapsed).

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