SPH
Classes | Public Attributes | List of all members
Post::HistogramParams Struct Reference

Parameters of the histogram. More...

#include <Analysis.h>

Classes

struct  ComponentParams
 Parameters used by histogram of components. More...
 

Public Attributes

Interval range
 Range of values from which the histogram is constructed. More...
 
Size binCnt = 0
 Number of histogram bins. More...
 
Float referenceDensity = 2700._f
 Reference density, used when computing particle radii from their masses. More...
 
Float massCutoff = 0._f
 Cutoff value (lower bound) of particle mass for inclusion in the histogram. More...
 
Float velocityCutoff = INFTY
 Cutoff value (upper bound) of particle velocity for inclusion in the histogram. More...
 
bool centerBins = true
 
struct Post::HistogramParams::ComponentParams components
 
Function< bool(Size index)> validator = [](Size UNUSED(index)) { return true; }
 Function used for inclusiong/exclusion of values in the histogram. More...
 

Detailed Description

Parameters of the histogram.

Definition at line 227 of file Analysis.h.

Member Data Documentation

◆ binCnt

Size Post::HistogramParams::binCnt = 0

Number of histogram bins.

0 means the number is selected based on the source data. Used only by differential SFD.

Definition at line 237 of file Analysis.h.

◆ centerBins

bool Post::HistogramParams::centerBins = true

If true, the bin values of the differential histogram are in the centers of the corresponding intervals, otherwise they correspond to the lower bound of the interval.

Definition at line 257 of file Analysis.h.

◆ components

struct Post::HistogramParams::ComponentParams Post::HistogramParams::components

◆ massCutoff

Float Post::HistogramParams::massCutoff = 0._f

Cutoff value (lower bound) of particle mass for inclusion in the histogram.

Particles with masses below this value are considered "below observational limit". Applicable for both component and particle histogram.

Definition at line 246 of file Analysis.h.

◆ range

Interval Post::HistogramParams::range

Range of values from which the histogram is constructed.

Unbounded range means the range is selected based on the source data.

Definition at line 232 of file Analysis.h.

◆ referenceDensity

Float Post::HistogramParams::referenceDensity = 2700._f

Reference density, used when computing particle radii from their masses.

Definition at line 240 of file Analysis.h.

◆ validator

Function<bool(Size index)> Post::HistogramParams::validator = [](Size UNUSED(index)) { return true; }

Function used for inclusiong/exclusion of values in the histogram.

Works only for particle histograms.

Definition at line 273 of file Analysis.h.

◆ velocityCutoff

Float Post::HistogramParams::velocityCutoff = INFTY

Cutoff value (upper bound) of particle velocity for inclusion in the histogram.

Particles moving faster than the cutoff are considered as fragments of projectile and excluded from histogram, as they are (most probably) not part of any observed family. Applicable for both component and particle histogram.

Definition at line 253 of file Analysis.h.


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