scran::PerCellQcMetrics::Buffers< Float, Integer > Struct Template Reference

Buffers for direct storage of the calculated statistics. More...

#include <PerCellQcMetrics.hpp>

Public Attributes
Float *	total = NULL
Integer *	detected = NULL
Integer *	max_index = NULL
Float *	max_count = NULL
std::vector< Float * >	subset_total
std::vector< Integer * >	subset_detected
bool	already_zeroed = false

Detailed Description

template<typename Float = double, typename Integer = int>
struct scran::PerCellQcMetrics::Buffers< Float, Integer >

Buffers for direct storage of the calculated statistics.

Template Parameters

Float	Floating point type to store the totals.
Integer	Integer type to store the counts and indices.

Member Data Documentation

total

template<typename Float = double, typename Integer = int>

Float* scran::PerCellQcMetrics::Buffers< Float, Integer >::total = NULL

Pointer to an array of length equal to the number of cells, equivalent to Results::total. Set to NULL to skip this calculation.

detected

template<typename Float = double, typename Integer = int>

Integer* scran::PerCellQcMetrics::Buffers< Float, Integer >::detected = NULL

Pointer to an array of length equal to the number of cells, equivalent to Results::detected. Set to NULL to skip this calculation.

max_index

template<typename Float = double, typename Integer = int>

Integer* scran::PerCellQcMetrics::Buffers< Float, Integer >::max_index = NULL

Pointer to an array of length equal to the number of cells, equivalent to Results::max_index. Set to NULL to skip this calculation.

max_count

template<typename Float = double, typename Integer = int>

Float* scran::PerCellQcMetrics::Buffers< Float, Integer >::max_count = NULL

Pointer to an array of length equal to the number of cells, equivalent to Results::max_count. Set to NULL to skip this calculation.

subset_total

template<typename Float = double, typename Integer = int>

std::vector<Float*> scran::PerCellQcMetrics::Buffers< Float, Integer >::subset_total

Vector of pointers of length equal to the number of feature subsets, where each point is to an array of length equal to the number of cells; equivalent to Results::subset_total. Set any value to NULL to skip the calculation for the corresponding feature subset, or leave empty to skip calculations for all feature subsets.

subset_detected

template<typename Float = double, typename Integer = int>

std::vector<Integer*> scran::PerCellQcMetrics::Buffers< Float, Integer >::subset_detected

Vector of pointers of length equal to the number of feature subsets, where each point is to an array of length equal to the number of cells; equivalent to Results::subset_detected. Set any value to NULL to skip the calculation for the corresponding feature subset, or leave empty to skip calculations for all feature subsets.

already_zeroed

template<typename Float = double, typename Integer = int>

bool scran::PerCellQcMetrics::Buffers< Float, Integer >::already_zeroed = false

Whether all of the arrays in Buffers have already been filled with zeros. (For Buffers::max_count, this should be filled with the lowest possible value of Float, if expression might be negative.)

---

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

• scran/quality_control/PerCellQcMetrics.hpp