#include <TotalSasaFilter.hh>

Inheritance diagram for protocols::simple_filters::TotalSasaFilter:

Public Member Functions
	TotalSasaFilter ()

	TotalSasaFilter (core::Real const lower_threshold, bool const hydrophobic=false, bool const polar=false, core::Real const upper_threshold=100000000.0, bool report_per_residue_sasa=false)

bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...

void	report (std::ostream &out, core::pose::Pose const &pose) const override

core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...

core::Real	compute (core::pose::Pose const &pose) const

core::pack::task::TaskFactoryOP	task_factory ()

void	task_factory (core::pack::task::TaskFactoryOP task_factory)
	Set the task factory to limit SASA calculation to packable residues. More...

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

	~TotalSasaFilter () override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &) override

std::string	name () const override

Public Member Functions inherited from protocols::filters::Filter
	Filter ()

	Filter (std::string const &)

	Filter (Filter const &)

	~Filter () override

virtual std::string	get_type () const

std::string	get_user_defined_name () const

void	set_user_defined_name (std::string const &name)

virtual void	clear ()
	used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...

virtual core::Real	score (core::pose::Pose &pose)

virtual bool	filter_provides_citation_info () const
	Does this filter provide information about how to cite it? More...

virtual utility::vector1 < basic::citation_manager::CitationCollectionCOP >	provide_citation_info () const
	Provide the citation. More...

virtual bool	filter_is_unpublished () const
	Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...

virtual utility::vector1 < basic::citation_manager::UnpublishedModuleInfoCOP >	provide_authorship_info_for_unpublished () const
	Provide a list of authors and their e-mail addresses, as strings. More...

Static Public Member Functions
static std::string	class_name ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
core::Real	lower_threshold_

core::Real	upper_threshold_

core::pack::task::TaskFactoryOP	taskfactory_

bool	hydrophobic_
	Residue subset definition. Only the surface area from packable residues. More...

bool	polar_

bool	report_per_residue_sasa_
	count only hydrophobics? polars? More...

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Constructor & Destructor Documentation

protocols::simple_filters::TotalSasaFilter::TotalSasaFilter ( )

protocols::simple_filters::TotalSasaFilter::TotalSasaFilter	(	core::Real const	lower_threshold,
		bool const	hydrophobic = `false`,
		bool const	polar = `false`,
		core::Real const	upper_threshold = `100000000.0`,
		bool	report_per_residue_sasa = `false`
	)

protocols::simple_filters::TotalSasaFilter::~TotalSasaFilter ( )

overridedefault

Member Function Documentation

bool protocols::simple_filters::TotalSasaFilter::apply ( core::pose::Pose const & pose ) const

overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References compute(), lower_threshold_, protocols::simple_filters::TR(), and upper_threshold_.

std::string protocols::simple_filters::TotalSasaFilter::class_name ( )

static

Referenced by protocols::simple_filters::TotalSasaFilterCreator::keyname(), name(), and provide_xml_schema().

filters::FilterOP protocols::simple_filters::TotalSasaFilter::clone ( ) const

overridevirtual

Implements protocols::filters::Filter.

core::Real protocols::simple_filters::TotalSasaFilter::compute ( core::pose::Pose const & pose ) const

References hydrophobic_, core::pose::metrics::CalculatorFactory::Instance(), core::pose::Pose::metric(), core::conformation::Residue::name3(), core::pose::Pose::pdb_info(), polar_, report_per_residue_sasa_, core::pose::Pose::residue(), core::pose::Pose::size(), taskfactory_, and protocols::simple_filters::TR().

Referenced by apply(), report(), and report_sm().

filters::FilterOP protocols::simple_filters::TotalSasaFilter::fresh_instance ( ) const

overridevirtual

Implements protocols::filters::Filter.

std::string protocols::simple_filters::TotalSasaFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::TotalSasaFilter::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data,
		filters::Filters_map const &	,
		protocols::moves::Movers_map const &	,
		core::pose::Pose const &
	)