element_information Struct Reference

Metadata describing an element's role and properties in analysis. More...

#include <elemental_profile.h>

Collaboration diagram for element_information:

Public Types
enum class	role {   do_not_include , isotope , particle_size , element ,   organic_carbon }
	Classification of element types. More...

Public Attributes
enum element_information::role	Role = role::element
double	standard_ratio
	Standard isotopic ratio for normalization.
string	base_element
	Parent element for isotopes.
bool	include_in_analysis = true
	Whether to include in statistical analyses.

Detailed Description

Metadata describing an element's role and properties in analysis.

Contains configuration information for how each element should be treated during sediment source fingerprinting analysis.

Examples

/home/runner/work/SedSat3/SedSat3/src/elemental_profile.cpp.

Definition at line 50 of file elemental_profile.h.

Member Enumeration Documentation

role

enum class element_information::role

strong

Classification of element types.

Enumerator
do_not_include	Exclude from all analyses.
isotope	Isotopic ratio (e.g., 206Pb/207Pb)
particle_size	Particle size distribution parameter.
element	Standard chemical element concentration.
organic_carbon	Organic carbon content.

Definition at line 56 of file elemental_profile.h.

Member Data Documentation

base_element

string element_information::base_element

Parent element for isotopes.

Definition at line 65 of file elemental_profile.h.

Referenced by SourceSinkData::BuildSourceMeanMatrix_Isotopes(), and SourceSinkData::ReadElementInformationfromJsonObject().

include_in_analysis

bool element_information::include_in_analysis = true

Whether to include in statistical analyses.

Examples

/home/runner/work/SedSat3/SedSat3/src/elemental_profile.cpp.

Definition at line 66 of file elemental_profile.h.

Referenced by Elemental_Profile::CreateAnalysisProfile(), and SourceSinkData::ReadElementInformationfromJsonObject().

Role

enum element_information::role element_information::Role = role::element

Examples

/home/runner/work/SedSat3/SedSat3/src/elemental_profile.cpp.

Referenced by Elemental_Profile::ApplyOrganicMatterAndSizeCorrections(), Elemental_Profile::CreateAnalysisProfile(), Elemental_Profile::ExtractChemicalElements(), and SourceSinkData::ReadElementInformationfromJsonObject().

standard_ratio

double element_information::standard_ratio

Standard isotopic ratio for normalization.

Definition at line 64 of file elemental_profile.h.

Referenced by SourceSinkData::BuildSourceMeanMatrix_Isotopes(), and SourceSinkData::ReadElementInformationfromJsonObject().

---

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

• elemental_profile.h