ReFRACtor
FullPhysics::MaxAPosterioriOutput Class Reference

This registers the portions of the MaxAPosteriori class that should be written as output. More...

#include <max_a_posteriori_output.h>

+ Inheritance diagram for FullPhysics::MaxAPosterioriOutput:
+ Collaboration diagram for FullPhysics::MaxAPosterioriOutput:

Public Member Functions

 MaxAPosterioriOutput (const boost::shared_ptr< MaxAPosteriori > &MAP, bool Write_jacobian=false)
 You can optionally turn on the writing of the Jacobian. More...
 
virtual ~MaxAPosterioriOutput ()
 
virtual std::string desc () const
 Description of object, to be printed to stream. More...
 
virtual void print (std::ostream &Os) const
 Print to stream. More...
 
std::string print_to_string () const
 Print to string. More...
 
virtual void register_output (const boost::shared_ptr< Output > &out) const
 Register portions of class that will be written to output. More...
 
virtual void register_output_apriori (const boost::shared_ptr< Output > &out) const
 Register apriori portions of class. More...
 

Detailed Description

This registers the portions of the MaxAPosteriori class that should be written as output.

See the discussion in RegisterOutputBase why this isn't just part of the ConnnorSolver class.

Definition at line 14 of file max_a_posteriori_output.h.

Constructor & Destructor Documentation

◆ MaxAPosterioriOutput()

FullPhysics::MaxAPosterioriOutput::MaxAPosterioriOutput ( const boost::shared_ptr< MaxAPosteriori > &  MAP,
bool  Write_jacobian = false 
)
inline

You can optionally turn on the writing of the Jacobian.

We don't do this by default because the files get large if we do, and most of the time we don't need the Jacobian values.

Definition at line 22 of file max_a_posteriori_output.h.

◆ ~MaxAPosterioriOutput()

virtual FullPhysics::MaxAPosterioriOutput::~MaxAPosterioriOutput ( )
inlinevirtual

Definition at line 25 of file max_a_posteriori_output.h.

Member Function Documentation

◆ desc()

virtual std::string FullPhysics::RegisterOutputBase::desc ( ) const
inlinevirtualinherited

Description of object, to be printed to stream.

This gives a cleaner interface for deriving from python.

Reimplemented in FullPhysics::HighResSpectrumOutput.

Definition at line 83 of file register_output_base.h.

◆ print()

virtual void FullPhysics::RegisterOutputBase::print ( std::ostream &  Os) const
inlinevirtualinherited

Print to stream.

The default calls the function "desc" that returns a string. This gives cleaner interface for deriving from this class in python, but most C++ classes will want to override this function rather than using desc.

Definition at line 76 of file register_output_base.h.

◆ print_to_string()

std::string FullPhysics::Printable< RegisterOutputBase >::print_to_string ( ) const
inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ register_output()

void MaxAPosterioriOutput::register_output ( const boost::shared_ptr< Output > &  out) const
virtual

Register portions of class that will be written to output.

This is for the final statevector, for classes where apriori and final are written out different.

Implements FullPhysics::RegisterOutputBase.

Definition at line 14 of file max_a_posteriori_output.cc.

◆ register_output_apriori()

virtual void FullPhysics::RegisterOutputBase::register_output_apriori ( const boost::shared_ptr< Output > &  out) const
inlinevirtualinherited

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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13