Output Analysis¶
Class providing on-the-fly analysis of Galacticus model outputs, computing statistics such as stellar mass functions, luminosity functions, size–mass relations, and other observational comparisons during the simulation run rather than as a post-processing step. Analyses are finalized (e.g. accumulated across trees and MPI tasks) after all trees have been processed, and results are written to the output HDF5 file. A log-likelihood method enables use within posterior sampling frameworks.
Default implementation: outputAnalysisNull
Methods¶
analyze→voidExtract properties from the given
nodeat output indexiOutputand accumulate them into the analysis statistic (e.g. histogram bin counts or likelihood contributions).type (treeNode), intent(inout) :: nodeinteger(c_size_t), intent(in ) :: iOutput
newTree→voidPerform any initialization or bookkeeping required at the start of analyzing a new merger tree at output index
iOutput, for example resetting per-tree accumulators.type (mergerTree), intent(inout) :: treeinteger(c_size_t ), intent(in ) :: iOutput
finalize→voidFinalize the analysis after all trees and MPI tasks have been processed, computing derived statistics and writing results to the output HDF5 group specified by
groupName.type(varying_string), intent(in ), optional :: groupName
reduce→voidReduce (aggregate) this analysis object’s accumulated statistics onto the
reducedobject, typically used for MPI reduction to combine results from multiple processes.class(outputAnalysisClass), intent(inout) :: reduced
logLikelihood→double precisionReturn the log-likelihood of the model predictions compared to the target observational data, summed over all bins or data points included in this analysis.
outputAnalysisBlackHoleBulgeRelation¶
Computes the relation between supermassive black hole mass and host spheroid (bulge) stellar mass for comparison with observational data, with configurable random and systematic error polynomial coefficients for both black hole and bulge masses.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.09d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.09d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.09d0) — The minimum random error for stellar masses.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisBlackHoleVelocityDispersionRelation¶
Computes the relation between supermassive black hole mass and host bulge stellar velocity dispersion using the observational data from McConnell and Ma (2013), with configurable random and systematic error polynomial coefficients for both black hole mass and velocity dispersion.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.01d0) — The minimum random error for velocity dispersions.[randomErrorMaximum](real; default0.01d0) — The minimum random error for velocity dispersions.[report](boolean; default.false.) — If true, report on statistics accumulation.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisBlackHoleVsHaloMassRelation¶
A black hole vs. halo mass relation output analysis class. Target data is read from an HDF5 file specified by the [fileNameTarget] parameter. This file must contain one or more groups named redshiftIntervalN where N is an integer. Each such group specifies the black hole mass–halo mass relation in one redshift interval, and must contain the following datasets and attributes:
dataset
massHalo: halo mass in units of \(\mathrm{M}_\odot\);dataset
massBlackHole: black hole mass in units of \(\mathrm{M}_\odot\);dataset
massBlackHoleError: uncertainty in black hole mass in units of \(\mathrm{M}_\odot\);dataset
massBlackHoleScatter: scatter in black hole mass in units of dex;dataset
massBlackHoleScatterError: uncertainty in scatter in black hole mass in units of dex;attribute
redshiftMinimum: the minimum redshift associated with this redshift interval;attribute
redshiftMaximum: the maximum redshift associated with this redshift interval.
While not required, it is recommended that each of these datasets has attributes description and unitsInSI that provide a description of the dataset, and the multiplicative factor needed to convert them to SI standard units, respectively.
Additionally, the file must contain a cosmology group that specifies the cosmological model assumed in constructing the dataset, and which has attributes:
OmegaMatter: the matter density in units of the critical density, \(\Omega_\mathrm{M}\);OmegaDarkEnergy: the dark energy density in units of the critical density, \(\Omega_\Lambda\);OmegaBaryon: the baryon density in units of the critical density, \(\Omega_\mathrm{b}\);HubbleConstant: the Hubble constant in units of km/s/Mpc.
The file must have an attribute haloMassDefinition which specifies the halo mass definition assumed in constructing the dataset. Allowed values are:
'spherical collapse'or'virial': halos are defined as have mean density contrasts given by spherical collapse calculations, e.g. Percival (2005);'Bryan & Norman (1998)': halos are defined as have mean density contrasts given by the fitting formula of Bryan and Norman (1998);'X * mean density': halos are defined as having mean densities equal to ;Xtimes the mean density of the universe;'X * critical density': halos are defined as having mean densities equal to ;Xtimes the critical density of the universe;
Lastly, the file must have two attributes used to identify and level the dataset:
label: a space-free label that will be appended to the analysis group in the output, e.g.Leauthaud2012;reference: a reference for the dataset suitable for inclusion in figures, e.g.Leauthaud et al. (2012).
Parameters
[likelihoodBins](integer) — Controls which bins in the black hole 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](string) — The name of the file containing the target data.[redshiftInterval](integer; default1) — The redshift interval to use.[likelihoodNormalize](boolean; default.false.) — If true, then normalize the likelihood to make it a probability density.[computeScatter](boolean; default.false.) — If true, the scatter in \(\log_{10}\)(black hole mass) is computed. Otherwise, the mean is computed.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for black hole mass in the black hole vs halo mass relation.[systematicErrorMassHaloPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the black hole vs halo mass relation.
outputAnalysisColorDistributionSDSS¶
Computes the distribution of galaxy optical colors from the Sloan Digital Sky Survey (SDSS), selecting one of 16 predefined stellar mass and redshift bin distributions via the distributionNumber parameter for comparison with observational data.
Parameters
[distributionNumber](integer; ≥ 1, ≤ 16) — The number (1-16) of the distribution to compute.[label](string) — A label for the analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing SDSS stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisVolumeFunction1D)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisVolumeFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisConcentrationDistribution¶
Computes the distribution of dark matter halo concentration parameters within a specified mass range and redshift, reading bin configuration from a file and comparing model predictions against target data with a minimum fractional root variance floor.
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
[rootVarianceFractionalMinimum](real; default0.0d0) — The minimum fractional root variance (relative to the target dataset).[fileName](string) — 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.[comment](string) — A descriptive comment for the star forming main sequence function.[label](string) — A label for the star forming main sequence function.[redshift](real) — The redshift of the transfer function to read.[massMinimum](real) — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.[massMaximum](real) — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.[concentrationMinimum](real) — Minimum concentration for the concentration distribution function.[concentrationMaximum](real) — Maximum concentration for the concentration distribution function.[countConcentrationsPerDecade](real) — Number of concentrations per decade at which to compute the concentration distribution function.[timeRecent](real) — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis.[massParticle](real) — The particle mass in the source N-body simulation.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisConcentrationDistributionCDMCOCO¶
Computes the halo concentration distribution function for comparison with the COCO cold dark matter N-body simulation data, selecting one of 7 mass bin distributions via distributionNumber and setting a minimum fractional root variance floor via rootVarianceFractionalMinimum.
Parameters
[rootVarianceFractionalMinimum](real; default0.0d0) — The minimum fractional root variance (relative to the target dataset).[distributionNumber](integer; ≥ 1, ≤ 7) — The number (1-7) of the distribution to compute.[fileName](string) — The name of the file from which to read concentration distribution function parameters. (inherited fromoutputAnalysisConcentrationDistribution)[comment](string) — A comment describing this analysis. (inherited fromoutputAnalysisConcentrationDistribution)[label](string) — A label for this analysis. (inherited fromoutputAnalysisConcentrationDistribution)[redshift](real) — The redshift at which to compute the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[massMinimum](real) — Minimum halo mass for the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[massMaximum](real) — Maximum halo mass for the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[concentrationMinimum](real) — Minimum concentration for the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[concentrationMaximum](real) — Maximum concentration for the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[countConcentrationsPerDecade](real) — Number of concentrations per decade at which to compute the concentration distribution function. (inherited fromoutputAnalysisConcentrationDistribution)[timeRecent](real) — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis. (inherited fromoutputAnalysisConcentrationDistribution)[massParticle](real) — The particle mass in the source N-body simulation. (inherited fromoutputAnalysisConcentrationDistribution)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisConcentrationDistribution)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisConcentrationDistribution)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisConcentrationDistribution)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisConcentrationVsHaloMassCDMLudlow2016¶
A concentration vs. halo mass analysis class matched to the Ludlow et al. (2016) CDM sample.
Parameters
[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisCorrelationFunction¶
A generic two-point correlation function output analysis class.
For constraints corresponding to (possibly, projected) correlation functions, the model expectation is computed using the halo model Cooray and Sheth (2002). For each model halo, each galaxy (satellite and central) is assessed to see if it meets the criteria for inclusion in the sample. Where the sample includes mass limits (either just a lower limit, or lower and upper limits) each galaxy is assigned a probability of inclusion in the sample based on its mass and the random error in mass. Thus, each halo is characterized by the probability of having a central galaxy in the sample, \(p^\mathrm{(c)}\), and \(N\) probabilities, \(p_i^\mathrm{(s)}\), of each satellite galaxy being in the sample. We assume binomial statistics for each galaxy’s probability of inclusion, and further assume that these probabilities are uncorrelated. Therefore, the contribution of the halo to the one- and two-halo terms of the power spectrum in the halo model are:
and
respectively, where \(w\) is the weight of the halo (i.e. the number of such model halos expected per unit volume), \(b(M)\) is the bias of halos of mass \(M\), \(u(k|M)\) is the Fourier-transform of the halo density profile, and \(P_\mathrm{lin}(k)\) is the linear theory power spectrum, and \(P(p_1,\ldots,p_N)\) is the Poisson binomial distribution for \(N\) events with probabilities \(p_1,\ldots,p_N\). The contribution of the halo to the galaxy density, \(n_\mathrm{gal}\), is simply \(\Delta n_\mathrm{gal} = w \left[ p^\mathrm{(c)} + \sum_{i=1}^N p_i^\mathrm{(s)} \right]\).
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[separations](real) — The separations corresponding to bin centers.[massMinima](real) — The minimum mass of each mass sample.[massMaxima](real) — The maximum mass of each mass sample.[massHaloBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing the mass function covariance matrix for main branch galaxies.[massHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[massHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[wavenumberCount](integer; default60_c_size_t) — The number of bins in wavenumber to use in computing the correlation function.[wavenumberMinimum](real; default1.0d-3) — The minimum wavenumber to use when computing the correlation function.[wavenumberMaximum](real; default1.0d4) — The maximum wavenumber to use when computing the correlation function.[integralConstraint](real) — The integral constraint for these correlation functions.[depthLineOfSight](real) — The line-of-sight depth over which the correlation function was projected.[halfIntegral](boolean) — Set to true if the projection integrand should be over line-of-sight depths greater than zero.[binnedProjectedCorrelationTarget](real) — The target function for likelihood calculations.[binnedProjectedCorrelationCovarianceTarget](real) — The target function covariance for likelihood calculations.[targetLabel](string) — Label for the target dataset.
outputAnalysisCorrelationFunctionHearin2013SDSS¶
Computes the galaxy two-point correlation function split by color for comparison with the Hearin et al. (2014) SDSS analysis, with stellar mass random/systematic error polynomial coefficients and binomial covariance matrix parameters for halo mass range.
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[massHaloBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing the mass function covariance matrix for main branch galaxies.[massHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[massHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisCorrelationFunction)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisCorrelationFunction)[separations](real) — The separations corresponding to bin centers. (inherited fromoutputAnalysisCorrelationFunction)[massMinima](real) — The minimum mass of each mass sample. (inherited fromoutputAnalysisCorrelationFunction)[massMaxima](real) — The maximum mass of each mass sample. (inherited fromoutputAnalysisCorrelationFunction)[wavenumberCount](integer; default60_c_size_t) — The number of bins in wavenumber to use in computing the correlation function. (inherited fromoutputAnalysisCorrelationFunction)[wavenumberMinimum](real; default1.0d-3) — The minimum wavenumber to use when computing the correlation function. (inherited fromoutputAnalysisCorrelationFunction)[wavenumberMaximum](real; default1.0d4) — The maximum wavenumber to use when computing the correlation function. (inherited fromoutputAnalysisCorrelationFunction)[integralConstraint](real) — The integral constraint for these correlation functions. (inherited fromoutputAnalysisCorrelationFunction)[depthLineOfSight](real) — The line-of-sight depth over which the correlation function was projected. (inherited fromoutputAnalysisCorrelationFunction)[halfIntegral](boolean) — Set to true if the projection integrand should be over line-of-sight depths greater than zero. (inherited fromoutputAnalysisCorrelationFunction)[binnedProjectedCorrelationTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisCorrelationFunction)[binnedProjectedCorrelationCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisCorrelationFunction)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisCorrelationFunction)
outputAnalysisCrossCorrelator1D¶
A generic 1D cross-correlator (i.e. the cross-correlation of two weights binned by some property, e.g. a mass function) output analysis class.
The assumptions used when constructing the covariance matrix are controlled by the parameter [covarianceModel], and follow the method described for the outputAnalysisVolumeFunction1D output analysis class.
Methods
results— Return the results of the volume function operator.finalizeAnalysis— Finalize the analysis of this function.setReporting— Activate/deactivate reporting.
Parameters
[binCenter](real) — The value of the property at the center of each bin.[binWidth](real) — The width of the bins.[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins.[outputWeight](real) — The weight to assign to each bin at each output.[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.
outputAnalysisFormationTimeDistribution¶
A dark matter halo time formation distribution output analysis class.
Parameters
[covarianceDiagonalize](boolean; default.false.) — If true, all off-diagonal elements of the covariance matrix are set to zero.[covarianceTargetOnly](boolean; default.false.) — If true, only the covariance of the target dataset is accounted for (otherwise the model covariance is added).[rootVarianceTargetFractional]— The diagonal of the covariance matrix is forced to be at least equal to this fraction multiplied by the target dataset squared. This may be a list of values corresponding to each element of the target dataset. If the list is shorter than the target dataset the final value in the list is applied to all remaining elements in the target dataset.[redshiftMinimum](real; default0.0d0) — Minimum redshift for the redshift formation time distribution.[redshiftMaximum](real; defaulthuge(0.0d0)) — Maximum redshift for the redshift formation time distribution.[alwaysIsolatedOnly](boolean) — If true, include only progenitors which have been always isolated halos.[redshiftParent](real) — Redshift of the parent halos.[fileName](string) — The name of the file from which to read redshift formation time parameters.[indexParent](integer) — The parent mass index to use from the file.[indexRedshift](integer) — The progenitor redshift index to use from the file.[comment](string) — A descriptive comment for the redshift formation time distribution.[label](string) — A label for the redshift formation time distribution.[targetLabel](string) — Label for the target dataset.[countRedshiftProgenitor](integer) — Number of redshift of progenitors at which to compute the redshift formation time distribution.[massParentMinimum](real) — Minimum mass of the parent halo for the progenitor mass function.[massParentMaximum](real) — Maximum mass of the parent halo for the progenitor mass function.[redshiftProgenitor](real) — Redshift of the progenitor halos.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisGalaxySizesSDSS¶
An output analysis class which computes the mass-dependent \(z\approx 0.07\) galaxy size distribution of Shen et al. (2003) from the SDSS. The size function reported by Shen et al. (2003) is converted to the appropriate cosmology for the given Galacticus model (assuming that sizes scale as the angular diameter distance, and masses as the square of the luminosity distance). The model sizes and masses are then used to construct a mass-dependent radius function by binning into a 2-D histogram using the size and mass bins reported by Shen et al. (2003) (modified as described above) as the centers of the bins (with bin boundaries placed at the geometric means of consecutive bin centers). Distributions are computed for both late-type and early-type galaxies, classified on the basis of the stellar mass spheroid-to-total ratio, with the division at a ratio given by [massStellarRatio].
Parameters
[distributionNumber](integer; ≥ 1, ≤ 34) — The number (1-34) of the distribution to compute.[massStellarRatio](real; default0.3d0) — The stellar mass bulge-to-total ratio used to discriminate late-type vs. early-type galaxies.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[label](string) — A label for the analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisVolumeFunction1D)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisVolumeFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisHeatedLikelihood¶
Wraps another outputAnalysisClass and raises its log-likelihood to the power \(1/T\) where \(T\) is the temperature parameter, effectively flattening the posterior for use in parallel tempering or annealing inference methods.
Parameters
[temperature](real) — The temperature to which to heat the likelihood.
outputAnalysisHIVsHaloMassRelationPadmanabhan2017¶
Computes the HI gas mass to dark matter halo mass relation for comparison with the Padmanabhan et al. (2017) ALFALFA observational constraints, with systematic and random error polynomial coefficients and optional single-bin likelihood evaluation.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for HI vs halo mass relation.[likelihoodBin](integer; default0_c_size_t) — If \(>0\) then use only the mass bin given by this value in the likelihood calculation.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisICMXrayLuminosityTemperature¶
Computes the intracluster medium X-ray luminosity–temperature relation for galaxy groups and clusters, comparing model predictions to observational data with configurable random and systematic error polynomial coefficients for both luminosity and temperature.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.05d0) — The minimum random error for X-ray temperature.[randomErrorMaximum](real; default0.05d0) — The maximum random error for X-ray temperature.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisLocalGroupMassMetallicityRelation¶
Computes the stellar mass–gas-phase metallicity relation for Local Group satellite galaxies, comparing model predictions against observed data with stellar mass and metallicity random/systematic error polynomial coefficients, binomial covariance parameters, and position-type selection.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for stellar masses.[metallicitySystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the metallicity systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.
outputAnalysisLocalGroupMassSizeRelation¶
Computes the stellar mass–half-light radius relation for Local Group satellite galaxies, comparing model predictions against observed data with stellar mass and size random/systematic error polynomial coefficients, binomial covariance parameters, and position-type selection.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for stellar masses.[sizeSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the size systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group mass-size relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group mass-size relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group mass-size relation covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.
outputAnalysisLocalGroupMassVelocityDispersionRelation¶
Computes the stellar mass–velocity dispersion relation for Local Group satellite galaxies, comparing model predictions against observed data with stellar mass and velocity dispersion random/systematic error polynomial coefficients, binomial covariance parameters, and position-type selection.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for stellar masses.[velocityDispersionSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the velocity dispersion systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group mass-velocity dispersion covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group mass-velocity dispersion covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group mass-velocity dispersion covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.
outputAnalysisLocalGroupOccupationFraction¶
Computes the fraction of dark matter halos occupied by observed Local Group satellite galaxies as a function of stellar mass, with configurable stellar mass random/systematic error polynomial coefficients, binomial covariance matrix parameters, and position-type selection.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for halo masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for halo masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for halo masses.[massStellarSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the stellar mass systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.
outputAnalysisLocalGroupStellarMassFunction¶
Computes the stellar mass function of Local Group satellite galaxies for comparison with observational data, with random/systematic error polynomial coefficients, fractional scatter, binomial covariance matrix parameters, position-type selection, and zero-point log-likelihood control.
Methods
finalizeAnalysis— Finalize analysis.
Parameters
[negativeBinomialScatterFractional](real; default0.18d0) — The fractional scatter (relative to the Poisson scatter) in the negative binomial distribution used in likelihood calculations.[randomErrorMinimum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group stellar mass function covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.[logLikelihoodZero](real; defaultlogImprobable) — The log-likelihood to assign to bins where the model expectation is zero.
outputAnalysisLocalGroupStellarMassHaloMassRelation¶
Computes the stellar mass–halo mass relation for Local Group satellite galaxies, comparing model predictions against observed data with stellar mass random/systematic error polynomial coefficients, binomial covariance matrix parameters, and position-type selection.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for halo masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for halo masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for halo masses.[massStellarSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the stellar mass systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar masses.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Local Group stellar mass-halo mass relation covariance matrices for main branch galaxies.[positionType](string; one ofposition,orbital; defaultorbital) — The type of position to use in survey geometry filters.
outputAnalysisLuminosityFunction¶
Computes the galaxy luminosity function as a number density per magnitude bin, with user-specified absolute magnitude bin centers, label, comment, optional target dataset for likelihood evaluation, and binomial covariance matrix construction parameters for halo mass range.
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[magnitudesAbsolute](real) — The absolute magnitudes corresponding to bin centers.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisLuminosityFunctionGunawardhana2013SDSS¶
Computes the H\(\alpha\) emission line luminosity function for comparison with the SDSS Gunawardhana et al. (2013) measurements, with H\(\alpha\) luminosity random/systematic error polynomial coefficients, gravitational lensing source size, and binomial covariance matrix parameters.
Parameters
[randomErrorMinimum](real; default0.1d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[depthOpticalISMCoefficient](real; default1.0d0) — Multiplicative coefficient for optical depth in the ISM.[label](string) — A label for the luminosity function. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[comment](string) — A descriptive comment for the luminosity function. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[luminosities](real) — The luminosities corresponding to bin centers. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[includeNitrogenII](boolean; default.false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisLuminosityFunctionHalpha¶
Computes the H\(\alpha\) emission line galaxy luminosity function in bins of line luminosity, optionally including [NII] doublet contamination (includeNitrogenII), applying ISM dust attenuation, and with configurable binomial covariance matrix parameters for halo mass range and optional target dataset.
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[luminosities](real) — The luminosities corresponding to bin centers.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[includeNitrogenII](boolean; default.false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet.[depthOpticalISMCoefficient](real; default1.0d0) — Multiplicative coefficient for optical depth in the ISM.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisLuminosityFunctionMonteroDorta2009SDSS¶
Computes the SDSS galaxy luminosity function in one of five photometric bands (u, g, r, i, or z) for comparison with the Montero-Dorta and Prada (2009) measurements, with magnitude random/systematic error polynomial coefficients, gravitational lensing source size, and binomial covariance parameters.
Parameters
[band](string) — The band (u, g, r, i, or z) for which the luminosity function should be computed.[randomErrorMinimum](real; default0.01d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.01d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.01d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the luminosity function. (inherited fromoutputAnalysisLuminosityFunction)[comment](string) — A descriptive comment for the luminosity function. (inherited fromoutputAnalysisLuminosityFunction)[magnitudesAbsolute](real) — The absolute magnitudes corresponding to bin centers. (inherited fromoutputAnalysisLuminosityFunction)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisLuminosityFunction)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunction)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunction)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisLuminosityFunctionSobral2013HiZELS¶
Computes the H\(\alpha\) luminosity function at one of four redshift intervals for comparison with the HiZELS Sobral et al. (2013) survey measurements, with H\(\alpha\) luminosity random/systematic error polynomial coefficients, gravitational lensing source size, and binomial covariance parameters.
Parameters
[redshiftInterval](integer) — The redshift interval (1, 2, 3, or 4) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for SDSS H\(\alpha\) luminosities.[randomErrorMaximum](real; default0.1d0) — The minimum random error for SDSS H\(\alpha\) luminosities.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for SDSS H\(\alpha\) luminosities.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS H\(\alpha\) luminosities.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing SDSS H\(\alpha\) luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS H\(\alpha\) luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS H\(\alpha\) luminosity function covariance matrices for main branch galaxies.[depthOpticalISMCoefficient](real; default1.0d0) — Multiplicative coefficient for optical depth in the ISM.[label](string) — A label for the luminosity function. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[comment](string) — A descriptive comment for the luminosity function. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[luminosities](real) — The luminosities corresponding to bin centers. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[includeNitrogenII](boolean; default.false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunctionHalpha)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisLuminosityFunctionStefanonMarchesini2013¶
Computes the near-infrared galaxy luminosity function in J or H band at one of four redshift intervals for comparison with the Stefanon and Marchesini (2013) survey measurements, with magnitude random/systematic error polynomial coefficients, gravitational lensing source size, and binomial covariance parameters.
Parameters
[band](string) — The band (J or H) for which the luminosity function should be computed.[redshiftInterval](integer; ≥ 0, ≤ 3) — The redshift interval (0-3) to use.[randomErrorMinimum](real; default0.01d0) — The minimum random error for absolute magnitudes.[randomErrorMaximum](real; default0.01d0) — The minimum random error for absolute magnitudes.[randomErrorPolynomialCoefficient](real; default[0.01d0]) — The coefficients of the random error polynomial for absolute magnitudes.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for absolute magnitudes.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS luminosity function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS luminosity function covariance matrices for main branch galaxies.[label](string) — A label for the luminosity function. (inherited fromoutputAnalysisLuminosityFunction)[comment](string) — A descriptive comment for the luminosity function. (inherited fromoutputAnalysisLuminosityFunction)[magnitudesAbsolute](real) — The absolute magnitudes corresponding to bin centers. (inherited fromoutputAnalysisLuminosityFunction)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisLuminosityFunction)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunction)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisLuminosityFunction)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionHI¶
Computes the HI gas mass function as a number density per unit log-mass, with user-specified mass bin centers, label, comment, optional target dataset for likelihood evaluation, and binomial covariance matrix construction parameters for halo mass range.
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[masses](real) — The masses corresponding to bin centers.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionHIALFALFAMartin2010¶
An ALFALFA HI \(z\approx 0.0\) mass function output analysis class measured by Martin et al. (2010). HI mass estimates can be affected by HI self-absorption for highly inclined galaxies. Zwaan et al. (1997) estimate that this effect would lead to a mean underestimation of HI masses by a factor \(1.1\) for a randomly oriented galaxy sample. Therefore, a value of \(-0.0414\) for the systematic parameter [systematicErrorPolynomialCoefficient] is recommended.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for ALFALFA HI masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing ALFALFA HI mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing ALFALFA HI mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing ALFALFA HI mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionHI)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionHI)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionHI)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionHI)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionHI)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionHI)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellar¶
Computes the galaxy stellar mass function as a number density per unit log-mass, with user-specified mass bin centers, label, comment, optional target dataset for likelihood evaluation, and binomial covariance matrix construction parameters for halo mass range.
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[masses](real) — The masses corresponding to bin centers.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarBaldry2012GAMA¶
A GAMA stellar mass function output analysis class, for \(z< 0.06\) galaxies measured by Baldry et al. (2012).
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for Baldry et al. (2012) GAMA stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for Baldry et al. (2012) GAMA stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for Baldry et al. (2012) GAMA stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for Baldry et al. (2012) GAMA stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Baldry et al. (2012) GAMA stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Baldry et al. (2012) GAMA stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Baldry et al. (2012) GAMA stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarBernardi2013SDSS¶
Computes the galaxy stellar mass function for comparison with the Bernardi et al. (2013) SDSS measurements, with stellar mass random/systematic error polynomial coefficients, gravitational lensing source size corrections, and binomial covariance matrix parameters for halo mass range.
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for Bernardi et al. (2013) SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for Bernardi et al. (2013) SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for Bernardi et al. (2013) SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for Bernardi et al. (2013) SDSS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Bernardi et al. (2013) SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Bernardi et al. (2013) SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Bernardi et al. (2013) SDSS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarPRIMUS¶
A PRIMUS stellar mass function output analysis class, for \(z\approx 0.2\) to \(z\approx 1\) galaxies measured by Moustakas et al. (2013).
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[redshiftInterval](integer) — The redshift interval (0-5) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for PRIMUS stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for PRIMUS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for PRIMUS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for PRIMUS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing PRIMUS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing PRIMUS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing PRIMUS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarSDSS¶
An SDSS stellar mass function output analysis class, which utilizes the stellar mass function for \(z\approx 0.07\) galaxies measured by Li and White (2009) from the SDSS.
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
The model masses are then used to construct a mass function by binning into a histogram using the masses reported by Li and White (2009) (modified as described above) as the centers of the bins (with bin boundaries placed at the geometric means of consecutive bin centers).
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing SDSS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarUKIDSSUDS¶
A UKIDSS UDS stellar mass function output analysis class, for \(z = 3\) to 5 galaxies measured by Caputi et al. (2011),
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[redshiftInterval](integer) — The redshift interval (0-2) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for UKIDSSUDS stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for UKIDSS UDS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for UKIDSS UDS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for UKIDSS UDS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing UKIDSS UDS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing UKIDSS UDS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing UKIDSS UDS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarULTRAVISTA¶
An ULTRAVISTA stellar mass function output analysis class, for \(0.2 < z< 4.0\) galaxies measured by Muzzin et al. (2013).
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[redshiftInterval](integer) — The redshift interval (0-6) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for ULTRAVISTA stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for ULTRAVISTA stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for ULTRAVISTA stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for ULTRAVISTA stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing ULTRAVISTA stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing ULTRAVISTA stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing ULTRAVISTA stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarVIPERS¶
A VIPERS stellar mass function output analysis class, for \(0.5 < z< 1.0\) galaxies measured by Davidzon et al. (2013).
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[redshiftInterval](integer) — The redshift interval (0-2) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for VIPERS stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for VIPERS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for VIPERS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for VIPERS stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing VIPERS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing VIPERS stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing VIPERS stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassFunctionStellarZFOURGE¶
A ZFOURGE stellar mass function output analysis class, for \(0.2 < z < 3\) galaxies measured by Tomczak et al. (2014).
Given a Galacticus model, total stellar masses of model galaxies are adjusted using:
where the \(\mathbf{S}\) operator is a multiplicative factor accounting for systematic errors in stellar mass determination and is equal to (Behroozi et al., 2010)
where \(s=\)[systematicErrorPolynomialCoefficient], the G operator is a multiplicative factor drawn from a log-normal distribution of width \(\sigma(M)\) dex for each galaxy to mimic the effects of random errors on stellar masses (motivated by the discussion of Behroozi et al. (2010)), the L operator accounts for gravitational lensing, and the C operator accounts for the difference between model and observed cosmologies. The random error model is given by:
where \(r=\)[randomErrorPolynomialCoefficient], \(\sigma_\mathrm{min}\)=[randomErrorMinimum], and \(\sigma_\mathrm{max}\)=[randomErrorMaximum].
Parameters
[redshiftInterval](integer) — The redshift interval (0-7) to use.[randomErrorMinimum](real; default0.1d0) — The minimum random error for ZFOURGE stellar masses.[randomErrorMaximum](real; default0.1d0) — The minimum random error for ZFOURGE stellar masses.[randomErrorPolynomialCoefficient](real; default[0.1d0]) — The coefficients of the random error polynomial for ZFOURGE stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for ZFOURGE stellar masses.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing ZFOURGE stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing ZFOURGE stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing ZFOURGE stellar mass function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisMassFunctionStellar)[masses](real) — The masses corresponding to bin centers. (inherited fromoutputAnalysisMassFunctionStellar)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisMassFunctionStellar)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMassFunctionStellar)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisMassMetallicityAndrews2013¶
Computes the gas-phase stellar mass–metallicity relation for comparison with the Andrews and Martini (2013) observational data, with stellar mass and metallicity random/systematic error polynomial coefficients and a gas fraction threshold for sample selection.
Parameters
[metallicitySystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the metallicity systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.07d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.07d0) — The maximum random error for stellar masses.[fractionGasThreshold](real; default0.05d0) — The minimum gas fraction to include in the sample.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisMassMetallicityBlanc2019¶
Computes the gas-phase stellar mass–metallicity relation for comparison with the Blanc et al. (2019) observational data, with stellar mass and metallicity random/systematic error polynomial coefficients and a gas fraction threshold for sample selection.
Parameters
[metallicitySystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the metallicity systematic error polynomial.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.07d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.07d0) — The maximum random error for stellar masses.[fractionGasThreshold](real; default0.05d0) — The minimum gas fraction to include in the sample.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisMassSizeRelationShen2003¶
An output analysis class that evaluates model likelihood given the galaxy mass-size relations of Shen et al. (2003).
Methods
finalizeAnalysis— Finalize the analysis of this function.
outputAnalysisMeanFunction1D¶
A generic 1D mean function (i.e. mean value of some property weighted by number density of objects binned by some property) output analysis class.
Methods
results— Return the results of the mean function operator.finalizeAnalysis— Finalize analysis of the mean function operator.setReporting— Activate/deactivate reporting.
Parameters
[label](string) — A label for the analysis.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis.[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis.[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis.[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis.[comment](string) — A descriptive comment for the analysis.[propertyLabel](string) — A label for the property variable.[propertyComment](string) — A descriptive comment for the property variable.[propertyUnits](string) — A human-readable description of the units for the property.[propertyQuantity](string) — Anastropy.units-parseable units string for the property.[propertyIsComoving](boolean) — If true, the property is in comoving units.[propertyUnitsInSI](real) — A units for the property in the SI system.[meanLabel](string) — A label for the mean.[meanComment](string) — A descriptive comment for the mean.[meanUnits](string) — A human-readable description of the units for the mean.[meanQuantity](string) — Anastropy.units-parseable units string for the mean.[meanIsComoving](boolean) — If true, the mean is in comoving units.[meanUnitsInSI](real) — A units for the mean in the SI system.[binCenter](real) — The value of the property at the center of each bin.[binWidth](real) — The width of the bins.[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins.[outputWeight](real) — The weight to assign to each bin at each output.[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density.[meanValueTarget](real) — The target function for likelihood calculations.[meanCovarianceTarget](real) — The target function covariance for likelihood calculations.[targetLabel](string) — A label for the target dataset in a plot of this analysis.
outputAnalysisMorphologicalFractionGAMAMoffett2016¶
Computes the early-type morphological fraction as a function of stellar mass for comparison with the GAMA Moffett et al. (2016) survey, classifying galaxies by spheroid-to-total ratio threshold (ratioEarlyType) with stellar mass and classification error polynomial coefficients.
Parameters
[ratioEarlyType](real; default0.5d0) — The minimum spheroid-to-total ratio for a galaxy to be classified as “early-type” when constructing the GAMA early-type fraction function.[ratioEarlyTypeError](real; default0.3d0) — The error in spheroid fraction to be used when constructing the GAMA early-type fraction function.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.07d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for stellar masses.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisMulti¶
Combines multiple outputAnalysisClass objects into a single analysis that runs all of them, enabling modular composition of independent analyses into a single output analysis configuration.
Methods
columnDescriptions— Return a description of the columns.elementCount— Return the number of properties in the tuple.extractDouble— Extract the double properties from the givennode.extractInteger— Extract the integer properties from the givennode.names— Return the names of the properties extracted.descriptions— Return descriptions of the properties extracted.unitsInSI— Return the units of the properties extracted in the SI system.units— Return an object containing units metadata for the properties.ranks— Return the ranks of the properties extracted.metaData— Populate a hash with meta-data for the property.
outputAnalysisNull¶
A no-op output analysis implementation that performs no analysis or output, useful as a placeholder or for disabling analyses without removing them from the configuration.
(Default implementation)
outputAnalysisProgenitorMassFunction¶
Computes the dark matter halo progenitor mass function (distribution of progenitor-to-descendant mass ratios at a given parent redshift) and compares to target data, with options for log-space likelihood, mass ratio range, covariance diagonalization, and restriction to always-isolated progenitors.
Parameters
[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density.[covarianceDiagonalize](boolean; default.false.) — If true, all off-diagonal elements of the covariance matrix are set to zero.[covarianceTargetOnly](boolean; default.false.) — If true, only the covariance of the target dataset is accounted for (otherwise the model covariance is added).[fillInZeroBins](boolean; default.false.) — If true, fill in values of empty bins to avoid improbable likelihoods.[rootVarianceTargetFractional]— The diagonal of the covariance matrix is forced to be at least equal to this fraction multiplied by the target dataset squared. This may be a list of values corresponding to each element of the target dataset. If the list is shorter than the target dataset the final value in the list is applied to all remaining elements in the target dataset.[likelihoodInCounts](boolean; default.false.) — If true, the likelihood is computed using the discrete counts instead of \(\phi\).[likelihoodInLog](boolean; default.false.) — If true, the likelihood is computed in \(\log\phi\) instead of in \(\phi\).[massRatioLikelihoodMinimum](real; default0.0d0) — The minimum mass ratio to include in likelihood calculations.[massRatioLikelihoodMaximum](real; defaulthuge(0.0d0)) — The maximum mass ratio to include in likelihood calculations.[alwaysIsolatedOnly](boolean) — If true, include only progenitors which have been always isolated halos.[redshiftParent](real) — Redshift of the parent halos.[fileName](string) — The name of the file from which to read progenitor mass function parameters.[indexParent](integer) — The parent mass index to use from the file.[indexRedshift](integer) — The progenitor redshift index to use from the file.[comment](string) — A descriptive comment for the progenitor mass function.[label](string) — A label for the progenitor mass function.[targetLabel](string) — Label for the target dataset.[massRatioMinimum](real) — Minimum mass ratio for the progenitor mass function.[massRatioMaximum](real) — Maximum mass ratio for the progenitor mass function.[countMassRatio](integer) — Number of mass ratios at which to compute the progenitor mass function.[massParentMinimum](real) — Minimum mass of the parent halo for the progenitor mass function.[massParentMaximum](real) — Maximum mass of the parent halo for the progenitor mass function.[redshiftProgenitor](real) — Redshift of the progenitor halos.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[functionCountTarget](integer) — The target count for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisQuiescentFraction¶
Computes the quiescent galaxy fraction as a function of stellar mass, classifying galaxies as quiescent when their specific star formation rate falls below starFormationRateSpecificQuiescentLogarithmic (in \(\log_{10}\) Gyr\(^{-1}\)) with a Gaussian scatter starFormationRateSpecificLogarithmicError in the classification boundary.
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
[starFormationRateSpecificQuiescentLogarithmic](real) — The base-10 logarithm specific star formation rate (in units of Gyr\(^{-1}\)) separating quiescent and star-forming galaxies.[starFormationRateSpecificLogarithmicError](real) — The observational fractional error in specific star formation rate (in units of dex) of galaxies.[fileName](string) — 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.[comment](string) — A descriptive comment for the star forming main sequence function.[label](string) — A label for the star forming main sequence function.[massMinimum](real) — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.[massMaximum](real) — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.[countMassesPerDecade](real) — Number of masses per decade at which to compute the star forming main sequence function.[targetLabel](string) — Label for the target dataset.[meanValueTarget](real) — The target function for likelihood calculations.[meanCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisQuiescentFractionWagner2016¶
Computes the quiescent galaxy fraction as a function of stellar mass for a low or high redshift interval from Wagner et al. (2016), with stellar mass and specific star formation rate random/systematic error polynomial coefficients and redshift range selection.
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[weightSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for specific star formation rates.[redshiftRange](string; one oflow,mid,high) — The redshift range (”low” or “high”) for this analysis.[starFormationRateSpecificQuiescentLogarithmic](real) — The base-10 logarithm specific star formation rate (in units of Gyr\(^{-1}\)) separating quiescent and star-forming galaxies. (inherited fromoutputAnalysisQuiescentFraction)[starFormationRateSpecificLogarithmicError](real) — The observational fractional error in specific star formation rate (in units of dex) of galaxies. (inherited fromoutputAnalysisQuiescentFraction)[fileName](string) — The name of the file from which to read quiescent fraction function parameters. (inherited fromoutputAnalysisQuiescentFraction)[comment](string) — A comment describing this analysis. (inherited fromoutputAnalysisQuiescentFraction)[label](string) — A label for this analysis. (inherited fromoutputAnalysisQuiescentFraction)[massMinimum](real) — Minimum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisQuiescentFraction)[massMaximum](real) — Maximum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisQuiescentFraction)[countMassesPerDecade](real) — Number of masses per decade at which to compute the star forming main sequence function. (inherited fromoutputAnalysisQuiescentFraction)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisQuiescentFraction)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisQuiescentFraction)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisQuiescentFraction)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisSatelliteBoundMass¶
Computes the satellite subhalo bound mass fraction as a function of time since infall, tracking tidal stripping evolution and comparing model predictions against a target dataset read from fileName, with a relative model uncertainty parameter.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[relativeModelUncertainty](real; default0.0d0) — Relative model uncertainty.
outputAnalysisSatelliteRadiusVelocityMaximum¶
An output analysis class that computes satellite radius fraction at which the maximum circular velocity is reached as a function of time.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[relativeModelUncertainty](real; default0.0d0) — Relative model uncertainty.
outputAnalysisSatelliteVelocityMaximum¶
Computes the satellite subhalo maximum circular velocity fraction (\(V_\mathrm{max}/V_\mathrm{max,0}\)) as a function of time since infall, tracking tidal evolution and comparing against a target dataset read from fileName, with a relative model uncertainty parameter.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[relativeModelUncertainty](real; default0.0d0) — Relative model uncertainty.
outputAnalysisScatterFunction1D¶
A generic 1D scatter function (i.e. the scatter of some property weighted by number density of objects binned by some property) output analysis class.
Methods
results— Return the results of the scatter function operator.finalizeAnalysis— Finalize analysis of the scatter function operator.
Parameters
[label](string) — A label for the analysis.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis.[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis.[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis.[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis.[comment](string) — A descriptive comment for the analysis.[propertyLabel](string) — A label for the property variable.[propertyComment](string) — A descriptive comment for the property variable.[propertyUnits](string) — A human-readable description of the units for the property.[propertyQuantity](string) — Anastropy.units-parseable units string for the property.[propertyIsComoving](boolean) — If true, the property is in comoving units.[propertyUnitsInSI](real) — A units for the property in the SI system.[scatterLabel](string) — A label for the scatter.[scatterComment](string) — A descriptive comment for the scatter.[scatterUnits](string) — A human-readable description of the units for the scatter.[scatterQuantity](string) — Anastropy.units-parseable units string for the scatter.[scatterIsComoving](boolean) — If true, the scatter is in comoving units.[scatterUnitsInSI](real) — A units for the scatter in the SI system.[binCenter](real) — The value of the property at the center of each bin.[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins.[outputWeight](real) — The weight to assign to each bin at each output.[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density.[scatterValueTarget](real) — The target function for likelihood calculations.[scatterCovarianceTarget](real) — The target function covariance for likelihood calculations.[targetLabel](string) — A label for the target dataset in a plot of this analysis.
outputAnalysisSizeVsStellarMassRelation¶
A size vs. stellar mass relation output analysis class. Target data is read from an HDF5 file specified by the [fileNameTarget] parameter. This file must contain one or more groups named sampleN where N is an integer. Each such group specifies the galaxy size—stellar mass relation for one sample (a combination of redshift interval and any selection criteria), and must contain the following datasets and attributes:
dataset
massStellar: stellar mass in units of \(\mathrm{M}_\odot\);dataset
radiusEffective: effective radius in units of Mpc;dataset
radiusEffectiveError: uncertainty in effective radius in units of Mpc;dataset
radiusEffectiveScatter: scatter in effective radius in units of dex;dataset
radiusEffectiveScatterError: uncertainty in scatter in effective radius in units of dex;attribute
redshiftMinimum: the minimum redshift associated with this sample;attribute
redshiftMaximum: the maximum redshift associated with this sample.
While not required, it is recommended that each of these datasets has attributes description and unitsInSI that provide a description of the dataset, and the multiplicative factor needed to convert them to SI standard units, respectively.
Additionally, the file must contain a cosmology group that specifies the cosmological model assumed in constructing the dataset, and which has attributes:
OmegaMatter: the matter density in units of the critical density, \(\Omega_\mathrm{M}\);OmegaDarkEnergy: the dark energy density in units of the critical density, \(\Omega_\Lambda\);OmegaBaryon: the baryon density in units of the critical density, \(\Omega_\mathrm{b}\);HubbleConstant: the Hubble constant in units of km/s/Mpc.
Each sampleN group must have an attribute selection which specifies the selection criterion used in constructing the dataset. Allowed values are:
'none': no selection criterion will be applied;'star forming': only galaxies on or above the star forming main sequence are included;'quiescent: only galaxies below the star forming main sequence are included.
For the “star forming” and “quiescent” options, a dataset mainSequenceSFR must be specified in the sampleN group which specifies the mean (of the logarithm of star formation rate in units of \(\mathrm{M}_\odot/\hbox{yr}^{-1}\)) of the star forming main sequence at the center of each bin, and an attribute offsetMainSequenceSFR which specifies an offset below the mean of the star forming main sequence below which galaxies are considered to be quiescent. That is, a galaxy will be classified as quiescent if
where \(\log_{10} ( \dot{\phi} / \mathrm{M}_\odot \hbox{yr}^{-1})\) is the star formation rate in the galaxy, \(\log_{10} ( \dot{M}_{\star,ms} / \mathrm{M}_\odot \hbox{yr}^{-1})\) is the mean of the star forming main sequence (as specified by mainSequenceSFR and interpolated to the stellar mass of the galaxy, and \(\Delta_{\star}\) is offsetMainSequenceSFR,
Lastly, the file must have two attributes used to identify and level the dataset:
label: a space-free label that will be appended to the analysis group in the output, e.g.vanDerWel2014;reference: a reference for the dataset suitable for inclusion in figures, e.g.van der Wel et al. (2014).
Parameters
[likelihoodBins](integer) — Controls which bins in the effective radius–stellar 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](string) — The name of the file containing the target data.[sample](integer; default1) — The integer index (starting at 1) of thesampleNgroup within the target HDF5 file to use when computing the size–stellar mass relation likelihood.[likelihoodNormalize](boolean; default.false.) — If true, then normalize the likelihood to make it a probability density.[computeScatter](boolean; default.false.) — If true, the scatter in log10(radius effective) is computed. Otherwise, the mean is computed.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for effective radius in the effective radius vs stellar mass relation.[systematicErrorMassStellarPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the effective radius vs stellar mass relation.[randomErrorMassStellarPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial for stellar mass in the effective radius vs stellar mass relation.[randomErrorMassStellarMinimum](real; default0.07d0) — The minimum random error for stellar masses.[randomErrorMassStellarMaximum](real; default0.07d0) — The minimum random error for stellar masses.
outputAnalysisSpinDistribution¶
Computes the dark matter halo spin parameter distribution within a specified mass range and redshift, accounting for N-body measurement errors via log-normal convolution with truncation range logNormalRange; reads bin configuration from file and supports optional target dataset for likelihood evaluation.
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
[errorTolerant](boolean; default.false.) — Error tolerance for the N-body spin distribution operator.[logNormalRange](real; 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](string) — 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.[comment](string) — A descriptive comment for the star forming main sequence function.[label](string) — A label for the star forming main sequence function.[redshift](real) — The redshift of the transfer function to read.[massMinimum](real) — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.[massMaximum](real) — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.[spinMinimum](real) — Minimum spin for the spin distribution function.[spinMaximum](real) — Maximum spin for the spin distribution function.[countSpinsPerDecade](real) — Number of spins per decade at which to compute the spin distribution function.[timeRecent](real) — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis.[particleCountMinimum](integer) — The minimum particle count to assume when computing N-body errors on spins.[massParticle](real) — The particle mass in the source N-body simulation.[energyEstimateParticleCountMaximum](real) — The maximum number of particles used in estimating halo energies when measuring spins from the N-body simulation.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisSpinDistributionBett2007¶
Computes the distribution of dark matter halo spin parameters for comparison with the Bett et al. (2007) N-body simulation data, accounting for N-body measurement errors via log-normal convolution with a truncation range logNormalRange; errorTolerant controls behavior on integration failures.
Parameters
[errorTolerant](boolean; default.false.) — Error tolerance for the N-body spin distribution operator.[logNormalRange](real; 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](string) — The name of the file from which to read spin distribution function parameters. (inherited fromoutputAnalysisSpinDistribution)[comment](string) — A comment describing this analysis. (inherited fromoutputAnalysisSpinDistribution)[label](string) — A label for this analysis. (inherited fromoutputAnalysisSpinDistribution)[redshift](real) — The redshift at which to compute the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[massMinimum](real) — Minimum halo mass for the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[massMaximum](real) — Maximum halo mass for the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[spinMinimum](real) — Minimum spin for the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[spinMaximum](real) — Maximum spin for the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[countSpinsPerDecade](real) — Number of spins per decade at which to compute the spin distribution function. (inherited fromoutputAnalysisSpinDistribution)[timeRecent](real) — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent]of the analysis time will be excluded from the analysis. (inherited fromoutputAnalysisSpinDistribution)[particleCountMinimum](integer) — The minimum particle count to assume when computing N-body errors on spins. (inherited fromoutputAnalysisSpinDistribution)[massParticle](real) — The mass of the particle used in the N-body simulation from which spins were measured. (inherited fromoutputAnalysisSpinDistribution)[energyEstimateParticleCountMaximum](real) — The maximum number of particles used in estimating halo energies when measuring spins from the N-body simulation. (inherited fromoutputAnalysisSpinDistribution)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisSpinDistribution)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisSpinDistribution)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisSpinDistribution)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisStarFormationRateFunction¶
Computes the galaxy star formation rate function as a number density per unit log-star-formation-rate, with user-specified SFR bin centers, label, comment, optional target dataset for likelihood evaluation, and binomial covariance matrix construction parameters for halo mass range.
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
[label](string) — A label for the star forming main sequence function.[comment](string) — A descriptive comment for the star forming main sequence function.[starFormationRates](real) — The star formation rates corresponding to bin centers.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d10) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d12) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.[targetLabel](string) — Label for the target dataset.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisStarFormationRateFunctionRobotham2011¶
Computes the galaxy star formation rate function for comparison with the Robotham et al. (2011) measurements, with star formation rate random/systematic error polynomial coefficients, gravitational lensing source size corrections, and binomial covariance matrix parameters for halo mass range.
Parameters
[randomErrorMinimum](real; default0.126d0) — The minimum random error for Robotham et al. (2011) star formation rates.[randomErrorMaximum](real; default0.126d0) — The minimum random error for Robotham et al. (2011) star formation rates.[randomErrorPolynomialCoefficient](real; default[0.126d0]) — The coefficients of the random error polynomial for Robotham et al. (2011) star formation rates.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for Robotham et al. (2011) star formation rates.[sizeSourceLensing](real; default2.0d-3) — The characteristic source size for gravitational lensing calculations.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing Robotham et al. (2011) star formation rate function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing Robotham et al. (2011) star formation rate function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing Robotham et al. (2011) star formation rate function covariance matrices for main branch galaxies.[label](string) — A label for the mass function. (inherited fromoutputAnalysisStarFormationRateFunction)[comment](string) — A descriptive comment for the mass function. (inherited fromoutputAnalysisStarFormationRateFunction)[starFormationRates](real) — The star formation rates corresponding to bin centers. (inherited fromoutputAnalysisStarFormationRateFunction)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisStarFormationRateFunction)[functionValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisStarFormationRateFunction)[functionCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisStarFormationRateFunction)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisVolumeFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisVolumeFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[distributionLabel](string) — A label for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionComment](string) — A descriptive comment for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnits](string) — A human-readable description of the units for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution. (inherited fromoutputAnalysisVolumeFunction1D)[distributionIsComoving](boolean) — If true, the distribution is in comoving units. (inherited fromoutputAnalysisVolumeFunction1D)[distributionUnitsInSI](real) — A units for the distribution in the SI system. (inherited fromoutputAnalysisVolumeFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisVolumeFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisVolumeFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisVolumeFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisVolumeFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisVolumeFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisVolumeFunction1D)
outputAnalysisStarFormingMainSequence¶
Computes the mean specific star formation rate as a function of stellar mass along the star-forming main sequence, reading bin configuration from file with user-specified stellar mass range and bin count, and comparing against an optional target dataset for likelihood evaluation.
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
[fileName](string) — 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.[comment](string) — A descriptive comment for the star forming main sequence function.[label](string) — A label for the star forming main sequence function.[massMinimum](real) — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.[massMaximum](real) — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.[countMassesPerDecade](real) — Number of masses per decade at which to compute the star forming main sequence function.[targetLabel](string) — Label for the target dataset.[meanValueTarget](real) — The target function for likelihood calculations.[meanCovarianceTarget](real) — The target function covariance for likelihood calculations.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true, then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisStarFormingMainSequenceSchreiber2015¶
Computes the star-forming main sequence (mean specific star formation rate vs. stellar mass) at one of six redshift indices for comparison with the Herschel Schreiber et al. (2015) measurements, with stellar mass and specific SFR random/systematic error polynomial coefficients.
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[weightSystematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for specific star formation rates.[redshiftIndex](integer) — The redshift index (1-6) for this analysis.[fileName](string) — The name of the file from which to read star forming main sequence function parameters. (inherited fromoutputAnalysisStarFormingMainSequence)[comment](string) — A comment describing this analysis. (inherited fromoutputAnalysisStarFormingMainSequence)[label](string) — A label for this analysis. (inherited fromoutputAnalysisStarFormingMainSequence)[massMinimum](real) — Minimum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[massMaximum](real) — Maximum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[countMassesPerDecade](real) — Number of masses per decade at which to compute the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisStarFormingMainSequence)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisStarFormingMainSequence)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisStarFormingMainSequence)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisStarFormingMainSequenceWagner2016¶
Computes the star-forming main sequence (mean specific star formation rate vs. stellar mass) for a specified redshift range and galaxy type (quiescent or star-forming) from Wagner et al. (2016), with stellar mass and specific SFR random/systematic error polynomial coefficients.
Parameters
[randomErrorMinimum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for SDSS stellar masses.[randomErrorPolynomialCoefficient](real; default[0.07d0]) — The coefficients of the random error polynomial for SDSS stellar masses.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for SDSS stellar masses.[redshiftRange](string; one oflow,high) — The redshift range (”low” or “high”) for this analysis.[galaxyType](string; one ofquiescent,starForming) — The galaxy type (”quiescent” or “starForming”) for this analysis.[fileName](string) — The name of the file from which to read star forming main sequence function parameters. (inherited fromoutputAnalysisStarFormingMainSequence)[comment](string) — A comment describing this analysis. (inherited fromoutputAnalysisStarFormingMainSequence)[label](string) — A label for this analysis. (inherited fromoutputAnalysisStarFormingMainSequence)[massMinimum](real) — Minimum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[massMaximum](real) — Maximum stellar mass for the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[countMassesPerDecade](real) — Number of masses per decade at which to compute the star forming main sequence function. (inherited fromoutputAnalysisStarFormingMainSequence)[targetLabel](string) — Label for the target dataset. (inherited fromoutputAnalysisStarFormingMainSequence)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisStarFormingMainSequence)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisStarFormingMainSequence)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisStellarVsHaloMassRelation¶
A stellar vs. halo mass relation output analysis class. Target data is read from an HDF5 file specified by the [fileNameTarget] parameter. This file must contain one or more groups named redshiftIntervalN where N is an integer. Each such group specifies the stellar mass–halo mass relation in one redshift interval, and must contain the following datasets and attributes:
dataset
massHalo: halo mass in units of \(\mathrm{M}_\odot\);dataset
massStellar: stellar mass in units of \(\mathrm{M}_\odot\);dataset
massStellarError: uncertainty in stellar mass in units of \(\mathrm{M}_\odot\);dataset
massStellarScatter: scatter in stellar mass in units of dex;dataset
massStellarScatterError: uncertainty in scatter in stellar mass in units of dex;attribute
redshiftMinimum: the minimum redshift associated with this redshift interval;attribute
redshiftMaximum: the maximum redshift associated with this redshift interval.
While not required, it is recommended that each of these datasets has attributes description and unitsInSI that provide a description of the dataset, and the multiplicative factor needed to convert them to SI standard units, respectively.
Additionally, the file must contain a cosmology group that specifies the cosmological model assumed in constructing the dataset, and which has attributes:
OmegaMatter: the matter density in units of the critical density, \(\Omega_\mathrm{M}\);OmegaDarkEnergy: the dark energy density in units of the critical density, \(\Omega_\Lambda\);OmegaBaryon: the baryon density in units of the critical density, \(\Omega_\mathrm{b}\);HubbleConstant: the Hubble constant in units of km/s/Mpc.
The file must have an attribute haloMassDefinition which specifies the halo mass definition assumed in constructing the dataset. Allowed values are:
'spherical collapse'or'virial': halos are defined as have mean density contrasts given by spherical collapse calculations, e.g. Percival (2005);'Bryan & Norman (1998)': halos are defined as have mean density contrasts given by the fitting formula of Bryan and Norman (1998);'X * mean density': halos are defined as having mean densities equal to ;Xtimes the mean density of the universe;'X * critical density': halos are defined as having mean densities equal to ;Xtimes the critical density of the universe;
Lastly, the file must have two attributes used to identify and level the dataset:
label: a space-free label that will be appended to the analysis group in the output, e.g.Leauthaud2012;reference: a reference for the dataset suitable for inclusion in figures, e.g.Leauthaud et al. (2012).
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
[likelihoodBins](integer) — 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](string) — The name of the file containing the target data.[redshiftInterval](integer; default1) — The redshift interval to use.[likelihoodNormalize](boolean; default.false.) — If true, then normalize the likelihood to make it a probability density.[computeScatter](boolean; default.false.) — If true, the scatter in log10(stellar mass) is computed. Otherwise, the mean is computed.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the stellar vs halo mass relation.[systematicErrorMassHaloPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the stellar vs halo mass relation.
outputAnalysisStellarVsHaloMassRelationLeauthaud2012¶
Computes the stellar mass–halo mass relation (mean or scatter) for one of three COSMOS redshift intervals from Leauthaud et al. (2012), with optional single-bin likelihood and likelihood normalization, and systematic error polynomial coefficients for both stellar and halo masses.
Parameters
[likelihoodBins](integer) — If \(>0\) then use only the mass bin given by this value in the likelihood calculation.[redshiftInterval](integer) — The redshift interval (1, 2, or 3) to use.[likelihoodNormalize](boolean; default.false.) — If true, then normalize the likelihood to make it a probability density.[computeScatter](boolean; default.false.) — If true, the scatter in log10(stellar mass) is computed. Otherwise, the mean is computed.[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the stellar vs halo mass relation.[systematicErrorMassHaloPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the stellar vs halo mass relation.
outputAnalysisSubhaloMassFunction¶
Computes the subhalo mass function (number of subhalos per unit mass ratio relative to the host halo) at a given redshift, reading bin configuration and target data from file, with options for empty-bin handling and negative binomial scatter in likelihood calculations.
Methods
finalizeAnalysis— Finalize analysis.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[massRatioMinimum](real; default1.0d-4) — The minimum mass ratio to consider.[massRatioMaximum](real; default1.0d0) — The maximum mass ratio to consider.[countMassRatios](integer; default10_c_size_t) — The number of bins in mass ratio to use.[redshift](real; default0.0d0) — The redshift at which to compute the subhalo mass function.[ignoreEmptyModelBins](boolean; default.false.) — If true, model bins containing no subhalos are ignored. Otherwise, if the target data is non-zero, an impossible likelihood is returned.[negativeBinomialScatterFractional](real; default0.18d0) — The fractional scatter (relative to the Poisson scatter) in the negative binomial distribution used in likelihood calculations.
outputAnalysisSubhaloRadialDistribution¶
Computes the radial distribution of subhalos as a function of fractional host-halo radius at a given redshift, with configurable mass threshold (absolute or as virial mass ratio), fractional radius bins, and negative binomial scatter in likelihood calculations.
Methods
finalizeAnalysis— Finalize analysis.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[radiusFractionMinimum](real; default1.0d-4) — The minimum fractional radius to consider.[radiusFractionMaximum](real; default1.0d0) — The maximum fractional radius to consider.[countRadiiFractional](integer; default10_c_size_t) — The number of bins in mass ratio to use.[massThreshold](real; default0.0d0) — The minimum satellite bound mass (or mass ratio—see the[thresholdIsRatio]parameter) to include in the radial distribution function.[thresholdIsRatio](boolean; default.true.) — If true, the[massThreshold]parameter is interpreted as a ratio with the virial mass of the host halo.[redshift](real; default0.0d0) — The redshift at which to compute the subhalo radial distribution.[negativeBinomialScatterFractional](real; default0.18d0) — The fractional scatter (relative to the Poisson scatter) in the negative binomial distribution used in likelihood calculations.
outputAnalysisSubhaloVMaxVsMass¶
Computes the mean subhalo maximum circular velocity \(V_\mathrm{max}\) as a function of bound mass at a given redshift, reading target data and mass bin configuration from file, for comparison with N-body simulation subhalo population statistics.
Parameters
[fileName](string) — The name of the file from which to read the target dataset.[massMinimum](real; default1.0d6) — The minimum mass to consider.[massMaximum](real; default1.0d12) — The maximum mass to consider.[countMasses](integer; default12_c_size_t) — The number of bins in mass to use.[redshift](real; default0.0d0) — The redshift at which to compute the subhalo \(V_\mathrm{max}\)–\(M\) relation.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisSunyaevZeldovichPlanck2013¶
Computes the mean thermal Sunyaev-Zeldovich signal (Compton-\(y\) parameter stacked over galaxy halos) as a function of stellar mass using the Planck Collaboration et al. (2013) observational data, with configurable random and systematic error polynomial coefficients.
Parameters
[systematicErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the systematic error polynomial.[randomErrorPolynomialCoefficient](real; default[0.0d0]) — The coefficients of the random error polynomial.[randomErrorMinimum](real; default0.07d0) — The minimum random error for stellar masses.[randomErrorMaximum](real; default0.07d0) — The minimum random error for stellar masses.[label](string) — A label for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)[comment](string) — A descriptive comment for the analysis. (inherited fromoutputAnalysisMeanFunction1D)[propertyLabel](string) — A label for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyComment](string) — A descriptive comment for the property variable. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnits](string) — A human-readable description of the units for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyQuantity](string) — Anastropy.units-parseable units string for the property. (inherited fromoutputAnalysisMeanFunction1D)[propertyIsComoving](boolean) — If true, the property is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[propertyUnitsInSI](real) — A units for the property in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[meanLabel](string) — A label for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanComment](string) — A descriptive comment for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanUnits](string) — A human-readable description of the units for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanQuantity](string) — Anastropy.units-parseable units string for the mean. (inherited fromoutputAnalysisMeanFunction1D)[meanIsComoving](boolean) — If true, the mean is in comoving units. (inherited fromoutputAnalysisMeanFunction1D)[meanUnitsInSI](real) — A units for the mean in the SI system. (inherited fromoutputAnalysisMeanFunction1D)[binCenter](real) — The value of the property at the center of each bin. (inherited fromoutputAnalysisMeanFunction1D)[binWidth](real) — The width of the bins. (inherited fromoutputAnalysisMeanFunction1D)[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins. (inherited fromoutputAnalysisMeanFunction1D)[outputWeight](real) — The weight to assign to each bin at each output. (inherited fromoutputAnalysisMeanFunction1D)[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies. (inherited fromoutputAnalysisMeanFunction1D)[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density. (inherited fromoutputAnalysisMeanFunction1D)[meanValueTarget](real) — The target function for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[meanCovarianceTarget](real) — The target function covariance for likelihood calculations. (inherited fromoutputAnalysisMeanFunction1D)[targetLabel](string) — A label for the target dataset in a plot of this analysis. (inherited fromoutputAnalysisMeanFunction1D)
outputAnalysisTidalTracksVelocityMaximum¶
Computes the subhalo tidal evolution track of \(V_\mathrm{max}\) vs. bound mass fraction, fitting the Peñarrubia et al. (2010) tidal track functional form with parameters \(\mu\) and \(\eta\), for comparison with N-body tidal stripping simulations.
Parameters
outputAnalysisVolumeFunction1D¶
A generic 1D volume function (i.e. number density of objects binned by some property, e.g. a mass function) output analysis class.
In addition to the volume function itself, the covariance matrix, \(\mathbf{C}_\mathrm{model}\), of the mass function is also computed. The assumptions used when constructing the covariance matrix are controlled by the parameter [covarianceModel]. If set to binomial, then to construct \(\mathbf{C}_\mathrm{model}\) we make use of the fact that Galacticus works by sampling a set of tree “root masses” from the \(z=0\) dark matter halo mass function. From each root, a tree is grown, within which the physics of galaxy formation is then solved. Root masses are sampled uniformly from the halo mass function. That is, the cumulative halo mass function, \(N(M)\), is constructed between the maximum and minimum halo masses to be simulated. The number of root masses, \(N_\mathrm{r}\), to be used in a model evaluation is then determined. Root masses are then chosen such that
for \(i=1\ldots N_\mathrm{r}\) (noting that \(N(M_\mathrm{max})=0\) by construction).
Consider first those galaxies which form in the main branch of each tree (i.e. those galaxies which are destined to become the central galaxy of the \(z=0\) halo). Suppose that we simulate \(N_k\) halos of root mass \(M_k\) at \(z=0\). In such halos the main branch galaxies will, at any time, have property values drawn from some distribution \(p_k(M_\star|t)\). The number of such galaxies contributing to bin \(i\) of the mass function is therefore binomially distributed with success probability \(p_{ik} = \int_{M_{i,\mathrm min}}^{M_{i,\mathrm max}} p_k(M_\star|t) \d M_\star\) and a sample size of \(N_k\).
Generalizing to consider all bins in our volume function, the number of galaxies in each bin will jointly follow a multinomial distribution. The contribution to the covariance matrix from these main branch galaxies is therefore:
where \(w_k\) is the weight to be assigned to each tree. To compute this covariance requires knowledge of the probabilities, \(p_{ik}\). We estimate these directly from the model. To do this, we bin trees into narrow bins of root mass and assume that \(p_{ik}\) does not vary significantly across the mass range of each bin. Using all realizations of trees that fall within a given bin, \(k\), we can directly estimate \(p_{ik}\). Similarly, \(N_k w_k^2\) is found by accumulating squared weights in bins of root mass. In computing \(p_{ik}\) and \(N_k\), the range of halo masses considered and the fineness of binning in halo mass are determined by the parameters [covarianceBinomialMassHaloMinimum], [covarianceBinomialMassHaloMaximum], and [covarianceBinomialBinsPerDecade].
If instead, [covarianceModel]\(=\)Poisson, the main branch galaxies are modeled as being sampled from a Poisson distribution (and so off-diagonal terms in the covariance matrix will be zero).
In addition to the main branch galaxies, each tree will contain a number of other galaxies (these will be “satellite” galaxies at \(z=0\), but at higher redshifts may still be central galaxies in their own halos). Tests have established that the number of satellites in halos is well described by a Poisson process. Note that, as described above, each galaxy contributes a Gaussian distribution to the mass function due to modeling of random errors in property value determinations. For main branch galaxies this is simply accounted for when accumulating the probabilities, \(p_{ik}\). For satellite galaxies, off-diagonal contributions to the covariance matrix arise as a result, \(C_{ij} = w_k f_i f_j\), where \(f_i\) is the fraction of the galaxy contributing to bin \(i\) of the mass function.
Methods
results— Return the results of the volume function operator.finalizeAnalysis— Finalize the analysis of this function.setReporting— Activate/deactivate reporting.logLikelihoodWrite— Write the log-likelihood of this analysis to the output group. Child classes that compute their own log-likelihood should override this to avoid evaluating the parent-class logLikelihood method.metadataWrite— Write class-specific metadata to the analysis output group. The default implementation does nothing; child classes may override it to add further attributes or datasets.
Parameters
[label](string) — A label for the analysis.[xAxisLabel](string) — A label for the \(x\)-axis in a plot of this analysis.[yAxisLabel](string) — A label for the \(y\)-axis in a plot of this analysis.[xAxisIsLog](boolean) — If true, indicates that the \(x\)-axis should be logarithmic in a plot of this analysis.[yAxisIsLog](boolean) — If true, indicates that the \(y\)-axis should be logarithmic in a plot of this analysis.[comment](string) — A descriptive comment for the analysis.[propertyLabel](string) — A label for the property variable.[propertyComment](string) — A descriptive comment for the property variable.[propertyUnits](string) — A human-readable description of the units for the property.[propertyQuantity](string) — Anastropy.units-parseable units string for the property.[propertyIsComoving](boolean) — If true, the property is in comoving units.[propertyUnitsInSI](real) — A units for the property in the SI system.[distributionLabel](string) — A label for the distribution.[distributionComment](string) — A descriptive comment for the distribution.[distributionUnits](string) — A human-readable description of the units for the distribution.[distributionQuantity](string) — Anastropy.units-parseable units string for the distribution.[distributionIsComoving](boolean) — If true, the distribution is in comoving units.[distributionUnitsInSI](real) — A units for the distribution in the SI system.[binCenter](real) — The value of the property at the center of each bin.[binWidth](real) — The width of the bins.[bufferCount](integer) — The number of buffer bins to include below and above the range of actual bins.[outputWeight](real) — The weight to assign to each bin at each output.[covarianceModel](string; one ofpoisson,binomial) — The model to use for computing covariances.[covarianceBinomialBinsPerDecade](integer; default10) — The number of bins per decade of halo mass to use when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMinimum](real; default1.0d8) — The minimum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[covarianceBinomialMassHaloMaximum](real; default1.0d16) — The maximum halo mass to consider when constructing volume function covariance matrices for main branch galaxies.[likelihoodNormalize](boolean; default.true.) — If true then normalize the likelihood to make it a probability density.[functionValueTarget](real) — The target function for likelihood calculations.[functionCovarianceTarget](real) — The target function covariance for likelihood calculations.[targetLabel](string) — A label for the target dataset in a plot of this analysis.