ufo::BlackList Class Reference

Generic black listing of observations. More...

#include <BlackList.h>

Inheritance diagram for ufo::BlackList:

Collaboration diagram for ufo::BlackList:

Public Types
typedef BlackListParameters	Parameters_

Public Member Functions
	BlackList (ioda::ObsSpace &, const Parameters_ &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
	~BlackList ()
Public Member Functions inherited from ufo::FilterBase
	FilterBase (ioda::ObsSpace &, const FilterParametersBaseWithAbstractAction &parameters, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
	FilterBase (ioda::ObsSpace &, const eckit::Configuration &, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
	~FilterBase ()
Public Member Functions inherited from ufo::ObsProcessorBase
	ObsProcessorBase (ioda::ObsSpace &, bool deferToPost, std::shared_ptr< ioda::ObsDataVector< int > >, std::shared_ptr< ioda::ObsDataVector< float > >)
	~ObsProcessorBase ()
void	preProcess () override
void	priorFilter (const GeoVaLs &) override
void	postFilter (const ioda::ObsVector &, const ioda::ObsVector &, const ObsDiagnostics &) override
oops::Variables	requiredVars () const override
oops::Variables	requiredHdiagnostics () const override

Static Public Member Functions
static const std::string	classname ()

Private Member Functions
void	print (std::ostream &) const override
void	applyFilter (const std::vector< bool > &, const Variables &, std::vector< std::vector< bool >> &) const override
int	qcFlag () const override

Private Attributes
Parameters_	parameters_

Additional Inherited Members
Protected Attributes inherited from ufo::FilterBase
const eckit::LocalConfiguration	config_
ufo::Variables	filtervars_
Protected Attributes inherited from ufo::ObsProcessorBase
ioda::ObsSpace &	obsdb_
std::shared_ptr< ioda::ObsDataVector< int > >	flags_
std::shared_ptr< ioda::ObsDataVector< float > >	obserr_
ufo::Variables	allvars_
ObsFilterData	data_

Detailed Description

Generic black listing of observations.

Filters observations out regardless of obs value The same effect can be achieved with opposite criteria through the "Domain Check", the choice is a matter of convenience or which seems more natural.

Definition at line 43 of file BlackList.h.

Member Typedef Documentation

Parameters_

typedef BlackListParameters ufo::BlackList::Parameters_

The type of parameters accepted by the constructor of this filter. This typedef is used by the FilterFactory.

Definition at line 48 of file BlackList.h.

Constructor & Destructor Documentation

BlackList()

ufo::BlackList::BlackList	(	ioda::ObsSpace &	obsdb,
		const Parameters_ &	parameters,
		std::shared_ptr< ioda::ObsDataVector< int > >	flags,
		std::shared_ptr< ioda::ObsDataVector< float > >	obserr
	)

Definition at line 25 of file BlackList.cc.

~BlackList()

ufo::BlackList::~BlackList

(

)

Definition at line 35 of file BlackList.cc.

Member Function Documentation

applyFilter()

void ufo::BlackList::applyFilter ( const std::vector< bool > &  apply, const Variables &  filtervars, std::vector< std::vector< bool >> &  flagged  ) const

overrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 39 of file BlackList.cc.

Here is the call graph for this function:

classname()

static const std::string ufo::BlackList::classname ( )

inlinestatic

Definition at line 50 of file BlackList.h.

print()

void ufo::BlackList::print ( std::ostream &  os ) const

overrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 51 of file BlackList.cc.

qcFlag()

int ufo::BlackList::qcFlag ( ) const

inlineoverrideprivatevirtual

Implements ufo::FilterBase.

Definition at line 61 of file BlackList.h.

Member Data Documentation

parameters_

Parameters_ ufo::BlackList::parameters_

private

Definition at line 63 of file BlackList.h.

---

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

• BlackList.h
• BlackList.cc