Galactic Filter¶
Object providing boolean filters that select or reject galaxies (nodes) based on their properties. Filters are used to restrict output analyses, apply selection criteria matching observational surveys, or limit processing to specific galaxy populations. Multiple filters can be combined using logical and, or, and not operations to build complex selection functions.
Default implementation: galacticFilterAlways
Methods¶
passes→logicalReturn true if the given
nodepasses the filter.type(treeNode), intent(inout), target :: node
galacticFilterAll¶
Implements a logical AND combination of multiple galacticFilterClass objects, passing only nodes that satisfy every filter in the list, enabling construction of complex selection criteria by composing simpler filters.
galacticFilterAlways¶
A trivial filter that unconditionally passes every node regardless of its properties, used as a default or placeholder when all nodes should be included in an analysis and also as a null object in testing filter infrastructure.
(Default implementation)
galacticFilterAny¶
Implements a logical OR combination of multiple galacticFilterClass objects, passing nodes that satisfy at least one filter in the list, enabling flexible union-based selection criteria from simpler component filters.
galacticFilterAnyDescendantNode¶
Applies a galacticFilterClass to all descendant nodes of a given node and passes if any descendant satisfies the filter, enabling selection of nodes based on the properties of their descendants in the merger tree.
Parameters
[allowSelf]— If true, the node itself is considered as a descendant, otherwise the node itself is excluded from the descendant node search.[branchOnly](default.false.) — If true, follow descendants only to the end of the branch. Otherwise, follow them to the end of the entire merger tree.
galacticFilterAnySatelliteNode¶
Applies a filter to satellite nodes of the given node and returns true if any satellite node passes.
galacticFilterBasicMass¶
A high-pass filter for basic mass. Halos with a basic mass mass greater than or equal to a fixed threshold, \(M_0=\)[massThreshold].
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the basic mass threshold for the basic mass galactic filter class.
galacticFilterBlackHoleMass¶
A galactic high-pass filter for black hole mass. Galaxies with a central black hole mass greater than or equal to a fixed threshold, \(M_{\bullet,0}=\)[massThreshold], are passed.
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the black hole mass threshold for the black hole mass galactic filter class.
galacticFilterBranchMostMassive¶
Selects only the most massive progenitor branch (main branch) halo among a node’s siblings at each timestep, filtering out secondary progenitors to focus analyses on the primary mass growth channel of a merger tree.
galacticFilterChildNode¶
Applies a filter to a child node of the given node. The [childRank] parameter specifies which child to use—a rank of 1 means the first child, a rank of \(N\) means the sibling of the \(N-1\) rank child. If a child of the specified rank does not exist this filter fails to pass.
Parameters
[childRank]— The rank of the child to use—a rank of 1 means the first child, a rank of \(N\) means the sibling of the \(N-1\) rank child.
galacticFilterConstrainedBranch¶
Passes only nodes that lie on constrained branches of a merger tree, i.e., branches whose merger history was constructed to match some applied constraint rather than generated stochastically, enabling targeted analysis of constrained vs. unconstrained halo populations.
galacticFilterDescendantNode¶
Evaluates a wrapped galacticFilterClass not on the current node but on its descendant node, enabling selection criteria based on the future state of a halo’s evolution rather than its current properties.
Parameters
[redshiftDescendant]— The redshift of the descendant node to which to apply the filter.[redshiftDescendant]— The redshift of the descendant node to which to apply the filter.[allowSelf]— If true, the node itself is considered as a possible descendant, otherwise the node itself is excluded from the descendant node search.
galacticFilterFormationTime¶
A filter which removes recently-formed halos. Halos with a formation time greater than the current time minus \(\Delta t=\)[timeRecent] are removed.
Parameters
[massParentMinimum]— The minimum parent mass to consider.[massParentMaximum]— The maximum parent mass to consider.[massParentCountPerDecade]— The number of bins per decade of parent mass.[redshiftFormationMinimum]— The minimum formation redshift to consider.[redshiftFormationMaximum]— The maximum formation redshift to consider.[redshiftFormationCountPerUnit]— The number of bins per unit of formation redshift.[snapshotParents]— The snapshot at which to select parent halos.[fractionFormation]— The mass fraction used to define the formation epoch.[description]— A description of this mass function.[simulationReference]— A reference for the simulation.[simulationURL]— A URL for the simulation.[timeRecent]— The parameter \(\Delta t\) (in units of Gyr) appearing in the formation time galactic filter class.
galacticFilterGasFractionISM¶
Passes nodes whose ISM gas fraction (the ratio of ISM gas mass to stellar mass) exceeds a specified threshold, enabling selection of gas-rich galaxies.
Parameters
[fractionGasThreshold]— The ISM gas fraction above which to pass.
galacticFilterHaloAlwaysIsolated¶
Passes only nodes that have never been a satellite throughout their entire merger tree history, selecting halos that have always resided as isolated field halos without ever experiencing a period of satellite status in a larger host halo.
galacticFilterHaloIsolated¶
Passes only nodes that are currently isolated halos (host halos that are not satellites of any larger structure at the current epoch), selecting field halos to exclude substructure when analyzing host halo populations.
galacticFilterHaloMass¶
A high-pass filter for basic mass. Halos with a halo mass greater than or equal to a fixed threshold, \(M_0=\)[massThreshold].
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the mass threshold for the halo mass galactic filter class.
galacticFilterHaloMassRange¶
Passes nodes whose halo mass (under a specified virial density contrast definition) falls within the range [massLow, massHigh), enabling selection of halos by mass.
Parameters
[massLow]— The minimum halo mass (in \(\mathrm{M}_\odot\)) that a node must have to pass the filter; nodes with mass below this threshold are rejected.[massHigh]— The maximum halo mass (in \(\mathrm{M}_\odot\)) that a node must have to pass the filter; nodes with mass above this threshold are rejected.
galacticFilterHaloNotIsolated¶
Passes only nodes that are currently satellites (non-isolated), selecting subhalos orbiting within a larger host halo at the current epoch, useful for environmental studies of satellite galaxy populations.
galacticFilterHierarchyDepthMaximum¶
Passes only nodes up to a specified maximum depth in the subhalo hierarchy, filtering out sub-subhalos and higher-order substructure beyond a given level of nesting, useful when analyses should not extend beyond a certain hierarchy depth.
Parameters
[depthHierarchyLargest]— The largest value of hierarchy maximum depth to pass.
galacticFilterHighPass¶
A high-pass galactic filter that passes only nodes for which a scalar property, extracted via [nodePropertyExtractor], equals or exceeds the specified [threshold] value. This allows selection of galaxies or halos above any quantitative threshold in any extractable property.
Parameters
[filterThreshold]— Threshold for the high-pass filter distribution operator.[filterWidth](default0.0d0) — The width of the filter (0 for a sharp transition; \(>0\) for a smoothed transition).[normalized](default.false.) — If true, the property value is set to the filter value, otherwise it is multiplied by it.[filterThreshold]— Threshold for the high-pass filter distribution operator.[filterWidth](default0.0d0) — The width of the filter (0 for a sharp transition; \(>0\) for a smoothed transition).[threshold]— The threshold value above which to pass.
galacticFilterHostMassRange¶
Passes nodes whose host halo basic mass, \(M_\mathrm{host}\), falls within the range [massMinimum]\(\le M_\mathrm{host}<\)[massMaximum]. This selects subhalos or galaxies hosted by halos of a specified mass interval, enabling mass-binned analyses of galaxy populations in their environmental context.
Parameters
[massMinimum]— The minimum mass of host halo to pass.[massMaximum]— The maximum mass of host halo to pass.[useFinalHost]— If true, the final host (i.e. the isolated host halo in the subhalo hierarchy) is used for filtering, otherwise the immediate host is used.
galacticFilterIntervalPass¶
An interval pass galactic filter that passes only nodes for which a scalar property, extracted via [nodePropertyExtractor], lies within the interval [[thresholdLow], [thresholdHigh]]. This enables selection of galaxies or halos within any bounded range of an extractable property.
Parameters
[thresholdLow]— The low threshold value above which to pass.[thresholdHigh]— The high threshold value below which to pass.
galacticFilterISMMass¶
A galactic high-pass filter for ISM mass. Galaxies with a combined disk plus spheroid ISM mass greater than or equal to a fixed threshold, \(M_\mathrm{ISM,0}=\)[massThreshold].
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the ISM mass threshold for the ISM mass galactic filter class.
galacticFilterIsolatedHostNode¶
Evaluates a wrapped galacticFilterClass on the isolated (top-level) host halo of the current node rather than on the node itself, enabling selection of satellites based on properties of their ultimate host environment.
galacticFilterLabelled¶
Tests whether the given node has been assigned the label specified by [label]. This filter passes only nodes that carry the designated label, enabling targeted selection of nodes based on categorical metadata attached during tree construction or post-processing.
Parameters
[label]— The label string that a node must carry in order to pass this filter; only nodes assigned this exact label during tree construction or post-processing will be selected.
galacticFilterLightcone¶
Passes nodes that fall within a lightcone geometry as defined by a geometryLightconeClass object, enabling mock catalog construction by selecting only galaxies observable within the survey volume.
Parameters
[includeObservedRedshift](default.false.) — If true output the observed redshift (i.e. including the effects of peculiar velocities).[includeAngularCoordinates](default.false.) — If true output angular coordinates in the lightcone.[includeObservedPosition](default.false.) — If true output the observed position (i.e. including the effects of peculiar velocities).[atCrossing](default.false.) — If true output positions/velocities at the time of lightcone crossing. Otherwise, output positions at the output time.[failIfNotInLightcone](default.true.) — If true, a node that is not in the lightcone will cause a fatal error. Otherwise, such nodes are simply assigned unphysical values for lightcone properties.
galacticFilterLowPass¶
A low-pass galactic filter that passes only nodes for which a scalar property, extracted via [nodePropertyExtractor], is less than or equal to the specified [threshold] value. This allows selection of galaxies or halos below any quantitative threshold in any extractable property.
Parameters
[threshold]— The threshold value below which to pass.
galacticFilterMainBranch¶
Passes only nodes that lie on the main progenitor branch of their merger tree (the branch of most massive progenitors tracing the primary assembly history), filtering out secondary merger branches for analyses focused on main branch evolution.
Parameters
[massFraction](default0.0d0) — Mass fraction relative to the descendant node on the main branch below which the progenitor branch does not grow any further.[invertFilter](default.false.) — If true, the filter is inverted to pass only nodes not on the main branch.[includeSubhalos](default.false.) — If set to true then subhalos of the main branch halo are also assigned a value of 1 (with subhalos of non-main branch halos assigned a value of 0). Otherwise, all subhalos are assigned a value of 0.
galacticFilterMergerRatio¶
An interval pass filter that selects halos whose merger mass ratio falls within the range [[ratioLow], [ratioHigh]]. The merger ratio quantifies the relative mass of merging progenitors, enabling selection of major or minor merger events within a specified mass-ratio interval.
Parameters
[ratioLow]— The low ratio value above which to pass.[ratioHigh]— The high ratio value below which to pass.
galacticFilterNodeMajorMergerRecent¶
A low-pass filter for time since the last major node merger. Halos with a time of the last major node merger greater than or equal to the current time minus \(\Delta t=\)[timeRecent] are passed.
Parameters
[timeLimit](default1.0d-2) — The maximum age of stellar populations to retain in the “recent” spectra postprocessing method.[timeRecent]— The parameter \(\Delta t\) (in units of Gyr) appearing in the recent node major merger galactic filter class.
galacticFilterNot¶
Implements logical negation of a wrapped galacticFilterClass, passing nodes that the wrapped filter would reject and rejecting those it would pass, enabling complement-based selection criteria without defining explicit inverse filters.
galacticFilterNull¶
A filter which simply returns the result of another filter. This is intended for use in filter pipelines where it may be useful to optionally switch in this filter or a galacticFilterNull filter (for example).
Parameters
[dimensionless](default.true.) — If true the null profile is considered to be dimensionless.
galacticFilterOutputTimes¶
A filter that passes nodes only if their cosmic time coincides with one of the requested simulation output times, within a relative tolerance specified by [toleranceRelative]. This ensures that only nodes snapshotted at designated output epochs are included in post-processing analyses.
Parameters
[toleranceRelative](default0.0d0) — The fractional tolerance to allow when comparing the time at which a node exists to output times.
galacticFilterParentNode¶
Applies a filter to a parent node of the given node. If a parent of the specified rank does not exist this filter fails to pass.
galacticFilterPrimaryDescendantNode¶
Applies a delegate galactic filter to all primary descendant nodes of the given node along the main progenitor branch and passes if any such primary descendant satisfies that filter. The [allowSelf] parameter controls whether the node itself is included among the candidates tested.
Parameters
[allowSelf]— If true, the node itself is considered as a descendant, otherwise the node itself is excluded from the descendant node search.
galacticFilterRadiusEffective¶
A galactic high-pass filter for stellar mass effective radius. Galaxies with a stellar mass effective radius greater than or equal to a fixed threshold, \(R_{\mathrm{eff},0}=\)[radiusEffectiveThreshold], are passed.
Parameters
[radiusThreshold]— The parameter \(R_{\mathrm{eff},0}\) (in units of Mpc) appearing in the stellar mass effective radius threshold.
galacticFilterRootNode¶
Passes only root nodes (the final descendant at the present day, with no further descendants), selecting the base of each merger tree that represents the surviving halo at the final output time, for present-epoch galaxy property analyses.
galacticFilterSpheroidStellarMass¶
A galactic high-pass filter for stellar mass. Galaxies with a spheroid stellar mass greater than or equal to a fixed threshold, \(M_{\star,0}=\)[massThreshold].
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the stellar mass threshold for the spheroid stellar mass galactic filter class.
galacticFilterStarFormationRate¶
A galactic high-pass filter for star formation rate. Galaxies with a combined disk, spheroid, plus NSC star formation rate greater than or equal to a mass-dependent threshold. The threshold is given by
where \(M_0=\)[logM0], \(\alpha_0=\)[logSFR0], and \(\alpha_1=\)[logSFR1].
Methods
tabulate— Tabulate the virial density contrast as a function of mass and time.restoreTable— Restore a tabulated solution from file.storeTable— Store a tabulated solution to file.
Parameters
[velocityCharacteristic](default250.0d0) — The velocity scale at which the SNe-driven outflow rate equals the star formation rate in disks.[exponent](default3.5d0) — The velocity scaling of the SNe-driven outflow rate in disks.[fraction](default0.01d0) — The normalization \(f\) of the outflow rate relative to the star formation rate at a reference halo velocity of 200 km/s and expansion factor of 1, setting the overall mass-loading amplitude of the halo-scaling feedback model.[exponentVelocity](default-2.0d0) — The exponent of virial velocity in the outflow rate in disks.[exponentRedshift](default0.0d0) — The power-law exponent of the cosmological expansion factor \((1+z)\) in the halo-scaling outflow rate, allowing the mass-loading factor to evolve with redshift; a value of zero gives no redshift evolution.[toleranceRelativeVelocityDispersion](default1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.[toleranceRelativeVelocityDispersionMaximum](default1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.[radiusNormalization](default3.3d-6) — The initial value appearing in the radius-mass relation[toleranceAbsoluteMass](default1.0d-6) — The mass tolerance used to judge whether the nuclear star cluster is physically plausible.[toleranceRelativeMetallicity](default1.0d-4) — The metallicity tolerance for ODE solution.[inactiveLuminositiesStellar](default.false.) — Specifies whether or not nuclear star cluster stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).[scaleRelativeMass](default1.0d-2) — The mass scale, relative to the total mass of the node, below which calculations in the delayed very simple hot halo component are allowed to become inaccurate.[starveSatellites](default.false.) — Specifies whether or not the hot halo should be removed (“starved”) when a node becomes a satellite.[starveSatellitesOutflowed](default.false.) — Specifies whether or not the outflowed hot halo should be removed (“starved”) when a node becomes a satellite.[outflowReturnOnFormation](default.false.) — Specifies whether or not outflowed gas should be returned to the hot reservoir on halo formation events.[angularMomentumAlwaysGrows](default.false.) — Specifies whether or not negative rates of accretion of angular momentum into the hot halo will be treated as positive for the purposes of computing the hot halo angular momentum.[fractionBaryonLimitInNodeMerger](default.false.) — Controls whether the hot gas content of nodes should be limited to not exceed the universal baryon fraction at node merger events. If set totrue, hot gas (and angular momentum, abundances, and chemicals proportionally) will be removed from the merged halo to the unaccreted gas reservoir to limit the baryonic mass to the universal baryon fraction where possible.[scaleAbsoluteMass](default100.0d0) — The absolute mass scale below which calculations in the very simple disk component are allowed to become inaccurate.[toleranceAbsoluteMass](default1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.[toleranceAbsoluteMass](default1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.[toleranceRelativeMetallicity](default1.0d-4) — The metallicity tolerance for ODE solution.[radiusStructureSolver](default1.0d0) — The radius (in units of the standard scale length) to use in solving for the size of the disk.[structureSolverUseCole2000Method](default.false.) — If true, use the method described in Cole et al. (2000) to correct for difference between thin disk and spherical mass distributions when solving for disk radii.[diskNegativeAngularMomentumAllowed](default.true.) — Specifies whether or not negative angular momentum is allowed for the disk.[inactiveLuminositiesStellar](default.false.) — Specifies whether or not disk stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).[postStepZeroNegativeMasses](default.true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.[ratioAngularMomentumSolverRadius](defaultratioAngularMomentumSolverRadiusDefault) — The assumed ratio of the specific angular momentum at the structure solver radius to the mean specific angular momentum of the standard disk component.[scaleAbsoluteMass](default100.0d0) — The absolute mass scale below which calculations in the very simple spheroid component are allowed to become inaccurate.[toleranceAbsoluteMass](default1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.[efficiencyEnergeticOutflow](default1.0d-2) — The proportionality factor relating mass outflow rate from the spheroid to the energy input rate divided by \(V_\mathrm{spheroid}^2\).[toleranceRelativeMetallicity](default1.0d-4) — The metallicity tolerance for ODE solution.[toleranceAbsoluteMass](default1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.[inactiveLuminositiesStellar](default.false.) — Specifies whether or not spheroid stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).[postStepZeroNegativeMasses](default.true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.[ratioAngularMomentumScaleRadius](defaultratioAngularMomentumScaleRadiusDefault) — The assumed ratio of the specific angular momentum at the scale radius to the mean specific angular momentum of the standard spheroid component.[outputMergers](default.false.) — Determines whether or not properties of black hole mergers will be output.[fileNames]— The name of the file(s) from which merger tree data should be read when using the[mergerTreeConstruct]\(=\)readtree construction method.[forestSizeMaximum](default0_c_size_t) — The maximum number of nodes allowed in a forest before it will be broken up into trees and processed individually. A value of 0 implies that forests should never be split.[presetMergerTimes](default.true.) — Specifies whether merging times for subhalos should be preset when reading merger trees from a file.[presetMergerNodes](default.true.) — Specifies whether the target nodes for mergers should be preset (i.e. determined from descendant nodes). If they are not, merging will be with each satellite’s host node.[presetSubhaloMasses](default.true.) — Specifies whether subhalo mass should be preset when reading merger trees from a file.[subhaloAngularMomentaMethod](defaultvar_str('summation')) — Specifies how to account for subhalo angular momentum when adding subhalo mass to host halo mass.[presetSubhaloIndices](default.true.) — Specifies whether subhalo indices should be preset when reading merger trees from a file.[presetPositions](default.true.) — Specifies whether node positions should be preset when reading merger trees from a file.[presetScaleRadii](default.true.) — Specifies whether node scale radii should be preset when reading merger trees from a file.[scaleRadiiFailureIsFatal](default.true.) — Specifies whether failure to set a node scale radii should be regarded as a fatal error. (If not, a fallback method to set scale radius is used in such cases.)[presetScaleRadiiConcentrationMinimum](default3.0d0) — The lowest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).[presetScaleRadiiConcentrationMaximum](default60.0d0) — The largest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).[presetScaleRadiiMinimumMass](default0.0d0) — The minimum halo mass for which scale radii should be preset (if[presetScaleRadii]\(=\)true).[presetUnphysicalAngularMomenta](default.false.) — When reading merger trees from file and presetting halo angular momenta, detect unphysical (<=0) angular momenta and preset them using the selected halo spin method.[presetAngularMomenta](default.true.) — Specifies whether node angular momenta should be preset when reading merger trees from a file.[presetAngularMomenta3D](default.false.) — Specifies whether node 3-D angular momenta vectors should be preset when reading merger trees from a file.[presetOrbits](default.true.) — Specifies whether node orbits should be preset when reading merger trees from a file.[presetOrbitsSetAll](default.true.) — Forces all orbits to be set. If the computed orbit does not cross the virial radius, then select one at random instead.[presetOrbitsAssertAllSet](default.true.) — Asserts that all virial orbits must be preset. If any can not be set, Galacticus will stop.[presetOrbitsBoundOnly](default.true.) — Specifies whether only bound node orbits should be set.[beginAt](default-1_kind_int8) — Specifies the index of the tree to begin at. (Use -1 to always begin with the first tree.)[outputTimeSnapTolerance](default0.0d0) — The relative tolerance required to “snap” a node time to the closest output time.[missingHostsAreFatal](default.true.) — Specifies whether nodes with missing host nodes should be considered to be fatal—see the discussion of missing host nodes in the class description above.[treeIndexToRootNodeIndex](default.false.) — Specifies whether tree indices should always be set to the index of their root node.[allowBranchJumps](default.true.) — Specifies whether nodes are allowed to jump between branches.[allowSubhaloPromotions](default.true.) — Specifies whether subhalos are permitted to be promoted to being isolated halos.[alwaysPromoteMostMassive](default.false.) — If true, the most massive progenitor is always promoted to be the primary progenitor even if it is a subhalo. Otherwise, isolated progenitors are given priority over subhalo progenitors, even if they are less massive.[presetNamedReals]— Names of real datasets to be additionally read and stored in the nodes of the merger tree when using the[mergerTreeConstruct]\(=\)readtree construction method.[presetNamedIntegers]— Names of integer datasets to be additionally read and stored in the nodes of the merger tree when using the[mergerTreeConstruct]\(=\)readtree construction method.[fatalMismatches](default.true.) — Specifies whether mismatches in cosmological parameter values between Galacticus and “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be considered fatal.[fatalNonTreeNode](default.true.) — Specifies whether nodes in snapshot files but not in the merger tree file should be considered fatal when importing from the “Sussing Merger Trees” format (Srisawat et al., 2013).[subvolumeCount](default1) — Specifies the number of subvolumes along each axis into which a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be split for processing through Galacticus.[subvolumeBuffer](default0.0d0) — Specifies the buffer region (in units of Mpc\(/h\) to follow the format convention) around subvolumes of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file which should be read in to ensure that no halos are missed from trees.[subvolumeIndex](default[0,0,0]) — Specifies the index (in each dimension) of the subvolume of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file to process. Indices range from 0 to[subvolumeCount]\(-1\).[badValue](default-0.5d0) — Use for bad value detection in “Sussing” merger trees. Values for scale radius and halo spin which exceed this threshold are assumed to be bad.[badValueTest](defaultvar_str('lessThan')) — Use for bad value detection in “Sussing” merger trees. Values which exceed the threshold in ths specified direction are assumed to be bad.[treeSampleRate](default1.0d0) — Specify the probability that any given tree should processed (to permit subsampling).[massOptions](defaultvar_str('default')) — Mass option for Sussing merger trees.[mergeProbability](default0.1d0) — The largest probability of branching allowed in a timestep in merger trees built by the Cole et al. (2000) method.[accretionLimit](default0.1d0) — The largest fractional mass change due to subresolution accretion allowed in a timestep in merger trees built by the Cole et al. (2000) method.[redshiftMaximum](default1.0d5) — The highest redshift to which merger trees will be built in the Cole et al. (2000) method.[toleranceTimeEarliest](default2.0d-6) — The fractional tolerance used to judge if a branch is at the earliest allowed time in the tree.[branchIntervalStep](default.true.) — Iffalseuse the original Cole et al. (2000) method to determine whether branching occurs in a timestep. Iftruedraw branching intervals from a negative exponential distribution.[toleranceResolutionSelf](default1.0d-6) — The fractional tolerance in node mass at the resolution limit below which branch mis-orderings will be ignored.[toleranceResolutionParent](default1.0d-3) — The fractional tolerance in parent node mass at the resolution limit below which branch mis-orderings will be ignored.[ignoreNoProgress](default.false.) — If true, failure to make progress on a branch will be ignored (and the branch terminated).[ignoreWellOrdering](default.false.) — If true, non-well-ordered tree branches are pruned away instead of causing errors..[redshiftBase](default0.0d0) — The redshift at which to plant the base node when building merger trees.[timeSnapTolerance](default1.0d-6) — The fractional tolerance within which the tree base time will be snapped to a nearby output time.[treeBeginAt](default0) — The index (in order of increasing base halo mass) of the tree at which to begin when building merger trees. A value of “0” means to begin with tree number 1 (if processing trees in ascending order), or equal to the number of trees (otherwise).[processDescending](default.true.) — If true, causes merger trees to be processed in order of decreasing mass.[splitTrees](default.false.) — If true, prune away any nodes of the tree that are not needed to determine evolution up to the latest time at which a node is present inside the lightcone. This typically leads to a tree splitting into a forest of trees.[label]— A label for the mass function.[comment]— A descriptive comment for the mass function.[starFormationRates]— The star formation rates corresponding to bin centers.[covarianceBinomialBinsPerDecade](default10) — The number of bins per decade of star formation rate to use when constructing star formation rate function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](default1.0d10) — The star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](default1.0d12) — The maximum star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[likelihoodBins]— Controls which bins in the stellar mass–halo mass relation will be used in computing the likelihood: * not present: all bins are included in the likelihood calculation; * list of integers: use only the mass bin(s) given in this list in the likelihood calculation; *auto: use only bins which have a non-zero number of halos contributing to them in the likelihood calculation.[fileNameTarget]— The name of the file containing the target data.[redshiftInterval](default1) — The redshift interval to use.[likelihoodNormalize](default.false.) — If true, then normalize the likelihood to make it a probability density.[computeScatter](default.false.) — If true, the scatter in log10(stellar mass) is computed. Otherwise, the mean is computed.[systematicErrorPolynomialCoefficient](default[0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the stellar vs halo mass relation.[systematicErrorMassHaloPolynomialCoefficient](default[0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the stellar vs halo mass relation.[errorTolerant](default.false.) — Error tolerance for the N-body spin distribution operator.[logNormalRange](default100.0d0) — The multiplicative range of the log-normal distribution used to model the distribution of the mass and energy terms in the spin parameter. Specifically, the lognormal distribution is truncated outside the range \((\lambda_\mathrm{m}/R,\lambda_\mathrm{m} R\), where \(\lambda_\mathrm{m}\) is the measured spin, and \(R=\)[logNormalRange][fileName]— The name of the file from which to read spin distribution function parameters.[comment]— A comment describing this analysis.[label]— A label for this analysis.[label]— A label for the spin distribution function.[comment]— A descriptive comment for the spin distribution function.[redshift]— The redshift at which to compute the spin distribution function.[massMinimum]— Minimum halo mass for the spin distribution function.[massMaximum]— Maximum halo mass for the spin distribution function.[spinMinimum]— Minimum spin for the spin distribution function.[spinMaximum]— Maximum spin for the spin distribution function.[countSpinsPerDecade]— Number of spins per decade at which to compute the spin distribution function.[timeRecent]— Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis.[particleCountMinimum]— The minimum particle count to assume when computing N-body errors on spins.[massParticle]— The mass of the particle used in the N-body simulation from which spins were measured.[energyEstimateParticleCountMaximum]— The maximum number of particles used in estimating halo energies when measuring spins from the N-body simulation.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[label]— A label for the mass function.[comment]— A descriptive comment for the mass function.[masses]— The masses corresponding to bin centers.[covarianceBinomialBinsPerDecade](default10) — The number of bins per decade of halo mass to use when constructing HI mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](default1.0d8) — The minimum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](default1.0d16) — The maximum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[label]— A label for the luminosity function.[comment]— A descriptive comment for the luminosity function.[magnitudesAbsolute]— The absolute magnitudes corresponding to bin centers.[covarianceBinomialBinsPerDecade](default10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](default1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](default1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[label]— A label for the luminosity function.[comment]— A descriptive comment for the luminosity function.[luminosities]— The luminosities corresponding to bin centers.[covarianceBinomialBinsPerDecade](default10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](default1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](default1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.[includeNitrogenII](default.false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet.[depthOpticalISMCoefficient](default1.0d0) — Multiplicative coefficient for optical depth in the ISM.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[label]— A label for the mass function.[comment]— A descriptive comment for the mass function.[masses]— The masses corresponding to bin centers.[covarianceBinomialBinsPerDecade](default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[rootVarianceFractionalMinimum](default0.0d0) — The minimum fractional root variance (relative to the target dataset).[fileName]— The name of the file from which to read concentration distribution function parameters.[comment]— A comment describing this analysis.[label]— A label for this analysis.[label]— A label for the concentration distribution function.[comment]— A descriptive comment for the concentration distribution function.[redshift]— The redshift at which to compute the concentration distribution function.[massMinimum]— Minimum halo mass for the concentration distribution function.[massMaximum]— Maximum halo mass for the concentration distribution function.[concentrationMinimum]— Minimum concentration for the concentration distribution function.[concentrationMaximum]— Maximum concentration for the concentration distribution function.[countConcentrationsPerDecade]— Number of concentrations per decade at which to compute the concentration distribution function.[timeRecent]— Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis.[massParticle]— The particle mass in the source N-body simulation.[targetLabel]— Label for the target dataset.[functionValueTarget]— The target function for likelihood calculations.[functionCovarianceTarget]— The target function covariance for likelihood calculations.[fileName]— The name of the file from which to read star forming main sequence function parameters.[comment]— A comment describing this analysis.[label]— A label for this analysis.[label]— A label for the star forming main sequence function.[comment]— A descriptive comment for the star forming main sequence function.[massMinimum]— Minimum stellar mass for the star forming main sequence function.[massMaximum]— Maximum stellar mass for the star forming main sequence function.[countMassesPerDecade]— Number of masses per decade at which to compute the star forming main sequence function.[targetLabel]— Label for the target dataset.[meanValueTarget]— The target function for likelihood calculations.[meanCovarianceTarget]— The target function covariance for likelihood calculations.[label]— A label for the mass function.[comment]— A descriptive comment for the mass function.[separations]— The separations corresponding to bin centers.[massMinima]— The minimum mass of each mass sample.[massMaxima]— The maximum mass of each mass sample.[massHaloBinsPerDecade](default10) — The number of bins per decade of halo mass to use when constructing the mass function covariance matrix for main branch galaxies.[massHaloMinimum](default1.0d8) — The minimum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[massHaloMaximum](default1.0d16) — The maximum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[wavenumberCount](default60_c_size_t) — The number of bins in wavenumber to use in computing the correlation function.[wavenumberMinimum](default1.0d-3) — The minimum wavenumber to use when computing the correlation function.[wavenumberMaximum](default1.0d4) — The maximum wavenumber to use when computing the correlation function.[integralConstraint]— The integral constraint for these correlation functions.[depthLineOfSight]— The line-of-sight depth over which the correlation function was projected.[halfIntegral]— Set to true if the projection integrand should be over line-of-sight depths greater than zero.[binnedProjectedCorrelationTarget]— The target function for likelihood calculations.[binnedProjectedCorrelationCovarianceTarget]— The target function covariance for likelihood calculations.[targetLabel](defaultvar_str('')) — A label for the target dataset in a plot of this analysis.[starFormationRateSpecificQuiescentLogarithmic]— The base-10 logarithm specific star formation rate (in units of Gyr\(^{-1}\)) separating quiescent and star-forming galaxies.[starFormationRateSpecificLogarithmicError]— The observational fractional error in specific star formation rate (in units of dex) of galaxies.[fileName]— The name of the file from which to read quiescent fraction function parameters.[comment]— A comment describing this analysis.[label]— A label for this analysis.[label]— A label for the star forming main sequence function.[comment]— A descriptive comment for the star forming main sequence function.[massMinimum]— Minimum stellar mass for the star forming main sequence function.[massMaximum]— Maximum stellar mass for the star forming main sequence function.[countMassesPerDecade]— Number of masses per decade at which to compute the star forming main sequence function.[targetLabel]— Label for the target dataset.[meanValueTarget]— The target function for likelihood calculations.[meanCovarianceTarget]— The target function covariance for likelihood calculations.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[radiusFractionalTruncateMinimum](default2.0d0) — The minimum radius (in units of the virial radius) to begin truncating the density profile.[radiusFractionalTruncateMaximum](default4.0d0) — The maximum radius (in units of the virial radius) to finish truncating the density profile.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[velocityDispersionApproximate](default.true.) — Iftrue, radial velocity dispersion is computed using an approximate method in which we assume that \(\sigma_\mathrm{r}^2(r) \rightarrow \sigma_\mathrm{r}^2(r) - (2/3) \epsilon(r)\), where \(\epsilon(r)\) is the specific heating energy. Iffalsethen radial velocity dispersion is computed by numerically solving the Jeans equation.[tolerateEnclosedMassIntegrationFailure](default.false.) — Iftrue, tolerate failures to find the mass enclosed as a function of radius.[tolerateVelocityDispersionFailure](default.false.) — Iftrue, tolerate failures to compute the velocity dispersion.[tolerateVelocityMaximumFailure](default.false.) — Iftrue, tolerate failures to find the radius of the maximum circular velocity.[toleratePotentialIntegrationFailure](default.false.) — Iftrue, tolerate numerical failures when computing the gravitational potential of a heated dark matter profile, allowing the calculation to continue with a fallback result rather than aborting.[toleranceRelativeVelocityDispersion](default1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.[toleranceRelativeVelocityDispersionMaximum](default1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.[fractionRadiusFinalSmall](default1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.[toleranceRelativePotential](default1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.[tolerateVelocityMaximumFailure](default.true.) — If true, tolerate failures to find the radius of the peak in the rotation curve.[lengthResolution]— The gravitational softening length \(\Delta x\) (in Mpc) of the N-body simulation, which sets the minimum spatial scale below which the dark matter profile is smoothed to avoid artificial two-body effects.[massResolution]— The mass resolution \(\Delta M\) (in \(\mathrm{M}_\odot\)) of the N-body simulation, representing the minimum halo mass that can be resolved; profiles of halos near this limit are softened to account for particle discreteness effects.[resolutionIsComoving]— If true, the resolution length is assumed to be fixed in comoving coordinates, otherwise in physical coordinates.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[C](default400.0d0) — The parameter \(C\) appearing in the halo concentration algorithm of Ludlow et al. (2016).[f](default0.02d0) — The parameter \(f\) appearing in the halo concentration algorithm of Ludlow et al. (2016).[timeFormationSeekDelta](default0.0d0) — The parameter \(\Delta \log t\) by which the logarithm of the trial formation time is incremented when stepping through the formation history of a node to find the formation time. If set to zero (or a negative value) the cumulative mass histories of nodes are assumed to be monotonic functions of time, and the formation time is instead found by a root finding algorithm,[massBoundIsInactive](default.false.) — Specifies whether or not the bound mass of the satellite component is inactive (i.e. does not appear in any ODE being solved).[useLastIsolatedTime](default.false.) — If true, evaluate the halo virial radius using a the virial density definition at the last isolated time of the halo.[filterName]— The filter to select.[filterType]— The filter type (rest or observed) to select.[redshiftBand]— The redshift of the band (if not the output redshift).[postprocessChain]— The postprocessing chain to use.[cloudyTableFileName](defaultvar_str('%DATASTATICPATH%/hiiRegions/emissionLineLuminosities_BC2003_highResolution_imfChabrier.hdf5')) — The file of emission line luminosities to use.[lineNames]— The emission lines to extract.[component]— The component from which to extract star formation rate.[toleranceRelative](default1.0d-3) — The relative tolerance used in integration over stellar population spectra.[component]— The component from which to extract star formation rate.[radiusCore]— The soliton core radius (in Mpc) characterizing the size of the quantum pressure-supported central core of the fuzzy dark matter halo; the density profile flattens inside this scale.[densitySolitonCentral]— The central density (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the solitonic core at \(r=0\), which sets the overall normalization of the density profile \(\rho(r) = \rho_\mathrm{c} [1+(r/r_c)^2]^{-8}\).[toleranceRelativePotential](default1.0d-3) — The relative tolerance used in numerical ODE solutions for the gravitational potential of the solitonic core profile.[dimensionless](default.true.) — If true the soliton profile is treated as dimensionless (scale-free), allowing its radial and density quantities to be specified in arbitrary units.[componentType](defaultvar_str('unknown')) — The galactic structure component type (e.g.dark matter halo, disk, spheroid) represented by this mass distribution, used for component-specific queries.[massType](defaultvar_str('unknown')) — The mass type (e.g.dark matter, baryonic, total) represented by this mass distribution, used for mass-type-specific queries.[radiusTransition]— The transition radius (in Mpc) at which the density profile smoothly switches from the halo profile to the accretion flow, controlled by the fourth-order transition function \(f_\mathrm{trans}(r)\).[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[componentType](defaultvar_str('unknown')) — The component type that this mass distribution represents.[massType](defaultvar_str('unknown')) — The mass type that this mass distribution represents.[timeAge]— The age of the halo (in Gyr) since its formation, determining the total time available for SIDM self-interactions to thermalize the inner halo and produce an isothermal core.[velocityRelativeMean]— Mean relative velocity to calculate self interaction cross section.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[componentType](defaultvar_str('unknown')) — The component type that this mass distribution represents.[massType](defaultvar_str('unknown')) — The mass type that this mass distribution represents.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[componentType](defaultvar_str('unknown')) — The component type that this mass distribution represents.[massType](defaultvar_str('unknown')) — The mass type that this mass distribution represents.[tolerateVelocityMaximumFailure](default.false.) — If true, tolerate failures to find the radius of the peak in the rotation curve.[tolerateEnclosedMassIntegrationFailure](default.false.) — Iftrue, tolerate failures to find the mass enclosed as a function of radius.[toleratePotentialIntegrationFailure](default.false.) — Iftrue, tolerate failures to compute the potential.[fractionRadiusFinalSmall](default1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.[toleranceRelativePotential](default1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.[lengthResolution]— The spatial resolution length scale (in Mpc) below which the underlying density profile is softened to a flat core, mimicking the finite force resolution of an N-body simulation.[nonAnalyticSolver](defaultvar_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.[componentType](defaultvar_str('unknown')) — The component type that this mass distribution represents.[massType](defaultvar_str('unknown')) — The mass type that this mass distribution represents.[massMinimum]— The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.[massMaximum]— The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.[massCountPerDecade]— The number of logarithmic bins per decade of halo mass used when constructing the halo mass function.[description]— A human-readable description of this mass function dataset, stored as metadata in the output file.[simulationReference]— A bibliographic reference for the N-body simulation from which this mass function is derived, stored as metadata.[simulationURL]— A URL pointing to the publicly accessible dataset or documentation for the N-body simulation, stored as metadata.[bootstrapSampleCount](default30_c_size_t) — The number of bootstrap resamples of the particles that should be used.[representativeMinimumCount](default10_c_size_t) — Minimum number of representative particles used to compute the center of a halo.[tolerance](default1.0d-2) — The tolerance in the summed weight of bound particles which must be attained to declare convergence.[bootstrapSampleRate](default1.0d0) — The sampling rate for particles.[representativeFraction](default0.05d0) — Fraction of bound particles used to compute the center of a halo.[analyzeAllParticles](default.true.) — If true, all particles are assumed to be self-bound at the beginning of the analysis. Unbound particles at previous times are allowed to become bound in the current snapshot. If false and the self-bound information from the previous snapshot is available, only the particles that are self-bound at the previous snapshot are assumed to be bound at the beginning of the analysis.[useVelocityMostBound](default.false.) — If true, the velocity of the most bound particle in velocity space is used as the representative velocity of the satellite. If false, use the mass weighted mean velocity (center-of-mass velocity) of self-bound particles instead.[orderRotation](defaultvar_str('none')) — The order in which evaluation of likelihoods should be rotated as a function of process number.[logLikelihoodAccept](defaulthuge(0.0d0)) — The log-likelihood which should be “accepted”—once the log-likelihood reaches this value (or larger) no further updates to the chain will be made.[report](default.false.) — If true, report on the log-likelihood obtained.[means]— The mean of the multivariate normal distribution.[covariance]— The covariance matrix for the of the multivariate normal distribution.[countForestsMaximum](default-1_c_size_t) — If set to a positive number, this is the maximum number of forests that will be evolved.[walltimeMaximum](default-1_kind_int8) — If set to a positive number, this is the maximum wall time for which forest evolution is allowed to proceed before the task gives up.[tolerateFailures](default.false.) — If true then failures to evolve a forest are tolerated. The forest is evolved no further, but evolution of other forests continues.[evolveForestsInParallel](default.true.) — If true then each forest is evolved by a separate OpenMP thread. Otherwise, a single thread evolves all forests.[suspendToRAM](default.true.) — Specifies whether trees should be suspended to RAM (otherwise they are suspend to file).[suspendPath]— The path to which tree suspension files will be stored.[timeIntervalCheckpoint](default-1_kind_int8) — If positive, gives the time in seconds between storing of checkpoint files. If zero or negative, no checkpointing is performed..[fileNameCheckpoint]— The path to which checkpoint data will be stored.[logM0](default10.0d0) — The parameter \(\log_{10} M_0\) (with \(M_0\) in units of \(\mathrm{M}_\odot\)) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.[logSFR0](default9.0d0) — The parameter \(\alpha_0\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.[logSFR1](default0.0d0) — The parameter \(\alpha_1\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.[cW](default3.78062835d0) — The parameter \(c_\mathrm{W}\) in the Bohr et al. (2021) power spectrum window function.[beta](default3.4638743d0) — The parameter \(\beta\) in the Bohr et al. (2021) power spectrum window function.[transferFunctionType](defaultvar_str('darkMatter')) — Specifies whether to use thedarkMatterortotaltransfer function.[fileName]— The name of the file from which to read a tabulated transfer function.[redshift](default0.0d0) — The redshift of the transfer function to read.[factorWavenumberSmoothExtrapolation](default0.0d0) — If positive, and extrapolation is used at high wavenumbers, the slope for extrapolation will be set by averaging over wavenumbers from \(k_\mathrm{max}/f\) to \(k_\mathrm{max}\), where \(f=\)[factorWavenumberSmoothExtrapolation]and \(k_\mathrm{max}\) is the highest wavenumber tabulated. This avoids spurious extrapolation for highly oscillatory transfer functions.[acceptNegativeValues](default.false.) — If true, negative values in the transfer function are allowed (and the absolute value is taken prior to interpolation). Otherwise, negative values result in an error.[fractionalTimeStep](default0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).[fileName](defaultvar_str('none')) — The name of the file to/from which tabulations of barrier first crossing probabilities should be written/read. If set to “none” tables will not be stored.[fractionalTimeStep](default0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).[varianceNumberPerUnitProbability](default1000) — The number of points to tabulate per unit variance for first crossing probabilities.[varianceNumberPerUnit](default40) — The number of tabulation points per unit of \(\sigma^2\) used when building the rate look-up table for the Farahi excursion-set first-crossing distribution; higher values improve interpolation accuracy at the cost of memory and initialization time.[varianceNumberPerDecade](default400) — The number of points to tabulate per decade of progenitor variance for first crossing rates.[varianceNumberPerDecadeNonCrossing](default40) — The number of points to tabulate per decade of progenitor variance for non-crossing rates.[timeNumberPerDecade](default10) — The number of tabulation points per decade of cosmic time used when building the first-crossing rate look-up table as a function of time; higher values improve temporal interpolation accuracy for rapidly evolving cosmologies.[varianceIsUnlimited](default.false.) — If true, the variance is assumed to have no upper limit (e.g. as in the case of CDM). This allows the tabulated solutions to be extended arbitrarily. Otherwise, tables are extended to encompass just the range of variance requested.[linkingLength](default0.2d0) — The friends-of-friends linking length to use in computing virial density contrasts with the percolation analysis of More et al. (2011).
galacticFilterStarFormationRateNonParametric¶
A galactic (high- or low-pass) filter for star formation rate. Galaxies with a combined disk, spheroid, plus NSC star formation rate are passed if they are above or below (for [filterType]\(=\)highPass or lowPass respectively) a mass-dependent threshold. The threshold is linearly interpolated in log([rateStarFormation]) vs. log([massStellar]).
Parameters
[filterType]— Specifies whether the filter passes galaxies below (lowPass) or above (highPass) the mass-dependent star formation rate threshold, controlling whether quiescent or star-forming galaxies are selected.[massStellar]— The list of stellar masses at which the star formation rate threshold is specified.[rateStarFormation]— The list of star formation rate thresholds for each stellar mass.
galacticFilterStellarAbsoluteMagnitudes¶
A galactic low-pass (i.e. bright-pass) filter for stellar absolute magnitudes. Galaxies with absolute magnitude in each band, \(i\), less than or equal to a fixed threshold, \(M_{0,i}=\)[absoluteMagnitudeThreshold].
Parameters
[absoluteMagnitudeThreshold]— The parameter \(M_0\) appearing in the stellar absolute magnitude threshold for the stellar absolute magnitude galactic filter class.
galacticFilterStellarApparentMagnitudes¶
A galactic low-pass (i.e. bright-pass) filter for stellar apparent magnitudes. Galaxies with apparent magnitude in each band, \(i\), less than or equal to a fixed threshold, \(m_{0,i}=\)[apparentMagnitudeThreshold].
Parameters
[apparentMagnitudeThreshold]— The parameter \(m_0\) appearing in the stellar apparent magnitude threshold for the stellar apparent magnitude galactic filter class.
galacticFilterStellarMass¶
A galactic high-pass filter for stellar mass. Galaxies with a combined disk, spheroid, plus NSC stellar mass greater than or equal to a fixed threshold, \(M_{\star,0}=\)[massThreshold].
Parameters
[massThreshold]— The parameter \(M_0\) (in units of \(\mathrm{M}_\odot\)) appearing in the stellar mass threshold for the stellar mass galactic filter class.
galacticFilterStellarMassMorphology¶
A galactic high-pass filter for stellar mass-weighted morphology (i.e. spheroid-to-total ratio). Galaxies with a spheroid-to-total ratio (by stellar mass) greater than or equal to a fixed threshold, \(R_{\star,0}=\)[spheroidToTotalThreshold].
Parameters
[spheroidToTotalRatioThreshold]— The parameter \(R_0\) appearing in the stellar mass-weight morphology threshold for the stellar mass-weighted morphology galactic filter class.
galacticFilterStreamImpact¶
A filter for subhalos that could impact a stream during the timestep. We consider a subhalo, at time \(t=0\) (defined as the current time), at position \(\mathbf{r}\) and moving with velocity \(\mathbf{v}\). The time of closest approach to a point \(\mathbf{r}^\prime\) is given by
We want to keep subhalos which may impact upon a stream of radius \(r^\prime\) during the timestep, allowing for arbitrary rotations of the subhalo system. Therefore, we must find the minimum and maximum possible values of \(t_\mathrm{impact}\) when considering all points on the sphere of radius \(r^\prime\). These extrema clearly occur when \(\mathbf{r}^\prime\) is aligned, or anti-aligned with \(\mathbf{v}\), i.e.:
Parameters
[radiusOrbitalStream]— The orbital radius of the stream (which is assumed to be on a circular orbit).
galacticFilterStreamKick¶
A filter for the velocity kick imparted by subhalos to a stellar stream. We compute an upper limit on the velocity kick a subhalo can impart on the stream, for any orientation along a sphere of radius [radiusOrbitalStream], and filter out any subhalos that do not create a total velocity kick greater than [cutoffVelocityKick].
Parameters
[radiusOrbitalStream]— The orbital radius of the stream (which is assumed to be on a circular orbit).[speedOrbitalStream]— The orbital speed of the stream (which is assumed to be on a circular orbit).[cutoffVelocityKick]— The minimum velocity kick (in km/s) that a subhalo must be able to impart on the stream for the node to pass; subhalos whose maximum kick falls below this threshold are rejected.
galacticFilterSurveyGeometry¶
A galactic filter that passes only nodes whose sky position and distance fall within the footprint of a specified survey geometry object. The [positionType] parameter selects whether the node’s intrinsic or orbital position is used when evaluating inclusion within the survey volume.
Parameters
[positionType](defaultvar_str('position')) — The type of position to use in survey geometry filters.
galacticFilterTreeHosted¶
Passes only nodes that are currently hosted in a merger tree, filtering out any unhosted nodes that may exist outside the tree structure.