Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::Sigmoid Class Reference

transform the output from a regular filter into a sigmoid ranging from 0-1 according to: fx = 1/[1 + exp[ ( x - offset ) * steepness ] The function asymptotically reaches 1 at negative values and 0 at positive values. It's 0.5 at the offset and steepness determines its slope at the offset More...

#include <SigmoidFilter.hh>

Public Member Functions

 Sigmoid ()
 
virtual ~Sigmoid ()
 
filters::FilterOP clone () const
 
filters::FilterOP fresh_instance () const
 
virtual bool apply (core::pose::Pose const &pose) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
virtual void report (std::ostream &out, core::pose::Pose const &pose) const
 
virtual core::Real report_sm (core::pose::Pose const &pose) const
 used to report filter internals through a score or silent file More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, filters::Filters_map const &filters, moves::Movers_map const &, core::pose::Pose const &)
 
core::Real compute (core::pose::Pose const &pose) const
 
core::Real steepness () const
 
void steepness (core::Real const s)
 
core::Real offset ()
 
void offset (core::Real const o)
 
bool negate () const
 
void negate (bool const b)
 
protocols::filters::FilterOP filter () const
 
void filter (protocols::filters::FilterOP f)
 
void reset_baseline (core::pose::Pose const &pose, bool const attempt_read_from_checkpoint)
 The first MC trajectory should not read the baseline from the checkpoint file, instead, it should set the baseline attempt_read_from_checkpoint determines whether a read attempt from checkpoint should be attempted. More...
 
core::Real threshold () const
 allows within-trajectory resetting of the baseline. Notice this is nonconst, so can't be called from apply. attempt_read_from_checkpoint should be true for MC trials > 1, but false otherwise More...
 
void threshold (core::Real const t)
 
void baseline_checkpointing_filename (std::string const s)
 
std::string baseline_checkpointing_filename () const
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
virtual ~Filter ()
 
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 void apply (core::io::serialization::PipeMap &pmap)
 
virtual void score (core::io::serialization::PipeMap &pmap)
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)
 
virtual std::string name () const
 

Private Attributes

protocols::filters::FilterOP filter_
 
core::Real steepness_
 dflt NULL More...
 
core::Real offset_
 
core::Real baseline_
 dflt 0 More...
 
bool negate_
 dflt 0; this is tricky; used internally to keep track of where the pose started. It is only reset by reset_baseline, and cannot, due to constness, be changed by apply More...
 
core::Real threshold_
 dflt false More...
 
std::string baseline_checkpointing_filename_
 dflt 0 (always accept) More...
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Detailed Description

transform the output from a regular filter into a sigmoid ranging from 0-1 according to: fx = 1/[1 + exp[ ( x - offset ) * steepness ] The function asymptotically reaches 1 at negative values and 0 at positive values. It's 0.5 at the offset and steepness determines its slope at the offset

Constructor & Destructor Documentation

protocols::simple_filters::Sigmoid::Sigmoid ( )

References filters.

Referenced by clone(), and fresh_instance().

protocols::simple_filters::Sigmoid::~Sigmoid ( )
virtual

Member Function Documentation

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

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

Implements protocols::filters::Filter.

References compute(), and threshold().

void protocols::simple_filters::Sigmoid::baseline_checkpointing_filename ( std::string const  s)
inline
std::string protocols::simple_filters::Sigmoid::baseline_checkpointing_filename ( ) const
inline
filters::FilterOP protocols::simple_filters::Sigmoid::clone ( ) const
inlinevirtual

Implements protocols::filters::Filter.

References Sigmoid().

core::Real protocols::simple_filters::Sigmoid::compute ( core::pose::Pose const &  pose) const
protocols::filters::FilterOP protocols::simple_filters::Sigmoid::filter ( ) const

References filter_.

Referenced by compute(), parse_my_tag(), and reset_baseline().

void protocols::simple_filters::Sigmoid::filter ( protocols::filters::FilterOP  f)

References filter_.

filters::FilterOP protocols::simple_filters::Sigmoid::fresh_instance ( ) const
inlinevirtual

Implements protocols::filters::Filter.

References Sigmoid().

bool protocols::simple_filters::Sigmoid::negate ( ) const
inline

References negate_.

Referenced by compute(), and parse_my_tag().

void protocols::simple_filters::Sigmoid::negate ( bool const  b)
inline
core::Real protocols::simple_filters::Sigmoid::offset ( )
inline

References offset_.

Referenced by parse_my_tag().

void protocols::simple_filters::Sigmoid::offset ( core::Real const  o)
inline

References offset_.

void protocols::simple_filters::Sigmoid::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap ,
filters::Filters_map const &  filters,
moves::Movers_map const &  ,
core::pose::Pose const &   
)
virtual
void protocols::simple_filters::Sigmoid::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
virtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::simple_filters::Sigmoid::report_sm ( core::pose::Pose const &  ) const
virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Referenced by compute().

void protocols::simple_filters::Sigmoid::reset_baseline ( core::pose::Pose const &  pose,
bool const  attempt_read_from_checkpoint 
)

The first MC trajectory should not read the baseline from the checkpoint file, instead, it should set the baseline attempt_read_from_checkpoint determines whether a read attempt from checkpoint should be attempted.

References baseline_, baseline_checkpointing_filename_, begin, end, filter(), getline(), protocols::filters::Filter::report_sm(), protocols::simple_filters::TR, and utility_exit_with_message.

core::Real protocols::simple_filters::Sigmoid::steepness ( ) const
inline

References steepness_.

Referenced by parse_my_tag().

void protocols::simple_filters::Sigmoid::steepness ( core::Real const  s)
inline

References steepness_.

core::Real protocols::simple_filters::Sigmoid::threshold ( ) const
inline

allows within-trajectory resetting of the baseline. Notice this is nonconst, so can't be called from apply. attempt_read_from_checkpoint should be true for MC trials > 1, but false otherwise

References threshold_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_filters::Sigmoid::threshold ( core::Real const  t)
inline

References threshold_.

Member Data Documentation

core::Real protocols::simple_filters::Sigmoid::baseline_
private

dflt 0

Referenced by compute(), and reset_baseline().

std::string protocols::simple_filters::Sigmoid::baseline_checkpointing_filename_
private

dflt 0 (always accept)

Referenced by baseline_checkpointing_filename(), parse_my_tag(), and reset_baseline().

protocols::filters::FilterOP protocols::simple_filters::Sigmoid::filter_
private

Referenced by filter().

bool protocols::simple_filters::Sigmoid::negate_
private

dflt 0; this is tricky; used internally to keep track of where the pose started. It is only reset by reset_baseline, and cannot, due to constness, be changed by apply

Referenced by negate().

core::Real protocols::simple_filters::Sigmoid::offset_
private

Referenced by compute(), and offset().

core::Real protocols::simple_filters::Sigmoid::steepness_
private

dflt NULL

Referenced by compute(), and steepness().

core::Real protocols::simple_filters::Sigmoid::threshold_
private

dflt false

Referenced by threshold().


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