scran_qc::AdtQcFilters< Float_ > Class Template Reference

Filter for high-quality cells using ADT-based metrics. More...

#include <adt_quality_control.hpp>

Public Member Functions
Float_	get_detected () const
const std::vector< Float_ > &	get_subset_sum () const
Float_ &	get_detected ()
std::vector< Float_ > &	get_subset_sum ()
template<typename Sum_ , typename Detected_ , typename Output_ >
void	filter (const std::size_t num, const ComputeAdtQcMetricsBuffers< Sum_, Detected_ > &metrics, Output_ *const output) const
template<typename Sum_ , typename Detected_ , typename Output_ >
void	filter (const ComputeAdtQcMetricsResults< Sum_, Detected_ > &metrics, Output_ *const output) const
template<typename Output_ = unsigned char, typename Sum_ , typename Detected_ >
std::vector< Output_ >	filter (const ComputeAdtQcMetricsResults< Sum_, Detected_ > &metrics) const

Detailed Description

template<typename Float_ = double>
class scran_qc::AdtQcFilters< Float_ >

Filter for high-quality cells using ADT-based metrics.

Template Parameters

Float_

Floating-point type of the filter thresholds.

Instances of this class are typically created by compute_adt_qc_filters().

Member Function Documentation

get_detected() [1/2]

template<typename Float_ = double>

Float_ scran_qc::AdtQcFilters< Float_ >::get_detected ( ) const

inline

Returns

Lower threshold to apply to the number of detected tags.

get_subset_sum() [1/2]

template<typename Float_ = double>

const std::vector< Float_ > & scran_qc::AdtQcFilters< Float_ >::get_subset_sum ( ) const

inline

Returns

Vector of length equal to the number of feature subsets, containing the upper threshold to apply to each subset proportion.

get_detected() [2/2]

template<typename Float_ = double>

Float_ & scran_qc::AdtQcFilters< Float_ >::get_detected ( )

inline

Returns

Lower threshold to apply to the number of detected tags.

get_subset_sum() [2/2]

template<typename Float_ = double>

std::vector< Float_ > & scran_qc::AdtQcFilters< Float_ >::get_subset_sum ( )

inline

Returns

Vector of length equal to the number of feature subsets, containing the upper threshold to apply to each subset proportion.

filter() [1/3]

template<typename Float_ = double>

template<typename Sum_ , typename Detected_ , typename Output_ >

void scran_qc::AdtQcFilters< Float_ >::filter ( const std::size_t num, const ComputeAdtQcMetricsBuffers< Sum_, Detected_ > & metrics, Output_ *const output ) const

inline

Template Parameters

Sum_	Numeric type to store the summed expression.
Detected_	Integer type to store the number of cells.
Output_	Boolean type to store the high quality flags.

Parameters

	num	Number of cells.
	metrics	A collection of arrays containing ADT-based QC metrics, filled by compute_adt_qc_metrics(). The feature subsets should be the same as those used in the metrics supplied to compute_adt_qc_filters().
[out]	output	Pointer to an array of length num. On output, this is truthy for cells considered to be of high quality, and false otherwise.

filter() [2/3]

template<typename Float_ = double>

template<typename Sum_ , typename Detected_ , typename Output_ >

void scran_qc::AdtQcFilters< Float_ >::filter ( const ComputeAdtQcMetricsResults< Sum_, Detected_ > & metrics, Output_ *const output ) const

inline

Template Parameters

Sum_	Numeric type to store the summed expression.
Detected_	Integer type to store the number of cells.
Output_	Boolean type to store the high quality flags.

Parameters

	metrics	ADT-based QC metrics returned by compute_adt_qc_metrics(). The feature subsets should be the same as those used in the metrics supplied to compute_adt_qc_filters().
[out]	output	Pointer to an array of length num. On output, this is truthy for cells considered to be of high quality, and false otherwise.

filter() [3/3]

template<typename Float_ = double>

template<typename Output_ = unsigned char, typename Sum_ , typename Detected_ >

std::vector< Output_ > scran_qc::AdtQcFilters< Float_ >::filter ( const ComputeAdtQcMetricsResults< Sum_, Detected_ > & metrics ) const

inline

Template Parameters

Output_	Boolean type to store the high quality flags.
Sum_	Numeric type to store the summed expression.
Detected_	Integer type to store the number of cells.

Parameters

metrics

ADT-based QC metrics returned by compute_adt_qc_metrics(). The feature subsets should be the same as those used in the metrics supplied to compute_adt_qc_filters().

Returns

Vector of length num, containing the high-quality calls.

---

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

• scran_qc/adt_quality_control.hpp